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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConverseTokensRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ConverseTokensRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMessages()	For responses, this returns true if the service returned a value for the Messages property.
boolean	hasSystem()	For responses, this returns true if the service returned a value for the System property.
List<Message>	messages()	An array of messages to count tokens for.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ConverseTokensRequest.Builder>	serializableBuilderClass()
List<SystemContentBlock>	system()	The system content blocks to count tokens for.
ConverseTokensRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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.

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