A B C D E F G H I K L M N O P Q R S T U V W X Y Z
All Classes All Packages

A

accept(String) - Method in class io.github.ollama4j.impl.ConsoleOutputStreamHandler

accept(String) - Method in interface io.github.ollama4j.models.generate.OllamaStreamHandler

add(String) - Method in class io.github.ollama4j.utils.PromptBuilder

Appends the specified text to the prompt.

addCustomRole(String) - Method in class io.github.ollama4j.OllamaAPI

Adds a custom role.

addFunction(String, ToolFunction) - Method in class io.github.ollama4j.tools.ToolRegistry

addLine(String) - Method in class io.github.ollama4j.utils.PromptBuilder

Appends the specified text followed by a newline character to the prompt.

addSeparator() - Method in class io.github.ollama4j.utils.PromptBuilder

Appends a separator line to the prompt.

ALFRED - Static variable in class io.github.ollama4j.types.OllamaModelType

ALL_MINILM - Static variable in class io.github.ollama4j.types.OllamaModelType

apply(Map<String, Object>) - Method in interface io.github.ollama4j.tools.ToolFunction

ASSISTANT - Static variable in class io.github.ollama4j.models.chat.OllamaChatMessageRole

B

BAKLLAVA - Static variable in class io.github.ollama4j.types.OllamaModelType

BasicAuth - Class in io.github.ollama4j.models.request

BasicAuth() - Constructor for class io.github.ollama4j.models.request.BasicAuth

BooleanToJsonFormatFlagSerializer - Class in io.github.ollama4j.utils

BooleanToJsonFormatFlagSerializer() - Constructor for class io.github.ollama4j.utils.BooleanToJsonFormatFlagSerializer

build() - Method in class io.github.ollama4j.models.chat.OllamaChatRequestBuilder

build() - Method in class io.github.ollama4j.models.embeddings.OllamaEmbeddingsRequestBuilder

Deprecated.

build() - Method in class io.github.ollama4j.models.embeddings.OllamaEmbedRequestBuilder

build() - Method in class io.github.ollama4j.models.generate.OllamaGenerateRequestBuilder

build() - Method in class io.github.ollama4j.tools.Tools.PromptBuilder

build() - Method in class io.github.ollama4j.tools.Tools.PropsBuilder

build() - Method in class io.github.ollama4j.utils.OptionsBuilder

Builds the options map.

build() - Method in class io.github.ollama4j.utils.PromptBuilder

Builds and returns the final prompt as a string.

C

call(OllamaRequestBody, OllamaStreamHandler) - Method in class io.github.ollama4j.models.request.OllamaChatEndpointCaller

call(OllamaRequestBody, OllamaStreamHandler) - Method in class io.github.ollama4j.models.request.OllamaGenerateEndpointCaller

callSync(OllamaRequestBody) - Method in class io.github.ollama4j.models.request.OllamaEndpointCaller

Calls the api server on the given host and endpoint suffix asynchronously, aka waiting for the response.

chat(OllamaChatRequest) - Method in class io.github.ollama4j.OllamaAPI

Ask a question to a model using an OllamaChatRequest.

chat(OllamaChatRequest, OllamaStreamHandler) - Method in class io.github.ollama4j.OllamaAPI

Ask a question to a model using an OllamaChatRequest.

chat(String, List<OllamaChatMessage>) - Method in class io.github.ollama4j.OllamaAPI

Ask a question to a model based on a given message stack (i.e.

CODEBOOGA - Static variable in class io.github.ollama4j.types.OllamaModelType

CODELLAMA - Static variable in class io.github.ollama4j.types.OllamaModelType

CODESTRAL - Static variable in class io.github.ollama4j.types.OllamaModelType

CODEUP - Static variable in class io.github.ollama4j.types.OllamaModelType

ConsoleOutputStreamHandler - Class in io.github.ollama4j.impl

ConsoleOutputStreamHandler() - Constructor for class io.github.ollama4j.impl.ConsoleOutputStreamHandler

createModelWithFilePath(String, String) - Method in class io.github.ollama4j.OllamaAPI

Create a custom model from a model file.

createModelWithModelFileContents(String, String) - Method in class io.github.ollama4j.OllamaAPI

Create a custom model from a model file.

CustomModelFileContentsRequest - Class in io.github.ollama4j.models.request

CustomModelFileContentsRequest() - Constructor for class io.github.ollama4j.models.request.CustomModelFileContentsRequest

CustomModelFilePathRequest - Class in io.github.ollama4j.models.request

CustomModelFilePathRequest() - Constructor for class io.github.ollama4j.models.request.CustomModelFilePathRequest

D

DEEPSEEK_CODER - Static variable in class io.github.ollama4j.types.OllamaModelType

DEEPSEEK_LLM - Static variable in class io.github.ollama4j.types.OllamaModelType

deleteModel(String, boolean) - Method in class io.github.ollama4j.OllamaAPI

Delete a model from Ollama server.

DOLPHIN_MISTRAL - Static variable in class io.github.ollama4j.types.OllamaModelType

DOLPHIN_MIXTRAL - Static variable in class io.github.ollama4j.types.OllamaModelType

DOLPHIN_PHI - Static variable in class io.github.ollama4j.types.OllamaModelType

DUCKDB_NSQL - Static variable in class io.github.ollama4j.types.OllamaModelType

E

embed(OllamaEmbedRequestModel) - Method in class io.github.ollama4j.OllamaAPI

Generate embeddings using a OllamaEmbedRequestModel.

embed(String, List<String>) - Method in class io.github.ollama4j.OllamaAPI

Generate embeddings for a given text from a model

equals(Object) - Method in class io.github.ollama4j.models.chat.OllamaChatRequest

equals(Object) - Method in class io.github.ollama4j.models.generate.OllamaGenerateRequest

EVERYTHINGLM - Static variable in class io.github.ollama4j.types.OllamaModelType

F

FALCON - Static variable in class io.github.ollama4j.types.OllamaModelType

FileToBase64Serializer - Class in io.github.ollama4j.utils

FileToBase64Serializer() - Constructor for class io.github.ollama4j.utils.FileToBase64Serializer

findModelTagFromLibrary(String, String) - Method in class io.github.ollama4j.OllamaAPI

Finds a specific model using model name and tag from Ollama library.

G

GEMMA - Static variable in class io.github.ollama4j.types.OllamaModelType

GEMMA2 - Static variable in class io.github.ollama4j.types.OllamaModelType

generate(String, String, boolean, Options) - Method in class io.github.ollama4j.OllamaAPI

Generates response using the specified AI model and prompt (in blocking mode).

generate(String, String, boolean, Options, OllamaStreamHandler) - Method in class io.github.ollama4j.OllamaAPI

Generate response for a question to a model running on Ollama server.

generateAsync(String, String, boolean) - Method in class io.github.ollama4j.OllamaAPI

Generate response for a question to a model running on Ollama server and get a callback handle that can be used to check for status and get the response from the model later.

generateEmbeddings(OllamaEmbeddingsRequestModel) - Method in class io.github.ollama4j.OllamaAPI

Deprecated.

Use OllamaAPI.embed(OllamaEmbedRequestModel) instead.

generateEmbeddings(String, String) - Method in class io.github.ollama4j.OllamaAPI

Deprecated.

Use OllamaAPI.embed(String, List) instead.

generateWithImageFiles(String, String, List<File>, Options) - Method in class io.github.ollama4j.OllamaAPI

Convenience method to call Ollama API without streaming responses.

generateWithImageFiles(String, String, List<File>, Options, OllamaStreamHandler) - Method in class io.github.ollama4j.OllamaAPI

With one or more image files, ask a question to a model running on Ollama server.

generateWithImageURLs(String, String, List<String>, Options) - Method in class io.github.ollama4j.OllamaAPI

Convenience method to call Ollama API without streaming responses.

generateWithImageURLs(String, String, List<String>, Options, OllamaStreamHandler) - Method in class io.github.ollama4j.OllamaAPI

With one or more image URLs, ask a question to a model running on Ollama server.

generateWithTools(String, String, Options) - Method in class io.github.ollama4j.OllamaAPI

Generates response using the specified AI model and prompt (in blocking mode), and then invokes a set of tools on the generated response.

getBodyPublisher() - Method in interface io.github.ollama4j.utils.OllamaRequestBody

Transforms the OllamaRequest Object to a JSON Object via Jackson.

getChatHistory() - Method in class io.github.ollama4j.models.chat.OllamaChatResult

getEndpointSuffix() - Method in class io.github.ollama4j.models.request.OllamaChatEndpointCaller

getEndpointSuffix() - Method in class io.github.ollama4j.models.request.OllamaEndpointCaller

getEndpointSuffix() - Method in class io.github.ollama4j.models.request.OllamaGenerateEndpointCaller

getFunction(String) - Method in class io.github.ollama4j.tools.ToolRegistry

getInstance(String) - Static method in class io.github.ollama4j.models.chat.OllamaChatRequestBuilder

getInstance(String) - Static method in class io.github.ollama4j.models.generate.OllamaGenerateRequestBuilder

getInstance(String, String) - Static method in class io.github.ollama4j.models.embeddings.OllamaEmbeddingsRequestBuilder

Deprecated.

getInstance(String, String...) - Static method in class io.github.ollama4j.models.embeddings.OllamaEmbedRequestBuilder

getLibraryModelDetails(LibraryModel) - Method in class io.github.ollama4j.OllamaAPI

Fetches the tags associated with a specific model from Ollama library.

getModelDetails(String) - Method in class io.github.ollama4j.OllamaAPI

Gets model details from the Ollama server.

getModelName() - Method in class io.github.ollama4j.models.response.Model

Returns the model name without its version

getModelVersion() - Method in class io.github.ollama4j.models.response.Model

Returns the model version without its name

getObjectMapper() - Static method in class io.github.ollama4j.utils.Utils

getRole(String) - Static method in class io.github.ollama4j.models.chat.OllamaChatMessageRole

getRole(String) - Method in class io.github.ollama4j.OllamaAPI

Retrieves a specific role by name.

getRoles() - Static method in class io.github.ollama4j.models.chat.OllamaChatMessageRole

getSampleDatabasePromptWithQuestion(String) - Static method in class io.github.ollama4j.utils.SamplePrompts

getToolResults() - Method in class io.github.ollama4j.tools.OllamaToolsResult

GOLIATH - Static variable in class io.github.ollama4j.types.OllamaModelType

H

handleCurrentResponsePart(OllamaChatResponseModel) - Method in class io.github.ollama4j.models.chat.OllamaChatStreamObserver

handleCurrentResponsePart(OllamaGenerateResponseModel) - Method in class io.github.ollama4j.models.generate.OllamaGenerateStreamObserver

I

io.github.ollama4j - package io.github.ollama4j

io.github.ollama4j.exceptions - package io.github.ollama4j.exceptions

io.github.ollama4j.impl - package io.github.ollama4j.impl

io.github.ollama4j.models.chat - package io.github.ollama4j.models.chat

io.github.ollama4j.models.embeddings - package io.github.ollama4j.models.embeddings

io.github.ollama4j.models.generate - package io.github.ollama4j.models.generate

io.github.ollama4j.models.ps - package io.github.ollama4j.models.ps

io.github.ollama4j.models.request - package io.github.ollama4j.models.request

io.github.ollama4j.models.response - package io.github.ollama4j.models.response

io.github.ollama4j.tools - package io.github.ollama4j.tools

io.github.ollama4j.types - package io.github.ollama4j.types

io.github.ollama4j.utils - package io.github.ollama4j.utils

isEmpty(SerializerProvider, Boolean) - Method in class io.github.ollama4j.utils.BooleanToJsonFormatFlagSerializer

K

keepAlive - Variable in class io.github.ollama4j.models.request.OllamaCommonRequest

L

LibraryModel - Class in io.github.ollama4j.models.response

LibraryModel() - Constructor for class io.github.ollama4j.models.response.LibraryModel

LibraryModelDetail - Class in io.github.ollama4j.models.response

LibraryModelDetail() - Constructor for class io.github.ollama4j.models.response.LibraryModelDetail

LibraryModelTag - Class in io.github.ollama4j.models.response

LibraryModelTag() - Constructor for class io.github.ollama4j.models.response.LibraryModelTag

listModels() - Method in class io.github.ollama4j.OllamaAPI

Lists available models from the Ollama server.

listModelsFromLibrary() - Method in class io.github.ollama4j.OllamaAPI

Retrieves a list of models from the Ollama library.

ListModelsResponse - Class in io.github.ollama4j.models.response

ListModelsResponse() - Constructor for class io.github.ollama4j.models.response.ListModelsResponse

listRoles() - Method in class io.github.ollama4j.OllamaAPI

Lists all available roles.

LLAMA_PRO - Static variable in class io.github.ollama4j.types.OllamaModelType

LLAMA2 - Static variable in class io.github.ollama4j.types.OllamaModelType

LLAMA2_CHINESE - Static variable in class io.github.ollama4j.types.OllamaModelType

LLAMA2_UNCENSORED - Static variable in class io.github.ollama4j.types.OllamaModelType

LLAMA3 - Static variable in class io.github.ollama4j.types.OllamaModelType

LLAMA3_1 - Static variable in class io.github.ollama4j.types.OllamaModelType

LLAVA - Static variable in class io.github.ollama4j.types.OllamaModelType

LLAVA_PHI3 - Static variable in class io.github.ollama4j.types.OllamaModelType

loadImageBytesFromUrl(String) - Static method in class io.github.ollama4j.utils.Utils

M

MAGICODER - Static variable in class io.github.ollama4j.types.OllamaModelType

MEDITRON - Static variable in class io.github.ollama4j.types.OllamaModelType

MEDLLAMA2 - Static variable in class io.github.ollama4j.types.OllamaModelType

MEGADOLPHIN - Static variable in class io.github.ollama4j.types.OllamaModelType

MISTRAL - Static variable in class io.github.ollama4j.types.OllamaModelType

MISTRAL_OPENORCA - Static variable in class io.github.ollama4j.types.OllamaModelType

MISTRALLITE - Static variable in class io.github.ollama4j.types.OllamaModelType

MIXTRAL - Static variable in class io.github.ollama4j.types.OllamaModelType

model - Variable in class io.github.ollama4j.models.request.OllamaCommonRequest

Model - Class in io.github.ollama4j.models.response

Model() - Constructor for class io.github.ollama4j.models.response.Model

ModelDetail - Class in io.github.ollama4j.models.response

ModelDetail() - Constructor for class io.github.ollama4j.models.response.ModelDetail

ModelDetails() - Constructor for class io.github.ollama4j.models.ps.ModelsProcessResponse.ModelDetails

ModelMeta - Class in io.github.ollama4j.models.response

ModelMeta() - Constructor for class io.github.ollama4j.models.response.ModelMeta

ModelProcess() - Constructor for class io.github.ollama4j.models.ps.ModelsProcessResponse.ModelProcess

ModelPullResponse - Class in io.github.ollama4j.models.response

ModelPullResponse() - Constructor for class io.github.ollama4j.models.response.ModelPullResponse

ModelRequest - Class in io.github.ollama4j.models.request

ModelRequest() - Constructor for class io.github.ollama4j.models.request.ModelRequest

ModelsProcessResponse - Class in io.github.ollama4j.models.ps

ModelsProcessResponse() - Constructor for class io.github.ollama4j.models.ps.ModelsProcessResponse

ModelsProcessResponse.ModelDetails - Class in io.github.ollama4j.models.ps

ModelsProcessResponse.ModelProcess - Class in io.github.ollama4j.models.ps

N

NEURAL_CHAT - Static variable in class io.github.ollama4j.types.OllamaModelType

newCustomRole(String) - Static method in class io.github.ollama4j.models.chat.OllamaChatMessageRole

NEXUSRAVEN - Static variable in class io.github.ollama4j.types.OllamaModelType

NOMIC_EMBED_TEXT - Static variable in class io.github.ollama4j.types.OllamaModelType

notify(OllamaChatResponseModel) - Method in class io.github.ollama4j.models.chat.OllamaChatStreamObserver

notify(OllamaGenerateResponseModel) - Method in class io.github.ollama4j.models.generate.OllamaGenerateStreamObserver

NOTUS - Static variable in class io.github.ollama4j.types.OllamaModelType

NOTUX - Static variable in class io.github.ollama4j.types.OllamaModelType

NOUS_HERMES - Static variable in class io.github.ollama4j.types.OllamaModelType

NOUS_HERMES2 - Static variable in class io.github.ollama4j.types.OllamaModelType

NOUS_HERMES2_MIXTRAL - Static variable in class io.github.ollama4j.types.OllamaModelType

O

OllamaAPI - Class in io.github.ollama4j

The base Ollama API class.

OllamaAPI() - Constructor for class io.github.ollama4j.OllamaAPI

Instantiates the Ollama API with default Ollama host: http://localhost:11434

OllamaAPI(String) - Constructor for class io.github.ollama4j.OllamaAPI

Instantiates the Ollama API with specified Ollama host address.

OllamaAsyncResultStreamer - Class in io.github.ollama4j.models.response

OllamaAsyncResultStreamer(HttpRequest.Builder, OllamaGenerateRequest, long) - Constructor for class io.github.ollama4j.models.response.OllamaAsyncResultStreamer

OllamaBaseException - Exception in io.github.ollama4j.exceptions

OllamaBaseException(String) - Constructor for exception io.github.ollama4j.exceptions.OllamaBaseException

OllamaChatEndpointCaller - Class in io.github.ollama4j.models.request

Specialization class for requests

OllamaChatEndpointCaller(String, BasicAuth, long, boolean) - Constructor for class io.github.ollama4j.models.request.OllamaChatEndpointCaller

OllamaChatMessage - Class in io.github.ollama4j.models.chat

Defines a single Message to be used inside a chat request against the ollama /api/chat endpoint.

OllamaChatMessage() - Constructor for class io.github.ollama4j.models.chat.OllamaChatMessage

OllamaChatMessageRole - Class in io.github.ollama4j.models.chat

Defines the possible Chat Message roles.

OllamaChatRequest - Class in io.github.ollama4j.models.chat

Defines a Request to use against the ollama /api/chat endpoint.

OllamaChatRequest() - Constructor for class io.github.ollama4j.models.chat.OllamaChatRequest

OllamaChatRequest(String, List<OllamaChatMessage>) - Constructor for class io.github.ollama4j.models.chat.OllamaChatRequest

OllamaChatRequestBuilder - Class in io.github.ollama4j.models.chat

Helper class for creating OllamaChatRequest objects using the builder-pattern.

OllamaChatResponseModel - Class in io.github.ollama4j.models.chat

OllamaChatResponseModel() - Constructor for class io.github.ollama4j.models.chat.OllamaChatResponseModel

OllamaChatResult - Class in io.github.ollama4j.models.chat

Specific chat-API result that contains the chat history sent to the model and appends the answer as OllamaChatResult given by the OllamaChatMessageRole.ASSISTANT role.

OllamaChatResult(String, long, int, List<OllamaChatMessage>) - Constructor for class io.github.ollama4j.models.chat.OllamaChatResult

OllamaChatStreamObserver - Class in io.github.ollama4j.models.chat

OllamaChatStreamObserver(OllamaStreamHandler) - Constructor for class io.github.ollama4j.models.chat.OllamaChatStreamObserver

OllamaCommonRequest - Class in io.github.ollama4j.models.request

OllamaCommonRequest() - Constructor for class io.github.ollama4j.models.request.OllamaCommonRequest

OllamaEmbeddingResponseModel - Class in io.github.ollama4j.models.embeddings

Deprecated.

OllamaEmbeddingResponseModel() - Constructor for class io.github.ollama4j.models.embeddings.OllamaEmbeddingResponseModel

Deprecated.

OllamaEmbeddingsRequestBuilder - Class in io.github.ollama4j.models.embeddings

Deprecated.

OllamaEmbeddingsRequestModel - Class in io.github.ollama4j.models.embeddings

Deprecated.

OllamaEmbeddingsRequestModel() - Constructor for class io.github.ollama4j.models.embeddings.OllamaEmbeddingsRequestModel

Deprecated.

OllamaEmbedRequestBuilder - Class in io.github.ollama4j.models.embeddings

Builderclass to easily create Requests for Embedding models using ollama.

OllamaEmbedRequestModel - Class in io.github.ollama4j.models.embeddings

OllamaEmbedRequestModel() - Constructor for class io.github.ollama4j.models.embeddings.OllamaEmbedRequestModel

OllamaEmbedResponseModel - Class in io.github.ollama4j.models.embeddings

OllamaEmbedResponseModel() - Constructor for class io.github.ollama4j.models.embeddings.OllamaEmbedResponseModel

OllamaEndpointCaller - Class in io.github.ollama4j.models.request

Abstract helperclass to call the ollama api server.

OllamaEndpointCaller(String, BasicAuth, long, boolean) - Constructor for class io.github.ollama4j.models.request.OllamaEndpointCaller

OllamaErrorResponse - Class in io.github.ollama4j.models.response

OllamaErrorResponse() - Constructor for class io.github.ollama4j.models.response.OllamaErrorResponse

OllamaGenerateEndpointCaller - Class in io.github.ollama4j.models.request

OllamaGenerateEndpointCaller(String, BasicAuth, long, boolean) - Constructor for class io.github.ollama4j.models.request.OllamaGenerateEndpointCaller

OllamaGenerateRequest - Class in io.github.ollama4j.models.generate

OllamaGenerateRequest() - Constructor for class io.github.ollama4j.models.generate.OllamaGenerateRequest

OllamaGenerateRequest(String, String) - Constructor for class io.github.ollama4j.models.generate.OllamaGenerateRequest

OllamaGenerateRequest(String, String, List<String>) - Constructor for class io.github.ollama4j.models.generate.OllamaGenerateRequest

OllamaGenerateRequestBuilder - Class in io.github.ollama4j.models.generate

Helper class for creating OllamaGenerateRequest objects using the builder-pattern.

OllamaGenerateResponseModel - Class in io.github.ollama4j.models.generate

OllamaGenerateResponseModel() - Constructor for class io.github.ollama4j.models.generate.OllamaGenerateResponseModel

OllamaGenerateStreamObserver - Class in io.github.ollama4j.models.generate

OllamaGenerateStreamObserver(OllamaStreamHandler) - Constructor for class io.github.ollama4j.models.generate.OllamaGenerateStreamObserver

OllamaModelType - Class in io.github.ollama4j.types

A class to provide constants for all the supported models by Ollama.

OllamaModelType() - Constructor for class io.github.ollama4j.types.OllamaModelType

OllamaRequestBody - Interface in io.github.ollama4j.utils

Interface to represent a OllamaRequest as HTTP-Request Body via HttpRequest.BodyPublishers.

OllamaResult - Class in io.github.ollama4j.models.response

The type Ollama result.

OllamaResult(String, long, int) - Constructor for class io.github.ollama4j.models.response.OllamaResult

OllamaResultStream - Class in io.github.ollama4j.models.response

OllamaResultStream() - Constructor for class io.github.ollama4j.models.response.OllamaResultStream

OllamaStreamHandler - Interface in io.github.ollama4j.models.generate

OllamaToolsResult - Class in io.github.ollama4j.tools

OllamaToolsResult() - Constructor for class io.github.ollama4j.tools.OllamaToolsResult

OllamaToolsResult.ToolResult - Class in io.github.ollama4j.tools

OPEN_ORCA_PLATYPUS2 - Static variable in class io.github.ollama4j.types.OllamaModelType

OPENCHAT - Static variable in class io.github.ollama4j.types.OllamaModelType

OPENHERMES - Static variable in class io.github.ollama4j.types.OllamaModelType

options - Variable in class io.github.ollama4j.models.embeddings.OllamaEmbeddingsRequestModel

Deprecated.

options - Variable in class io.github.ollama4j.models.request.OllamaCommonRequest

Options - Class in io.github.ollama4j.utils

Class for options for Ollama model.

Options() - Constructor for class io.github.ollama4j.utils.Options

OptionsBuilder - Class in io.github.ollama4j.utils

Builder class for creating options for Ollama model.

OptionsBuilder() - Constructor for class io.github.ollama4j.utils.OptionsBuilder

Constructs a new OptionsBuilder with an empty options map.

ORCA_MINI - Static variable in class io.github.ollama4j.types.OllamaModelType

ORCA2 - Static variable in class io.github.ollama4j.types.OllamaModelType

P

Parameters() - Constructor for class io.github.ollama4j.tools.Tools.PromptFuncDefinition.Parameters

parseResponseAndAddToBuffer(String, StringBuilder) - Method in class io.github.ollama4j.models.request.OllamaChatEndpointCaller

Parses streamed Response line from ollama chat.

parseResponseAndAddToBuffer(String, StringBuilder) - Method in class io.github.ollama4j.models.request.OllamaEndpointCaller

parseResponseAndAddToBuffer(String, StringBuilder) - Method in class io.github.ollama4j.models.request.OllamaGenerateEndpointCaller

PHI - Static variable in class io.github.ollama4j.types.OllamaModelType

PHI3 - Static variable in class io.github.ollama4j.types.OllamaModelType

PHIND_CODELLAMA - Static variable in class io.github.ollama4j.types.OllamaModelType

ping() - Method in class io.github.ollama4j.OllamaAPI

API to check the reachability of Ollama server.

poll() - Method in class io.github.ollama4j.models.response.OllamaResultStream

PromptBuilder - Class in io.github.ollama4j.utils

The PromptBuilder class is used to construct prompt texts for language models (LLMs).

PromptBuilder() - Constructor for class io.github.ollama4j.tools.Tools.PromptBuilder

PromptBuilder() - Constructor for class io.github.ollama4j.utils.PromptBuilder

Constructs a new PromptBuilder with an empty prompt.

PromptFuncDefinition() - Constructor for class io.github.ollama4j.tools.Tools.PromptFuncDefinition

PromptFuncSpec() - Constructor for class io.github.ollama4j.tools.Tools.PromptFuncDefinition.PromptFuncSpec

Property() - Constructor for class io.github.ollama4j.tools.Tools.PromptFuncDefinition.Property

PropsBuilder() - Constructor for class io.github.ollama4j.tools.Tools.PropsBuilder

ps() - Method in class io.github.ollama4j.OllamaAPI

Provides a list of running models and details about each model currently loaded into memory.

pullModel(LibraryModelTag) - Method in class io.github.ollama4j.OllamaAPI

Pulls a model using the specified Ollama library model tag.

pullModel(String) - Method in class io.github.ollama4j.OllamaAPI

Pull a model on the Ollama server from the list of available models.

Q

QWEN - Static variable in class io.github.ollama4j.types.OllamaModelType

QWEN2 - Static variable in class io.github.ollama4j.types.OllamaModelType

R

registerTool(Tools.ToolSpecification) - Method in class io.github.ollama4j.OllamaAPI

reset() - Method in class io.github.ollama4j.models.chat.OllamaChatRequestBuilder

returnFormatJson - Variable in class io.github.ollama4j.models.request.OllamaCommonRequest

RoleNotFoundException - Exception in io.github.ollama4j.exceptions

RoleNotFoundException(String) - Constructor for exception io.github.ollama4j.exceptions.RoleNotFoundException

run() - Method in class io.github.ollama4j.models.response.OllamaAsyncResultStreamer

S

SAMANTHA_MISTRAL - Static variable in class io.github.ollama4j.types.OllamaModelType

SamplePrompts - Class in io.github.ollama4j.utils

SamplePrompts() - Constructor for class io.github.ollama4j.utils.SamplePrompts

serialize(Boolean, JsonGenerator, SerializerProvider) - Method in class io.github.ollama4j.utils.BooleanToJsonFormatFlagSerializer

serialize(Collection<byte[]>, JsonGenerator, SerializerProvider) - Method in class io.github.ollama4j.utils.FileToBase64Serializer

setBasicAuth(String, String) - Method in class io.github.ollama4j.OllamaAPI

Set basic authentication for accessing Ollama server that's behind a reverse-proxy/gateway.

setCustomOption(String, Object) - Method in class io.github.ollama4j.utils.OptionsBuilder

Allows passing an option not formally supported by the library

setMinP(float) - Method in class io.github.ollama4j.utils.OptionsBuilder

Alternative to the top_p, and aims to ensure a balance of qualityand variety.

setMirostat(int) - Method in class io.github.ollama4j.utils.OptionsBuilder

Enable Mirostat sampling for controlling perplexity.

setMirostatEta(float) - Method in class io.github.ollama4j.utils.OptionsBuilder

Influences how quickly the algorithm responds to feedback from the generated text.

setMirostatTau(float) - Method in class io.github.ollama4j.utils.OptionsBuilder

Controls the balance between coherence and diversity of the output.

setNumCtx(int) - Method in class io.github.ollama4j.utils.OptionsBuilder

Sets the size of the context window used to generate the next token.

setNumGpu(int) - Method in class io.github.ollama4j.utils.OptionsBuilder

The number of layers to send to the GPU(s).

setNumGqa(int) - Method in class io.github.ollama4j.utils.OptionsBuilder

The number of GQA groups in the transformer layer.

setNumPredict(int) - Method in class io.github.ollama4j.utils.OptionsBuilder

Maximum number of tokens to predict when generating text.

setNumThread(int) - Method in class io.github.ollama4j.utils.OptionsBuilder

Sets the number of threads to use during computation.

setRepeatLastN(int) - Method in class io.github.ollama4j.utils.OptionsBuilder

Sets how far back for the model to look back to prevent repetition.

setRepeatPenalty(float) - Method in class io.github.ollama4j.utils.OptionsBuilder

Sets how strongly to penalize repetitions.

setSeed(int) - Method in class io.github.ollama4j.utils.OptionsBuilder

Sets the random number seed to use for generation.

setStop(String) - Method in class io.github.ollama4j.utils.OptionsBuilder

Sets the stop sequences to use.

setTemperature(float) - Method in class io.github.ollama4j.utils.OptionsBuilder

The temperature of the model.

setTfsZ(float) - Method in class io.github.ollama4j.utils.OptionsBuilder

Tail free sampling is used to reduce the impact of less probable tokens from the output.

setTopK(int) - Method in class io.github.ollama4j.utils.OptionsBuilder

Reduces the probability of generating nonsense.

setTopP(float) - Method in class io.github.ollama4j.utils.OptionsBuilder

Works together with top-k.

SOLAR - Static variable in class io.github.ollama4j.types.OllamaModelType

SQLCODER - Static variable in class io.github.ollama4j.types.OllamaModelType

STABLE_BELUGA - Static variable in class io.github.ollama4j.types.OllamaModelType

STABLE_CODE - Static variable in class io.github.ollama4j.types.OllamaModelType

STABLELM_ZEPHYR - Static variable in class io.github.ollama4j.types.OllamaModelType

STABLELM2 - Static variable in class io.github.ollama4j.types.OllamaModelType

STARCODER - Static variable in class io.github.ollama4j.types.OllamaModelType

STARLING_LM - Static variable in class io.github.ollama4j.types.OllamaModelType

stream - Variable in class io.github.ollama4j.models.request.OllamaCommonRequest

SYSTEM - Static variable in class io.github.ollama4j.models.chat.OllamaChatMessageRole

T

template - Variable in class io.github.ollama4j.models.request.OllamaCommonRequest

TINYDOLPHIN - Static variable in class io.github.ollama4j.types.OllamaModelType

TINYLLAMA - Static variable in class io.github.ollama4j.types.OllamaModelType

TOOL - Static variable in class io.github.ollama4j.models.chat.OllamaChatMessageRole

ToolFunction - Interface in io.github.ollama4j.tools

ToolFunctionCallSpec - Class in io.github.ollama4j.tools

ToolFunctionCallSpec() - Constructor for class io.github.ollama4j.tools.ToolFunctionCallSpec

ToolInvocationException - Exception in io.github.ollama4j.exceptions

ToolInvocationException(String, Exception) - Constructor for exception io.github.ollama4j.exceptions.ToolInvocationException

ToolNotFoundException - Exception in io.github.ollama4j.exceptions

ToolNotFoundException(String) - Constructor for exception io.github.ollama4j.exceptions.ToolNotFoundException

ToolRegistry - Class in io.github.ollama4j.tools

ToolRegistry() - Constructor for class io.github.ollama4j.tools.ToolRegistry

ToolResult() - Constructor for class io.github.ollama4j.tools.OllamaToolsResult.ToolResult

Tools - Class in io.github.ollama4j.tools

Tools() - Constructor for class io.github.ollama4j.tools.Tools

Tools.PromptBuilder - Class in io.github.ollama4j.tools

Tools.PromptFuncDefinition - Class in io.github.ollama4j.tools

Tools.PromptFuncDefinition.Parameters - Class in io.github.ollama4j.tools

Tools.PromptFuncDefinition.PromptFuncSpec - Class in io.github.ollama4j.tools

Tools.PromptFuncDefinition.Property - Class in io.github.ollama4j.tools

Tools.PropsBuilder - Class in io.github.ollama4j.tools

Tools.ToolSpecification - Class in io.github.ollama4j.tools

ToolSpecification() - Constructor for class io.github.ollama4j.tools.Tools.ToolSpecification

toString() - Method in class io.github.ollama4j.models.chat.OllamaChatMessage

toString() - Method in class io.github.ollama4j.models.chat.OllamaChatMessageRole

toString() - Method in class io.github.ollama4j.models.embeddings.OllamaEmbeddingsRequestModel

Deprecated.

toString() - Method in class io.github.ollama4j.models.embeddings.OllamaEmbedRequestModel

toString() - Method in class io.github.ollama4j.models.request.CustomModelFileContentsRequest

toString() - Method in class io.github.ollama4j.models.request.CustomModelFilePathRequest

toString() - Method in class io.github.ollama4j.models.request.ModelRequest

toString() - Method in class io.github.ollama4j.models.request.OllamaCommonRequest

toString() - Method in class io.github.ollama4j.models.response.Model

toString() - Method in class io.github.ollama4j.models.response.ModelDetail

toString() - Method in class io.github.ollama4j.models.response.ModelMeta

toString() - Method in class io.github.ollama4j.models.response.OllamaResult

U

USER - Static variable in class io.github.ollama4j.models.chat.OllamaChatMessageRole

Utils - Class in io.github.ollama4j.utils

Utils() - Constructor for class io.github.ollama4j.utils.Utils

V

VICUNA - Static variable in class io.github.ollama4j.types.OllamaModelType

W

withGetJsonResponse() - Method in class io.github.ollama4j.models.chat.OllamaChatRequestBuilder

withGetJsonResponse() - Method in class io.github.ollama4j.models.generate.OllamaGenerateRequestBuilder

withKeepAlive(String) - Method in class io.github.ollama4j.models.chat.OllamaChatRequestBuilder

withKeepAlive(String) - Method in class io.github.ollama4j.models.embeddings.OllamaEmbeddingsRequestBuilder

Deprecated.

withKeepAlive(String) - Method in class io.github.ollama4j.models.embeddings.OllamaEmbedRequestBuilder

withKeepAlive(String) - Method in class io.github.ollama4j.models.generate.OllamaGenerateRequestBuilder

withMessage(OllamaChatMessageRole, String, String...) - Method in class io.github.ollama4j.models.chat.OllamaChatRequestBuilder

withMessage(OllamaChatMessageRole, String, List<File>) - Method in class io.github.ollama4j.models.chat.OllamaChatRequestBuilder

withMessages(List<OllamaChatMessage>) - Method in class io.github.ollama4j.models.chat.OllamaChatRequestBuilder

withOptions(Options) - Method in class io.github.ollama4j.models.chat.OllamaChatRequestBuilder

withOptions(Options) - Method in class io.github.ollama4j.models.embeddings.OllamaEmbeddingsRequestBuilder

Deprecated.

withOptions(Options) - Method in class io.github.ollama4j.models.embeddings.OllamaEmbedRequestBuilder

withOptions(Options) - Method in class io.github.ollama4j.models.generate.OllamaGenerateRequestBuilder

withoutTruncate() - Method in class io.github.ollama4j.models.embeddings.OllamaEmbedRequestBuilder

withPrompt(String) - Method in class io.github.ollama4j.models.generate.OllamaGenerateRequestBuilder

withPrompt(String) - Method in class io.github.ollama4j.tools.Tools.PromptBuilder

withProperty(String, Tools.PromptFuncDefinition.Property) - Method in class io.github.ollama4j.tools.Tools.PropsBuilder

withStreaming() - Method in class io.github.ollama4j.models.chat.OllamaChatRequestBuilder

withStreaming() - Method in class io.github.ollama4j.models.generate.OllamaGenerateRequestBuilder

withTemplate(String) - Method in class io.github.ollama4j.models.chat.OllamaChatRequestBuilder

withTemplate(String) - Method in class io.github.ollama4j.models.generate.OllamaGenerateRequestBuilder

withToolSpecification(Tools.ToolSpecification) - Method in class io.github.ollama4j.tools.Tools.PromptBuilder

WIZARD_MATH - Static variable in class io.github.ollama4j.types.OllamaModelType

WIZARD_VICUNA - Static variable in class io.github.ollama4j.types.OllamaModelType

WIZARD_VICUNA_UNCENSORED - Static variable in class io.github.ollama4j.types.OllamaModelType

WIZARDCODER - Static variable in class io.github.ollama4j.types.OllamaModelType

WIZARDLM - Static variable in class io.github.ollama4j.types.OllamaModelType

WIZARDLM_UNCENSORED - Static variable in class io.github.ollama4j.types.OllamaModelType

X

XWINLM - Static variable in class io.github.ollama4j.types.OllamaModelType

Y

YARN_LLAMA2 - Static variable in class io.github.ollama4j.types.OllamaModelType

YARN_MISTRAL - Static variable in class io.github.ollama4j.types.OllamaModelType

YI - Static variable in class io.github.ollama4j.types.OllamaModelType

Z

ZEPHYR - Static variable in class io.github.ollama4j.types.OllamaModelType

A B C D E F G H I K L M N O P Q R S T U V W X Y Z
All Classes All Packages