Class CountTokensRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.bedrockruntime.model.BedrockRuntimeRequest
software.amazon.awssdk.services.bedrockruntime.model.CountTokensRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CountTokensRequest.Builder,CountTokensRequest>
@Generated("software.amazon.awssdk:codegen") public final class CountTokensRequest extends BedrockRuntimeRequest implements ToCopyableBuilder<CountTokensRequest.Builder,CountTokensRequest>

  • Method Details

    • modelId

      public final String modelId()

      The unique identifier or ARN of the foundation model to use for token counting. Each model processes tokens differently, so the token count is specific to the model you specify.

      Returns:
      The unique identifier or ARN of the foundation model to use for token counting. Each model processes tokens differently, so the token count is specific to the model you specify.

    • input

      public final CountTokensInput input()

      The input for which to count tokens. The structure of this parameter depends on whether you're counting tokens for an InvokeModel or Converse request:

      • For InvokeModel requests, provide the request body in the invokeModel field

      • For Converse requests, provide the messages and system content in the converse field

      The input format must be compatible with the model specified in the modelId parameter.

      Returns:
      The input for which to count tokens. The structure of this parameter depends on whether you're counting tokens for an InvokeModel or Converse request:

      • For InvokeModel requests, provide the request body in the invokeModel field

      • For Converse requests, provide the messages and system content in the converse field

      The input format must be compatible with the model specified in the modelId parameter.

    • toBuilder

      public CountTokensRequest.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<CountTokensRequest.Builder,CountTokensRequest>
      Specified by:
      toBuilder in class BedrockRuntimeRequest
      Returns:
      a builder for type T

    • builder

      public static CountTokensRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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