Package org.springframework.ai.zhipuai

Class ZhiPuAiChatOptions

java.lang.Object

org.springframework.ai.zhipuai.ZhiPuAiChatOptions

All Implemented Interfaces:

ChatOptions, FunctionCallingOptions, ModelOptions

public class ZhiPuAiChatOptions
extends Object
implements FunctionCallingOptions, ChatOptions

ZhiPuAiChatOptions represents the options for the ZhiPuAiChat model.

Since:

1.0.0 M1

Author:

Geng Rong, Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ZhiPuAiChatOptions.Builder

Constructor Summary

Constructors

Constructor	Description
ZhiPuAiChatOptions()

Method Summary

Modifier and Type	Method	Description
static ZhiPuAiChatOptions.Builder	builder()
ZhiPuAiChatOptions	copy()
boolean	equals(Object obj)
static ZhiPuAiChatOptions	fromOptions(ZhiPuAiChatOptions fromOptions)
Boolean	getDoSample()
Double	getFrequencyPenalty()
List<FunctionCallback>	getFunctionCallbacks()	Function Callbacks to be registered with the ChatModel.
Set<String>	getFunctions()
Integer	getMaxTokens()
String	getModel()
Double	getPresencePenalty()
Boolean	getProxyToolCalls()
String	getRequestId()
List<String>	getStop()
List<String>	getStopSequences()
Double	getTemperature()
String	getToolChoice()
Map<String,Object>	getToolContext()
List<ZhiPuAiApi.FunctionTool>	getTools()
Integer	getTopK()
Double	getTopP()
String	getUser()
int	hashCode()
void	setDoSample(Boolean doSample)
void	setFunctionCallbacks(List<FunctionCallback> functionCallbacks)	Set the Function Callbacks to be registered with the ChatModel.
void	setFunctions(Set<String> functionNames)	Set the list of function names from the ChatModel registry to be used in the next chat completion requests.
void	setMaxTokens(Integer maxTokens)
void	setModel(String model)
void	setProxyToolCalls(Boolean proxyToolCalls)
void	setRequestId(String requestId)
void	setStop(List<String> stop)
void	setStopSequences(List<String> stopSequences)
void	setTemperature(Double temperature)
void	setToolChoice(String toolChoice)
void	setToolContext(Map<String,Object> toolContext)
void	setTools(List<ZhiPuAiApi.FunctionTool> tools)
void	setTopP(Double topP)
void	setUser(String user)

Methods inherited from class java.lang.Object

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

Constructor Details

ZhiPuAiChatOptions

public ZhiPuAiChatOptions()

Method Details

builder

public static ZhiPuAiChatOptions.Builder builder()

Returns:

Returns FunctionCallingOptionsBuilder to create a new instance of FunctionCallingOptions.

getModel

public String getModel()

Specified by:

getModel in interface ChatOptions

setModel

public void setModel(String model)

getMaxTokens

public Integer getMaxTokens()

Specified by:

getMaxTokens in interface ChatOptions

setMaxTokens

public void setMaxTokens(Integer maxTokens)

getStopSequences

public List<String> getStopSequences()

Specified by:

getStopSequences in interface ChatOptions

setStopSequences

public void setStopSequences(List<String> stopSequences)

getStop

public List<String> getStop()

setStop

public void setStop(List<String> stop)

getTemperature

public Double getTemperature()

Specified by:

getTemperature in interface ChatOptions

setTemperature

public void setTemperature(Double temperature)

getTopP

public Double getTopP()

Specified by:

getTopP in interface ChatOptions

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)

getFunctionCallbacks

public List<FunctionCallback> getFunctionCallbacks()

Description copied from interface: FunctionCallingOptions

Function Callbacks to be registered with the ChatModel. For Prompt Options the functionCallbacks are automatically enabled for the duration of the prompt execution. For Default Options the FunctionCallbacks are registered but disabled by default. You have to use "functions" property to list the function names from the ChatModel registry to be used in the chat completion requests.

Specified by:

getFunctionCallbacks in interface FunctionCallingOptions

Returns:

Return the Function Callbacks to be registered with the ChatModel.

setFunctionCallbacks

public void setFunctionCallbacks(List<FunctionCallback> functionCallbacks)

Description copied from interface: FunctionCallingOptions

Set the Function Callbacks to be registered with the ChatModel.

Specified by:

setFunctionCallbacks in interface FunctionCallingOptions

Parameters:

functionCallbacks - the Function Callbacks to be registered with the ChatModel.

getFunctions

public Set<String> getFunctions()

Specified by:

getFunctions in interface FunctionCallingOptions

Returns:

List of function names from the ChatModel registry to be used in the next chat completion requests.

setFunctions

public void setFunctions(Set<String> functionNames)

Description copied from interface: FunctionCallingOptions

Set the list of function names from the ChatModel registry to be used in the next chat completion requests.

Specified by:

setFunctions in interface FunctionCallingOptions

Parameters:

functionNames - the list of function names from the ChatModel registry to be used in the next chat completion requests.

getFrequencyPenalty

public Double getFrequencyPenalty()

Specified by:

getFrequencyPenalty in interface ChatOptions

getPresencePenalty

public Double getPresencePenalty()

Specified by:

getPresencePenalty in interface ChatOptions

getTopK

public Integer getTopK()

Specified by:

getTopK in interface ChatOptions

getProxyToolCalls

public Boolean getProxyToolCalls()

Specified by:

getProxyToolCalls in interface FunctionCallingOptions

setProxyToolCalls

public void setProxyToolCalls(Boolean proxyToolCalls)

Specified by:

setProxyToolCalls in interface FunctionCallingOptions

getToolContext

public Map<String,Object> getToolContext()

Specified by:

getToolContext in interface FunctionCallingOptions

setToolContext

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

Specified by:

setToolContext in interface FunctionCallingOptions

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

copy

public ZhiPuAiChatOptions copy()

Specified by:

copy in interface ChatOptions

fromOptions

public static ZhiPuAiChatOptions fromOptions(ZhiPuAiChatOptions fromOptions)