Class VertexAISearch (1.100.0)

VertexAISearch(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

Attributes

Name Description
datastore str
Optional. Fully-qualified Vertex AI Search data store resource ID. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
engine str
Optional. Fully-qualified Vertex AI Search engine resource ID. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
max_results int
Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
filter str
Optional. Filter strings to be passed to the search API.
data_store_specs MutableSequence[google.cloud.aiplatform_v1beta1.types.VertexAISearch.DataStoreSpec]
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.

Classes

DataStoreSpec

DataStoreSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec

Methods

VertexAISearch

VertexAISearch(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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