- 1.35.0 (latest)
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
Reference documentation and code samples for the Google Cloud Ai Platform V1 Client 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
Generated from protobuf message google.cloud.aiplatform.v1.VertexAISearch
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ datastore
string
Optional. Fully-qualified Vertex AI Search data store resource ID. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
↳ engine
string
Optional. Fully-qualified Vertex AI Search engine resource ID. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
↳ max_results
int
Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
↳ filter
string
Optional. Filter strings to be passed to the search API.
↳ data_store_specs
array< 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.
getDatastore
Optional. Fully-qualified Vertex AI Search data store resource ID.
Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
string
setDatastore
Optional. Fully-qualified Vertex AI Search data store resource ID.
Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
var
string
$this
getEngine
Optional. Fully-qualified Vertex AI Search engine resource ID.
Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
string
setEngine
Optional. Fully-qualified Vertex AI Search engine resource ID.
Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
var
string
$this
getMaxResults
Optional. Number of search results to return per query.
The default value is 10. The maximumm allowed value is 10.
int
setMaxResults
Optional. Number of search results to return per query.
The default value is 10. The maximumm allowed value is 10.
var
int
$this
getFilter
Optional. Filter strings to be passed to the search API.
string
setFilter
Optional. Filter strings to be passed to the search API.
var
string
$this
getDataStoreSpecs
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.
setDataStoreSpecs
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.
$this
