Interface Tool.ParallelAiSearchOrBuilder (3.100.0)

public static interface Tool.ParallelAiSearchOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getApiKey()

public abstract 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
Type Description
String

The apiKey.

getApiKeyBytes()

public abstract 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
Type Description
ByteString

The bytes for apiKey.

getCustomConfigs()

public abstract 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
Type Description
Struct

The customConfigs.

getCustomConfigsOrBuilder()

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

Returns
Type Description
StructOrBuilder

getEnableZeroDataRetention()

public abstract boolean getEnableZeroDataRetention()

Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used.

bool enable_zero_data_retention = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enableZeroDataRetention.

hasCustomConfigs()

public abstract 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
Type Description
boolean

Whether the customConfigs field is set.