Class OutputConfig

java.lang.Object
software.amazon.awssdk.services.bedrockruntime.model.OutputConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OutputConfig.Builder,OutputConfig>
@Generated("software.amazon.awssdk:codegen") public final class OutputConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OutputConfig.Builder,OutputConfig>

Output configuration for a model response in a call to Converse or ConverseStream.

See Also:

  • Method Details

    • textFormat

      public final OutputFormat textFormat()

      Structured output parameters to control the model's text response.

      Returns:
      Structured output parameters to control the model's text response.

    • effort

      public final String effort()

      The effort level for the model to use when generating a response. Higher effort levels allow the model to spend more time reasoning before responding. Supported values are low, medium, high, xhigh, and max.

      When extended thinking is disabled, the effort level is capped at high. Use effort high or below, or enable thinking to use higher effort levels.

      Returns:
      The effort level for the model to use when generating a response. Higher effort levels allow the model to spend more time reasoning before responding. Supported values are low, medium, high, xhigh, and max.

      When extended thinking is disabled, the effort level is capped at high. Use effort high or below, or enable thinking to use higher effort levels.

    • toBuilder

      public OutputConfig.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<OutputConfig.Builder,OutputConfig>
      Returns:
      a builder for type T

    • builder

      public static OutputConfig.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.