Package com.google.cloud.aiplatform.v1

Class Tool.ParallelAiSearch

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch
All Implemented Interfaces:
Tool.ParallelAiSearchOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Tool
public static final class Tool.ParallelAiSearch extends com.google.protobuf.GeneratedMessage implements Tool.ParallelAiSearchOrBuilder
 ParallelAiSearch tool type.
 A tool that uses the Parallel.ai search engine for grounding.
Protobuf type google.cloud.aiplatform.v1.Tool.ParallelAiSearch
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Tool.ParallelAiSearch.Builder
    ParallelAiSearch tool type.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    API_KEY_FIELD_NUMBER
     
    static final int
    CUSTOM_CONFIGS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getApiKey()
    Optional.
    com.google.protobuf.ByteString
    getApiKeyBytes()
    Optional.
    com.google.protobuf.Struct
    getCustomConfigs()
    Optional.
    com.google.protobuf.StructOrBuilder
    getCustomConfigsOrBuilder()
    Optional.
    static Tool.ParallelAiSearch
    getDefaultInstance()
     
    Tool.ParallelAiSearch
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<Tool.ParallelAiSearch>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasCustomConfigs()
    Optional.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Tool.ParallelAiSearch.Builder
    newBuilder()
     
    static Tool.ParallelAiSearch.Builder
    newBuilder(Tool.ParallelAiSearch prototype)
     
    Tool.ParallelAiSearch.Builder
    newBuilderForType()
     
    protected Tool.ParallelAiSearch.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Tool.ParallelAiSearch
    parseDelimitedFrom(InputStream input)
     
    static Tool.ParallelAiSearch
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Tool.ParallelAiSearch
    parseFrom(byte[] data)
     
    static Tool.ParallelAiSearch
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Tool.ParallelAiSearch
    parseFrom(com.google.protobuf.ByteString data)
     
    static Tool.ParallelAiSearch
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Tool.ParallelAiSearch
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Tool.ParallelAiSearch
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Tool.ParallelAiSearch
    parseFrom(InputStream input)
     
    static Tool.ParallelAiSearch
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Tool.ParallelAiSearch
    parseFrom(ByteBuffer data)
     
    static Tool.ParallelAiSearch
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Tool.ParallelAiSearch>
    parser()
     
    Tool.ParallelAiSearch.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • API_KEY_FIELD_NUMBER

      public static final int API_KEY_FIELD_NUMBER
      See Also:

    • CUSTOM_CONFIGS_FIELD_NUMBER

      public static final int CUSTOM_CONFIGS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getApiKey

      public String getApiKey()
       Optional. The API key for ParallelAiSearch.
 If an API key is not provided, the system will attempt to verify access
 by checking for an active Parallel.ai subscription through the Google
 Cloud Marketplace.
 See https://docs.parallel.ai/search/search-quickstart for more details.
      string api_key = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getApiKey in interface Tool.ParallelAiSearchOrBuilder
      Returns:
      The apiKey.

    • getApiKeyBytes

      public com.google.protobuf.ByteString getApiKeyBytes()
       Optional. The API key for ParallelAiSearch.
 If an API key is not provided, the system will attempt to verify access
 by checking for an active Parallel.ai subscription through the Google
 Cloud Marketplace.
 See https://docs.parallel.ai/search/search-quickstart for more details.
      string api_key = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getApiKeyBytes in interface Tool.ParallelAiSearchOrBuilder
      Returns:
      The bytes for apiKey.

    • hasCustomConfigs

      public boolean hasCustomConfigs()
       Optional. Custom configs for ParallelAiSearch.
 This field can be used to pass any parameter from the Parallel.ai
 Search API.
 See the Parallel.ai documentation for the full list of available
 parameters and their usage:
 https://docs.parallel.ai/api-reference/search-beta/search
 Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
 `fetch_policy` can be set via this field. For example:
 {
 "source_policy": {
 "include_domains": ["google.com", "wikipedia.org"],
 "exclude_domains": ["example.com"]
 },
 "fetch_policy": {
 "max_age_seconds": 3600
 }
 }
      .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasCustomConfigs in interface Tool.ParallelAiSearchOrBuilder
      Returns:
      Whether the customConfigs field is set.

    • getCustomConfigs

      public com.google.protobuf.Struct getCustomConfigs()
       Optional. Custom configs for ParallelAiSearch.
 This field can be used to pass any parameter from the Parallel.ai
 Search API.
 See the Parallel.ai documentation for the full list of available
 parameters and their usage:
 https://docs.parallel.ai/api-reference/search-beta/search
 Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
 `fetch_policy` can be set via this field. For example:
 {
 "source_policy": {
 "include_domains": ["google.com", "wikipedia.org"],
 "exclude_domains": ["example.com"]
 },
 "fetch_policy": {
 "max_age_seconds": 3600
 }
 }
      .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomConfigs in interface Tool.ParallelAiSearchOrBuilder
      Returns:
      The customConfigs.

    • getCustomConfigsOrBuilder

      public com.google.protobuf.StructOrBuilder getCustomConfigsOrBuilder()
       Optional. Custom configs for ParallelAiSearch.
 This field can be used to pass any parameter from the Parallel.ai
 Search API.
 See the Parallel.ai documentation for the full list of available
 parameters and their usage:
 https://docs.parallel.ai/api-reference/search-beta/search
 Currently only `source_policy`, `excerpts`, `max_results`, `mode`,
 `fetch_policy` can be set via this field. For example:
 {
 "source_policy": {
 "include_domains": ["google.com", "wikipedia.org"],
 "exclude_domains": ["example.com"]
 },
 "fetch_policy": {
 "max_age_seconds": 3600
 }
 }
      .google.protobuf.Struct custom_configs = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomConfigsOrBuilder in interface Tool.ParallelAiSearchOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Tool.ParallelAiSearch parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool.ParallelAiSearch parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool.ParallelAiSearch parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool.ParallelAiSearch parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool.ParallelAiSearch parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool.ParallelAiSearch parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool.ParallelAiSearch parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Tool.ParallelAiSearch parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Tool.ParallelAiSearch parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Tool.ParallelAiSearch parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Tool.ParallelAiSearch parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Tool.ParallelAiSearch parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Tool.ParallelAiSearch.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Tool.ParallelAiSearch.Builder newBuilder()

    • newBuilder

      public static Tool.ParallelAiSearch.Builder newBuilder(Tool.ParallelAiSearch prototype)

    • toBuilder

      public Tool.ParallelAiSearch.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Tool.ParallelAiSearch.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Tool.ParallelAiSearch getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Tool.ParallelAiSearch> parser()

    • getParserForType

      public com.google.protobuf.Parser<Tool.ParallelAiSearch> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Tool.ParallelAiSearch getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder