Package org.springframework.ai.deepseek

Class DeepSeekChatOptions

java.lang.Object

org.springframework.ai.deepseek.DeepSeekChatOptions

All Implemented Interfaces:

ChatOptions, ModelOptions, ToolCallingChatOptions

public class DeepSeekChatOptions
extends Object
implements ToolCallingChatOptions

Chat completions options for the DeepSeek chat API. DeepSeek chat completion

Author:

Geng Rong, Sebastien Deleuze

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	DeepSeekChatOptions.AbstractBuilder<B extends DeepSeekChatOptions.AbstractBuilder<B>>
static class	DeepSeekChatOptions.Builder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DeepSeekChatOptions(@Nullable String model, @Nullable Double frequencyPenalty, @Nullable Integer maxTokens, @Nullable Double presencePenalty, @Nullable ResponseFormat responseFormat, @Nullable List<String> stop, @Nullable Double temperature, @Nullable Double topP, @Nullable Boolean logprobs, @Nullable Integer topLogprobs, @Nullable List<DeepSeekApi.FunctionTool> tools, @Nullable Object toolChoice, @Nullable List<ToolCallback> toolCallbacks, @Nullable Map<String,Object> toolContext)

Method Summary

Modifier and Type	Method	Description
static DeepSeekChatOptions.Builder	builder()	A builder to create a new ToolCallingChatOptions instance.
boolean	equals(@Nullable Object o)
@Nullable Double	getFrequencyPenalty()	Returns the frequency penalty to use for the chat.
@Nullable Boolean	getLogprobs()
@Nullable Integer	getMaxTokens()	Returns the maximum number of tokens to use for the chat.
String	getModel()	Returns the model to use for the chat.
@Nullable Double	getPresencePenalty()	Returns the presence penalty to use for the chat.
@Nullable ResponseFormat	getResponseFormat()
@Nullable List<String>	getStop()
@Nullable List<String>	getStopSequences()	Returns the stop sequences to use for the chat.
Double	getTemperature()	Returns the temperature to use for the chat.
@Nullable List<ToolCallback>	getToolCallbacks()	ToolCallbacks to be registered with the ChatModel.
@Nullable Object	getToolChoice()
@Nullable Map<String,Object>	getToolContext()	Get the configured tool context.
@Nullable List<DeepSeekApi.FunctionTool>	getTools()
@Nullable Integer	getTopK()	Returns the top K to use for the chat.
@Nullable Integer	getTopLogprobs()
@Nullable Double	getTopP()	Returns the top P to use for the chat.
int	hashCode()
DeepSeekChatOptions.Builder	mutate()	Returns a new ToolCallingChatOptions.Builder initialized with the values of this ToolCallingChatOptions.

Methods inherited from class java.lang.Object

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

Constructor Details

DeepSeekChatOptions

protected DeepSeekChatOptions(@Nullable String model,
 @Nullable Double frequencyPenalty,
 @Nullable Integer maxTokens,
 @Nullable Double presencePenalty,
 @Nullable ResponseFormat responseFormat,
 @Nullable List<String> stop,
 @Nullable Double temperature,
 @Nullable Double topP,
 @Nullable Boolean logprobs,
 @Nullable Integer topLogprobs,
 @Nullable List<DeepSeekApi.FunctionTool> tools,
 @Nullable Object toolChoice,
 @Nullable List<ToolCallback> toolCallbacks,
 @Nullable Map<String,Object> toolContext)

Method Details

builder

public static DeepSeekChatOptions.Builder builder()

Description copied from interface: ToolCallingChatOptions

A builder to create a new ToolCallingChatOptions instance.

Returns:

Returns a new ChatOptions.Builder.

getModel

public String getModel()

Description copied from interface: ChatOptions

Returns the model to use for the chat.

Specified by:

getModel in interface ChatOptions

Returns:

the model to use for the chat

getFrequencyPenalty

public @Nullable Double getFrequencyPenalty()

Description copied from interface: ChatOptions

Returns the frequency penalty to use for the chat.

Specified by:

getFrequencyPenalty in interface ChatOptions

Returns:

the frequency penalty to use for the chat

getMaxTokens

public @Nullable Integer getMaxTokens()

Description copied from interface: ChatOptions

Returns the maximum number of tokens to use for the chat.

Specified by:

getMaxTokens in interface ChatOptions

Returns:

the maximum number of tokens to use for the chat

getPresencePenalty

public @Nullable Double getPresencePenalty()

Description copied from interface: ChatOptions

Returns the presence penalty to use for the chat.

Specified by:

getPresencePenalty in interface ChatOptions

Returns:

the presence penalty to use for the chat

getResponseFormat

public @Nullable ResponseFormat getResponseFormat()

getStopSequences

public @Nullable List<String> getStopSequences()

Description copied from interface: ChatOptions

Returns the stop sequences to use for the chat.

Specified by:

getStopSequences in interface ChatOptions

Returns:

the stop sequences to use for the chat

getStop

public @Nullable List<String> getStop()

getTemperature

public Double getTemperature()

Description copied from interface: ChatOptions

Returns the temperature to use for the chat.

Specified by:

getTemperature in interface ChatOptions

Returns:

the temperature to use for the chat

getTopP

public @Nullable Double getTopP()

Description copied from interface: ChatOptions

Returns the top P to use for the chat.

Specified by:

getTopP in interface ChatOptions

Returns:

the top P to use for the chat

getTools

public @Nullable List<DeepSeekApi.FunctionTool> getTools()

getToolChoice

public @Nullable Object getToolChoice()

getToolCallbacks

public @Nullable List<ToolCallback> getToolCallbacks()

Description copied from interface: ToolCallingChatOptions

ToolCallbacks to be registered with the ChatModel.

Specified by:

getToolCallbacks in interface ToolCallingChatOptions

getLogprobs

public @Nullable Boolean getLogprobs()

getTopLogprobs

public @Nullable Integer getTopLogprobs()

getTopK

public @Nullable Integer getTopK()

Description copied from interface: ChatOptions

Returns the top K to use for the chat.

Specified by:

getTopK in interface ChatOptions

Returns:

the top K to use for the chat

getToolContext

public @Nullable Map<String,Object> getToolContext()

Description copied from interface: ToolCallingChatOptions

Get the configured tool context.

Specified by:

getToolContext in interface ToolCallingChatOptions

Returns:

the tool context map.

mutate

public DeepSeekChatOptions.Builder mutate()

Description copied from interface: ToolCallingChatOptions

Returns a new ToolCallingChatOptions.Builder initialized with the values of this ToolCallingChatOptions. Narrows the return type of ChatOptions.mutate() so generic tool calling code can chain methods without casting.

Specified by:

mutate in interface ChatOptions

Specified by:

mutate in interface ToolCallingChatOptions

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object