Class VertexAISearch
-
- All Implemented Interfaces:
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. This data type is not supported in Gemini API.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public abstract classVertexAISearch.BuilderBuilder for VertexAISearch.
-
Field Summary
Fields Modifier and Type Field Description public final static StringMAX_READ_LENGTH_PROPERTY
-
Constructor Summary
Constructors Constructor Description VertexAISearch()
-
Method Summary
Modifier and Type Method Description abstract Optional<List<VertexAISearchDataStoreSpec>>dataStoreSpecs()Specifications that define the specific DataStores to be searched, along with configurations for those data stores. abstract Optional<String>datastore()Optional. abstract Optional<String>engine()Optional. abstract Optional<String>filter()Optional. abstract Optional<Integer>maxResults()Optional. static VertexAISearch.Builderbuilder()Instantiates a builder for VertexAISearch. abstract VertexAISearch.BuildertoBuilder()Creates a builder with the same values as this instance. static VertexAISearchfromJson(String jsonString)Deserializes a JSON string to a VertexAISearch 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
-
dataStoreSpecs
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
abstract Optional<String> datastore()
Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
-
engine
abstract Optional<String> engine()
Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
-
maxResults
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
static VertexAISearch.Builder builder()
Instantiates a builder for VertexAISearch.
-
toBuilder
abstract VertexAISearch.Builder toBuilder()
Creates a builder with the same values as this instance.
-
fromJson
static VertexAISearch fromJson(String jsonString)
Deserializes a JSON string to a VertexAISearch object.
-
-
-
-