Google Cloud Ai Platform V1 Client - Class VertexAISearch (1.19.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 \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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}

getDatastore

Optional. Fully-qualified Vertex AI Search data store resource ID.

Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}

Returns
Type Description
string

setDatastore

Optional. Fully-qualified Vertex AI Search data store resource ID.

Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}

Parameter
Name Description
var string
Returns
Type Description
$this

getEngine

Optional. Fully-qualified Vertex AI Search engine resource ID.

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

Returns
Type Description
string

setEngine

Optional. Fully-qualified Vertex AI Search engine resource ID.

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

Parameter
Name Description
var string
Returns
Type Description
$this