Google Cloud Ai Platform V1 Client - Class EventMetadata (1.52.0)

Version latest

• 1.52.0 (latest)
• 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 EventMetadata.

Metadata relating to a LLM response event.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ grounding_metadata	GroundingMetadata Optional. Metadata returned to client when grounding is enabled.
↳ partial	bool Optional. Indicates whether the text content is part of a unfinished text stream. Only used for streaming mode and when the content is plain text.
↳ turn_complete	bool Optional. Indicates whether the response from the model is complete. Only used for streaming mode.
↳ interrupted	bool Optional. Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming.
↳ long_running_tool_ids	array Optional. Set of ids of the long running function calls. Agent client will know from this field about which function call is long running. Only valid for function call event.
↳ branch	string Optional. The branch of the event. The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of agent_2, and agent_2 is the parent of agent_3. Branch is used when multiple child agents shouldn't see their siblings' conversation history.
↳ custom_metadata	Google\Protobuf\Struct The custom metadata of the LlmResponse.
↳ input_transcription	Transcription Optional. Audio transcription of user input.
↳ output_transcription	Transcription Optional. Audio transcription of model output.

getGroundingMetadata

Optional. Metadata returned to client when grounding is enabled.

Returns
Type	Description
GroundingMetadata|null

hasGroundingMetadata

clearGroundingMetadata

setGroundingMetadata

Optional. Metadata returned to client when grounding is enabled.

Parameter
Name	Description
var	GroundingMetadata

Returns
Type	Description
$this

getPartial

Optional. Indicates whether the text content is part of a unfinished text stream. Only used for streaming mode and when the content is plain text.

Returns
Type	Description
bool

setPartial

Optional. Indicates whether the text content is part of a unfinished text stream. Only used for streaming mode and when the content is plain text.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getTurnComplete

Optional. Indicates whether the response from the model is complete.

Only used for streaming mode.

Returns
Type	Description
bool

setTurnComplete

Optional. Indicates whether the response from the model is complete.

Only used for streaming mode.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getInterrupted

Optional. Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming.

Returns
Type	Description
bool

setInterrupted

Optional. Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getLongRunningToolIds

Optional. Set of ids of the long running function calls.

Agent client will know from this field about which function call is long running. Only valid for function call event.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setLongRunningToolIds

Optional. Set of ids of the long running function calls.

Agent client will know from this field about which function call is long running. Only valid for function call event.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getBranch

Optional. The branch of the event.

The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of agent_2, and agent_2 is the parent of agent_3. Branch is used when multiple child agents shouldn't see their siblings' conversation history.

Returns
Type	Description
string

setBranch

Optional. The branch of the event.

The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of agent_2, and agent_2 is the parent of agent_3. Branch is used when multiple child agents shouldn't see their siblings' conversation history.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCustomMetadata

The custom metadata of the LlmResponse.

Returns
Type	Description
Google\Protobuf\Struct|null

hasCustomMetadata

clearCustomMetadata

setCustomMetadata

The custom metadata of the LlmResponse.

Parameter
Name	Description
var	Google\Protobuf\Struct

Returns
Type	Description
$this

getInputTranscription

Optional. Audio transcription of user input.

Returns
Type	Description
Transcription|null

hasInputTranscription

clearInputTranscription

setInputTranscription

Optional. Audio transcription of user input.

Parameter
Name	Description
var	Transcription

Returns
Type	Description
$this

getOutputTranscription

Optional. Audio transcription of model output.

Returns
Type	Description
Transcription|null

hasOutputTranscription

clearOutputTranscription

setOutputTranscription

Optional. Audio transcription of model output.

Parameter
Name	Description
var	Transcription

Returns
Type	Description
$this