Package org.springframework.ai.zhipuai

Class ZhiPuAiChatOptions

java.lang.Object

org.springframework.ai.zhipuai.ZhiPuAiChatOptions

All Implemented Interfaces:

ChatOptions, ModelOptions, ToolCallingChatOptions

public class ZhiPuAiChatOptions
extends Object
implements ToolCallingChatOptions

ZhiPuAiChatOptions represents the options for the ZhiPuAiChat model.

Since:

1.0.0 M1

Author:

Geng Rong, Thomas Vitale, Ilayaperumal Gopinathan, YunKui Lu

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ZhiPuAiChatOptions.Builder

Field Summary

Fields inherited from interface org.springframework.ai.model.tool.ToolCallingChatOptions

DEFAULT_TOOL_EXECUTION_ENABLED

Constructor Summary

Constructors

Constructor	Description
ZhiPuAiChatOptions()

Method Summary

Modifier and Type	Method	Description
static ZhiPuAiChatOptions.Builder	builder()
ZhiPuAiChatOptions	copy()	Returns a copy of this ChatOptions.
final boolean	equals(Object o)
static ZhiPuAiChatOptions	fromOptions(ZhiPuAiChatOptions fromOptions)
Boolean	getDoSample()
Double	getFrequencyPenalty()	Returns the frequency penalty to use for the chat.
Boolean	getInternalToolExecutionEnabled()	Whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.
Integer	getMaxTokens()	Returns the maximum number of tokens to use for the chat.
String	getModel()	Returns the model to use for the chat.
Double	getPresencePenalty()	Returns the presence penalty to use for the chat.
String	getRequestId()
ZhiPuAiApi.ChatCompletionRequest.ResponseFormat	getResponseFormat()
List<String>	getStop()
List<String>	getStopSequences()	Returns the stop sequences to use for the chat.
Double	getTemperature()	Returns the temperature to use for the chat.
ZhiPuAiApi.ChatCompletionRequest.Thinking	getThinking()
List<ToolCallback>	getToolCallbacks()	ToolCallbacks to be registered with the ChatModel.
String	getToolChoice()
Map<String,Object>	getToolContext()	Get the configured tool context.
Set<String>	getToolNames()	Names of the tools to register with the ChatModel.
List<ZhiPuAiApi.FunctionTool>	getTools()
Integer	getTopK()	Returns the top K to use for the chat.
Double	getTopP()	Returns the top P to use for the chat.
String	getUser()
int	hashCode()
ToolCallingChatOptions	merge(ChatOptions options)
void	setDoSample(Boolean doSample)
void	setInternalToolExecutionEnabled(Boolean internalToolExecutionEnabled)	Set whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.
void	setMaxTokens(Integer maxTokens)
void	setModel(String model)
void	setRequestId(String requestId)
ZhiPuAiChatOptions	setResponseFormat(ZhiPuAiApi.ChatCompletionRequest.ResponseFormat responseFormat)
void	setStop(List<String> stop)
void	setStopSequences(List<String> stopSequences)
void	setTemperature(Double temperature)
ZhiPuAiChatOptions	setThinking(ZhiPuAiApi.ChatCompletionRequest.Thinking thinking)
void	setToolCallbacks(List<ToolCallback> toolCallbacks)	Set the ToolCallbacks to be registered with the ChatModel.
void	setToolChoice(String toolChoice)
void	setToolContext(Map<String,Object> toolContext)	Set the tool context values as map.
void	setToolNames(Set<String> toolNames)	Set the names of the tools to register with the ChatModel.
void	setTools(List<ZhiPuAiApi.FunctionTool> tools)
void	setTopP(Double topP)
void	setUser(String user)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ZhiPuAiChatOptions

public ZhiPuAiChatOptions()

Method Details

builder

public static ZhiPuAiChatOptions.Builder builder()

fromOptions

public static ZhiPuAiChatOptions fromOptions(ZhiPuAiChatOptions fromOptions)

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

setModel

public void setModel(String model)

getMaxTokens

public 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

setMaxTokens

public void setMaxTokens(Integer maxTokens)

getStopSequences

public 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

setStopSequences

public void setStopSequences(List<String> stopSequences)

getStop

public List<String> getStop()

setStop

public void setStop(List<String> stop)

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

setTemperature

public void setTemperature(Double temperature)

getTopP

public 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

setTopP

public void setTopP(Double topP)

getTools

public List<ZhiPuAiApi.FunctionTool> getTools()

setTools

public void setTools(List<ZhiPuAiApi.FunctionTool> tools)

getToolChoice

public String getToolChoice()

setToolChoice

public void setToolChoice(String toolChoice)

getUser

public String getUser()

setUser

public void setUser(String user)

getRequestId

public String getRequestId()

setRequestId

public void setRequestId(String requestId)

getDoSample

public Boolean getDoSample()

setDoSample

public void setDoSample(Boolean doSample)

getResponseFormat

public ZhiPuAiApi.ChatCompletionRequest.ResponseFormat getResponseFormat()

setResponseFormat

public ZhiPuAiChatOptions setResponseFormat(ZhiPuAiApi.ChatCompletionRequest.ResponseFormat responseFormat)

getThinking

public ZhiPuAiApi.ChatCompletionRequest.Thinking getThinking()

setThinking

public ZhiPuAiChatOptions setThinking(ZhiPuAiApi.ChatCompletionRequest.Thinking thinking)

getFrequencyPenalty

public 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

getPresencePenalty

public 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

getTopK

public 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

getToolCallbacks

public List<ToolCallback> getToolCallbacks()

Description copied from interface: ToolCallingChatOptions

ToolCallbacks to be registered with the ChatModel.

Specified by:

getToolCallbacks in interface ToolCallingChatOptions

setToolCallbacks

public void setToolCallbacks(List<ToolCallback> toolCallbacks)

Description copied from interface: ToolCallingChatOptions

Set the ToolCallbacks to be registered with the ChatModel.

Specified by:

setToolCallbacks in interface ToolCallingChatOptions

getToolNames

public Set<String> getToolNames()

Description copied from interface: ToolCallingChatOptions

Names of the tools to register with the ChatModel.

Specified by:

getToolNames in interface ToolCallingChatOptions

setToolNames

public void setToolNames(Set<String> toolNames)

Description copied from interface: ToolCallingChatOptions

Set the names of the tools to register with the ChatModel.

Specified by:

setToolNames in interface ToolCallingChatOptions

getInternalToolExecutionEnabled

@Nullable
public Boolean getInternalToolExecutionEnabled()

Description copied from interface: ToolCallingChatOptions

Whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.

Specified by:

getInternalToolExecutionEnabled in interface ToolCallingChatOptions

setInternalToolExecutionEnabled

public void setInternalToolExecutionEnabled(@Nullable
 Boolean internalToolExecutionEnabled)

Description copied from interface: ToolCallingChatOptions

Set whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.

Specified by:

setInternalToolExecutionEnabled in interface ToolCallingChatOptions

getToolContext

public 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.

setToolContext

public void setToolContext(Map<String,Object> toolContext)

Description copied from interface: ToolCallingChatOptions

Set the tool context values as map.

Specified by:

setToolContext in interface ToolCallingChatOptions

Parameters:

toolContext - as map

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

copy

public ZhiPuAiChatOptions copy()

Description copied from interface: ChatOptions

Returns a copy of this ChatOptions.

Specified by:

copy in interface ChatOptions

Returns:

a copy of this ChatOptions

merge

public ToolCallingChatOptions merge(ChatOptions options)