google-genai-kotlin/com.google.genai.kotlin.types/ToolParallelAiSearch

ToolParallelAiSearch

@Serializable

data class ToolParallelAiSearch(val apiKey: String? = null, val customConfigs: Map<String, JsonElement>? = null, val enableDataRetention: Boolean? = null, val enableZeroDataRetention: Boolean? = null)

ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. This data type is not supported in Gemini API.

Constructors

constructor(apiKey: String? = null, customConfigs: Map<String, JsonElement>? = null, enableDataRetention: Boolean? = null, enableZeroDataRetention: Boolean? = null)

Properties

apiKey

val apiKey: String? = null

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.

customConfigs

val customConfigs: Map<String, JsonElement>? = null

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 } }

enableDataRetention

val enableDataRetention: Boolean? = null

Optional. Deprecated: Use enable_zero_data_retention instead. 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.

enableZeroDataRetention

val enableZeroDataRetention: Boolean? = null

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.