Package com.google.cloud.aiplatform.v1

Class EventMetadata

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.EventMetadata
All Implemented Interfaces:
EventMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class EventMetadata extends com.google.protobuf.GeneratedMessage implements EventMetadataOrBuilder
 Metadata relating to a LLM response event.
Protobuf type google.cloud.aiplatform.v1.EventMetadata
See Also:

  • Field Details

    • GROUNDING_METADATA_FIELD_NUMBER

      public static final int GROUNDING_METADATA_FIELD_NUMBER
      See Also:

    • PARTIAL_FIELD_NUMBER

      public static final int PARTIAL_FIELD_NUMBER
      See Also:

    • TURN_COMPLETE_FIELD_NUMBER

      public static final int TURN_COMPLETE_FIELD_NUMBER
      See Also:

    • INTERRUPTED_FIELD_NUMBER

      public static final int INTERRUPTED_FIELD_NUMBER
      See Also:

    • LONG_RUNNING_TOOL_IDS_FIELD_NUMBER

      public static final int LONG_RUNNING_TOOL_IDS_FIELD_NUMBER
      See Also:

    • BRANCH_FIELD_NUMBER

      public static final int BRANCH_FIELD_NUMBER
      See Also:

    • CUSTOM_METADATA_FIELD_NUMBER

      public static final int CUSTOM_METADATA_FIELD_NUMBER
      See Also:

    • INPUT_TRANSCRIPTION_FIELD_NUMBER

      public static final int INPUT_TRANSCRIPTION_FIELD_NUMBER
      See Also:

    • OUTPUT_TRANSCRIPTION_FIELD_NUMBER

      public static final int OUTPUT_TRANSCRIPTION_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasGroundingMetadata

      public boolean hasGroundingMetadata()
       Optional. Metadata returned to client when grounding is enabled.
      .google.cloud.aiplatform.v1.GroundingMetadata grounding_metadata = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasGroundingMetadata in interface EventMetadataOrBuilder
      Returns:
      Whether the groundingMetadata field is set.

    • getGroundingMetadata

      public GroundingMetadata getGroundingMetadata()
       Optional. Metadata returned to client when grounding is enabled.
      .google.cloud.aiplatform.v1.GroundingMetadata grounding_metadata = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGroundingMetadata in interface EventMetadataOrBuilder
      Returns:
      The groundingMetadata.

    • getGroundingMetadataOrBuilder

      public GroundingMetadataOrBuilder getGroundingMetadataOrBuilder()
       Optional. Metadata returned to client when grounding is enabled.
      .google.cloud.aiplatform.v1.GroundingMetadata grounding_metadata = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGroundingMetadataOrBuilder in interface EventMetadataOrBuilder

    • getPartial

      public 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];
      Specified by:
      getPartial in interface EventMetadataOrBuilder
      Returns:
      The partial.

    • getTurnComplete

      public 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];
      Specified by:
      getTurnComplete in interface EventMetadataOrBuilder
      Returns:
      The turnComplete.

    • getInterrupted

      public 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];
      Specified by:
      getInterrupted in interface EventMetadataOrBuilder
      Returns:
      The interrupted.

    • getLongRunningToolIdsList

      public com.google.protobuf.ProtocolStringList 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];
      Specified by:
      getLongRunningToolIdsList in interface EventMetadataOrBuilder
      Returns:
      A list containing the longRunningToolIds.

    • getLongRunningToolIdsCount

      public 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];
      Specified by:
      getLongRunningToolIdsCount in interface EventMetadataOrBuilder
      Returns:
      The count of longRunningToolIds.

    • getLongRunningToolIds

      public 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];
      Specified by:
      getLongRunningToolIds in interface EventMetadataOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The longRunningToolIds at the given index.

    • getLongRunningToolIdsBytes

      public com.google.protobuf.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];
      Specified by:
      getLongRunningToolIdsBytes in interface EventMetadataOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the longRunningToolIds at the given index.

    • getBranch

      public 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];
      Specified by:
      getBranch in interface EventMetadataOrBuilder
      Returns:
      The branch.

    • getBranchBytes

      public com.google.protobuf.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];
      Specified by:
      getBranchBytes in interface EventMetadataOrBuilder
      Returns:
      The bytes for branch.

    • hasCustomMetadata

      public boolean hasCustomMetadata()
       The custom metadata of the LlmResponse.
      .google.protobuf.Struct custom_metadata = 7;
      Specified by:
      hasCustomMetadata in interface EventMetadataOrBuilder
      Returns:
      Whether the customMetadata field is set.

    • getCustomMetadata

      public com.google.protobuf.Struct getCustomMetadata()
       The custom metadata of the LlmResponse.
      .google.protobuf.Struct custom_metadata = 7;
      Specified by:
      getCustomMetadata in interface EventMetadataOrBuilder
      Returns:
      The customMetadata.

    • getCustomMetadataOrBuilder

      public com.google.protobuf.StructOrBuilder getCustomMetadataOrBuilder()
       The custom metadata of the LlmResponse.
      .google.protobuf.Struct custom_metadata = 7;
      Specified by:
      getCustomMetadataOrBuilder in interface EventMetadataOrBuilder

    • hasInputTranscription

      public boolean hasInputTranscription()
       Optional. Audio transcription of user input.
      .google.cloud.aiplatform.v1.Transcription input_transcription = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasInputTranscription in interface EventMetadataOrBuilder
      Returns:
      Whether the inputTranscription field is set.

    • getInputTranscription

      public Transcription getInputTranscription()
       Optional. Audio transcription of user input.
      .google.cloud.aiplatform.v1.Transcription input_transcription = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getInputTranscription in interface EventMetadataOrBuilder
      Returns:
      The inputTranscription.

    • getInputTranscriptionOrBuilder

      public TranscriptionOrBuilder getInputTranscriptionOrBuilder()
       Optional. Audio transcription of user input.
      .google.cloud.aiplatform.v1.Transcription input_transcription = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getInputTranscriptionOrBuilder in interface EventMetadataOrBuilder

    • hasOutputTranscription

      public boolean hasOutputTranscription()
       Optional. Audio transcription of model output.
      .google.cloud.aiplatform.v1.Transcription output_transcription = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasOutputTranscription in interface EventMetadataOrBuilder
      Returns:
      Whether the outputTranscription field is set.

    • getOutputTranscription

      public Transcription getOutputTranscription()
       Optional. Audio transcription of model output.
      .google.cloud.aiplatform.v1.Transcription output_transcription = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOutputTranscription in interface EventMetadataOrBuilder
      Returns:
      The outputTranscription.

    • getOutputTranscriptionOrBuilder

      public TranscriptionOrBuilder getOutputTranscriptionOrBuilder()
       Optional. Audio transcription of model output.
      .google.cloud.aiplatform.v1.Transcription output_transcription = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOutputTranscriptionOrBuilder in interface EventMetadataOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static EventMetadata parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EventMetadata parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EventMetadata parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EventMetadata parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EventMetadata parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EventMetadata parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EventMetadata parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EventMetadata parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static EventMetadata parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static EventMetadata parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EventMetadata parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EventMetadata parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public EventMetadata.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static EventMetadata.Builder newBuilder()

    • newBuilder

      public static EventMetadata.Builder newBuilder(EventMetadata prototype)

    • toBuilder

      public EventMetadata.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected EventMetadata.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static EventMetadata getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<EventMetadata> parser()

    • getParserForType

      public com.google.protobuf.Parser<EventMetadata> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public EventMetadata getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder