Package org.springframework.ai.bedrock.anthropic3.api

Record Class Anthropic3ChatBedrockApi.AnthropicChatRequest

java.lang.Object

java.lang.Record

org.springframework.ai.bedrock.anthropic3.api.Anthropic3ChatBedrockApi.AnthropicChatRequest

Record Components:

messages - A list of messages comprising the conversation so far.

system - A system prompt, providing context and instructions to Claude, such as specifying a particular goal or role.

temperature - (default 0.5) The temperature to use for the chat. You should either alter temperature or top_p, but not both.

maxTokens - (default 200) Specify the maximum number of tokens to use in the generated response. Note that the models may stop before reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate. We recommend a limit of 4,000 tokens for optimal performance.

topK - (default 250) Specify the number of token choices the model uses to generate the next token.

topP - (default 1) Nucleus sampling to specify the cumulative probability of the next token in range [0,1]. In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by top_p. You should either alter temperature or top_p, but not both.

stopSequences - (defaults to "\n\nHuman:") Configure up to four sequences that the model recognizes. After a stop sequence, the model stops generating further tokens. The returned text doesn't contain the stop sequence.

anthropicVersion - The version of the model to use. The default value is bedrock-2023-05-31.

Enclosing class:

Anthropic3ChatBedrockApi

public static record Anthropic3ChatBedrockApi.AnthropicChatRequest(List<Anthropic3ChatBedrockApi.ChatCompletionMessage> messages, String system, Double temperature, Integer maxTokens, Integer topK, Double topP, List<String> stopSequences, String anthropicVersion)
extends Record

AnthropicChatRequest encapsulates the request parameters for the Anthropic messages model. https://docs.anthropic.com/claude/reference/messages_post

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Anthropic3ChatBedrockApi.AnthropicChatRequest.Builder	Builder for Anthropic3ChatBedrockApi.AnthropicChatRequest.

Constructor Summary

Constructors

Constructor	Description
AnthropicChatRequest(List<Anthropic3ChatBedrockApi.ChatCompletionMessage> messages, String system, Double temperature, Integer maxTokens, Integer topK, Double topP, List<String> stopSequences, String anthropicVersion)	Creates an instance of a AnthropicChatRequest record class.

Method Summary

Modifier and Type	Method	Description
String	anthropicVersion()	Returns the value of the anthropicVersion record component.
static Anthropic3ChatBedrockApi.AnthropicChatRequest.Builder	builder(List<Anthropic3ChatBedrockApi.ChatCompletionMessage> messages)	Create a new Anthropic3ChatBedrockApi.AnthropicChatRequest instance.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Integer	maxTokens()	Returns the value of the maxTokens record component.
List<Anthropic3ChatBedrockApi.ChatCompletionMessage>	messages()	Returns the value of the messages record component.
List<String>	stopSequences()	Returns the value of the stopSequences record component.
String	system()	Returns the value of the system record component.
Double	temperature()	Returns the value of the temperature record component.
Integer	topK()	Returns the value of the topK record component.
Double	topP()	Returns the value of the topP record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

AnthropicChatRequest

public AnthropicChatRequest(List<Anthropic3ChatBedrockApi.ChatCompletionMessage> messages,
 String system,
 Double temperature,
 Integer maxTokens,
 Integer topK,
 Double topP,
 List<String> stopSequences,
 String anthropicVersion)

Creates an instance of a AnthropicChatRequest record class.

Parameters:

messages - the value for the messages record component

system - the value for the system record component

temperature - the value for the temperature record component

maxTokens - the value for the maxTokens record component

topK - the value for the topK record component

topP - the value for the topP record component

stopSequences - the value for the stopSequences record component

anthropicVersion - the value for the anthropicVersion record component

Method Details

builder

public static Anthropic3ChatBedrockApi.AnthropicChatRequest.Builder builder(List<Anthropic3ChatBedrockApi.ChatCompletionMessage> messages)

Create a new Anthropic3ChatBedrockApi.AnthropicChatRequest instance.

Parameters:

messages - A list of messages comprising the conversation so far.

Returns:

the Anthropic3ChatBedrockApi.AnthropicChatRequest

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

messages

public List<Anthropic3ChatBedrockApi.ChatCompletionMessage> messages()

Returns the value of the messages record component.

Returns:

the value of the messages record component

system

public String system()

Returns the value of the system record component.

Returns:

the value of the system record component

temperature

public Double temperature()

Returns the value of the temperature record component.

Returns:

the value of the temperature record component

maxTokens

public Integer maxTokens()

Returns the value of the maxTokens record component.

Returns:

the value of the maxTokens record component

topK

public Integer topK()

Returns the value of the topK record component.

Returns:

the value of the topK record component

topP

public Double topP()

Returns the value of the topP record component.

Returns:

the value of the topP record component

stopSequences

public List<String> stopSequences()

Returns the value of the stopSequences record component.

Returns:

the value of the stopSequences record component

anthropicVersion

public String anthropicVersion()

Returns the value of the anthropicVersion record component.

Returns:

the value of the anthropicVersion record component