Interface EventMetadataOrBuilder (3.64.0)

public interface EventMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBranch()

public abstract String 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.

string branch = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The branch.

getBranchBytes()

public abstract ByteString getBranchBytes()

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.

string branch = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for branch.

getGroundingMetadata()

public abstract GroundingMetadata getGroundingMetadata()

Optional. Metadata returned to client when grounding is enabled.

.google.cloud.aiplatform.v1beta1.GroundingMetadata grounding_metadata = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GroundingMetadata

The groundingMetadata.

getGroundingMetadataOrBuilder()

public abstract GroundingMetadataOrBuilder getGroundingMetadataOrBuilder()

Optional. Metadata returned to client when grounding is enabled.

.google.cloud.aiplatform.v1beta1.GroundingMetadata grounding_metadata = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GroundingMetadataOrBuilder

getInterrupted()

public abstract boolean getInterrupted()

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

bool interrupted = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The interrupted.

getLongRunningToolIds(int index)

public abstract String getLongRunningToolIds(int index)

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.

repeated string long_running_tool_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The longRunningToolIds at the given index.

getLongRunningToolIdsBytes(int index)

public abstract ByteString getLongRunningToolIdsBytes(int index)

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.

repeated string long_running_tool_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the longRunningToolIds at the given index.

getLongRunningToolIdsCount()

public abstract int getLongRunningToolIdsCount()

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.

repeated string long_running_tool_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of longRunningToolIds.

getLongRunningToolIdsList()

public abstract List<String> getLongRunningToolIdsList()

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.

repeated string long_running_tool_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<String>

A list containing the longRunningToolIds.

getPartial()

public abstract boolean 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.

bool partial = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The partial.

getTurnComplete()

public abstract boolean getTurnComplete()

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

bool turn_complete = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The turnComplete.

hasGroundingMetadata()

public abstract boolean hasGroundingMetadata()

Optional. Metadata returned to client when grounding is enabled.

.google.cloud.aiplatform.v1beta1.GroundingMetadata grounding_metadata = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the groundingMetadata field is set.