Class SampledSequence

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

A single generated sequence from the model.

See Also:

  • Method Details

    • stopReason

      public final StopReason stopReason()

      The reason why generation stopped. A value of stop indicates a stop sequence was encountered. A value of length indicates the maximum token limit was reached.

      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 generation stopped. A value of stop indicates a stop sequence was encountered. A value of length indicates the maximum token limit was reached.
      See Also:

    • stopReasonAsString

      public final String stopReasonAsString()

      The reason why generation stopped. A value of stop indicates a stop sequence was encountered. A value of length indicates the maximum token limit was reached.

      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 generation stopped. A value of stop indicates a stop sequence was encountered. A value of length indicates the maximum token limit was reached.
      See Also:

    • hasTokens

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

    • tokens

      public final List<Integer> tokens()

      The token IDs of the generated sequence.

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

      Returns:
      The token IDs of the generated sequence.

    • hasLogprobs

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

    • logprobs

      public final List<Double> logprobs()

      The per-token log-probabilities for the generated tokens.

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

      Returns:
      The per-token log-probabilities for the generated tokens.

    • tokenUsage

      public final SampleTokenUsage tokenUsage()

      The token usage statistics for this individual sample.

      Returns:
      The token usage statistics for this individual sample.

    • toBuilder

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

    • builder

      public static SampledSequence.Builder builder()

    • serializableBuilderClass

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