Class CountTokensInput

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

The input value for token counting. The value should be either an InvokeModel or Converse request body.

See Also:

  • Method Details

    • invokeModel

      public final InvokeModelTokensRequest invokeModel()

      An InvokeModel request for which to count tokens. Use this field when you want to count tokens for a raw text input that would be sent to the InvokeModel operation.

      Returns:
      An InvokeModel request for which to count tokens. Use this field when you want to count tokens for a raw text input that would be sent to the InvokeModel operation.

    • converse

      public final ConverseTokensRequest converse()

      A Converse request for which to count tokens. Use this field when you want to count tokens for a conversation-based input that would be sent to the Converse operation.

      Returns:
      A Converse request for which to count tokens. Use this field when you want to count tokens for a conversation-based input that would be sent to the Converse operation.

    • toBuilder

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

    • builder

      public static CountTokensInput.Builder builder()

    • serializableBuilderClass

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

    • fromInvokeModel

      public static CountTokensInput fromInvokeModel(InvokeModelTokensRequest invokeModel)
      Create an instance of this class with invokeModel() initialized to the given value.

      An InvokeModel request for which to count tokens. Use this field when you want to count tokens for a raw text input that would be sent to the InvokeModel operation.

      Parameters:
      invokeModel - An InvokeModel request for which to count tokens. Use this field when you want to count tokens for a raw text input that would be sent to the InvokeModel operation.

    • fromInvokeModel

      public static CountTokensInput fromInvokeModel(Consumer<InvokeModelTokensRequest.Builder> invokeModel)
      Create an instance of this class with invokeModel() initialized to the given value.

      An InvokeModel request for which to count tokens. Use this field when you want to count tokens for a raw text input that would be sent to the InvokeModel operation.

      Parameters:
      invokeModel - An InvokeModel request for which to count tokens. Use this field when you want to count tokens for a raw text input that would be sent to the InvokeModel operation.

    • fromConverse

      public static CountTokensInput fromConverse(ConverseTokensRequest converse)
      Create an instance of this class with converse() initialized to the given value.

      A Converse request for which to count tokens. Use this field when you want to count tokens for a conversation-based input that would be sent to the Converse operation.

      Parameters:
      converse - A Converse request for which to count tokens. Use this field when you want to count tokens for a conversation-based input that would be sent to the Converse operation.

    • fromConverse

      public static CountTokensInput fromConverse(Consumer<ConverseTokensRequest.Builder> converse)
      Create an instance of this class with converse() initialized to the given value.

      A Converse request for which to count tokens. Use this field when you want to count tokens for a conversation-based input that would be sent to the Converse operation.

      Parameters:
      converse - A Converse request for which to count tokens. Use this field when you want to count tokens for a conversation-based input that would be sent to the Converse operation.

    • type

      public CountTokensInput.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be CountTokensInput.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be CountTokensInput.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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