Package software.amazon.awssdk.services.bedrockruntime.model

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.

    • performanceConfig

      public final PerformanceConfiguration performanceConfig()

      Model performance settings for the request.

      Returns:
      Model performance settings for the request.

    • serviceTier

      public final ServiceTier serviceTier()

      Specifies the processing tier configuration used for serving the request.

      Returns:
      Specifies the processing tier configuration used for serving the request.

    • toBuilder

      public ConverseResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ConverseResponse.Builder,ConverseResponse>
      Specified by:
      toBuilder in class AwsResponse

    • 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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkResponse

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo