Google Cloud Ai Platform V1 Client - Class RetrieveContextsRequest (1.21.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