Awesome

Ollama4j

A Java library (wrapper/binding) for Ollama server.

Find more details on the website.

GitHub stars GitHub forks GitHub watchers GitHub License

GitHub last commit

</div>

How does it work?
Requirements
Installation
API Spec
Javadoc
Development
Contributions
References

How does it work?

  flowchart LR
    o4j[Ollama4j]
    o[Ollama Server]
    o4j -->|Communicates with| o;
    m[Models]
    subgraph Ollama Deployment
        direction TB
        o -->|Manages| m
    end

Requirements

<a href="https://ollama.ai/" target="_blank">Local Installation</a>

</td> <td>

<a href="https://hub.docker.com/r/ollama/ollama" target="_blank">Docker Installation</a>

</td> </tr> <tr> <td>

<a href="https://ollama.com/download/Ollama-darwin.zip" target="_blank">Download for macOS</a>

<a href="https://ollama.com/download/OllamaSetup.exe" target="_blank">Download for Windows</a>

Install on Linux

curl -fsSL https://ollama.com/install.sh | sh

</td> <td>

CPU only

docker run -d -p 11434:11434 \
  -v ollama:/root/.ollama \
  --name ollama \
  ollama/ollama

NVIDIA GPU

docker run -d -p 11434:11434 \
  --gpus=all \
  -v ollama:/root/.ollama \
  --name ollama \
  ollama/ollama

</td> </tr> </table>

Installation

[!NOTE] We are now publishing the artifacts to both Maven Central and GitHub package repositories.

Track the releases here and update the dependency version according to your requirements.

For Maven

Using Maven Central

In your Maven project, add this dependency:


<dependency>
    <groupId>io.github.ollama4j</groupId>
    <artifactId>ollama4j</artifactId>
    <version>1.0.79</version>
</dependency>

Using GitHub's Maven Package Repository

Add GitHub Maven Packages repository to your project's pom.xml or your settings.xml:


<repositories>
    <repository>
        <id>github</id>
        <name>GitHub Apache Maven Packages</name>
        <url>https://maven.pkg.github.com/ollama4j/ollama4j</url>
        <releases>
            <enabled>true</enabled>
        </releases>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>

Add GitHub server to settings.xml. (Usually available at ~/.m2/settings.xml)


<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                      http://maven.apache.org/xsd/settings-1.0.0.xsd">
    <servers>
        <server>
            <id>github</id>
            <username>YOUR-USERNAME</username>
            <password>YOUR-TOKEN</password>
        </server>
    </servers>
</settings>

In your Maven project, add this dependency:


<dependency>
    <groupId>io.github.ollama4j</groupId>
    <artifactId>ollama4j</artifactId>
    <version>1.0.79</version>
</dependency>

For Gradle

Add the dependency

dependencies {
    implementation 'io.github.ollama4j:ollama4j:1.0.79'
}

API Spec

[!TIP] Find the full API specifications on the website.

Development

Build:

make build

Run unit tests:

make unit-tests

Run integration tests:

make integration-tests

Releases

Newer artifacts are published via GitHub Actions CI workflow when a new release is created from main branch.

Who's using Ollama4j?

Datafaker: a library to generate fake data
- https://github.com/datafaker-net/datafaker-experimental/tree/main/ollama-api
Vaadin Web UI: UI-Tester for Interactions with Ollama via ollama4j
- https://github.com/TEAMPB/ollama4j-vaadin-ui
ollama-translator: Minecraft 1.20.6 spigot plugin allows to easily break language barriers by using ollama on the server to translate all messages into a specfic target language.
- https://github.com/liebki/ollama-translator
Ollama4j Web UI: A web UI for Ollama written in Java using Spring Boot and Vaadin framework and Ollama4j. https://github.com/ollama4j/ollama4j-web-ui

Traction

Get Involved

<a href=""> Open Issues </a> <a href=""> Closed Issues </a> <a href=""> Open PRs </a> <a href=""> Closed PRs </a> <a href=""> Discussions </a>