Package org.springframework.ai.bedrock.converse.api

Record Class ConverseApiUtils.MetadataAggregation

java.lang.Object
java.lang.Record
org.springframework.ai.bedrock.converse.api.ConverseApiUtils.MetadataAggregation
Enclosing class:
ConverseApiUtils
public static record ConverseApiUtils.MetadataAggregation(String role, String stopReason, software.amazon.awssdk.core.document.Document additionalModelResponseFields, software.amazon.awssdk.services.bedrockruntime.model.TokenUsage tokenUsage, software.amazon.awssdk.services.bedrockruntime.model.ConverseStreamMetrics metrics, software.amazon.awssdk.services.bedrockruntime.model.ConverseStreamTrace trace) extends Record

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ConverseApiUtils.MetadataAggregation.Builder
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    MetadataAggregation(String role, String stopReason, software.amazon.awssdk.core.document.Document additionalModelResponseFields, software.amazon.awssdk.services.bedrockruntime.model.TokenUsage tokenUsage, software.amazon.awssdk.services.bedrockruntime.model.ConverseStreamMetrics metrics, software.amazon.awssdk.services.bedrockruntime.model.ConverseStreamTrace trace)
    Creates an instance of a MetadataAggregation record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    software.amazon.awssdk.core.document.Document
    additionalModelResponseFields()
    Returns the value of the additionalModelResponseFields record component.
    static ConverseApiUtils.MetadataAggregation.Builder
    builder()
     
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    software.amazon.awssdk.services.bedrockruntime.model.ConverseStreamMetrics
    metrics()
    Returns the value of the metrics record component.
    String
    role()
    Returns the value of the role record component.
    String
    stopReason()
    Returns the value of the stopReason record component.
    software.amazon.awssdk.services.bedrockruntime.model.TokenUsage
    tokenUsage()
    Returns the value of the tokenUsage record component.
    final String
    toString()
    Returns a string representation of this record class.
    software.amazon.awssdk.services.bedrockruntime.model.ConverseStreamTrace
    trace()
    Returns the value of the trace record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • MetadataAggregation

      public MetadataAggregation(String role, String stopReason, software.amazon.awssdk.core.document.Document additionalModelResponseFields, software.amazon.awssdk.services.bedrockruntime.model.TokenUsage tokenUsage, software.amazon.awssdk.services.bedrockruntime.model.ConverseStreamMetrics metrics, software.amazon.awssdk.services.bedrockruntime.model.ConverseStreamTrace trace)
      Creates an instance of a MetadataAggregation record class.
      Parameters:
      role - the value for the role record component
      stopReason - the value for the stopReason record component
      additionalModelResponseFields - the value for the additionalModelResponseFields record component
      tokenUsage - the value for the tokenUsage record component
      metrics - the value for the metrics record component
      trace - the value for the trace record component

  • Method Details

    • builder

      public static ConverseApiUtils.MetadataAggregation.Builder builder()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • role

      public String role()
      Returns the value of the role record component.
      Returns:
      the value of the role record component

    • stopReason

      public String stopReason()
      Returns the value of the stopReason record component.
      Returns:
      the value of the stopReason record component

    • additionalModelResponseFields

      public software.amazon.awssdk.core.document.Document additionalModelResponseFields()
      Returns the value of the additionalModelResponseFields record component.
      Returns:
      the value of the additionalModelResponseFields record component

    • tokenUsage

      public software.amazon.awssdk.services.bedrockruntime.model.TokenUsage tokenUsage()
      Returns the value of the tokenUsage record component.
      Returns:
      the value of the tokenUsage record component

    • metrics

      public software.amazon.awssdk.services.bedrockruntime.model.ConverseStreamMetrics metrics()
      Returns the value of the metrics record component.
      Returns:
      the value of the metrics record component

    • trace

      public software.amazon.awssdk.services.bedrockruntime.model.ConverseStreamTrace trace()
      Returns the value of the trace record component.
      Returns:
      the value of the trace record component