Package org.springframework.ai.ollama.api

Class OllamaApi

java.lang.Object

org.springframework.ai.ollama.api.OllamaApi

public class OllamaApi
extends Object

Java Client for the Ollama API. https://ollama.ai

Since:

0.8.0

Author:

Christian Tzolov, Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	OllamaApi.ChatRequest	Chat request object.
static final record	OllamaApi.ChatResponse	Ollama chat response object.
static final record	OllamaApi.CopyModelRequest
static final record	OllamaApi.DeleteModelRequest
static final record	OllamaApi.EmbeddingsRequest	Generate embeddings from a model.
static final record	OllamaApi.EmbeddingsResponse	The response object returned from the /embedding endpoint.
static final record	OllamaApi.ListModelResponse
static final record	OllamaApi.Message	Chat message object.
static final record	OllamaApi.Model
static final record	OllamaApi.ProgressResponse
static final record	OllamaApi.PullModelRequest
static final record	OllamaApi.ShowModelRequest
static final record	OllamaApi.ShowModelResponse

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROVIDER_NAME
static final String	REQUEST_BODY_NULL_ERROR

Constructor Summary

Constructors

Constructor	Description
OllamaApi()	Default constructor that uses the default localhost url.
OllamaApi(String baseUrl)	Crate a new OllamaApi instance with the given base url.
OllamaApi(String baseUrl, org.springframework.web.client.RestClient.Builder restClientBuilder, org.springframework.web.reactive.function.client.WebClient.Builder webClientBuilder)	Crate a new OllamaApi instance with the given base url and RestClient.Builder.

Method Summary

Modifier and Type	Method	Description
OllamaApi.ChatResponse	chat(OllamaApi.ChatRequest chatRequest)	Generate the next message in a chat with a provided model.
org.springframework.http.ResponseEntity<Void>	copyModel(OllamaApi.CopyModelRequest copyModelRequest)	Copy a model.
org.springframework.http.ResponseEntity<Void>	deleteModel(OllamaApi.DeleteModelRequest deleteModelRequest)	Delete a model and its data.
OllamaApi.EmbeddingsResponse	embed(OllamaApi.EmbeddingsRequest embeddingsRequest)	Generate embeddings from a model.
OllamaApi.ListModelResponse	listModels()	List models that are available locally on the machine where Ollama is running.
reactor.core.publisher.Flux<OllamaApi.ProgressResponse>	pullModel(OllamaApi.PullModelRequest pullModelRequest)	Download a model from the Ollama library.
OllamaApi.ShowModelResponse	showModel(OllamaApi.ShowModelRequest showModelRequest)	Show information about a model available locally on the machine where Ollama is running.
reactor.core.publisher.Flux<OllamaApi.ChatResponse>	streamingChat(OllamaApi.ChatRequest chatRequest)	Streaming response for the chat completion request.

Methods inherited from class java.lang.Object

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

Field Details

PROVIDER_NAME

public static final String PROVIDER_NAME

REQUEST_BODY_NULL_ERROR

public static final String REQUEST_BODY_NULL_ERROR

See Also:

• Constant Field Values

Constructor Details

OllamaApi

public OllamaApi()

Default constructor that uses the default localhost url.

OllamaApi

public OllamaApi(String baseUrl)

Crate a new OllamaApi instance with the given base url.

Parameters:

baseUrl - The base url of the Ollama server.

OllamaApi

public OllamaApi(String baseUrl,
 org.springframework.web.client.RestClient.Builder restClientBuilder,
 org.springframework.web.reactive.function.client.WebClient.Builder webClientBuilder)

Crate a new OllamaApi instance with the given base url and RestClient.Builder.

Parameters:

baseUrl - The base url of the Ollama server.

restClientBuilder - The RestClient.Builder to use.

Method Details

chat

public OllamaApi.ChatResponse chat(OllamaApi.ChatRequest chatRequest)

Generate the next message in a chat with a provided model. This is a streaming endpoint (controlled by the 'stream' request property), so there will be a series of responses. The final response object will include statistics and additional data from the request.

Parameters:

chatRequest - Chat request.

Returns:

Chat response.

streamingChat

public reactor.core.publisher.Flux<OllamaApi.ChatResponse> streamingChat(OllamaApi.ChatRequest chatRequest)

Streaming response for the chat completion request.

Parameters:

chatRequest - Chat request. The request must set the stream property to true.

Returns:

Chat response as a Flux stream.

embed

public OllamaApi.EmbeddingsResponse embed(OllamaApi.EmbeddingsRequest embeddingsRequest)

Generate embeddings from a model.

Parameters:

embeddingsRequest - Embedding request.

Returns:

Embeddings response.

listModels

public OllamaApi.ListModelResponse listModels()

List models that are available locally on the machine where Ollama is running.

showModel

public OllamaApi.ShowModelResponse showModel(OllamaApi.ShowModelRequest showModelRequest)

Show information about a model available locally on the machine where Ollama is running.

copyModel

public org.springframework.http.ResponseEntity<Void> copyModel(OllamaApi.CopyModelRequest copyModelRequest)

Copy a model. Creates a model with another name from an existing model.

deleteModel

public org.springframework.http.ResponseEntity<Void> deleteModel(OllamaApi.DeleteModelRequest deleteModelRequest)

Delete a model and its data.

pullModel

public reactor.core.publisher.Flux<OllamaApi.ProgressResponse> pullModel(OllamaApi.PullModelRequest pullModelRequest)

Download a model from the Ollama library. Cancelled pulls are resumed from where they left off, and multiple calls will share the same download progress.