Package org.springframework.ai.ollama.api

Class OllamaChatOptions

java.lang.Object

org.springframework.ai.ollama.api.OllamaChatOptions

All Implemented Interfaces:

ChatOptions, ModelOptions, StructuredOutputChatOptions, ToolCallingChatOptions

public class OllamaChatOptions
extends Object
implements ToolCallingChatOptions, StructuredOutputChatOptions

Helper class for creating strongly-typed Ollama options.

Since:

0.8.0

Author:

Christian Tzolov, Thomas Vitale, Ilayaperumal Gopinathan, Nicolas Krier, Sebastien Deleuze

See Also:

• Ollama Valid Parameters and Values
• Ollama Types

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OllamaChatOptions(@Nullable Boolean useNUMA, @Nullable Integer numCtx, @Nullable Integer numBatch, @Nullable Integer numGPU, @Nullable Integer mainGPU, @Nullable Boolean lowVRAM, @Nullable Boolean f16KV, @Nullable Boolean logitsAll, @Nullable Boolean vocabOnly, @Nullable Boolean useMMap, @Nullable Boolean useMLock, @Nullable Integer numThread, @Nullable Integer numKeep, @Nullable Integer seed, @Nullable Integer numPredict, @Nullable Integer topK, @Nullable Double topP, @Nullable Double minP, @Nullable Float tfsZ, @Nullable Float typicalP, @Nullable Integer repeatLastN, @Nullable Double temperature, @Nullable Double repeatPenalty, @Nullable Double presencePenalty, @Nullable Double frequencyPenalty, @Nullable Integer mirostat, @Nullable Float mirostatTau, @Nullable Float mirostatEta, @Nullable Boolean penalizeNewline, @Nullable List<String> stop, @Nullable String model, @Nullable Object format, @Nullable String keepAlive, @Nullable Boolean truncate, @Nullable ThinkOption thinkOption, @Nullable List<ToolCallback> toolCallbacks, @Nullable Map<String,Object> toolContext)

Method Summary

Modifier and Type	Method	Description
static OllamaChatOptions.Builder	builder()	A builder to create a new ToolCallingChatOptions instance.
boolean	equals(@Nullable Object o)
static Map<String,Object>	filterNonSupportedFields(Map<String,Object> options)	Filter out the non-supported fields from the options.
@Nullable Boolean	getF16KV()
@Nullable Object	getFormat()
@Nullable Double	getFrequencyPenalty()	Returns the frequency penalty to use for the chat.
@Nullable String	getKeepAlive()
@Nullable Boolean	getLogitsAll()
@Nullable Boolean	getLowVRAM()
@Nullable Integer	getMainGPU()
@Nullable Integer	getMaxTokens()	Returns the maximum number of tokens to use for the chat.
@Nullable Double	getMinP()
@Nullable Integer	getMirostat()
@Nullable Float	getMirostatEta()
@Nullable Float	getMirostatTau()
String	getModel()	Returns the model to use for the chat.
@Nullable Integer	getNumBatch()
@Nullable Integer	getNumCtx()
@Nullable Integer	getNumGPU()
@Nullable Integer	getNumKeep()
@Nullable Integer	getNumPredict()
@Nullable Integer	getNumThread()
@Nullable String	getOutputSchema()
@Nullable Boolean	getPenalizeNewline()
@Nullable Double	getPresencePenalty()	Returns the presence penalty to use for the chat.
@Nullable Integer	getRepeatLastN()
@Nullable Double	getRepeatPenalty()
@Nullable Integer	getSeed()
@Nullable List<String>	getStop()
@Nullable List<String>	getStopSequences()	Returns the stop sequences to use for the chat.
@Nullable Double	getTemperature()	Returns the temperature to use for the chat.
@Nullable Float	getTfsZ()
@Nullable ThinkOption	getThinkOption()
@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.
@Nullable Double	getTopP()	Returns the top P to use for the chat.
@Nullable Boolean	getTruncate()
@Nullable Float	getTypicalP()
@Nullable Boolean	getUseMLock()
@Nullable Boolean	getUseMMap()
@Nullable Boolean	getUseNUMA()
@Nullable Boolean	getVocabOnly()
int	hashCode()
OllamaChatOptions.Builder	mutate()	Returns a new ToolCallingChatOptions.Builder initialized with the values of this ToolCallingChatOptions.
Map<String,Object>	toMap()	Convert the OllamaChatOptions object to a Map of key/value pairs.

Methods inherited from class java.lang.Object

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

Constructor Details

OllamaChatOptions

protected OllamaChatOptions(@Nullable Boolean useNUMA,
 @Nullable Integer numCtx,
 @Nullable Integer numBatch,
 @Nullable Integer numGPU,
 @Nullable Integer mainGPU,
 @Nullable Boolean lowVRAM,
 @Nullable Boolean f16KV,
 @Nullable Boolean logitsAll,
 @Nullable Boolean vocabOnly,
 @Nullable Boolean useMMap,
 @Nullable Boolean useMLock,
 @Nullable Integer numThread,
 @Nullable Integer numKeep,
 @Nullable Integer seed,
 @Nullable Integer numPredict,
 @Nullable Integer topK,
 @Nullable Double topP,
 @Nullable Double minP,
 @Nullable Float tfsZ,
 @Nullable Float typicalP,
 @Nullable Integer repeatLastN,
 @Nullable Double temperature,
 @Nullable Double repeatPenalty,
 @Nullable Double presencePenalty,
 @Nullable Double frequencyPenalty,
 @Nullable Integer mirostat,
 @Nullable Float mirostatTau,
 @Nullable Float mirostatEta,
 @Nullable Boolean penalizeNewline,
 @Nullable List<String> stop,
 @Nullable String model,
 @Nullable Object format,
 @Nullable String keepAlive,
 @Nullable Boolean truncate,
 @Nullable ThinkOption thinkOption,
 @Nullable List<ToolCallback> toolCallbacks,
 @Nullable Map<String,Object> toolContext)

Method Details

builder

public static OllamaChatOptions.Builder builder()

Description copied from interface: ToolCallingChatOptions

A builder to create a new ToolCallingChatOptions instance.

Returns:

Returns a new ChatOptions.Builder.

filterNonSupportedFields

public static Map<String,Object> filterNonSupportedFields(Map<String,Object> options)

Filter out the non-supported fields from the options.

Parameters:

options - The options to filter.

Returns:

The filtered options.

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

getFormat

public @Nullable Object getFormat()

getKeepAlive

public @Nullable String getKeepAlive()

getUseNUMA

public @Nullable Boolean getUseNUMA()

getNumCtx

public @Nullable Integer getNumCtx()

getNumBatch

public @Nullable Integer getNumBatch()

getNumGPU

public @Nullable Integer getNumGPU()

getMainGPU

public @Nullable Integer getMainGPU()

getLowVRAM

public @Nullable Boolean getLowVRAM()

getF16KV

public @Nullable Boolean getF16KV()

getLogitsAll

public @Nullable Boolean getLogitsAll()

getVocabOnly

public @Nullable Boolean getVocabOnly()

getUseMMap

public @Nullable Boolean getUseMMap()

getUseMLock

public @Nullable Boolean getUseMLock()

getNumThread

public @Nullable Integer getNumThread()

getNumKeep

public @Nullable Integer getNumKeep()

getSeed

public @Nullable Integer getSeed()

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

getNumPredict

public @Nullable Integer getNumPredict()

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

getTopP

public @Nullable 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

getMinP

public @Nullable Double getMinP()

getTfsZ

public @Nullable Float getTfsZ()

getTypicalP

public @Nullable Float getTypicalP()

getRepeatLastN

public @Nullable Integer getRepeatLastN()

getTemperature

public @Nullable 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

getRepeatPenalty

public @Nullable Double getRepeatPenalty()

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

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

getMirostat

public @Nullable Integer getMirostat()

getMirostatTau

public @Nullable Float getMirostatTau()

getMirostatEta

public @Nullable Float getMirostatEta()

getPenalizeNewline

public @Nullable Boolean getPenalizeNewline()

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

getStop

public @Nullable List<String> getStop()

getTruncate

public @Nullable Boolean getTruncate()

getThinkOption

public @Nullable ThinkOption getThinkOption()

getToolCallbacks

public @Nullable List<ToolCallback> getToolCallbacks()

Description copied from interface: ToolCallingChatOptions

ToolCallbacks to be registered with the ChatModel.

Specified by:

getToolCallbacks in interface ToolCallingChatOptions

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

toMap

public Map<String,Object> toMap()

Convert the OllamaChatOptions object to a Map of key/value pairs.

Returns:

The Map of key/value pairs.

mutate

public OllamaChatOptions.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

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object