Index

A B C D E F G H I K L M N O P R S T U W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

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

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

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

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.Ollama

Adds a custom role.

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.

addTool(Tools.Tool) - Method in class io.github.ollama4j.tools.ToolRegistry

addTools(List<Tools.Tool>) - Method in class io.github.ollama4j.tools.ToolRegistry

APPLICATION_JSON - Static variable in class io.github.ollama4j.utils.Constants.HttpConstants

APPLICATION_XML - Static variable in class io.github.ollama4j.utils.Constants.HttpConstants

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

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

as(Class<T>) - Method in class io.github.ollama4j.models.response.OllamaResult

Get the structured response mapped to a specific class type.

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

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

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

B

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

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

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

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

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.embed.OllamaEmbedRequestBuilder

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

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.

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

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

C

call(OllamaChatRequest, OllamaChatTokenHandler) - Method in class io.github.ollama4j.models.request.OllamaChatEndpointCaller

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

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

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

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

chat(OllamaChatRequest, OllamaChatTokenHandler) - Method in class io.github.ollama4j.Ollama

Sends a chat request to a model using an OllamaChatRequest and sets up streaming response.

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

Removes all registered tools from the registry.

ConsoleOutputChatTokenHandler - Class in io.github.ollama4j.impl

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

ConsoleOutputGenerateTokenHandler - Class in io.github.ollama4j.impl

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

Constants - Class in io.github.ollama4j.utils

Constants.HttpConstants - Class in io.github.ollama4j.utils

createModel(CustomModelRequest) - Method in class io.github.ollama4j.Ollama

Creates a custom model.

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

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

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

D

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

Deletes a model from the Ollama server.

deregisterTools() - Method in class io.github.ollama4j.Ollama

Deregisters all tools from the tool registry.

desc() - Element in annotation type io.github.ollama4j.tools.annotations.ToolProperty

desc() - Element in annotation type io.github.ollama4j.tools.annotations.ToolSpec

Provides a detailed description of the tool's functionality.

E

embed(OllamaEmbedRequest) - Method in class io.github.ollama4j.Ollama

Generate embeddings using a OllamaEmbedRequest.

endpoint - Static variable in class io.github.ollama4j.models.request.OllamaChatEndpointCaller

endpoint - Static variable in class io.github.ollama4j.models.request.OllamaGenerateEndpointCaller

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

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

F

FileToBase64Serializer - Class in io.github.ollama4j.utils

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

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

The value can either be

G

generate(OllamaGenerateRequest, OllamaGenerateStreamObserver) - Method in class io.github.ollama4j.Ollama

Generates a response from a model using the specified parameters and stream observer.

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

Generates a response from a model asynchronously, returning a streamer for results.

getAuthHeaderValue() - Method in class io.github.ollama4j.models.request.Auth

Get authentication header value.

getAuthHeaderValue() - Method in class io.github.ollama4j.models.request.BasicAuth

Get basic authentication header value.

getAuthHeaderValue() - Method in class io.github.ollama4j.models.request.BearerAuth

Get authentication header value.

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

Transforms the OllamaRequest Object to a JSON Object via Jackson.

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

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

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

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

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

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

Get default request builder.

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

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

Retrieves a specific role by name.

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

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

Get the structured response if the response is a JSON object.

getStructuredResponse() - Method in class io.github.ollama4j.models.response.OllamaStructuredResult

Get the structured response if the response is a JSON object.

getStructuredResponse(Class<T>) - Method in class io.github.ollama4j.models.response.OllamaStructuredResult

Get the structured response mapped to a specific class type.

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

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

getVersion() - Method in class io.github.ollama4j.Ollama

Gets the Ollama server version.

H

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

HEADER_KEY_ACCEPT - Static variable in class io.github.ollama4j.utils.Constants.HttpConstants

HEADER_KEY_CONTENT_TYPE - Static variable in class io.github.ollama4j.utils.Constants.HttpConstants

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.metrics - package io.github.ollama4j.metrics

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

io.github.ollama4j.models.embed - package io.github.ollama4j.models.embed

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.tools.annotations - package io.github.ollama4j.tools.annotations

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

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

Check if Auth credentials set.

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

K

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

L

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

Lists available models from the Ollama server.

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.Ollama

Lists all available roles.

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

M

MetricsRecorder - Class in io.github.ollama4j.metrics

MetricsRecorder() - Constructor for class io.github.ollama4j.metrics.MetricsRecorder

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.ModelProcessesResult.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.ModelProcessesResult.ModelProcess

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

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

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

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

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

N

name() - Element in annotation type io.github.ollama4j.tools.annotations.ToolProperty

name() - Element in annotation type io.github.ollama4j.tools.annotations.ToolSpec

Specifies the name of the tool as exposed to the LLM.

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

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

O

of(Map<String, Tools.Property>) - Static method in class io.github.ollama4j.tools.Tools.Parameters

Ollama - Class in io.github.ollama4j

The main API class for interacting with the Ollama server.

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

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

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

Instantiates the Ollama API with a 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

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

Specialization class for requests

OllamaChatEndpointCaller(String, Auth, long) - 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, boolean, 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(OllamaChatResponseModel, List<OllamaChatMessage>) - Constructor for class io.github.ollama4j.models.chat.OllamaChatResult

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

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

OllamaChatTokenHandler - Interface in io.github.ollama4j.models.chat

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

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

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

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

OllamaEmbedRequest - Class in io.github.ollama4j.models.embed

OllamaEmbedRequest() - Constructor for class io.github.ollama4j.models.embed.OllamaEmbedRequest

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

Builder class to easily create Requests for Embedding models using ollama.

OllamaEmbedResult - Class in io.github.ollama4j.models.embed

OllamaEmbedResult() - Constructor for class io.github.ollama4j.models.embed.OllamaEmbedResult

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

Abstract helper class to call the ollama api server.

OllamaEndpointCaller(String, Auth, long) - 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

OllamaException - Exception Class in io.github.ollama4j.exceptions

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

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

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

OllamaGenerateEndpointCaller(String, Auth, long) - 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(OllamaGenerateTokenHandler, OllamaGenerateTokenHandler) - Constructor for class io.github.ollama4j.models.generate.OllamaGenerateStreamObserver

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

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, 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

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

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

OllamaToolCallsFunction - Class in io.github.ollama4j.tools

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

OllamaToolService - Annotation Type in io.github.ollama4j.tools.annotations

Annotation to mark a class as an Ollama tool service.

OllamaToolsResult - Class in io.github.ollama4j.tools

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

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

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

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

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.

P

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

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

Parses streamed Response line from ollama chat.

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

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

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

Checks the reachability of the 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.utils.PromptBuilder

Constructs a new PromptBuilder with an empty prompt.

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

providers() - Element in annotation type io.github.ollama4j.tools.annotations.OllamaToolService

Specifies the provider classes whose methods annotated with ToolSpec should be registered as tools.

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

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

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

Pulls a model using the specified Ollama library model tag.

R

record(String, String, boolean, boolean, boolean, Map<String, Object>, Object, long, int, Object) - Static method in class io.github.ollama4j.metrics.MetricsRecorder

ReflectionalToolFunction - Class in io.github.ollama4j.tools

Specification of a ToolFunction that provides the implementation via java reflection calling.

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

registerAnnotatedTools() - Method in class io.github.ollama4j.Ollama

Registers tools based on the annotations found on the methods of the caller's class and its providers.

registerAnnotatedTools(Object) - Method in class io.github.ollama4j.Ollama

Registers tools based on the annotations found on the methods of the provided object.

registerTool(Tools.Tool) - Method in class io.github.ollama4j.Ollama

Registers a single tool in the tool registry.

registerTools(List<Tools.Tool>) - Method in class io.github.ollama4j.Ollama

Registers multiple tools in the tool registry.

required() - Element in annotation type io.github.ollama4j.tools.annotations.ToolProperty

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

RoleNotFoundException - Exception Class in io.github.ollama4j.exceptions

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

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

S

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.Ollama

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

setBearerAuth(String) - Method in class io.github.ollama4j.Ollama

Set Bearer authentication for accessing an 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.

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

TEXT_PLAIN - Static variable in class io.github.ollama4j.utils.Constants.HttpConstants

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

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

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 Class in io.github.ollama4j.exceptions

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

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

ToolNotFoundException - Exception Class in io.github.ollama4j.exceptions

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

ToolProperty - Annotation Type in io.github.ollama4j.tools.annotations

Annotates a Method Parameter in a ToolSpec annotated Method.

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.Parameters - Class in io.github.ollama4j.tools

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

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

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

ToolSpec - Annotation Type in io.github.ollama4j.tools.annotations

Annotation to mark a method as a tool that can be registered automatically by registerAnnotatedTools().

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

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.chat.OllamaChatResult

toString() - Method in class io.github.ollama4j.models.embed.OllamaEmbedRequest

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.CustomModelRequest

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

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

toString() - Method in class io.github.ollama4j.tools.Tools.Parameters

U

unloadModel(String) - Method in class io.github.ollama4j.Ollama

Unloads a model from memory.

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

Utils - Class in io.github.ollama4j.utils

W

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

withFormat(Map<String, Object>) - Method in class io.github.ollama4j.models.generate.OllamaGenerateRequestBuilder

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

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

withImages(List<File>) - Method in class io.github.ollama4j.models.generate.OllamaGenerateRequestBuilder

withImagesBase64(List<String>) - Method in class io.github.ollama4j.models.generate.OllamaGenerateRequestBuilder

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

withSystem(String) - 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

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

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

withTools(List<Tools.Tool>) - Method in class io.github.ollama4j.models.generate.OllamaGenerateRequestBuilder

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

A B C D E F G H I K L M N O P R S T U W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form