Package io.github.amithkoujalgi.ollama4j.core

Klasse OllamaAPI

java.lang.Object

io.github.amithkoujalgi.ollama4j.core.OllamaAPI

public class OllamaAPI
extends Object

The base Ollama API class.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
OllamaAPI(String host)	Instantiates the Ollama API.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
OllamaResult	ask(String model, String promptText)	Ask a question to a model running on Ollama server.
OllamaAsyncResultCallback	askAsync(String model, String promptText)	Ask 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.
OllamaResult	askWithImageFiles(String model, String promptText, List<File> imageFiles)	With one or more image files, ask a question to a model running on Ollama server.
OllamaResult	askWithImageURLs(String model, String promptText, List<String> imageURLs)	With one or more image URLs, ask a question to a model running on Ollama server.
void	createModelWithFilePath(String modelName, String modelFilePath)	Create a custom model from a model file.
void	createModelWithModelFileContents(String modelName, String modelFileContents)	Create a custom model from a model file.
void	deleteModel(String modelName, boolean ignoreIfNotPresent)	Delete a model from Ollama server.
List<Double>	generateEmbeddings(String model, String prompt)	Generate embeddings for a given text from a model
ModelDetail	getModelDetails(String modelName)	Gets model details from the Ollama server.
List<Model>	listModels()	List available models from Ollama server.
boolean	ping()	API to check the reachability of Ollama server.
void	pullModel(String modelName)	Pull a model on the Ollama server from the list of available models.
void	setBasicAuth(String username, String password)
void	setRequestTimeoutSeconds(long requestTimeoutSeconds)
void	setVerbose(boolean verbose)	Set/unset logging of responses

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

OllamaAPI

public OllamaAPI(String host)

Instantiates the Ollama API.

Parameter:

host - the host address of Ollama server

Methodendetails

setRequestTimeoutSeconds

public void setRequestTimeoutSeconds(long requestTimeoutSeconds)

setVerbose

public void setVerbose(boolean verbose)

Set/unset logging of responses

Parameter:

verbose - true/false

setBasicAuth

public void setBasicAuth(String username,
 String password)

ping

public boolean ping()

API to check the reachability of Ollama server.

Gibt zurück:

true if the server is reachable, false otherwise.

listModels

public List<Model> listModels()
                       throws OllamaBaseException,
IOException,
InterruptedException,
URISyntaxException

List available models from Ollama server.

Gibt zurück:

the list

Löst aus:

OllamaBaseException

IOException

InterruptedException

URISyntaxException

pullModel

public void pullModel(String modelName)
               throws OllamaBaseException,
IOException,
URISyntaxException,
InterruptedException

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

Parameter:

modelName - the name of the model

Löst aus:

OllamaBaseException

IOException

URISyntaxException

InterruptedException

getModelDetails

public ModelDetail getModelDetails(String modelName)
                            throws IOException,
OllamaBaseException,
InterruptedException

Gets model details from the Ollama server.

Parameter:

modelName - the model

Gibt zurück:

the model details

Löst aus:

IOException

OllamaBaseException

InterruptedException

createModelWithFilePath

public void createModelWithFilePath(String modelName,
 String modelFilePath)
                             throws IOException,
InterruptedException,
OllamaBaseException

Create a custom model from a model file. Read more about custom model file creation here.

Parameter:

modelName - the name of the custom model to be created.

modelFilePath - the path to model file that exists on the Ollama server.

Löst aus:

IOException

InterruptedException

OllamaBaseException

createModelWithModelFileContents

public void createModelWithModelFileContents(String modelName,
 String modelFileContents)
                                      throws IOException,
InterruptedException,
OllamaBaseException

Create a custom model from a model file. Read more about custom model file creation here.

Parameter:

modelName - the name of the custom model to be created.

modelFileContents - the path to model file that exists on the Ollama server.

Löst aus:

IOException

InterruptedException

OllamaBaseException

deleteModel

public void deleteModel(String modelName,
 boolean ignoreIfNotPresent)
                 throws IOException,
InterruptedException,
OllamaBaseException

Delete a model from Ollama server.

Parameter:

modelName - the name of the model to be deleted.

ignoreIfNotPresent - - ignore errors if the specified model is not present on Ollama server.

Löst aus:

IOException

InterruptedException

OllamaBaseException

generateEmbeddings

public List<Double> generateEmbeddings(String model,
 String prompt)
                                throws IOException,
InterruptedException,
OllamaBaseException

Generate embeddings for a given text from a model

Parameter:

model - name of model to generate embeddings from

prompt - text to generate embeddings for

Gibt zurück:

embeddings

Löst aus:

IOException

InterruptedException

OllamaBaseException

ask

public OllamaResult ask(String model,
 String promptText)
                 throws OllamaBaseException,
IOException,
InterruptedException

Ask a question to a model running on Ollama server. This is a sync/blocking call.

Parameter:

model - the ollama model to ask the question to

promptText - the prompt/question text

Gibt zurück:

OllamaResult - that includes response text and time taken for response

Löst aus:

OllamaBaseException

IOException

InterruptedException

askAsync

public OllamaAsyncResultCallback askAsync(String model,
 String promptText)

Ask 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. This would be an async/non-blocking call.

Parameter:

model - the ollama model to ask the question to

promptText - the prompt/question text

Gibt zurück:

the ollama async result callback handle

askWithImageFiles

public OllamaResult askWithImageFiles(String model,
 String promptText,
 List<File> imageFiles)
                               throws OllamaBaseException,
IOException,
InterruptedException

With one or more image files, ask a question to a model running on Ollama server. This is a sync/blocking call.

Parameter:

model - the ollama model to ask the question to

promptText - the prompt/question text

imageFiles - the list of image files to use for the question

Gibt zurück:

OllamaResult - that includes response text and time taken for response

Löst aus:

OllamaBaseException

IOException

InterruptedException

askWithImageURLs

public OllamaResult askWithImageURLs(String model,
 String promptText,
 List<String> imageURLs)
                              throws OllamaBaseException,
IOException,
InterruptedException,
URISyntaxException

With one or more image URLs, ask a question to a model running on Ollama server. This is a sync/blocking call.

Parameter:

model - the ollama model to ask the question to

promptText - the prompt/question text

imageURLs - the list of image URLs to use for the question

Gibt zurück:

OllamaResult - that includes response text and time taken for response

Löst aus:

OllamaBaseException

IOException

InterruptedException

URISyntaxException