google-adk-kotlin-core/com.google.adk.kt.types/VertexAISearch

VertexAISearch

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.

Constructors

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

Properties

Link copied to clipboard
val datastore: String? = null
Link copied to clipboard
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.

Link copied to clipboard
val engine: String? = null

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

Link copied to clipboard
val filter: String? = null

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

Link copied to clipboard
val maxResults: Int? = null

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