Package org.springframework.ai.ollama.api

Class OllamaOptions

java.lang.Object

org.springframework.ai.ollama.api.OllamaOptions

All Implemented Interfaces:

ChatOptions, EmbeddingOptions, FunctionCallingOptions, ModelOptions, ToolCallingChatOptions

public class OllamaOptions
extends Object
implements ToolCallingChatOptions, EmbeddingOptions

Helper class for creating strongly-typed Ollama options.

Since:

0.8.0

Author:

Christian Tzolov, Thomas Vitale, Ilayaperumal Gopinathan

See Also:

• Ollama Valid Parameters and Values
• Ollama Types

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OllamaOptions.Builder

Field Summary

Fields inherited from interface org.springframework.ai.model.tool.ToolCallingChatOptions

DEFAULT_TOOL_EXECUTION_ENABLED

Constructor Summary

Constructors

Constructor	Description
OllamaOptions()

Method Summary

Modifier and Type	Method	Description
static OllamaOptions.Builder	builder()
OllamaOptions	copy()
boolean	equals(Object o)
static Map<String,Object>	filterNonSupportedFields(Map<String,Object> options)	Filter out the non-supported fields from the options.
static OllamaOptions	fromOptions(OllamaOptions fromOptions)
Integer	getDimensions()
Boolean	getF16KV()
Object	getFormat()
Double	getFrequencyPenalty()
List<FunctionCallback>	getFunctionCallbacks()	Deprecated.
Set<String>	getFunctions()	Deprecated.
String	getKeepAlive()
Boolean	getLogitsAll()
Boolean	getLowVRAM()
Integer	getMainGPU()
Integer	getMaxTokens()
Integer	getMirostat()
Float	getMirostatEta()
Float	getMirostatTau()
String	getModel()
Integer	getNumBatch()
Integer	getNumCtx()
Integer	getNumGPU()
Integer	getNumKeep()
Integer	getNumPredict()
Integer	getNumThread()
Boolean	getPenalizeNewline()
Double	getPresencePenalty()
Boolean	getProxyToolCalls()	Deprecated.
Integer	getRepeatLastN()
Double	getRepeatPenalty()
Integer	getSeed()
List<String>	getStop()
List<String>	getStopSequences()
Double	getTemperature()
Float	getTfsZ()
List<FunctionCallback>	getToolCallbacks()
Map<String,Object>	getToolContext()
Set<String>	getToolNames()
Integer	getTopK()
Double	getTopP()
Boolean	getTruncate()
Float	getTypicalP()
Boolean	getUseMLock()
Boolean	getUseMMap()
Boolean	getUseNUMA()
Boolean	getVocabOnly()
int	hashCode()
Boolean	isInternalToolExecutionEnabled()
void	setF16KV(Boolean f16kv)
void	setFormat(Object format)
void	setFrequencyPenalty(Double frequencyPenalty)
void	setFunctionCallbacks(List<FunctionCallback> functionCallbacks)	Deprecated.
void	setFunctions(Set<String> functions)	Deprecated.
void	setInternalToolExecutionEnabled(Boolean internalToolExecutionEnabled)
void	setKeepAlive(String keepAlive)
void	setLogitsAll(Boolean logitsAll)
void	setLowVRAM(Boolean lowVRAM)
void	setMainGPU(Integer mainGPU)
void	setMaxTokens(Integer maxTokens)
void	setMirostat(Integer mirostat)
void	setMirostatEta(Float mirostatEta)
void	setMirostatTau(Float mirostatTau)
void	setModel(String model)
void	setNumBatch(Integer numBatch)
void	setNumCtx(Integer numCtx)
void	setNumGPU(Integer numGPU)
void	setNumKeep(Integer numKeep)
void	setNumPredict(Integer numPredict)
void	setNumThread(Integer numThread)
void	setPenalizeNewline(Boolean penalizeNewline)
void	setPresencePenalty(Double presencePenalty)
void	setProxyToolCalls(Boolean proxyToolCalls)	Deprecated.
void	setRepeatLastN(Integer repeatLastN)
void	setRepeatPenalty(Double repeatPenalty)
void	setSeed(Integer seed)
void	setStop(List<String> stop)
void	setStopSequences(List<String> stopSequences)
void	setTemperature(Double temperature)
void	setTfsZ(Float tfsZ)
void	setToolCallbacks(List<FunctionCallback> toolCallbacks)
void	setToolContext(Map<String,Object> toolContext)
void	setToolNames(Set<String> toolNames)
void	setTopK(Integer topK)
void	setTopP(Double topP)
void	setTruncate(Boolean truncate)
void	setTypicalP(Float typicalP)
void	setUseMLock(Boolean useMLock)
void	setUseMMap(Boolean useMMap)
void	setUseNUMA(Boolean useNUMA)
void	setVocabOnly(Boolean vocabOnly)
Map<String,Object>	toMap()	Convert the OllamaOptions 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

OllamaOptions

public OllamaOptions()

Method Details

builder

public static OllamaOptions.Builder 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.

fromOptions

public static OllamaOptions fromOptions(OllamaOptions fromOptions)

getModel

public String getModel()

Specified by:

getModel in interface ChatOptions

Specified by:

getModel in interface EmbeddingOptions

setModel

public void setModel(String model)

getFormat

public Object getFormat()

setFormat

public void setFormat(Object format)

getKeepAlive

public String getKeepAlive()

setKeepAlive

public void setKeepAlive(String keepAlive)

getUseNUMA

public Boolean getUseNUMA()

setUseNUMA

public void setUseNUMA(Boolean useNUMA)

getNumCtx

public Integer getNumCtx()

setNumCtx

public void setNumCtx(Integer numCtx)

getNumBatch

public Integer getNumBatch()

setNumBatch

public void setNumBatch(Integer numBatch)

getNumGPU

public Integer getNumGPU()

setNumGPU

public void setNumGPU(Integer numGPU)

getMainGPU

public Integer getMainGPU()

setMainGPU

public void setMainGPU(Integer mainGPU)

getLowVRAM

public Boolean getLowVRAM()

setLowVRAM

public void setLowVRAM(Boolean lowVRAM)

getF16KV

public Boolean getF16KV()

setF16KV

public void setF16KV(Boolean f16kv)

getLogitsAll

public Boolean getLogitsAll()

setLogitsAll

public void setLogitsAll(Boolean logitsAll)

getVocabOnly

public Boolean getVocabOnly()

setVocabOnly

public void setVocabOnly(Boolean vocabOnly)

getUseMMap

public Boolean getUseMMap()

setUseMMap

public void setUseMMap(Boolean useMMap)

getUseMLock

public Boolean getUseMLock()

setUseMLock

public void setUseMLock(Boolean useMLock)

getNumThread

public Integer getNumThread()

setNumThread

public void setNumThread(Integer numThread)

getNumKeep

public Integer getNumKeep()

setNumKeep

public void setNumKeep(Integer numKeep)

getSeed

public Integer getSeed()

setSeed

public void setSeed(Integer seed)

getMaxTokens

public Integer getMaxTokens()

Specified by:

getMaxTokens in interface ChatOptions

setMaxTokens

public void setMaxTokens(Integer maxTokens)

getNumPredict

public Integer getNumPredict()

setNumPredict

public void setNumPredict(Integer numPredict)

getTopK

public Integer getTopK()

Specified by:

getTopK in interface ChatOptions

setTopK

public void setTopK(Integer topK)

getTopP

public Double getTopP()

Specified by:

getTopP in interface ChatOptions

setTopP

public void setTopP(Double topP)

getTfsZ

public Float getTfsZ()

setTfsZ

public void setTfsZ(Float tfsZ)

getTypicalP

public Float getTypicalP()

setTypicalP

public void setTypicalP(Float typicalP)

getRepeatLastN

public Integer getRepeatLastN()

setRepeatLastN

public void setRepeatLastN(Integer repeatLastN)

getTemperature

public Double getTemperature()

Specified by:

getTemperature in interface ChatOptions

setTemperature

public void setTemperature(Double temperature)

getRepeatPenalty

public Double getRepeatPenalty()

setRepeatPenalty

public void setRepeatPenalty(Double repeatPenalty)

getPresencePenalty

public Double getPresencePenalty()

Specified by:

getPresencePenalty in interface ChatOptions

setPresencePenalty

public void setPresencePenalty(Double presencePenalty)

getFrequencyPenalty

public Double getFrequencyPenalty()

Specified by:

getFrequencyPenalty in interface ChatOptions

setFrequencyPenalty

public void setFrequencyPenalty(Double frequencyPenalty)

getMirostat

public Integer getMirostat()

setMirostat

public void setMirostat(Integer mirostat)

getMirostatTau

public Float getMirostatTau()

setMirostatTau

public void setMirostatTau(Float mirostatTau)

getMirostatEta

public Float getMirostatEta()

setMirostatEta

public void setMirostatEta(Float mirostatEta)

getPenalizeNewline

public Boolean getPenalizeNewline()

setPenalizeNewline

public void setPenalizeNewline(Boolean penalizeNewline)

getStopSequences

public List<String> getStopSequences()

Specified by:

getStopSequences in interface ChatOptions

setStopSequences

public void setStopSequences(List<String> stopSequences)

getStop

public List<String> getStop()

setStop

public void setStop(List<String> stop)

getTruncate

public Boolean getTruncate()

setTruncate

public void setTruncate(Boolean truncate)

getToolCallbacks

public List<FunctionCallback> getToolCallbacks()

Specified by:

getToolCallbacks in interface ToolCallingChatOptions

setToolCallbacks

public void setToolCallbacks(List<FunctionCallback> toolCallbacks)

Specified by:

setToolCallbacks in interface ToolCallingChatOptions

getToolNames

public Set<String> getToolNames()

Specified by:

getToolNames in interface ToolCallingChatOptions

setToolNames

public void setToolNames(Set<String> toolNames)

Specified by:

setToolNames in interface ToolCallingChatOptions

isInternalToolExecutionEnabled

@Nullable
public Boolean isInternalToolExecutionEnabled()

Specified by:

isInternalToolExecutionEnabled in interface ToolCallingChatOptions

setInternalToolExecutionEnabled

public void setInternalToolExecutionEnabled(@Nullable
 Boolean internalToolExecutionEnabled)

Specified by:

setInternalToolExecutionEnabled in interface ToolCallingChatOptions

getFunctionCallbacks

@Deprecated
public List<FunctionCallback> getFunctionCallbacks()

Deprecated.

Specified by:

getFunctionCallbacks in interface FunctionCallingOptions

setFunctionCallbacks

@Deprecated
public void setFunctionCallbacks(List<FunctionCallback> functionCallbacks)

Deprecated.

Specified by:

setFunctionCallbacks in interface FunctionCallingOptions

getFunctions

@Deprecated
public Set<String> getFunctions()

Deprecated.

Specified by:

getFunctions in interface FunctionCallingOptions

setFunctions

@Deprecated
public void setFunctions(Set<String> functions)

Deprecated.

Specified by:

setFunctions in interface FunctionCallingOptions

getDimensions

public Integer getDimensions()

Specified by:

getDimensions in interface EmbeddingOptions

getProxyToolCalls

@Deprecated
public Boolean getProxyToolCalls()

Deprecated.

Specified by:

getProxyToolCalls in interface FunctionCallingOptions

setProxyToolCalls

@Deprecated
public void setProxyToolCalls(Boolean proxyToolCalls)

Deprecated.

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

toMap

public Map<String,Object> toMap()

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

Returns:

The Map of key/value pairs.

copy

public OllamaOptions copy()

Specified by:

copy in interface ChatOptions

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object