Package org.springframework.ai.google.genai

Class GoogleGenAiChatOptions.AbstractBuilder<B extends GoogleGenAiChatOptions.AbstractBuilder<B>>

java.lang.Object

org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder<B>

org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder<B>

org.springframework.ai.google.genai.GoogleGenAiChatOptions.AbstractBuilder<B>

All Implemented Interfaces:

ChatOptions.Builder<B>, StructuredOutputChatOptions.Builder<B>, ToolCallingChatOptions.Builder<B>

Direct Known Subclasses:

GoogleGenAiChatOptions.Builder

Enclosing class:

GoogleGenAiChatOptions

@NullMarked
protected abstract static class GoogleGenAiChatOptions.AbstractBuilder<B extends GoogleGenAiChatOptions.AbstractBuilder<B>>
extends DefaultToolCallingChatOptions.Builder<B>
implements StructuredOutputChatOptions.Builder<B>

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable Integer	autoCacheThreshold
protected @Nullable Duration	autoCacheTtl
protected @Nullable String	cachedContentName
protected @Nullable Integer	candidateCount
protected @Nullable Boolean	googleSearchRetrieval
protected @Nullable Boolean	includeExtendedUsageMetadata
protected @Nullable Boolean	includeServerSideToolInvocations
protected @Nullable Boolean	includeThoughts
protected Map<String,String>	labels
protected @Nullable String	responseMimeType
protected @Nullable String	responseSchema
protected List<GoogleGenAiSafetySetting>	safetySettings
protected @Nullable Integer	thinkingBudget
protected @Nullable GoogleGenAiThinkingLevel	thinkingLevel
protected @Nullable Boolean	useCachedContent

Fields inherited from class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder

internalToolExecutionEnabled, toolCallbacks, toolContext, toolNames

Fields inherited from class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

frequencyPenalty, maxTokens, model, presencePenalty, stopSequences, temperature, topK, topP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBuilder()

Method Summary

Modifier and Type	Method	Description
B	autoCacheThreshold(@Nullable Integer autoCacheThreshold)
B	autoCacheTtl(@Nullable Duration autoCacheTtl)
GoogleGenAiChatOptions	build()	Build the ChatOptions.
B	cachedContentName(@Nullable String cachedContentName)
B	candidateCount(@Nullable Integer candidateCount)
B	combineWith(ChatOptions.Builder<?> other)	Mutate this builder by taking all other's values that are non-null, retaining this other values.
B	googleSearchRetrieval(@Nullable Boolean googleSearch)
B	includeExtendedUsageMetadata(@Nullable Boolean includeExtendedUsageMetadata)
B	includeServerSideToolInvocations(@Nullable Boolean includeServerSideToolInvocations)
B	includeThoughts(@Nullable Boolean includeThoughts)
B	labels(Map<String,String> labels)
B	maxOutputTokens(@Nullable Integer maxOutputTokens)
B	model(@Nullable GoogleGenAiChatModel.ChatModel model)
B	outputSchema(@Nullable String jsonSchema)
B	responseMimeType(@Nullable String mimeType)
B	responseSchema(@Nullable String responseSchema)
B	safetySettings(List<GoogleGenAiSafetySetting> safetySettings)
B	thinkingBudget(@Nullable Integer thinkingBudget)
B	thinkingLevel(@Nullable GoogleGenAiThinkingLevel thinkingLevel)
B	useCachedContent(@Nullable Boolean useCachedContent)

Methods inherited from class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder

internalToolExecutionEnabled, toolCallbacks, toolCallbacks, toolContext, toolContext, toolNames, toolNames

Methods inherited from class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

frequencyPenalty, maxTokens, model, presencePenalty, self, stopSequences, temperature, topK, topP

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder

frequencyPenalty, maxTokens, model, presencePenalty, stopSequences, temperature, topK, topP

Field Details

candidateCount

protected @Nullable Integer candidateCount

responseMimeType

protected @Nullable String responseMimeType

responseSchema

protected @Nullable String responseSchema

thinkingBudget

protected @Nullable Integer thinkingBudget

includeThoughts

protected @Nullable Boolean includeThoughts

thinkingLevel

protected @Nullable GoogleGenAiThinkingLevel thinkingLevel

includeExtendedUsageMetadata

protected @Nullable Boolean includeExtendedUsageMetadata

cachedContentName

protected @Nullable String cachedContentName

useCachedContent

protected @Nullable Boolean useCachedContent

autoCacheThreshold

protected @Nullable Integer autoCacheThreshold

autoCacheTtl

protected @Nullable Duration autoCacheTtl

googleSearchRetrieval

protected @Nullable Boolean googleSearchRetrieval

includeServerSideToolInvocations

protected @Nullable Boolean includeServerSideToolInvocations

safetySettings

protected List<GoogleGenAiSafetySetting> safetySettings

labels

protected Map<String,String> labels

Constructor Details

AbstractBuilder

protected AbstractBuilder()

Method Details

candidateCount

public B candidateCount(@Nullable Integer candidateCount)

maxOutputTokens

public B maxOutputTokens(@Nullable Integer maxOutputTokens)

model

public B model(@Nullable GoogleGenAiChatModel.ChatModel model)

responseMimeType

public B responseMimeType(@Nullable String mimeType)

responseSchema

public B responseSchema(@Nullable String responseSchema)

outputSchema

public B outputSchema(@Nullable String jsonSchema)

Specified by:

outputSchema in interface StructuredOutputChatOptions.Builder<B extends GoogleGenAiChatOptions.AbstractBuilder<B>>

googleSearchRetrieval

public B googleSearchRetrieval(@Nullable Boolean googleSearch)

includeServerSideToolInvocations

public B includeServerSideToolInvocations(@Nullable Boolean includeServerSideToolInvocations)

safetySettings

public B safetySettings(List<GoogleGenAiSafetySetting> safetySettings)

thinkingBudget

public B thinkingBudget(@Nullable Integer thinkingBudget)

includeThoughts

public B includeThoughts(@Nullable Boolean includeThoughts)

thinkingLevel

public B thinkingLevel(@Nullable GoogleGenAiThinkingLevel thinkingLevel)

includeExtendedUsageMetadata

public B includeExtendedUsageMetadata(@Nullable Boolean includeExtendedUsageMetadata)

labels

public B labels(Map<String,String> labels)

cachedContentName

public B cachedContentName(@Nullable String cachedContentName)

useCachedContent

public B useCachedContent(@Nullable Boolean useCachedContent)

autoCacheThreshold

public B autoCacheThreshold(@Nullable Integer autoCacheThreshold)

autoCacheTtl

public B autoCacheTtl(@Nullable Duration autoCacheTtl)

combineWith

public B combineWith(ChatOptions.Builder<?> other)

Description copied from interface: ChatOptions.Builder

Mutate this builder by taking all other's values that are non-null, retaining this other values.

Specified by:

combineWith in interface ChatOptions.Builder<B extends GoogleGenAiChatOptions.AbstractBuilder<B>>

Overrides:

combineWith in class DefaultToolCallingChatOptions.Builder<B extends GoogleGenAiChatOptions.AbstractBuilder<B>>

build

public GoogleGenAiChatOptions build()

Description copied from interface: ChatOptions.Builder

Build the ChatOptions.

Specified by:

build in interface ChatOptions.Builder<B extends GoogleGenAiChatOptions.AbstractBuilder<B>>

Specified by:

build in interface ToolCallingChatOptions.Builder<B extends GoogleGenAiChatOptions.AbstractBuilder<B>>

Overrides:

build in class DefaultToolCallingChatOptions.Builder<B extends GoogleGenAiChatOptions.AbstractBuilder<B>>

Returns:

the Chat options.