Google Cloud Ai Platform V1 Client - Class AugmentPromptRequest (1.17.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class AugmentPromptRequest.

Request message for AugmentPrompt.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ vertex_rag_store
VertexRagStore

Optional. Retrieves contexts from the Vertex RagStore.

↳ parent
string

Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: projects/{project}/locations/{location} .

↳ contents
array< Content >

Optional. Input content to augment, only text format is supported for now.

↳ model
AugmentPromptRequest\Model

Optional. Metadata of the backend deployed model.

getVertexRagStore

Optional. Retrieves contexts from the Vertex RagStore.

Returns
Type
Description

hasVertexRagStore

setVertexRagStore

Optional. Retrieves contexts from the Vertex RagStore.

Parameter
Name
Description
Returns
Type
Description
$this

getParent

Required. The resource name of the Location from which to augment prompt.

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 augment prompt.

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

getContents

Optional. Input content to augment, only text format is supported for now.

Returns
Type
Description

setContents

Optional. Input content to augment, only text format is supported for now.

Parameter
Name
Description
var
array< Content >
Returns
Type
Description
$this

getModel

Optional. Metadata of the backend deployed model.

Returns
Type
Description

hasModel

clearModel

setModel

Optional. Metadata of the backend deployed model.

Parameter
Name
Description
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 augment prompt. 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.

model
AugmentPromptRequest\Model

Optional. Metadata of the backend deployed model.

vertexRagStore
VertexRagStore

Optional. Retrieves contexts from the Vertex RagStore.

Returns
Type
Description
Design a Mobile Site
View Site in Mobile | Classic
Share by: