Package com.google.cloud.aiplatform.v1

Class Tool.ParallelAiSearch.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Tool.ParallelAiSearch.Builder>
com.google.cloud.aiplatform.v1.Tool.ParallelAiSearch.Builder
All Implemented Interfaces:
Tool.ParallelAiSearchOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Tool.ParallelAiSearch
public static final class Tool.ParallelAiSearch.Builder extends com.google.protobuf.GeneratedMessage.Builder<Tool.ParallelAiSearch.Builder> 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

  • 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.Builder<Tool.ParallelAiSearch.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Tool.ParallelAiSearch.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public Tool.ParallelAiSearch.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Tool.ParallelAiSearch.Builder>

    • mergeFrom

      public Tool.ParallelAiSearch.Builder mergeFrom(Tool.ParallelAiSearch other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Tool.ParallelAiSearch.Builder>

    • mergeFrom

      public Tool.ParallelAiSearch.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Tool.ParallelAiSearch.Builder>
      Throws:
      IOException

    • 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.

    • setApiKey

      public Tool.ParallelAiSearch.Builder setApiKey(String value)
       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];
      Parameters:
      value - The apiKey to set.
      Returns:
      This builder for chaining.

    • clearApiKey

      public Tool.ParallelAiSearch.Builder clearApiKey()
       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];
      Returns:
      This builder for chaining.

    • setApiKeyBytes

      public Tool.ParallelAiSearch.Builder setApiKeyBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for apiKey to set.
      Returns:
      This builder for chaining.

    • 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.

    • setCustomConfigs

      public Tool.ParallelAiSearch.Builder setCustomConfigs(com.google.protobuf.Struct value)
       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];

    • setCustomConfigs

      public Tool.ParallelAiSearch.Builder setCustomConfigs(com.google.protobuf.Struct.Builder builderForValue)
       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];

    • mergeCustomConfigs

      public Tool.ParallelAiSearch.Builder mergeCustomConfigs(com.google.protobuf.Struct value)
       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];

    • clearCustomConfigs

      public Tool.ParallelAiSearch.Builder clearCustomConfigs()
       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];

    • getCustomConfigsBuilder

      public com.google.protobuf.Struct.Builder getCustomConfigsBuilder()
       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];

    • 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