Package com.google.cloud.aiplatform.v1

Interface EventMetadataOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
EventMetadata, EventMetadata.Builder
@Generated public interface EventMetadataOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasGroundingMetadata

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

    • getGroundingMetadata

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

    • getGroundingMetadataOrBuilder

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

    • getPartial

      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:
      The partial.

    • getTurnComplete

      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:
      The turnComplete.

    • getInterrupted

      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:
      The interrupted.

    • getLongRunningToolIdsList

      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:
      A list containing the longRunningToolIds.

    • getLongRunningToolIdsCount

      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:
      The count of longRunningToolIds.

    • getLongRunningToolIds

      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];
      Parameters:
      index - The index of the element to return.
      Returns:
      The longRunningToolIds at the given index.

    • getLongRunningToolIdsBytes

      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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the longRunningToolIds at the given index.

    • getBranch

      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:
      The branch.

    • getBranchBytes

      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];
      Returns:
      The bytes for branch.

    • hasCustomMetadata

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

    • getCustomMetadata

      com.google.protobuf.Struct getCustomMetadata()
       The custom metadata of the LlmResponse.
      .google.protobuf.Struct custom_metadata = 7;
      Returns:
      The customMetadata.

    • getCustomMetadataOrBuilder

      com.google.protobuf.StructOrBuilder getCustomMetadataOrBuilder()
       The custom metadata of the LlmResponse.
      .google.protobuf.Struct custom_metadata = 7;

    • hasInputTranscription

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

    • getInputTranscription

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

    • getInputTranscriptionOrBuilder

      TranscriptionOrBuilder getInputTranscriptionOrBuilder()
       Optional. Audio transcription of user input.
      .google.cloud.aiplatform.v1.Transcription input_transcription = 10 [(.google.api.field_behavior) = OPTIONAL];

    • hasOutputTranscription

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

    • getOutputTranscription

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

    • getOutputTranscriptionOrBuilder

      TranscriptionOrBuilder getOutputTranscriptionOrBuilder()
       Optional. Audio transcription of model output.
      .google.cloud.aiplatform.v1.Transcription output_transcription = 11 [(.google.api.field_behavior) = OPTIONAL];