google-genai-kotlin/com.google.genai.kotlin.types/VertexAISearch

VertexAISearch

@Serializable

data class VertexAISearch(val dataStoreSpecs: List<VertexAISearchDataStoreSpec>? = null, val datastore: String? = null, val engine: String? = null, val filter: String? = null, val maxResults: Int? = null)

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.

Constructors

VertexAISearch

constructor(dataStoreSpecs: List<VertexAISearchDataStoreSpec>? = null, datastore: String? = null, engine: String? = null, filter: String? = null, maxResults: Int? = null)

Properties

datastore

val datastore: String? = null

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

dataStoreSpecs

val dataStoreSpecs: List<VertexAISearchDataStoreSpec>? = null

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.

engine

val engine: String? = null

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

filter

val filter: String? = null

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

maxResults

val maxResults: Int? = null

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