Vertex AI v1 API - Class VertexAISearch (3.38.0) 

public sealed class VertexAISearch : IMessage<VertexAISearch>, IEquatable<VertexAISearch>, IDeepCloneable<VertexAISearch>, IBufferMessage, IMessage

Reference documentation and code samples for the Vertex AI v1 API class VertexAISearch.

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 > VertexAISearch

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

VertexAISearch()

public VertexAISearch()

VertexAISearch(VertexAISearch)

public VertexAISearch(VertexAISearch other)
Parameter
Name Description
other VertexAISearch

Properties

DataStoreSpecs

public RepeatedField<VertexAISearch.Types.DataStoreSpec> DataStoreSpecs { get; }

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.

Property Value
Type Description
RepeatedFieldVertexAISearchTypesDataStoreSpec

Datastore

public string Datastore { get; set; }

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

Property Value
Type Description
string

Engine

public string Engine { get; set; }

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

Property Value
Type Description
string

Filter

public string Filter { get; set; }

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

Property Value
Type Description
string

MaxResults

public int MaxResults { get; set; }

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

Property Value
Type Description
int