Package org.springframework.ai.ollama.api

Class OllamaChatOptions.AbstractBuilder<B extends OllamaChatOptions.AbstractBuilder<B>>

java.lang.Object

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

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

org.springframework.ai.ollama.api.OllamaChatOptions.AbstractBuilder<B>

All Implemented Interfaces:

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

Direct Known Subclasses:

OllamaChatOptions.Builder

Enclosing class:

OllamaChatOptions

protected abstract static class OllamaChatOptions.AbstractBuilder<B extends OllamaChatOptions.AbstractBuilder<B>>
extends DefaultToolCallingChatOptions.Builder<B>
implements StructuredOutputChatOptions.Builder<B>

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable Boolean	f16KV
protected @Nullable Object	format
protected @Nullable String	keepAlive
protected @Nullable Boolean	logitsAll
protected @Nullable Boolean	lowVRAM
protected @Nullable Integer	mainGPU
protected @Nullable Double	minP
protected @Nullable Integer	mirostat
protected @Nullable Float	mirostatEta
protected @Nullable Float	mirostatTau
protected @Nullable Integer	numBatch
protected @Nullable Integer	numCtx
protected @Nullable Integer	numGPU
protected @Nullable Integer	numKeep
protected @Nullable Integer	numThread
protected @Nullable Boolean	penalizeNewline
protected @Nullable Integer	repeatLastN
protected @Nullable Double	repeatPenalty
protected @Nullable Integer	seed
protected @Nullable Float	tfsZ
protected @Nullable ThinkOption	thinkOption
protected @Nullable Boolean	truncate
protected @Nullable Float	typicalP
protected @Nullable Boolean	useMLock
protected @Nullable Boolean	useMMap
protected @Nullable Boolean	useNUMA
protected @Nullable Boolean	vocabOnly

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

toolCallbacks, toolContext

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
OllamaChatOptions	build()	Build the ChatOptions.
B	combineWith(ChatOptions.Builder<?> other)	Mutate this builder by taking all other's values that are non-null, retaining this other values.
B	disableThinking()	Disable thinking mode for the model.
B	enableThinking()	Enable thinking mode for the model.
B	f16KV(@Nullable Boolean f16KV)
B	format(@Nullable Object format)
B	keepAlive(@Nullable String keepAlive)
B	logitsAll(@Nullable Boolean logitsAll)
B	lowVRAM(@Nullable Boolean lowVRAM)
B	mainGPU(@Nullable Integer mainGPU)
B	minP(@Nullable Double minP)
B	mirostat(@Nullable Integer mirostat)
B	mirostatEta(@Nullable Float mirostatEta)
B	mirostatTau(@Nullable Float mirostatTau)
B	model(@Nullable OllamaModel model)
B	numBatch(@Nullable Integer numBatch)
B	numCtx(@Nullable Integer numCtx)
B	numGPU(@Nullable Integer numGPU)
B	numKeep(@Nullable Integer numKeep)
B	numPredict(@Nullable Integer numPredict)
B	numThread(@Nullable Integer numThread)
B	outputSchema(@Nullable String outputSchema)
B	penalizeNewline(@Nullable Boolean penalizeNewline)
B	repeatLastN(@Nullable Integer repeatLastN)
B	repeatPenalty(@Nullable Double repeatPenalty)
B	seed(@Nullable Integer seed)
B	stop(@Nullable List<String> stop)
B	tfsZ(@Nullable Float tfsZ)
B	thinkHigh()	Set thinking level to "high" (for GPT-OSS model).
B	thinkLow()	Set thinking level to "low" (for GPT-OSS model).
B	thinkMedium()	Set thinking level to "medium" (for GPT-OSS model).
B	thinkOption(@Nullable ThinkOption thinkOption)	Set the think option explicitly.
B	truncate(@Nullable Boolean truncate)
B	typicalP(@Nullable Float typicalP)
B	useMLock(@Nullable Boolean useMLock)
B	useMMap(@Nullable Boolean useMMap)
B	useNUMA(@Nullable Boolean useNUMA)
B	vocabOnly(@Nullable Boolean vocabOnly)

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

clone, toolCallbacks, toolCallbacks, toolContext, toolContext

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

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

Methods inherited from interface org.springframework.ai.chat.prompt.ChatOptions.Builder

clone

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

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

Field Details

useNUMA

protected @Nullable Boolean useNUMA

numCtx

protected @Nullable Integer numCtx

numBatch

protected @Nullable Integer numBatch

numGPU

protected @Nullable Integer numGPU

mainGPU

protected @Nullable Integer mainGPU

lowVRAM

protected @Nullable Boolean lowVRAM

f16KV

protected @Nullable Boolean f16KV

logitsAll

protected @Nullable Boolean logitsAll

vocabOnly

protected @Nullable Boolean vocabOnly

useMMap

protected @Nullable Boolean useMMap

useMLock

protected @Nullable Boolean useMLock

numThread

protected @Nullable Integer numThread

numKeep

protected @Nullable Integer numKeep

seed

protected @Nullable Integer seed

minP

protected @Nullable Double minP

tfsZ

protected @Nullable Float tfsZ

typicalP

protected @Nullable Float typicalP

repeatLastN

protected @Nullable Integer repeatLastN

repeatPenalty

protected @Nullable Double repeatPenalty

mirostat

protected @Nullable Integer mirostat

mirostatTau

protected @Nullable Float mirostatTau

mirostatEta

protected @Nullable Float mirostatEta

penalizeNewline

protected @Nullable Boolean penalizeNewline

format

protected @Nullable Object format

keepAlive

protected @Nullable String keepAlive

truncate

protected @Nullable Boolean truncate

thinkOption

protected @Nullable ThinkOption thinkOption

Constructor Details

AbstractBuilder

protected AbstractBuilder()

Method Details

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 OllamaChatOptions.AbstractBuilder<B>>

Overrides:

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

model

public B model(@Nullable OllamaModel model)

numPredict

public B numPredict(@Nullable Integer numPredict)

stop

public B stop(@Nullable List<String> stop)

format

public B format(@Nullable Object format)

keepAlive

public B keepAlive(@Nullable String keepAlive)

truncate

public B truncate(@Nullable Boolean truncate)

useNUMA

public B useNUMA(@Nullable Boolean useNUMA)

numCtx

public B numCtx(@Nullable Integer numCtx)

numBatch

public B numBatch(@Nullable Integer numBatch)

numGPU

public B numGPU(@Nullable Integer numGPU)

mainGPU

public B mainGPU(@Nullable Integer mainGPU)

lowVRAM

public B lowVRAM(@Nullable Boolean lowVRAM)

f16KV

public B f16KV(@Nullable Boolean f16KV)

logitsAll

public B logitsAll(@Nullable Boolean logitsAll)

vocabOnly

public B vocabOnly(@Nullable Boolean vocabOnly)

useMMap

public B useMMap(@Nullable Boolean useMMap)

useMLock

public B useMLock(@Nullable Boolean useMLock)

numThread

public B numThread(@Nullable Integer numThread)

numKeep

public B numKeep(@Nullable Integer numKeep)

seed

public B seed(@Nullable Integer seed)

minP

public B minP(@Nullable Double minP)

tfsZ

public B tfsZ(@Nullable Float tfsZ)

typicalP

public B typicalP(@Nullable Float typicalP)

repeatLastN

public B repeatLastN(@Nullable Integer repeatLastN)

repeatPenalty

public B repeatPenalty(@Nullable Double repeatPenalty)

mirostat

public B mirostat(@Nullable Integer mirostat)

mirostatTau

public B mirostatTau(@Nullable Float mirostatTau)

mirostatEta

public B mirostatEta(@Nullable Float mirostatEta)

penalizeNewline

public B penalizeNewline(@Nullable Boolean penalizeNewline)

enableThinking

public B enableThinking()

Enable thinking mode for the model. The model will include its reasoning process in the response's thinking field.

Supported by models: Qwen 3, DeepSeek-v3.1, DeepSeek R1

Returns:

this builder

See Also:

• disableThinking()
• thinkLow()

disableThinking

public B disableThinking()

Disable thinking mode for the model.

Returns:

this builder

See Also:

• enableThinking()

thinkLow

public B thinkLow()

Set thinking level to "low" (for GPT-OSS model).

GPT-OSS requires one of: low, medium, high. Boolean enable/disable is not supported for this model.

Returns:

this builder

See Also:

• thinkMedium()
• thinkHigh()

thinkMedium

public B thinkMedium()

Set thinking level to "medium" (for GPT-OSS model).

Returns:

this builder

See Also:

• thinkLow()
• thinkHigh()

thinkHigh

public B thinkHigh()

Set thinking level to "high" (for GPT-OSS model).

Returns:

this builder

See Also:

• thinkLow()
• thinkMedium()

thinkOption

public B thinkOption(@Nullable ThinkOption thinkOption)

Set the think option explicitly. Use enableThinking(), disableThinking(), thinkLow(), thinkMedium(), or thinkHigh() for more convenient alternatives.

Parameters:

thinkOption - the think option

Returns:

this builder

outputSchema

public B outputSchema(@Nullable String outputSchema)

Specified by:

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

build

public OllamaChatOptions build()

Description copied from interface: ChatOptions.Builder

Build the ChatOptions.

Specified by:

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

Specified by:

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

Overrides:

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

Returns:

the Chat options.