Package org.springframework.ai.ollama

Class OllamaEmbeddingModel

java.lang.Object

org.springframework.ai.embedding.AbstractEmbeddingModel

org.springframework.ai.ollama.OllamaEmbeddingModel

All Implemented Interfaces:

EmbeddingModel, Model<EmbeddingRequest,EmbeddingResponse>

public class OllamaEmbeddingModel
extends AbstractEmbeddingModel

EmbeddingModel implementation for Ollama. Ollama allows developers to run large language models and generate embeddings locally. It supports open-source models available on [Ollama AI Library](https://ollama.ai/library). Examples of models supported: - Llama 2 (7B parameters, 3.8GB size) - Mistral (7B parameters, 4.1GB size) Please refer to the official Ollama website for the most up-to-date information on available models.

Since:

0.8.0

Author:

Christian Tzolov, Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OllamaEmbeddingModel.DurationParser

Field Summary

Fields inherited from class org.springframework.ai.embedding.AbstractEmbeddingModel

embeddingDimensions

Constructor Summary

Constructors

Constructor	Description
OllamaEmbeddingModel(OllamaApi ollamaApi)
OllamaEmbeddingModel(OllamaApi ollamaApi, OllamaOptions defaultOptions)
OllamaEmbeddingModel(OllamaApi ollamaApi, OllamaOptions defaultOptions, io.micrometer.observation.ObservationRegistry observationRegistry)

Method Summary

Modifier and Type	Method	Description
EmbeddingResponse	call(EmbeddingRequest request)	Executes a method call to the AI model.
float[]	embed(Document document)	Embeds the given document's content into a vector.
void	setObservationConvention(EmbeddingModelObservationConvention observationConvention)	Use the provided convention for reporting observation data

Methods inherited from class org.springframework.ai.embedding.AbstractEmbeddingModel

dimensions, dimensions

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.embedding.EmbeddingModel

embed, embed, embed, embedForResponse

Constructor Details

OllamaEmbeddingModel

public OllamaEmbeddingModel(OllamaApi ollamaApi)

OllamaEmbeddingModel

public OllamaEmbeddingModel(OllamaApi ollamaApi,
 OllamaOptions defaultOptions)

OllamaEmbeddingModel

public OllamaEmbeddingModel(OllamaApi ollamaApi,
 OllamaOptions defaultOptions,
 io.micrometer.observation.ObservationRegistry observationRegistry)

Method Details

embed

public float[] embed(Document document)

Description copied from interface: EmbeddingModel

Embeds the given document's content into a vector.

Parameters:

document - the document to embed.

Returns:

the embedded vector.

call

public EmbeddingResponse call(EmbeddingRequest request)

Description copied from interface: Model

Executes a method call to the AI model.

Parameters:

request - the request object to be sent to the AI model

Returns:

the response from the AI model

setObservationConvention

public void setObservationConvention(EmbeddingModelObservationConvention observationConvention)

Use the provided convention for reporting observation data

Parameters:

observationConvention - The provided convention