Class ToolParallelAiSearch
-
- All Implemented Interfaces:
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 public abstract classToolParallelAiSearch.BuilderBuilder for ToolParallelAiSearch.
-
Field Summary
Fields Modifier and Type Field Description public final static StringMAX_READ_LENGTH_PROPERTY
-
Constructor Summary
Constructors Constructor Description ToolParallelAiSearch()
-
Method Summary
Modifier and Type Method Description abstract Optional<String>apiKey()Optional. abstract Optional<Map<String, Object>>customConfigs()Optional. static ToolParallelAiSearch.Builderbuilder()Instantiates a builder for ToolParallelAiSearch. abstract ToolParallelAiSearch.BuildertoBuilder()Creates a builder with the same values as this instance. static ToolParallelAiSearchfromJson(String jsonString)Deserializes a JSON string to a ToolParallelAiSearch object. -
Methods inherited from class com.google.genai.JsonSerializable
fromJsonNode, fromJsonString, objectMapper, setMaxReadLength, stringToJsonNode, toJson, toJsonNode, toJsonString -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
apiKey
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
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 } }
-
builder
static ToolParallelAiSearch.Builder builder()
Instantiates a builder for ToolParallelAiSearch.
-
toBuilder
abstract ToolParallelAiSearch.Builder toBuilder()
Creates a builder with the same values as this instance.
-
fromJson
static ToolParallelAiSearch fromJson(String jsonString)
Deserializes a JSON string to a ToolParallelAiSearch object.
-
-
-
-