seeseemelk/ollama4j
1
0
Fork 0
forked from Mirror/ollama4j
Code Issues Pull Requests Actions Packages Releases 1 Activity

Added APIs to pass images and ask questions on it with LLaVA model

Browse Source
This commit is contained in:
Amith Koujalgi 2023-12-17 15:02:30 +05:30
parent 08118b88fc
commit 251968e5e0
3 changed files with 355 additions and 214 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

282
README.md
View File

@ -2,7 +2,8 @@
<img src='https://raw.githubusercontent.com/amithkoujalgi/ollama4j/65a9d526150da8fcd98e2af6a164f055572bf722/ollama4j.jpeg' width='100' alt="ollama4j-icon"> <img src='https://raw.githubusercontent.com/amithkoujalgi/ollama4j/65a9d526150da8fcd98e2af6a164f055572bf722/ollama4j.jpeg' width='100' alt="ollama4j-icon">
A Java library (wrapper/binding) for [Ollama](https://github.com/jmorganca/ollama/blob/main/docs/api.md) APIs. A Java library (wrapper/binding)
for [Ollama](https://github.com/jmorganca/ollama/blob/main/docs/api.md) APIs.
```mermaid ```mermaid
flowchart LR flowchart LR
@ -38,7 +39,8 @@ A Java library (wrapper/binding) for [Ollama](https://github.com/jmorganca/ollam
#### Requirements #### Requirements
- Ollama (Either [natively](https://ollama.ai/download) setup or via [Docker](https://hub.docker.com/r/ollama/ollama)) - Ollama (Either [natively](https://ollama.ai/download) setup or
via [Docker](https://hub.docker.com/r/ollama/ollama))
- Java 11 or above - Java 11 or above
#### Installation #### Installation
@ -49,21 +51,22 @@ the [Central Repository](https://s01.oss.sonatype.org/#nexus-search;quick~ollama
```xml ```xml
<dependency> <dependency>
<groupId>io.github.amithkoujalgi</groupId> <groupId>io.github.amithkoujalgi</groupId>
<artifactId>ollama4j</artifactId> <artifactId>ollama4j</artifactId>
<version>1.0-SNAPSHOT</version> <version>1.0-SNAPSHOT</version>
</dependency> </dependency>
``` ```
You might want to include the Maven repository to pull the ollama4j library from. Include this in your `pom.xml`: You might want to include the Maven repository to pull the ollama4j library from. Include this in
your `pom.xml`:
```xml ```xml
<repositories> <repositories>
<repository> <repository>
<id>ollama4j-from-ossrh</id> <id>ollama4j-from-ossrh</id>
<url>https://s01.oss.sonatype.org/content/repositories/snapshots</url> <url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
</repository> </repository>
</repositories> </repositories>
``` ```
@ -104,13 +107,14 @@ Instantiate `OllamaAPI`
```java ```java
public class Main { public class Main {
public static void main(String[] args) {
String host = "http://localhost:11434/";
OllamaAPI ollamaAPI = new OllamaAPI(host);
// set verbose - true/false public static void main(String[] args) {
ollamaAPI.setVerbose(true); String host = "http://localhost:11434/";
} OllamaAPI ollamaAPI = new OllamaAPI(host);
// set verbose - true/false
ollamaAPI.setVerbose(true);
}
} }
``` ```
@ -118,11 +122,12 @@ public class Main {
```java ```java
public class Main { public class Main {
public static void main(String[] args) {
String host = "http://localhost:11434/"; public static void main(String[] args) {
OllamaAPI ollamaAPI = new OllamaAPI(host); String host = "http://localhost:11434/";
ollamaAPI.pullModel(OllamaModelType.LLAMA2); OllamaAPI ollamaAPI = new OllamaAPI(host);
} ollamaAPI.pullModel(OllamaModelType.LLAMA2);
}
} }
``` ```
@ -132,12 +137,13 @@ _Find the list of available models from Ollama [here](https://ollama.ai/library)
```java ```java
public class Main { public class Main {
public static void main(String[] args) {
String host = "http://localhost:11434/"; public static void main(String[] args) {
OllamaAPI ollamaAPI = new OllamaAPI(host); String host = "http://localhost:11434/";
List<Model> models = ollamaAPI.listModels(); OllamaAPI ollamaAPI = new OllamaAPI(host);
models.forEach(model -> System.out.println(model.getName())); List<Model> models = ollamaAPI.listModels();
} models.forEach(model -> System.out.println(model.getName()));
}
} }
``` ```
@ -152,12 +158,13 @@ sqlcoder:latest
```java ```java
public class Main { public class Main {
public static void main(String[] args) {
String host = "http://localhost:11434/"; public static void main(String[] args) {
OllamaAPI ollamaAPI = new OllamaAPI(host); String host = "http://localhost:11434/";
ModelDetail modelDetails = ollamaAPI.getModelDetails(OllamaModelType.LLAMA2); OllamaAPI ollamaAPI = new OllamaAPI(host);
System.out.println(modelDetails); ModelDetail modelDetails = ollamaAPI.getModelDetails(OllamaModelType.LLAMA2);
} System.out.println(modelDetails);
}
} }
``` ```
@ -176,11 +183,12 @@ Response:
```java ```java
public class Main { public class Main {
public static void main(String[] args) {
String host = "http://localhost:11434/"; public static void main(String[] args) {
OllamaAPI ollamaAPI = new OllamaAPI(host); String host = "http://localhost:11434/";
ollamaAPI.createModel("mycustommodel", "/path/to/modelfile/on/ollama-server"); OllamaAPI ollamaAPI = new OllamaAPI(host);
} ollamaAPI.createModel("mycustommodel", "/path/to/modelfile/on/ollama-server");
}
} }
``` ```
@ -188,12 +196,13 @@ public class Main {
```java ```java
public class Main { public class Main {
public static void main(String[] args) {
String host = "http://localhost:11434/"; public static void main(String[] args) {
OllamaAPI ollamaAPI = new OllamaAPI(host); String host = "http://localhost:11434/";
ollamaAPI.setVerbose(false); OllamaAPI ollamaAPI = new OllamaAPI(host);
ollamaAPI.deleteModel("mycustommodel", true); ollamaAPI.setVerbose(false);
} ollamaAPI.deleteModel("mycustommodel", true);
}
} }
``` ```
@ -201,12 +210,14 @@ public class Main {
```java ```java
public class Main { public class Main {
public static void main(String[] args) {
String host = "http://localhost:11434/"; public static void main(String[] args) {
OllamaAPI ollamaAPI = new OllamaAPI(host); String host = "http://localhost:11434/";
List<Double> embeddings = ollamaAPI.generateEmbeddings(OllamaModelType.LLAMA2, "Here is an article about llamas..."); OllamaAPI ollamaAPI = new OllamaAPI(host);
embeddings.forEach(System.out::println); List<Double> embeddings = ollamaAPI.generateEmbeddings(OllamaModelType.LLAMA2,
} "Here is an article about llamas...");
embeddings.forEach(System.out::println);
}
} }
``` ```
@ -216,12 +227,13 @@ public class Main {
```java ```java
public class Main { public class Main {
public static void main(String[] args) {
String host = "http://localhost:11434/"; public static void main(String[] args) {
OllamaAPI ollamaAPI = new OllamaAPI(host); String host = "http://localhost:11434/";
String response = ollamaAPI.ask(OllamaModelType.LLAMA2, "Who are you?"); OllamaAPI ollamaAPI = new OllamaAPI(host);
System.out.println(response); String response = ollamaAPI.ask(OllamaModelType.LLAMA2, "Who are you?");
} System.out.println(response);
}
} }
``` ```
@ -229,27 +241,32 @@ public class Main {
```java ```java
public class Main { public class Main {
public static void main(String[] args) {
String host = "http://localhost:11434/"; public static void main(String[] args) {
OllamaAPI ollamaAPI = new OllamaAPI(host); String host = "http://localhost:11434/";
OllamaAsyncResultCallback ollamaAsyncResultCallback = ollamaAPI.askAsync(OllamaModelType.LLAMA2, "Who are you?"); OllamaAPI ollamaAPI = new OllamaAPI(host);
while (true) { OllamaAsyncResultCallback ollamaAsyncResultCallback = ollamaAPI.askAsync(OllamaModelType.LLAMA2,
if (ollamaAsyncResultCallback.isComplete()) { "Who are you?");
System.out.println(ollamaAsyncResultCallback.getResponse()); while (true) {
break; if (ollamaAsyncResultCallback.isComplete()) {
} System.out.println(ollamaAsyncResultCallback.getResponse());
// introduce sleep to check for status with a time interval break;
// Thread.sleep(1000); }
} // introduce sleep to check for status with a time interval
// Thread.sleep(1000);
} }
}
} }
``` ```
You'd then get a response from the model: You'd then get a response from the model:
> I am LLaMA, an AI assistant developed by Meta AI that can understand and respond to human input in a conversational > I am LLaMA, an AI assistant developed by Meta AI that can understand and respond to human input in
> manner. I am trained on a massive dataset of text from the internet and can generate human-like responses to a wide > a conversational
> range of topics and questions. I can be used to create chatbots, virtual assistants, and other applications that > manner. I am trained on a massive dataset of text from the internet and can generate human-like
> responses to a wide
> range of topics and questions. I can be used to create chatbots, virtual assistants, and other
> applications that
> require > require
> natural language understanding and generation capabilities. > natural language understanding and generation capabilities.
@ -257,20 +274,22 @@ You'd then get a response from the model:
```java ```java
public class Main { public class Main {
public static void main(String[] args) {
String host = "http://localhost:11434/";
OllamaAPI ollamaAPI = new OllamaAPI(host);
String prompt = "List all cricket world cup teams of 2019."; public static void main(String[] args) {
String response = ollamaAPI.ask(OllamaModelType.LLAMA2, prompt); String host = "http://localhost:11434/";
System.out.println(response); OllamaAPI ollamaAPI = new OllamaAPI(host);
}
String prompt = "List all cricket world cup teams of 2019.";
String response = ollamaAPI.ask(OllamaModelType.LLAMA2, prompt);
System.out.println(response);
}
} }
``` ```
You'd then get a response from the model: You'd then get a response from the model:
> The 2019 ICC Cricket World Cup was held in England and Wales from May 30 to July 14, 2019. The following teams > The 2019 ICC Cricket World Cup was held in England and Wales from May 30 to July 14, 2019. The
> following teams
> participated in the tournament: > participated in the tournament:
> >
> 1. Australia > 1. Australia
@ -283,21 +302,24 @@ You'd then get a response from the model:
> 8. Sri Lanka > 8. Sri Lanka
> 9. West Indies > 9. West Indies
> >
> These teams competed in a round-robin format, with the top four teams advancing to the semi-finals. The tournament was > These teams competed in a round-robin format, with the top four teams advancing to the
> semi-finals. The tournament was
> won by the England cricket team, who defeated New Zealand in the final. > won by the England cricket team, who defeated New Zealand in the final.
#### Try asking for a Database query for your data schema: #### Try asking for a Database query for your data schema:
```java ```java
public class Main { public class Main {
public static void main(String[] args) {
String host = "http://localhost:11434/";
OllamaAPI ollamaAPI = new OllamaAPI(host);
String prompt = SamplePrompts.getSampleDatabasePromptWithQuestion("List all customer names who have bought one or more products"); public static void main(String[] args) {
String response = ollamaAPI.ask(OllamaModelType.SQLCODER, prompt); String host = "http://localhost:11434/";
System.out.println(response); OllamaAPI ollamaAPI = new OllamaAPI(host);
}
String prompt = SamplePrompts.getSampleDatabasePromptWithQuestion(
"List all customer names who have bought one or more products");
String response = ollamaAPI.ask(OllamaModelType.SQLCODER, prompt);
System.out.println(response);
}
} }
``` ```
@ -315,27 +337,75 @@ FROM sales
GROUP BY customers.name; GROUP BY customers.name;
``` ```
#### Try asking some questions by passing images 🖼️:
With Files:
```java
public class Main {
public static void main(String[] args) {
String host = "http://localhost:11434/";
OllamaAPI ollamaAPI = new OllamaAPI(host);
ollamaAPI.setRequestTimeoutSeconds(10);
OllamaResult response = ollamaAPI.askWithImageURLs(OllamaModelType.LLAVA,
"What's in this image?",
List.of(
"/path/to/image"));
System.out.println(response);
}
}
```
With URLs:
```java
public class Main {
public static void main(String[] args) {
String host = "http://localhost:11434/";
OllamaAPI ollamaAPI = new OllamaAPI(host);
ollamaAPI.setRequestTimeoutSeconds(10);
OllamaResult response = ollamaAPI.askWithImageURLs(OllamaModelType.LLAVA,
"What's in this image?",
List.of(
"https://t3.ftcdn.net/jpg/02/96/63/80/360_F_296638053_0gUVA4WVBKceGsIr7LNqRWSnkusi07dq.jpg"));
System.out.println(response);
}
}
```
You'd then get a response from the model:
```
This image features a white boat with brown cushions, where a dog is sitting on the back of the boat.
The dog seems to be enjoying its time outdoors, perhaps on a lake.
```
#### Async API with streaming response #### Async API with streaming response
```java ```java
@SuppressWarnings("ALL") @SuppressWarnings("ALL")
public class Main { public class Main {
public static void main(String[] args) {
String host = "http://localhost:11434/";
OllamaAPI ollamaAPI = new OllamaAPI(host);
String prompt = "List all cricket world cup teams of 2019."; public static void main(String[] args) {
OllamaAsyncResultCallback callback = ollamaAPI.askAsync(OllamaModelType.LLAMA2, prompt); String host = "http://localhost:11434/";
while (!callback.isComplete() || !callback.getStream().isEmpty()) { OllamaAPI ollamaAPI = new OllamaAPI(host);
// poll for data from the response stream
String response = callback.getStream().poll(); String prompt = "List all cricket world cup teams of 2019.";
if (response != null) { OllamaAsyncResultCallback callback = ollamaAPI.askAsync(OllamaModelType.LLAMA2, prompt);
System.out.print(response); while (!callback.isComplete() || !callback.getStream().isEmpty()) {
} // poll for data from the response stream
Thread.sleep(1000); String response = callback.getStream().poll();
} if (response != null) {
System.out.print(response);
}
Thread.sleep(1000);
} }
}
} }
``` ```
@ -369,14 +439,16 @@ make it
### Areas of improvement ### Areas of improvement
- [x] Use Java-naming conventions for attributes in the request/response models instead of the snake-case conventions. ( - [x] Use Java-naming conventions for attributes in the request/response models instead of the
snake-case conventions. (
possibly with Jackson-mapper's `@JsonProperty`) possibly with Jackson-mapper's `@JsonProperty`)
- [x] Fix deprecated HTTP client code - [x] Fix deprecated HTTP client code
- [ ] Add additional params for `ask` APIs such as: - [ ] Add additional params for `ask` APIs such as:
- `options`: additional model parameters for the Modelfile such as `temperature` - `options`: additional model parameters for the Modelfile such as `temperature`
- `system`: system prompt to (overrides what is defined in the Modelfile) - `system`: system prompt to (overrides what is defined in the Modelfile)
- `template`: the full prompt or prompt template (overrides what is defined in the Modelfile) - `template`: the full prompt or prompt template (overrides what is defined in the Modelfile)
- `context`: the context parameter returned from a previous request, which can be used to keep a short - `context`: the context parameter returned from a previous request, which can be used to keep a
short
conversational memory conversational memory
- `stream`: Add support for streaming responses from the model - `stream`: Add support for streaming responses from the model
- [x] Setup logging - [x] Setup logging
@ -386,9 +458,11 @@ make it
### Get Involved ### Get Involved
Contributions are most welcome! Whether it's reporting a bug, proposing an enhancement, or helping with code - any sort Contributions are most welcome! Whether it's reporting a bug, proposing an enhancement, or helping
with code - any sort
of contribution is much appreciated. of contribution is much appreciated.
### Credits ### Credits
The nomenclature and the icon have been adopted from the incredible [Ollama](https://ollama.ai/) project. The nomenclature and the icon have been adopted from the incredible [Ollama](https://ollama.ai/)
project.

257
src/main/java/io/github/amithkoujalgi/ollama4j/core/OllamaAPI.java
View File

@ -4,28 +4,37 @@ import io.github.amithkoujalgi.ollama4j.core.exceptions.OllamaBaseException;
import io.github.amithkoujalgi.ollama4j.core.models.*; import io.github.amithkoujalgi.ollama4j.core.models.*;
import io.github.amithkoujalgi.ollama4j.core.utils.Utils; import io.github.amithkoujalgi.ollama4j.core.utils.Utils;
import java.io.BufferedReader; import java.io.BufferedReader;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException; import java.io.IOException;
import java.io.InputStream; import java.io.InputStream;
import java.io.InputStreamReader; import java.io.InputStreamReader;
import java.net.URI; import java.net.URI;
import java.net.URISyntaxException; import java.net.URISyntaxException;
import java.net.URL;
import java.net.http.HttpClient; import java.net.http.HttpClient;
import java.net.http.HttpRequest; import java.net.http.HttpRequest;
import java.net.http.HttpResponse; import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets; import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.time.Duration; import java.time.Duration;
import java.util.ArrayList;
import java.util.Base64;
import java.util.List; import java.util.List;
import org.slf4j.Logger; import org.slf4j.Logger;
import org.slf4j.LoggerFactory; import org.slf4j.LoggerFactory;
/** The base Ollama API class. */ /**
* The base Ollama API class.
*/
@SuppressWarnings("DuplicatedCode") @SuppressWarnings("DuplicatedCode")
public class OllamaAPI { public class OllamaAPI {
private static final Logger logger = LoggerFactory.getLogger(OllamaAPI.class); private static final Logger logger = LoggerFactory.getLogger(OllamaAPI.class);
private final String host; private final String host;
private final long requestTimeoutSeconds = 3; private long requestTimeoutSeconds = 3;
private boolean verbose = false; private boolean verbose = true;
/** /**
* Instantiates the Ollama API. * Instantiates the Ollama API.
@ -40,6 +49,10 @@ public class OllamaAPI {
} }
} }
public void setRequestTimeoutSeconds(long requestTimeoutSeconds) {
this.requestTimeoutSeconds = requestTimeoutSeconds;
}
/** /**
* Set/unset logging of responses * Set/unset logging of responses
* *
@ -58,21 +71,15 @@ public class OllamaAPI {
throws OllamaBaseException, IOException, InterruptedException, URISyntaxException { throws OllamaBaseException, IOException, InterruptedException, URISyntaxException {
String url = this.host + "/api/tags"; String url = this.host + "/api/tags";
HttpClient httpClient = HttpClient.newHttpClient(); HttpClient httpClient = HttpClient.newHttpClient();
HttpRequest httpRequest = HttpRequest httpRequest = HttpRequest.newBuilder().uri(new URI(url))
HttpRequest.newBuilder() .header("Accept", "application/json").header("Content-type", "application/json")
.uri(new URI(url)) .timeout(Duration.ofSeconds(requestTimeoutSeconds)).GET().build();
.header("Accept", "application/json") HttpResponse<String> response = httpClient.send(httpRequest,
.header("Content-type", "application/json") HttpResponse.BodyHandlers.ofString());
.timeout(Duration.ofSeconds(requestTimeoutSeconds))
.GET()
.build();
HttpResponse<String> response =
httpClient.send(httpRequest, HttpResponse.BodyHandlers.ofString());
int statusCode = response.statusCode(); int statusCode = response.statusCode();
String responseString = response.body(); String responseString = response.body();
if (statusCode == 200) { if (statusCode == 200) {
return Utils.getObjectMapper() return Utils.getObjectMapper().readValue(responseString, ListModelsResponse.class)
.readValue(responseString, ListModelsResponse.class)
.getModels(); .getModels();
} else { } else {
throw new OllamaBaseException(statusCode + " - " + responseString); throw new OllamaBaseException(statusCode + " - " + responseString);
@ -89,26 +96,22 @@ public class OllamaAPI {
throws OllamaBaseException, IOException, URISyntaxException, InterruptedException { throws OllamaBaseException, IOException, URISyntaxException, InterruptedException {
String url = this.host + "/api/pull"; String url = this.host + "/api/pull";
String jsonData = String.format("{\"name\": \"%s\"}", model); String jsonData = String.format("{\"name\": \"%s\"}", model);
HttpRequest request = HttpRequest request = HttpRequest.newBuilder().uri(new URI(url))
HttpRequest.newBuilder() .POST(HttpRequest.BodyPublishers.ofString(jsonData)).header("Accept", "application/json")
.uri(new URI(url)) .header("Content-type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(jsonData)) .timeout(Duration.ofSeconds(requestTimeoutSeconds)).build();
.header("Accept", "application/json")
.header("Content-type", "application/json")
.timeout(Duration.ofSeconds(requestTimeoutSeconds))
.build();
HttpClient client = HttpClient.newHttpClient(); HttpClient client = HttpClient.newHttpClient();
HttpResponse<InputStream> response = HttpResponse<InputStream> response = client.send(request,
client.send(request, HttpResponse.BodyHandlers.ofInputStream()); HttpResponse.BodyHandlers.ofInputStream());
int statusCode = response.statusCode(); int statusCode = response.statusCode();
InputStream responseBodyStream = response.body(); InputStream responseBodyStream = response.body();
String responseString = ""; String responseString = "";
try (BufferedReader reader = try (BufferedReader reader = new BufferedReader(
new BufferedReader(new InputStreamReader(responseBodyStream, StandardCharsets.UTF_8))) { new InputStreamReader(responseBodyStream, StandardCharsets.UTF_8))) {
String line; String line;
while ((line = reader.readLine()) != null) { while ((line = reader.readLine()) != null) {
ModelPullResponse modelPullResponse = ModelPullResponse modelPullResponse = Utils.getObjectMapper()
Utils.getObjectMapper().readValue(line, ModelPullResponse.class); .readValue(line, ModelPullResponse.class);
if (verbose) { if (verbose) {
logger.info(modelPullResponse.getStatus()); logger.info(modelPullResponse.getStatus());
} }
@ -129,14 +132,10 @@ public class OllamaAPI {
throws IOException, OllamaBaseException, InterruptedException { throws IOException, OllamaBaseException, InterruptedException {
String url = this.host + "/api/show"; String url = this.host + "/api/show";
String jsonData = String.format("{\"name\": \"%s\"}", modelName); String jsonData = String.format("{\"name\": \"%s\"}", modelName);
HttpRequest request = HttpRequest request = HttpRequest.newBuilder().uri(URI.create(url))
HttpRequest.newBuilder() .header("Accept", "application/json").header("Content-type", "application/json")
.uri(URI.create(url)) .timeout(Duration.ofSeconds(requestTimeoutSeconds))
.header("Accept", "application/json") .POST(HttpRequest.BodyPublishers.ofString(jsonData)).build();
.header("Content-type", "application/json")
.timeout(Duration.ofSeconds(requestTimeoutSeconds))
.POST(HttpRequest.BodyPublishers.ofString(jsonData))
.build();
HttpClient client = HttpClient.newHttpClient(); HttpClient client = HttpClient.newHttpClient();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
int statusCode = response.statusCode(); int statusCode = response.statusCode();
@ -152,22 +151,18 @@ public class OllamaAPI {
* Create a custom model from a model file. Read more about custom model file creation <a * Create a custom model from a model file. Read more about custom model file creation <a
* href="https://github.com/jmorganca/ollama/blob/main/docs/modelfile.md">here</a>. * href="https://github.com/jmorganca/ollama/blob/main/docs/modelfile.md">here</a>.
* *
* @param modelName the name of the custom model to be created. * @param modelName the name of the custom model to be created.
* @param modelFilePath the path to model file that exists on the Ollama server. * @param modelFilePath the path to model file that exists on the Ollama server.
*/ */
public void createModel(String modelName, String modelFilePath) public void createModel(String modelName, String modelFilePath)
throws IOException, InterruptedException, OllamaBaseException { throws IOException, InterruptedException, OllamaBaseException {
String url = this.host + "/api/create"; String url = this.host + "/api/create";
String jsonData = String jsonData = String.format("{\"name\": \"%s\", \"path\": \"%s\"}", modelName,
String.format("{\"name\": \"%s\", \"path\": \"%s\"}", modelName, modelFilePath); modelFilePath);
HttpRequest request = HttpRequest request = HttpRequest.newBuilder().uri(URI.create(url))
HttpRequest.newBuilder() .header("Accept", "application/json").header("Content-Type", "application/json")
.uri(URI.create(url)) .timeout(Duration.ofSeconds(requestTimeoutSeconds))
.header("Accept", "application/json") .POST(HttpRequest.BodyPublishers.ofString(jsonData, StandardCharsets.UTF_8)).build();
.header("Content-Type", "application/json")
.timeout(Duration.ofSeconds(requestTimeoutSeconds))
.POST(HttpRequest.BodyPublishers.ofString(jsonData, StandardCharsets.UTF_8))
.build();
HttpClient client = HttpClient.newHttpClient(); HttpClient client = HttpClient.newHttpClient();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
int statusCode = response.statusCode(); int statusCode = response.statusCode();
@ -188,22 +183,18 @@ public class OllamaAPI {
/** /**
* Delete a model from Ollama server. * Delete a model from Ollama server.
* *
* @param name the name of the model to be deleted. * @param name the name of the model to be deleted.
* @param ignoreIfNotPresent - ignore errors if the specified model is not present on Ollama * @param ignoreIfNotPresent - ignore errors if the specified model is not present on Ollama
* server. * server.
*/ */
public void deleteModel(String name, boolean ignoreIfNotPresent) public void deleteModel(String name, boolean ignoreIfNotPresent)
throws IOException, InterruptedException, OllamaBaseException { throws IOException, InterruptedException, OllamaBaseException {
String url = this.host + "/api/delete"; String url = this.host + "/api/delete";
String jsonData = String.format("{\"name\": \"%s\"}", name); String jsonData = String.format("{\"name\": \"%s\"}", name);
HttpRequest request = HttpRequest request = HttpRequest.newBuilder().uri(URI.create(url))
HttpRequest.newBuilder() .method("DELETE", HttpRequest.BodyPublishers.ofString(jsonData, StandardCharsets.UTF_8))
.uri(URI.create(url)) .header("Accept", "application/json").header("Content-type", "application/json")
.method("DELETE", HttpRequest.BodyPublishers.ofString(jsonData, StandardCharsets.UTF_8)) .timeout(Duration.ofSeconds(requestTimeoutSeconds)).build();
.header("Accept", "application/json")
.header("Content-type", "application/json")
.timeout(Duration.ofSeconds(requestTimeoutSeconds))
.build();
HttpClient client = HttpClient.newHttpClient(); HttpClient client = HttpClient.newHttpClient();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
int statusCode = response.statusCode(); int statusCode = response.statusCode();
@ -219,7 +210,7 @@ public class OllamaAPI {
/** /**
* Generate embeddings for a given text from a model * Generate embeddings for a given text from a model
* *
* @param model name of model to generate embeddings from * @param model name of model to generate embeddings from
* @param prompt text to generate embeddings for * @param prompt text to generate embeddings for
* @return embeddings * @return embeddings
*/ */
@ -228,20 +219,16 @@ public class OllamaAPI {
String url = this.host + "/api/embeddings"; String url = this.host + "/api/embeddings";
String jsonData = String.format("{\"model\": \"%s\", \"prompt\": \"%s\"}", model, prompt); String jsonData = String.format("{\"model\": \"%s\", \"prompt\": \"%s\"}", model, prompt);
HttpClient httpClient = HttpClient.newHttpClient(); HttpClient httpClient = HttpClient.newHttpClient();
HttpRequest request = HttpRequest request = HttpRequest.newBuilder().uri(URI.create(url))
HttpRequest.newBuilder() .header("Accept", "application/json").header("Content-type", "application/json")
.uri(URI.create(url)) .timeout(Duration.ofSeconds(requestTimeoutSeconds))
.header("Accept", "application/json") .POST(HttpRequest.BodyPublishers.ofString(jsonData)).build();
.header("Content-type", "application/json")
.timeout(Duration.ofSeconds(requestTimeoutSeconds))
.POST(HttpRequest.BodyPublishers.ofString(jsonData))
.build();
HttpResponse<String> response = httpClient.send(request, HttpResponse.BodyHandlers.ofString()); HttpResponse<String> response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());
int statusCode = response.statusCode(); int statusCode = response.statusCode();
String responseBody = response.body(); String responseBody = response.body();
if (statusCode == 200) { if (statusCode == 200) {
EmbeddingResponse embeddingResponse = EmbeddingResponse embeddingResponse = Utils.getObjectMapper()
Utils.getObjectMapper().readValue(responseBody, EmbeddingResponse.class); .readValue(responseBody, EmbeddingResponse.class);
return embeddingResponse.getEmbedding(); return embeddingResponse.getEmbedding();
} else { } else {
throw new OllamaBaseException(statusCode + " - " + responseBody); throw new OllamaBaseException(statusCode + " - " + responseBody);
@ -251,40 +238,119 @@ public class OllamaAPI {
/** /**
* Ask a question to a model running on Ollama server. This is a sync/blocking call. * Ask a question to a model running on Ollama server. This is a sync/blocking call.
* *
* @param model the ollama model to ask the question to * @param model the ollama model to ask the question to
* @param promptText the prompt/question text * @param promptText the prompt/question text
* @return OllamaResult - that includes response text and time taken for response * @return OllamaResult - that includes response text and time taken for response
*/ */
public OllamaResult ask(String model, String promptText) public OllamaResult ask(String model, String promptText)
throws OllamaBaseException, IOException, InterruptedException { throws OllamaBaseException, IOException, InterruptedException {
OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, promptText); OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, promptText);
return askSync(ollamaRequestModel);
}
/**
* With one or more image files, ask a question to a model running on Ollama server. This is a
* sync/blocking call.
*
* @param model the ollama model to ask the question to
* @param promptText the prompt/question text
* @param imageFiles the list of image files to use for the question
* @return OllamaResult - that includes response text and time taken for response
*/
public OllamaResult askWithImages(String model, String promptText, List<File> imageFiles)
throws OllamaBaseException, IOException, InterruptedException {
List<String> images = new ArrayList<>();
for (File imageFile : imageFiles) {
images.add(encodeFileToBase64(imageFile));
}
OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, promptText, images);
return askSync(ollamaRequestModel);
}
/**
* With one or more image URLs, ask a question to a model running on Ollama server. This is a
* sync/blocking call.
*
* @param model the ollama model to ask the question to
* @param promptText the prompt/question text
* @param imageURLs the list of image URLs to use for the question
* @return OllamaResult - that includes response text and time taken for response
*/
public OllamaResult askWithImageURLs(String model, String promptText, List<String> imageURLs)
throws OllamaBaseException, IOException, InterruptedException, URISyntaxException {
List<String> images = new ArrayList<>();
for (String imageURL : imageURLs) {
images.add(encodeByteArrayToBase64(loadImageBytesFromUrl(imageURL)));
}
OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, promptText, images);
return askSync(ollamaRequestModel);
}
public static String encodeFileToBase64(File file) throws IOException {
return Base64.getEncoder().encodeToString(Files.readAllBytes(file.toPath()));
}
public static String encodeByteArrayToBase64(byte[] bytes) {
return Base64.getEncoder().encodeToString(bytes);
}
public static byte[] loadImageBytesFromUrl(String imageUrl)
throws IOException, URISyntaxException {
URL url = new URI(imageUrl).toURL();
try (InputStream in = url.openStream(); ByteArrayOutputStream out = new ByteArrayOutputStream()) {
byte[] buffer = new byte[1024];
int bytesRead;
while ((bytesRead = in.read(buffer)) != -1) {
out.write(buffer, 0, bytesRead);
}
return out.toByteArray();
}
}
/**
* 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.
*
* @param model the ollama model to ask the question to
* @param promptText the prompt/question text
* @return the ollama async result callback handle
*/
public OllamaAsyncResultCallback askAsync(String model, String promptText) {
OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, promptText);
HttpClient httpClient = HttpClient.newHttpClient();
URI uri = URI.create(this.host + "/api/generate");
OllamaAsyncResultCallback ollamaAsyncResultCallback = new OllamaAsyncResultCallback(httpClient,
uri, ollamaRequestModel, requestTimeoutSeconds);
ollamaAsyncResultCallback.start();
return ollamaAsyncResultCallback;
}
private OllamaResult askSync(OllamaRequestModel ollamaRequestModel)
throws OllamaBaseException, IOException, InterruptedException {
long startTime = System.currentTimeMillis(); long startTime = System.currentTimeMillis();
HttpClient httpClient = HttpClient.newHttpClient(); HttpClient httpClient = HttpClient.newHttpClient();
URI uri = URI.create(this.host + "/api/generate"); URI uri = URI.create(this.host + "/api/generate");
HttpRequest request = HttpRequest request = HttpRequest.newBuilder(uri).POST(HttpRequest.BodyPublishers.ofString(
HttpRequest.newBuilder(uri) Utils.getObjectMapper().writeValueAsString(ollamaRequestModel)))
.POST( .header("Content-Type", "application/json")
HttpRequest.BodyPublishers.ofString( .timeout(Duration.ofSeconds(requestTimeoutSeconds)).build();
Utils.getObjectMapper().writeValueAsString(ollamaRequestModel))) HttpResponse<InputStream> response = httpClient.send(request,
.header("Content-Type", "application/json") HttpResponse.BodyHandlers.ofInputStream());
.timeout(Duration.ofSeconds(requestTimeoutSeconds))
.build();
HttpResponse<InputStream> response =
httpClient.send(request, HttpResponse.BodyHandlers.ofInputStream());
int statusCode = response.statusCode(); int statusCode = response.statusCode();
InputStream responseBodyStream = response.body(); InputStream responseBodyStream = response.body();
StringBuilder responseBuffer = new StringBuilder(); StringBuilder responseBuffer = new StringBuilder();
try (BufferedReader reader = try (BufferedReader reader = new BufferedReader(
new BufferedReader(new InputStreamReader(responseBodyStream, StandardCharsets.UTF_8))) { new InputStreamReader(responseBodyStream, StandardCharsets.UTF_8))) {
String line; String line;
while ((line = reader.readLine()) != null) { while ((line = reader.readLine()) != null) {
if (statusCode == 404) { if (statusCode == 404) {
OllamaErrorResponseModel ollamaResponseModel = OllamaErrorResponseModel ollamaResponseModel = Utils.getObjectMapper()
Utils.getObjectMapper().readValue(line, OllamaErrorResponseModel.class); .readValue(line, OllamaErrorResponseModel.class);
responseBuffer.append(ollamaResponseModel.getError()); responseBuffer.append(ollamaResponseModel.getError());
} else { } else {
OllamaResponseModel ollamaResponseModel = OllamaResponseModel ollamaResponseModel = Utils.getObjectMapper()
Utils.getObjectMapper().readValue(line, OllamaResponseModel.class); .readValue(line, OllamaResponseModel.class);
if (!ollamaResponseModel.isDone()) { if (!ollamaResponseModel.isDone()) {
responseBuffer.append(ollamaResponseModel.getResponse()); responseBuffer.append(ollamaResponseModel.getResponse());
} }
@ -298,23 +364,4 @@ public class OllamaAPI {
return new OllamaResult(responseBuffer.toString().trim(), endTime - startTime, statusCode); return new OllamaResult(responseBuffer.toString().trim(), endTime - startTime, statusCode);
} }
} }
/**
* 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.
*
* @param model the ollama model to ask the question to
* @param promptText the prompt/question text
* @return the ollama async result callback handle
*/
public OllamaAsyncResultCallback askAsync(String model, String promptText) {
OllamaRequestModel ollamaRequestModel = new OllamaRequestModel(model, promptText);
HttpClient httpClient = HttpClient.newHttpClient();
URI uri = URI.create(this.host + "/api/generate");
OllamaAsyncResultCallback ollamaAsyncResultCallback =
new OllamaAsyncResultCallback(httpClient, uri, ollamaRequestModel, requestTimeoutSeconds);
ollamaAsyncResultCallback.start();
return ollamaAsyncResultCallback;
}
} }

30
src/main/java/io/github/amithkoujalgi/ollama4j/core/models/OllamaRequestModel.java
View File

@ -1,15 +1,35 @@
package io.github.amithkoujalgi.ollama4j.core.models; package io.github.amithkoujalgi.ollama4j.core.models;
import static io.github.amithkoujalgi.ollama4j.core.utils.Utils.getObjectMapper;
import com.fasterxml.jackson.core.JsonProcessingException;
import java.util.List;
import lombok.Data; import lombok.Data;
@Data @Data
public class OllamaRequestModel { public class OllamaRequestModel {
private String model;
private String prompt;
public OllamaRequestModel(String model, String prompt) { private String model;
this.model = model; private String prompt;
this.prompt = prompt; private List<String> images;
public OllamaRequestModel(String model, String prompt) {
this.model = model;
this.prompt = prompt;
}
public OllamaRequestModel(String model, String prompt, List<String> images) {
this.model = model;
this.prompt = prompt;
this.images = images;
}
public String toString() {
try {
return getObjectMapper().writerWithDefaultPrettyPrinter().writeValueAsString(this);
} catch (JsonProcessingException e) {
throw new RuntimeException(e);
} }
}
} }