Package com.google.cloud.aiplatform.v1

Interface Tool.ParallelAiSearchOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Tool.ParallelAiSearch, Tool.ParallelAiSearch.Builder
Enclosing class:
Tool
public static interface Tool.ParallelAiSearchOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getApiKey()
    Optional.
    com.google.protobuf.ByteString
    getApiKeyBytes()
    Optional.
    com.google.protobuf.Struct
    getCustomConfigs()
    Optional.
    com.google.protobuf.StructOrBuilder
    getCustomConfigsOrBuilder()
    Optional.
    boolean
    hasCustomConfigs()
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getApiKey

      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];
      Returns:
      The apiKey.

    • getApiKeyBytes

      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];
      Returns:
      The bytes for apiKey.

    • hasCustomConfigs

      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];
      Returns:
      Whether the customConfigs field is set.

    • getCustomConfigs

      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];
      Returns:
      The customConfigs.

    • getCustomConfigsOrBuilder

      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];