Package com.google.genai.types

Class ToolParallelAiSearch

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.ToolParallelAiSearch

public abstract class ToolParallelAiSearch
extends JsonSerializable

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ToolParallelAiSearch.Builder	Builder for ToolParallelAiSearch.

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
ToolParallelAiSearch()

Method Summary

Modifier and Type	Method	Description
abstract Optional<String>	apiKey()	Optional.
static ToolParallelAiSearch.Builder	builder()	Instantiates a builder for ToolParallelAiSearch.
abstract Optional<Map<String,Object>>	customConfigs()	Optional.
abstract Optional<Boolean>	enableDataRetention()	Optional.
abstract Optional<Boolean>	enableZeroDataRetention()	Optional.
static ToolParallelAiSearch	fromJson(String jsonString)	Deserializes a JSON string to a ToolParallelAiSearch object.
abstract ToolParallelAiSearch.Builder	toBuilder()	Creates a builder with the same values as this instance.

Methods inherited from class com.google.genai.JsonSerializable

fromJsonNode, fromJsonString, objectMapper, setMaxReadLength, stringToJsonNode, toJson, toJsonNode, toJsonString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ToolParallelAiSearch

public ToolParallelAiSearch()

Method Details

apiKey

public abstract Optional<String> apiKey()

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

public abstract Optional<Map<String,Object>> customConfigs()

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

public abstract Optional<Boolean> enableDataRetention()

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

public abstract Optional<Boolean> enableZeroDataRetention()

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.

builder

public static ToolParallelAiSearch.Builder builder()

Instantiates a builder for ToolParallelAiSearch.

toBuilder

public abstract ToolParallelAiSearch.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static ToolParallelAiSearch fromJson(String jsonString)

Deserializes a JSON string to a ToolParallelAiSearch object.