Package org.springframework.ai.vertexai.gemini

Class VertexAiGeminiChatOptions

java.lang.Object

org.springframework.ai.vertexai.gemini.VertexAiGeminiChatOptions

All Implemented Interfaces:

ChatOptions, FunctionCallingOptions, ModelOptions, ToolCallingChatOptions

public class VertexAiGeminiChatOptions
extends Object
implements ToolCallingChatOptions

Options for the Vertex AI Gemini Chat API.

Since:

1.0.0

Author:

Christian Tzolov, Thomas Vitale, Grogdunn, Ilayaperumal Gopinathan

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VertexAiGeminiChatOptions.Builder
static enum	VertexAiGeminiChatOptions.TransportType

Field Summary

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

DEFAULT_TOOL_EXECUTION_ENABLED

Constructor Summary

Constructors

Constructor	Description
VertexAiGeminiChatOptions()

Method Summary

Modifier and Type	Method	Description
static VertexAiGeminiChatOptions.Builder	builder()	A builder to create a new ToolCallingChatOptions instance.
VertexAiGeminiChatOptions	copy()	Returns a copy of this ChatOptions.
boolean	equals(Object o)
static VertexAiGeminiChatOptions	fromOptions(VertexAiGeminiChatOptions fromOptions)
Integer	getCandidateCount()
Double	getFrequencyPenalty()	Returns the frequency penalty to use for the chat.
List<FunctionCallback>	getFunctionCallbacks()	Deprecated.
Set<String>	getFunctions()	Deprecated.
Boolean	getGoogleSearchRetrieval()
Integer	getMaxOutputTokens()
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.
Boolean	getProxyToolCalls()	Deprecated.
String	getResponseMimeType()
List<VertexAiGeminiSafetySetting>	getSafetySettings()
List<String>	getStopSequences()	Returns the stop sequences to use for the chat.
Double	getTemperature()	Returns the temperature to use for the chat.
List<FunctionCallback>	getToolCallbacks()	ToolCallbacks to be registered with the ChatModel.
Map<String,Object>	getToolContext()
Set<String>	getToolNames()	Names of the tools to register with the ChatModel.
Integer	getTopK()	Returns the top K to use for the chat.
Double	getTopP()	Returns the top P to use for the chat.
int	hashCode()
Boolean	isInternalToolExecutionEnabled()	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	setCandidateCount(Integer candidateCount)
void	setFunctionCallbacks(List<FunctionCallback> functionCallbacks)	Deprecated.
void	setFunctions(Set<String> functions)	Deprecated.
void	setGoogleSearchRetrieval(Boolean googleSearchRetrieval)
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	setMaxOutputTokens(Integer maxOutputTokens)
void	setMaxTokens(Integer maxTokens)
void	setModel(String modelName)
void	setProxyToolCalls(Boolean proxyToolCalls)	Deprecated.
void	setResponseMimeType(String mimeType)
void	setSafetySettings(List<VertexAiGeminiSafetySetting> safetySettings)
void	setStopSequences(List<String> stopSequences)
void	setTemperature(Double temperature)
void	setToolCallbacks(List<FunctionCallback> toolCallbacks)	Set the ToolCallbacks to be registered with the ChatModel.
void	setToolContext(Map<String,Object> toolContext)
void	setToolNames(Set<String> toolNames)	Set the names of the tools to register with the ChatModel.
void	setTopK(Integer topK)
void	setTopP(Double topP)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

VertexAiGeminiChatOptions

public VertexAiGeminiChatOptions()

Method Details

builder

public static VertexAiGeminiChatOptions.Builder builder()

Description copied from interface: ToolCallingChatOptions

A builder to create a new ToolCallingChatOptions instance.

Returns:

Returns DefaultFunctionCallingOptionsBuilder to create a new instance of FunctionCallingOptions.

fromOptions

public static VertexAiGeminiChatOptions fromOptions(VertexAiGeminiChatOptions fromOptions)

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)

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)

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

setTopK

public void setTopK(Integer topK)

getCandidateCount

public Integer getCandidateCount()

setCandidateCount

public void setCandidateCount(Integer candidateCount)

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)

getMaxOutputTokens

public Integer getMaxOutputTokens()

setMaxOutputTokens

public void setMaxOutputTokens(Integer maxOutputTokens)

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 modelName)

getResponseMimeType

public String getResponseMimeType()

setResponseMimeType

public void setResponseMimeType(String mimeType)

getFunctionCallbacks

@Deprecated
public List<FunctionCallback> getFunctionCallbacks()

Deprecated.

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

@Deprecated
public void setFunctionCallbacks(List<FunctionCallback> functionCallbacks)

Deprecated.

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.

getToolCallbacks

public List<FunctionCallback> getToolCallbacks()

Description copied from interface: ToolCallingChatOptions

ToolCallbacks to be registered with the ChatModel.

Specified by:

getToolCallbacks in interface ToolCallingChatOptions

setToolCallbacks

public void setToolCallbacks(List<FunctionCallback> toolCallbacks)

Description copied from interface: ToolCallingChatOptions

Set the ToolCallbacks to be registered with the ChatModel.

Specified by:

setToolCallbacks in interface ToolCallingChatOptions

getFunctions

@Deprecated
public Set<String> getFunctions()

Deprecated.

Specified by:

getFunctions in interface FunctionCallingOptions

Returns:

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

setFunctions

@Deprecated
public void setFunctions(Set<String> functions)

Deprecated.

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:

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

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

isInternalToolExecutionEnabled

@Nullable
public Boolean isInternalToolExecutionEnabled()

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:

isInternalToolExecutionEnabled 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

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

getGoogleSearchRetrieval

public Boolean getGoogleSearchRetrieval()

setGoogleSearchRetrieval

public void setGoogleSearchRetrieval(Boolean googleSearchRetrieval)

getSafetySettings

public List<VertexAiGeminiSafetySetting> getSafetySettings()

setSafetySettings

public void setSafetySettings(List<VertexAiGeminiSafetySetting> safetySettings)

getProxyToolCalls

@Deprecated
public Boolean getProxyToolCalls()

Deprecated.

Specified by:

getProxyToolCalls in interface FunctionCallingOptions

setProxyToolCalls

@Deprecated
public void setProxyToolCalls(Boolean proxyToolCalls)

Deprecated.

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

equals

public 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 VertexAiGeminiChatOptions copy()

Description copied from interface: ChatOptions

Returns a copy of this ChatOptions.

Specified by:

copy in interface ChatOptions

Returns:

a copy of this ChatOptions