Google Cloud Ai Platform V1 Client - Class AugmentPromptRequest (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 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
VertexRagStore|null

hasVertexRagStore

setVertexRagStore

Optional. Retrieves contexts from the Vertex RagStore.

Parameter
Name	Description
var	VertexRagStore

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
Google\Protobuf\Internal\RepeatedField

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
AugmentPromptRequest\Model|null

hasModel

clearModel

setModel

Optional. Metadata of the backend deployed model.

Parameter
Name	Description
var	AugmentPromptRequest\Model

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
AugmentPromptRequest