Google Cloud Ai Platform V1 Client - Class RetrieveContextsRequest (1.13.0)

Version latest

• 1.13.0 (latest)
• 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 RetrieveContextsRequest.

Request message for VertexRagService.RetrieveContexts.

Generated from protobuf message google.cloud.aiplatform.v1.RetrieveContextsRequest

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ vertex_rag_store	RetrieveContextsRequest\VertexRagStore The data source for Vertex RagStore.
↳ parent	string Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: projects/{project}/locations/{location}.
↳ query	RagQuery Required. Single RAG retrieve query.

getVertexRagStore

The data source for Vertex RagStore.

Returns
Type	Description
RetrieveContextsRequest\VertexRagStore|null

hasVertexRagStore

setVertexRagStore

The data source for Vertex RagStore.

Parameter
Name	Description
var	RetrieveContextsRequest\VertexRagStore

Returns
Type	Description
$this

getParent

Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project.

Format: projects/{project}/locations/{location}.

Returns
Type	Description
string

setParent

Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project.

Format: projects/{project}/locations/{location}.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getQuery

Required. Single RAG retrieve query.

Returns
Type	Description
RagQuery|null

hasQuery

clearQuery

setQuery

Required. Single RAG retrieve query.

Parameter
Name	Description
var	RagQuery

Returns
Type	Description
$this

getDataSource

Returns
Type	Description
string

static::build

Parameters
Name	Description
parent	string Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: projects/{project}/locations/{location}. Please see VertexRagServiceClient::locationName() for help formatting this field.
query	RagQuery Required. Single RAG retrieve query.

Returns
Type	Description
RetrieveContextsRequest