VertexAisearch class final

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

Inheritance
  • Object
  • ProtoMessage
  • VertexAisearch

Constructors

VertexAisearch({String datastore = '', String engine = '', int maxResults = 0, String filter = '', List<VertexAisearch_DataStoreSpec> dataStoreSpecs = const []})
VertexAisearch.fromJson(Object? j)
factory

Properties

datastore String
Optional. Fully-qualified Vertex AI Search data store resource ID. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
final
dataStoreSpecs List<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.
final
engine String
Optional. Fully-qualified Vertex AI Search engine resource ID. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
final
filter String
Optional. Filter strings to be passed to the search API.
final
hashCode int
The hash code for this object.
no setterinherited
maxResults int
Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
final
qualifiedName String
The fully qualified name of this message, i.e., google.protobuf.Duration or google.rpc.ErrorInfo.
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Object
override
toString() String
A string representation of this object.
override

Operators

operator ==(Object other) bool
The equality operator.
inherited

Constants

fullyQualifiedName → const String