Package org.springframework.ai.anthropic.api

Record Class AnthropicApi.ChatCompletionRequest

java.lang.Object

java.lang.Record

org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequest

Record Components:

model - The model that will complete your prompt. See the list of models for additional details and options.

messages - Input messages.

system - System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our guide to system prompts.

maxTokens - The maximum number of tokens to generate before stopping. Note that our models may stop before reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate. Different models have different maximum values for this parameter.

metadata - An object describing metadata about the request.

stopSequences - Custom text sequences that will cause the model to stop generating. Our models will normally stop when they have naturally completed their turn, which will result in a response stop_reason of "end_turn". If you want the model to stop generating when it encounters custom strings of text, you can use the stop_sequences parameter. If the model encounters one of the custom sequences, the response stop_reason value will be "stop_sequence" and the response stop_sequence value will contain the matched stop sequence.

stream - Whether to incrementally stream the response using server-sent events.

temperature - Amount of randomness injected into the response.Defaults to 1.0. Ranges from 0.0 to 1.0. Use temperature closer to 0.0 for analytical / multiple choice, and closer to 1.0 for creative and generative tasks. Note that even with temperature of 0.0, the results will not be fully deterministic.

topP - Use nucleus sampling. 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. Recommended for advanced use cases only. You usually only need to use temperature.

topK - Only sample from the top K options for each subsequent token. Used to remove "long tail" low probability responses. Learn more technical details here. Recommended for advanced use cases only. You usually only need to use temperature.

tools - Definitions of tools that the model may use. If provided the model may return tool_use content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using tool_result content blocks.

Enclosing class:

AnthropicApi

public static record AnthropicApi.ChatCompletionRequest(String model, List<AnthropicApi.AnthropicMessage> messages, String system, Integer maxTokens, AnthropicApi.ChatCompletionRequest.Metadata metadata, List<String> stopSequences, Boolean stream, Double temperature, Double topP, Integer topK, List<AnthropicApi.Tool> tools)
extends Record

Chat completion request object.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	AnthropicApi.ChatCompletionRequest.Metadata	Metadata about the request.

Constructor Summary

Constructors

Constructor	Description
ChatCompletionRequest(String model, List<AnthropicApi.AnthropicMessage> messages, String system, Integer maxTokens, Double temperature, Boolean stream)
ChatCompletionRequest(String model, List<AnthropicApi.AnthropicMessage> messages, String system, Integer maxTokens, List<String> stopSequences, Double temperature, Boolean stream)
ChatCompletionRequest(String model, List<AnthropicApi.AnthropicMessage> messages, String system, Integer maxTokens, AnthropicApi.ChatCompletionRequest.Metadata metadata, List<String> stopSequences, Boolean stream, Double temperature, Double topP, Integer topK, List<AnthropicApi.Tool> tools)	Creates an instance of a ChatCompletionRequest record class.

Method Summary

Modifier and Type	Method	Description
static AnthropicApi.ChatCompletionRequestBuilder	builder()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static AnthropicApi.ChatCompletionRequestBuilder	from(AnthropicApi.ChatCompletionRequest request)
final int	hashCode()	Returns a hash code value for this object.
Integer	maxTokens()	Returns the value of the maxTokens record component.
List<AnthropicApi.AnthropicMessage>	messages()	Returns the value of the messages record component.
AnthropicApi.ChatCompletionRequest.Metadata	metadata()	Returns the value of the metadata record component.
String	model()	Returns the value of the model record component.
List<String>	stopSequences()	Returns the value of the stopSequences record component.
Boolean	stream()	Returns the value of the stream record component.
String	system()	Returns the value of the system record component.
Double	temperature()	Returns the value of the temperature record component.
List<AnthropicApi.Tool>	tools()	Returns the value of the tools 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

ChatCompletionRequest

public ChatCompletionRequest(String model,
 List<AnthropicApi.AnthropicMessage> messages,
 String system,
 Integer maxTokens,
 Double temperature,
 Boolean stream)

ChatCompletionRequest

public ChatCompletionRequest(String model,
 List<AnthropicApi.AnthropicMessage> messages,
 String system,
 Integer maxTokens,
 List<String> stopSequences,
 Double temperature,
 Boolean stream)

ChatCompletionRequest

public ChatCompletionRequest(String model,
 List<AnthropicApi.AnthropicMessage> messages,
 String system,
 Integer maxTokens,
 AnthropicApi.ChatCompletionRequest.Metadata metadata,
 List<String> stopSequences,
 Boolean stream,
 Double temperature,
 Double topP,
 Integer topK,
 List<AnthropicApi.Tool> tools)

Creates an instance of a ChatCompletionRequest record class.

Parameters:

model - the value for the model record component

messages - the value for the messages record component

system - the value for the system record component

maxTokens - the value for the maxTokens record component

metadata - the value for the metadata record component

stopSequences - the value for the stopSequences record component

stream - the value for the stream record component

temperature - the value for the temperature record component

topP - the value for the topP record component

topK - the value for the topK record component

tools - the value for the tools record component

Method Details

builder

public static AnthropicApi.ChatCompletionRequestBuilder builder()

from

public static AnthropicApi.ChatCompletionRequestBuilder from(AnthropicApi.ChatCompletionRequest request)

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.

model

public String model()

Returns the value of the model record component.

Returns:

the value of the model record component

messages

public List<AnthropicApi.AnthropicMessage> 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

maxTokens

public Integer maxTokens()

Returns the value of the maxTokens record component.

Returns:

the value of the maxTokens record component

metadata

public AnthropicApi.ChatCompletionRequest.Metadata metadata()

Returns the value of the metadata record component.

Returns:

the value of the metadata record component

stopSequences

public List<String> stopSequences()

Returns the value of the stopSequences record component.

Returns:

the value of the stopSequences record component

stream

public Boolean stream()

Returns the value of the stream record component.

Returns:

the value of the stream record component

temperature

public Double temperature()

Returns the value of the temperature record component.

Returns:

the value of the temperature record component

topP

public Double topP()

Returns the value of the topP record component.

Returns:

the value of the topP record component

topK

public Integer topK()

Returns the value of the topK record component.

Returns:

the value of the topK record component

tools

public List<AnthropicApi.Tool> tools()

Returns the value of the tools record component.

Returns:

the value of the tools record component