Class PromptModelInferenceConfiguration

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

Contains inference configurations related to model inference for a prompt. For more information, see Inference parameters.

See Also:

  • Method Details

    • maxTokens

      public final Integer maxTokens()

      The maximum number of tokens to return in the response.

      Returns:
      The maximum number of tokens to return in the response.

    • hasStopSequences

      public final boolean hasStopSequences()
      For responses, this returns true if the service returned a value for the StopSequences property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • stopSequences

      public final List<String> stopSequences()

      A list of strings that define sequences after which the model will stop generating.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStopSequences() method.

      Returns:
      A list of strings that define sequences after which the model will stop generating.

    • temperature

      public final Float temperature()

      Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.

      Returns:
      Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.

    • topK

      public final Integer topK()

      The number of most-likely candidates that the model considers for the next token during generation.

      Returns:
      The number of most-likely candidates that the model considers for the next token during generation.

    • topP

      public final Float topP()

      The percentage of most-likely candidates that the model considers for the next token.

      Returns:
      The percentage of most-likely candidates that the model considers for the next token.

    • toBuilder

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

    • builder

      public static PromptModelInferenceConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PromptModelInferenceConfiguration.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.