Package org.springframework.ai.ollama.api

Class OllamaEmbeddingOptions

java.lang.Object

org.springframework.ai.ollama.api.OllamaEmbeddingOptions

All Implemented Interfaces:

EmbeddingOptions, ModelOptions

public class OllamaEmbeddingOptions
extends Object
implements 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	OllamaEmbeddingOptions.Builder

Constructor Summary

Constructors

Constructor	Description
OllamaEmbeddingOptions()

Method Summary

Modifier and Type	Method	Description
static OllamaEmbeddingOptions.Builder	builder()
OllamaEmbeddingOptions	copy()
boolean	equals(Object o)
static Map<String,Object>	filterNonSupportedFields(Map<String,Object> options)	Filter out the non-supported fields from the options.
static OllamaEmbeddingOptions	fromOptions(OllamaEmbeddingOptions fromOptions)
static OllamaEmbeddingOptions	fromOptions(OllamaOptions fromOptions)
Integer	getDimensions()
String	getKeepAlive()
Boolean	getLowVRAM()
Integer	getMainGPU()
String	getModel()
Integer	getNumBatch()
Integer	getNumGPU()
Integer	getNumThread()
Boolean	getTruncate()
Boolean	getUseMLock()
Boolean	getUseMMap()
Boolean	getUseNUMA()
Boolean	getVocabOnly()
int	hashCode()
void	setKeepAlive(String keepAlive)
void	setLowVRAM(Boolean lowVRAM)
void	setMainGPU(Integer mainGPU)
void	setModel(String model)
void	setNumBatch(Integer numBatch)
void	setNumGPU(Integer numGPU)
void	setNumThread(Integer numThread)
void	setTruncate(Boolean truncate)
void	setUseMLock(Boolean useMLock)
void	setUseMMap(Boolean useMMap)
void	setUseNUMA(Boolean useNUMA)
void	setVocabOnly(Boolean vocabOnly)
Map<String,Object>	toMap()	Convert the OllamaEmbeddingOptions 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

OllamaEmbeddingOptions

public OllamaEmbeddingOptions()

Method Details

builder

public static OllamaEmbeddingOptions.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 OllamaEmbeddingOptions fromOptions(OllamaEmbeddingOptions fromOptions)

fromOptions

public static OllamaEmbeddingOptions fromOptions(OllamaOptions fromOptions)

getModel

public String getModel()

Specified by:

getModel in interface EmbeddingOptions

setModel

public void setModel(String model)

getKeepAlive

public String getKeepAlive()

setKeepAlive

public void setKeepAlive(String keepAlive)

getTruncate

public Boolean getTruncate()

setTruncate

public void setTruncate(Boolean truncate)

getUseNUMA

public Boolean getUseNUMA()

setUseNUMA

public void setUseNUMA(Boolean useNUMA)

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)

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)

getDimensions

public Integer getDimensions()

Specified by:

getDimensions in interface EmbeddingOptions

toMap

public Map<String,Object> toMap()

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

Returns:

The Map of key/value pairs.

copy

public OllamaEmbeddingOptions copy()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object