Package org.springframework.ai.ollama

Class OllamaEmbeddingModel

java.lang.Object
org.springframework.ai.embedding.AbstractEmbeddingModel
org.springframework.ai.ollama.OllamaEmbeddingModel
All Implemented Interfaces:
org.springframework.ai.embedding.EmbeddingModel, org.springframework.ai.model.Model<org.springframework.ai.embedding.EmbeddingRequest,org.springframework.ai.embedding.EmbeddingResponse>
public class OllamaEmbeddingModel extends org.springframework.ai.embedding.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](...) and on Hugging Face. 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, Ilayaperumal Gopinathan, Jonghoon Park

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    OllamaEmbeddingModel.Builder
     
    static class 
    OllamaEmbeddingModel.DurationParser
     

  • Field Summary

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

    embeddingDimensions

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static OllamaEmbeddingModel.Builder
    builder()
     
    org.springframework.ai.embedding.EmbeddingResponse
    call(org.springframework.ai.embedding.EmbeddingRequest request)
     
    float[]
    embed(org.springframework.ai.document.Document document)
     
    void
    setObservationConvention(org.springframework.ai.embedding.observation.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, OllamaOptions defaultOptions, io.micrometer.observation.ObservationRegistry observationRegistry, ModelManagementOptions modelManagementOptions)

  • Method Details

    • builder

      public static OllamaEmbeddingModel.Builder builder()

    • embed

      public float[] embed(org.springframework.ai.document.Document document)

    • call

      public org.springframework.ai.embedding.EmbeddingResponse call(org.springframework.ai.embedding.EmbeddingRequest request)

    • setObservationConvention

      public void setObservationConvention(org.springframework.ai.embedding.observation.EmbeddingModelObservationConvention observationConvention)
      Use the provided convention for reporting observation data
      Parameters:
      observationConvention - The provided convention