Table of Contents

Class VertexAISearch

Namespace
GenerativeAI.Types.RagEngine
Assembly
GenerativeAI.dll

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

public class VertexAISearch
Inheritance
VertexAISearch
Inherited Members
Extension Methods

Properties

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.

[JsonPropertyName("dataStoreSpecs")]
public List<VertexAISearchDataStoreSpec>? DataStoreSpecs { get; set; }

Property Value

List<VertexAISearchDataStoreSpec>

Datastore

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

[JsonPropertyName("datastore")]
public string? Datastore { get; set; }

Property Value

string

Engine

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

[JsonPropertyName("engine")]
public string? Engine { get; set; }

Property Value

string

Filter

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

[JsonPropertyName("filter")]
public string? Filter { get; set; }

Property Value

string

MaxResults

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

[JsonPropertyName("maxResults")]
public int? MaxResults { get; set; }

Property Value

int?