Vertex AI v1beta1 API - Class EventMetadata (1.0.0-beta61) 

public sealed class EventMetadata : IMessage<EventMetadata>, IEquatable<EventMetadata>, IDeepCloneable<EventMetadata>, IBufferMessage, IMessage

Reference documentation and code samples for the Vertex AI v1beta1 API class EventMetadata.

Metadata relating to a LLM response event.

Inheritance

object > EventMetadata

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

EventMetadata()

public EventMetadata()

EventMetadata(EventMetadata)

public EventMetadata(EventMetadata other)
Parameter
Name Description
other EventMetadata

Properties

Branch

public string Branch { get; set; }

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.

Property Value
Type Description
string

CustomMetadata

public Struct CustomMetadata { get; set; }

The custom metadata of the LlmResponse.

Property Value
Type Description
Struct

GroundingMetadata

public GroundingMetadata GroundingMetadata { get; set; }

Optional. Metadata returned to client when grounding is enabled.

Property Value
Type Description
GroundingMetadata

Interrupted

public bool Interrupted { get; set; }

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

Property Value
Type Description
bool

LongRunningToolIds

public RepeatedField<string> LongRunningToolIds { get; }

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.

Property Value
Type Description
RepeatedFieldstring

Partial

public bool Partial { get; set; }

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.

Property Value
Type Description
bool

TurnComplete

public bool TurnComplete { get; set; }

Optional. Indicates whether the response from the model is complete. Only used for streaming mode.

Property Value
Type Description
bool