Package org.springframework.ai.vertexai.gemini

Class VertexAiGeminiChatOptions

java.lang.Object

org.springframework.ai.vertexai.gemini.VertexAiGeminiChatOptions

All Implemented Interfaces:

ChatOptions, FunctionCallingOptions, ModelOptions

public class VertexAiGeminiChatOptions
extends Object
implements FunctionCallingOptions, ChatOptions

Since:

1.0.0

Author:

Christian Tzolov, Thomas Vitale, Grogdunn

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
VertexAiGeminiChatOptions()

Method Summary

Modifier and Type	Method	Description
static VertexAiGeminiChatOptions.Builder	builder()
VertexAiGeminiChatOptions	copy()
boolean	equals(Object o)
static VertexAiGeminiChatOptions	fromOptions(VertexAiGeminiChatOptions fromOptions)
Integer	getCandidateCount()
Double	getFrequencyPenalty()
List<FunctionCallback>	getFunctionCallbacks()	Function Callbacks to be registered with the ChatModel.
Set<String>	getFunctions()
boolean	getGoogleSearchRetrieval()
Integer	getMaxOutputTokens()
Integer	getMaxTokens()
String	getModel()
Double	getPresencePenalty()
Boolean	getProxyToolCalls()
String	getResponseMimeType()
List<String>	getStopSequences()
Double	getTemperature()
Map<String,Object>	getToolContext()
Integer	getTopK()
Double	getTopP()
int	hashCode()
void	setCandidateCount(Integer candidateCount)
void	setFunctionCallbacks(List<FunctionCallback> functionCallbacks)	Set the Function Callbacks to be registered with the ChatModel.
void	setFunctions(Set<String> functions)	Set the list of function names from the ChatModel registry to be used in the next chat completion requests.
void	setGoogleSearchRetrieval(boolean googleSearchRetrieval)
void	setMaxOutputTokens(Integer maxOutputTokens)
void	setMaxTokens(Integer maxTokens)
void	setModel(String modelName)
void	setProxyToolCalls(Boolean proxyToolCalls)
String	setResponseMimeType(String mimeType)
void	setStopSequences(List<String> stopSequences)
void	setTemperature(Double temperature)
void	setToolContext(Map<String,Object> toolContext)
void	setTopK(Float topK)
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()

Returns:

Returns FunctionCallingOptionsBuilder to create a new instance of FunctionCallingOptions.

getStopSequences

public List<String> getStopSequences()

Specified by:

getStopSequences in interface ChatOptions

setStopSequences

public void setStopSequences(List<String> stopSequences)

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)

getTopK

public Integer getTopK()

Specified by:

getTopK in interface ChatOptions

setTopK

public void setTopK(Float topK)

setTopK

public void setTopK(Integer topK)

getCandidateCount

public Integer getCandidateCount()

setCandidateCount

public void setCandidateCount(Integer candidateCount)

getMaxTokens

public Integer getMaxTokens()

Specified by:

getMaxTokens in interface ChatOptions

setMaxTokens

public void setMaxTokens(Integer maxTokens)

getMaxOutputTokens

public Integer getMaxOutputTokens()

setMaxOutputTokens

public void setMaxOutputTokens(Integer maxOutputTokens)

getModel

public String getModel()

Specified by:

getModel in interface ChatOptions

setModel

public void setModel(String modelName)

getResponseMimeType

public String getResponseMimeType()

setResponseMimeType

public String setResponseMimeType(String mimeType)

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

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.

getFrequencyPenalty

public Double getFrequencyPenalty()

Specified by:

getFrequencyPenalty in interface ChatOptions

getPresencePenalty

public Double getPresencePenalty()

Specified by:

getPresencePenalty in interface ChatOptions

getGoogleSearchRetrieval

public boolean getGoogleSearchRetrieval()

setGoogleSearchRetrieval

public void setGoogleSearchRetrieval(boolean googleSearchRetrieval)

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

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

Specified by:

copy in interface ChatOptions

fromOptions

public static VertexAiGeminiChatOptions fromOptions(VertexAiGeminiChatOptions fromOptions)