Package com.google.genai.types

Class VertexAISearch

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.VertexAISearch

public abstract class VertexAISearch
extends JsonSerializable

Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
VertexAISearch()

Method Summary

Modifier and Type	Method	Description
static VertexAISearch.Builder	builder()	Instantiates a builder for VertexAISearch.
abstract Optional<String>	datastore()	Optional.
abstract Optional<List<VertexAISearchDataStoreSpec>>	dataStoreSpecs()	Specifications that define the specific DataStores to be searched, along with configurations for those data stores.
abstract Optional<String>	engine()	Optional.
abstract Optional<String>	filter()	Optional.
static VertexAISearch	fromJson(String jsonString)	Deserializes a JSON string to a VertexAISearch object.
abstract Optional<Integer>	maxResults()	Optional.
abstract VertexAISearch.Builder	toBuilder()	Creates a builder with the same values as this instance.

Methods inherited from class com.google.genai.JsonSerializable

stringToJsonNode, toJson

Methods inherited from class java.lang.Object

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

Constructor Details

VertexAISearch

public VertexAISearch()

Method Details

dataStoreSpecs

public abstract Optional<List<VertexAISearchDataStoreSpec>> dataStoreSpecs()

Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.

datastore

public abstract Optional<String> datastore()

Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`

engine

public abstract Optional<String> engine()

Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`

filter

public abstract Optional<String> filter()

Optional. Filter strings to be passed to the search API.

maxResults

public abstract Optional<Integer> maxResults()

Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.

builder

public static VertexAISearch.Builder builder()

Instantiates a builder for VertexAISearch.

toBuilder

public abstract VertexAISearch.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static VertexAISearch fromJson(String jsonString)

Deserializes a JSON string to a VertexAISearch object.