Google Cloud Ai Platform V1 Client - Class AskContextsRequest (1.56.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
Returns
Type
Description
$this

getTools

Optional. The tools to use for AskContexts.

Returns
Type
Description

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
Create a Mobile Website
View Site in Mobile | Classic
Share by: