Class SamplingParams

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

The parameters controlling the text generation sampling strategy.

See Also:

  • Method Details

    • maxTokens

      public final Integer maxTokens()

      The maximum number of tokens to generate per sample.

      Returns:
      The maximum number of tokens to generate per sample.

    • temperature

      public final Double temperature()

      The sampling temperature controlling randomness. Higher values produce more diverse outputs.

      Returns:
      The sampling temperature controlling randomness. Higher values produce more diverse outputs.

    • topK

      public final Integer topK()

      The number of highest-probability vocabulary tokens to keep for top-k filtering. Set to -1 to disable.

      Returns:
      The number of highest-probability vocabulary tokens to keep for top-k filtering. Set to -1 to disable.

    • topP

      public final Double topP()

      The cumulative probability threshold for nucleus (top-p) sampling. Only tokens with cumulative probability below this threshold are considered.

      Returns:
      The cumulative probability threshold for nucleus (top-p) sampling. Only tokens with cumulative probability below this threshold are considered.

    • seed

      public final Integer seed()

      The random seed for reproducible sampling. When set, the same seed with the same input produces deterministic outputs.

      Returns:
      The random seed for reproducible sampling. When set, the same seed with the same input produces deterministic outputs.

    • hasStop

      public final boolean hasStop()
      For responses, this returns true if the service returned a value for the Stop 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.

    • stop

      public final List<String> stop()

      The list of stop sequences that terminate generation when encountered in the output.

      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 hasStop() method.

      Returns:
      The list of stop sequences that terminate generation when encountered in the output.

    • toBuilder

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

    • builder

      public static SamplingParams.Builder builder()

    • serializableBuilderClass

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