Package org.springframework.ai.google.genai

Class GoogleGenAiChatOptions

java.lang.Object

org.springframework.ai.google.genai.GoogleGenAiChatOptions

All Implemented Interfaces:

ChatOptions, ModelOptions, StructuredOutputChatOptions, ToolCallingChatOptions

public class GoogleGenAiChatOptions
extends Object
implements ToolCallingChatOptions, StructuredOutputChatOptions

Options for the Google GenAI Chat API.

Since:

1.0.0

Author:

Christian Tzolov, Thomas Vitale, Grogdunn, Ilayaperumal Gopinathan, Soby Chacko, Dan Dobrin, Sebastien Deleuze

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GoogleGenAiChatOptions(@Nullable String model, @Nullable Double frequencyPenalty, @Nullable Integer maxOutputTokens, @Nullable Double presencePenalty, @Nullable List<String> stopSequences, @Nullable Double temperature, @Nullable Integer topK, @Nullable Double topP, @Nullable List<ToolCallback> toolCallbacks, @Nullable Map<String,Object> toolContext, @Nullable Integer candidateCount, @Nullable String responseMimeType, @Nullable String responseSchema, @Nullable Integer thinkingBudget, @Nullable Boolean includeThoughts, @Nullable GoogleGenAiThinkingLevel thinkingLevel, @Nullable Boolean includeExtendedUsageMetadata, @Nullable String cachedContentName, @Nullable Boolean useCachedContent, @Nullable Integer autoCacheThreshold, @Nullable Duration autoCacheTtl, @Nullable Boolean googleSearchRetrieval, @Nullable Boolean includeServerSideToolInvocations, @Nullable List<GoogleGenAiSafetySetting> safetySettings, @Nullable Map<String,String> labels, @Nullable GoogleGenAiServiceTier serviceTier)

Method Summary

Modifier and Type	Method	Description
static GoogleGenAiChatOptions.Builder	builder()	A builder to create a new ToolCallingChatOptions instance.
boolean	equals(@Nullable Object o)
@Nullable Integer	getAutoCacheThreshold()
@Nullable Duration	getAutoCacheTtl()
@Nullable String	getCachedContentName()
@Nullable Integer	getCandidateCount()
@Nullable Double	getFrequencyPenalty()	Returns the frequency penalty to use for the chat.
@Nullable Boolean	getGoogleSearchRetrieval()
@Nullable Boolean	getIncludeExtendedUsageMetadata()
@Nullable Boolean	getIncludeServerSideToolInvocations()
@Nullable Boolean	getIncludeThoughts()
@Nullable Map<String,String>	getLabels()
@Nullable Integer	getMaxOutputTokens()
@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 String	getOutputSchema()
@Nullable Double	getPresencePenalty()	Returns the presence penalty to use for the chat.
@Nullable String	getResponseMimeType()
@Nullable String	getResponseSchema()
@Nullable List<GoogleGenAiSafetySetting>	getSafetySettings()
@Nullable GoogleGenAiServiceTier	getServiceTier()
@Nullable List<String>	getStopSequences()	Returns the stop sequences to use for the chat.
Double	getTemperature()	Returns the temperature to use for the chat.
@Nullable Integer	getThinkingBudget()
@Nullable GoogleGenAiThinkingLevel	getThinkingLevel()
@Nullable List<ToolCallback>	getToolCallbacks()	ToolCallbacks to be registered with the ChatModel.
@Nullable Map<String,Object>	getToolContext()	Get the configured tool context.
@Nullable Integer	getTopK()	Returns the top K to use for the chat.
Double	getTopP()	Returns the top P to use for the chat.
@Nullable Boolean	getUseCachedContent()
int	hashCode()
GoogleGenAiChatOptions.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

GoogleGenAiChatOptions

protected GoogleGenAiChatOptions(@Nullable String model,
 @Nullable Double frequencyPenalty,
 @Nullable Integer maxOutputTokens,
 @Nullable Double presencePenalty,
 @Nullable List<String> stopSequences,
 @Nullable Double temperature,
 @Nullable Integer topK,
 @Nullable Double topP,
 @Nullable List<ToolCallback> toolCallbacks,
 @Nullable Map<String,Object> toolContext,
 @Nullable Integer candidateCount,
 @Nullable String responseMimeType,
 @Nullable String responseSchema,
 @Nullable Integer thinkingBudget,
 @Nullable Boolean includeThoughts,
 @Nullable GoogleGenAiThinkingLevel thinkingLevel,
 @Nullable Boolean includeExtendedUsageMetadata,
 @Nullable String cachedContentName,
 @Nullable Boolean useCachedContent,
 @Nullable Integer autoCacheThreshold,
 @Nullable Duration autoCacheTtl,
 @Nullable Boolean googleSearchRetrieval,
 @Nullable Boolean includeServerSideToolInvocations,
 @Nullable List<GoogleGenAiSafetySetting> safetySettings,
 @Nullable Map<String,String> labels,
 @Nullable GoogleGenAiServiceTier serviceTier)

Method Details

builder

public static GoogleGenAiChatOptions.Builder builder()

Description copied from interface: ToolCallingChatOptions

A builder to create a new ToolCallingChatOptions instance.

Returns:

Returns a new ChatOptions.Builder.

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

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

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

getCandidateCount

public @Nullable Integer getCandidateCount()

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

getMaxOutputTokens

public @Nullable Integer getMaxOutputTokens()

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

getResponseMimeType

public @Nullable String getResponseMimeType()

getResponseSchema

public @Nullable String getResponseSchema()

getToolCallbacks

public @Nullable List<ToolCallback> getToolCallbacks()

Description copied from interface: ToolCallingChatOptions

ToolCallbacks to be registered with the ChatModel.

Specified by:

getToolCallbacks in interface ToolCallingChatOptions

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

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

getThinkingBudget

public @Nullable Integer getThinkingBudget()

getIncludeThoughts

public @Nullable Boolean getIncludeThoughts()

getThinkingLevel

public @Nullable GoogleGenAiThinkingLevel getThinkingLevel()

getIncludeExtendedUsageMetadata

public @Nullable Boolean getIncludeExtendedUsageMetadata()

getCachedContentName

public @Nullable String getCachedContentName()

getUseCachedContent

public @Nullable Boolean getUseCachedContent()

getAutoCacheThreshold

public @Nullable Integer getAutoCacheThreshold()

getAutoCacheTtl

public @Nullable Duration getAutoCacheTtl()

getGoogleSearchRetrieval

public @Nullable Boolean getGoogleSearchRetrieval()

getIncludeServerSideToolInvocations

public @Nullable Boolean getIncludeServerSideToolInvocations()

getSafetySettings

public @Nullable List<GoogleGenAiSafetySetting> getSafetySettings()

getLabels

public @Nullable Map<String,String> getLabels()

getServiceTier

public @Nullable GoogleGenAiServiceTier getServiceTier()

Since:

2.0.0

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.

getOutputSchema

public @Nullable String getOutputSchema()

Specified by:

getOutputSchema in interface StructuredOutputChatOptions

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

mutate

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

Specified by:

mutate in interface ToolCallingChatOptions