Package software.amazon.awssdk.services.bedrockruntime.model

Class ConverseTokensRequest

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

The inputs from a Converse API request for token counting.

This structure mirrors the input format for the Converse operation, allowing you to count tokens for conversation-based inference requests.

See Also:

  • Method Details

    • hasMessages

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

    • messages

      public final List<Message> messages()

      An array of messages to count tokens for.

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

      Returns:
      An array of messages to count tokens for.

    • hasSystem

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

    • system

      public final List<SystemContentBlock> system()

      The system content blocks to count tokens for. System content provides instructions or context to the model about how it should behave or respond. The token count will include any system content provided.

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

      Returns:
      The system content blocks to count tokens for. System content provides instructions or context to the model about how it should behave or respond. The token count will include any system content provided.

    • toolConfig

      public final ToolConfiguration toolConfig()

      The toolConfig of Converse input request to count tokens for. Configuration information for the tools that the model can use when generating a response.

      Returns:
      The toolConfig of Converse input request to count tokens for. Configuration information for the tools that the model can use when generating a response.

    • additionalModelRequestFields

      public final Document additionalModelRequestFields()

      The additionalModelRequestFields of Converse input request to count tokens for. Use this field when you want to pass additional parameters that the model supports.

      Returns:
      The additionalModelRequestFields of Converse input request to count tokens for. Use this field when you want to pass additional parameters that the model supports.

    • toBuilder

      public ConverseTokensRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ConverseTokensRequest.Builder,ConverseTokensRequest>

    • builder

      public static ConverseTokensRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ConverseTokensRequest.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo