Class ConverseResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.bedrockruntime.model.BedrockRuntimeResponse
software.amazon.awssdk.services.bedrockruntime.model.ConverseResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ConverseResponse.Builder,ConverseResponse>
@Generated("software.amazon.awssdk:codegen") public final class ConverseResponse extends BedrockRuntimeResponse implements ToCopyableBuilder<ConverseResponse.Builder,ConverseResponse>

  • Method Details

    • output

      public final ConverseOutput output()

      The result from the call to Converse.

      Returns:
      The result from the call to Converse.

    • stopReason

      public final StopReason stopReason()

      The reason why the model stopped generating output.

      If the service returns an enum value that is not available in the current SDK version, stopReason will return StopReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stopReasonAsString().

      Returns:
      The reason why the model stopped generating output.
      See Also:

    • stopReasonAsString

      public final String stopReasonAsString()

      The reason why the model stopped generating output.

      If the service returns an enum value that is not available in the current SDK version, stopReason will return StopReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stopReasonAsString().

      Returns:
      The reason why the model stopped generating output.
      See Also:

    • usage

      public final TokenUsage usage()

      The total number of tokens used in the call to Converse. The total includes the tokens input to the model and the tokens generated by the model.

      Returns:
      The total number of tokens used in the call to Converse. The total includes the tokens input to the model and the tokens generated by the model.

    • metrics

      public final ConverseMetrics metrics()

      Metrics for the call to Converse.

      Returns:
      Metrics for the call to Converse.

    • additionalModelResponseFields

      public final Document additionalModelResponseFields()

      Additional fields in the response that are unique to the model.

      Returns:
      Additional fields in the response that are unique to the model.

    • trace

      public final ConverseTrace trace()

      A trace object that contains information about the Guardrail behavior.

      Returns:
      A trace object that contains information about the Guardrail behavior.

    • toBuilder

      public ConverseResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ConverseResponse.Builder,ConverseResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static ConverseResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ConverseResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.