Google Cloud Ai Platform V1 Client - Class AskContextsRequest (1.53.0)

Version latest

• 1.53.0 (latest)
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 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 AskContextsRequest.

Agentic Retrieval Ask API for RAG.

Request message for VertexRagService.AskContexts.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ 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.
↳ tools	array<Tool> Optional. The tools to use for AskContexts.

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

getTools

Optional. The tools to use for AskContexts.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setTools

Optional. The tools to use for AskContexts.

Parameter
Name	Description
var	array<Tool>

Returns
Type	Description
$this

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
AskContextsRequest