### Ollama4j

ollama4j-icon

A Java library (wrapper/binding) for [Ollama](https://ollama.ai/) server. Find more details on the [website](https://amithkoujalgi.github.io/ollama4j/). ![GitHub stars](https://img.shields.io/github/stars/amithkoujalgi/ollama4j) ![GitHub forks](https://img.shields.io/github/forks/amithkoujalgi/ollama4j) ![GitHub watchers](https://img.shields.io/github/watchers/amithkoujalgi/ollama4j) ![Contributors](https://img.shields.io/github/contributors/amithkoujalgi/ollama4j) ![GitHub License](https://img.shields.io/github/license/amithkoujalgi/ollama4j) ![GitHub repo size](https://img.shields.io/github/repo-size/amithkoujalgi/ollama4j) ![GitHub top language](https://img.shields.io/github/languages/top/amithkoujalgi/ollama4j) ![GitHub last commit](https://img.shields.io/github/last-commit/amithkoujalgi/ollama4j?color=green) [![codecov](https://codecov.io/gh/amithkoujalgi/ollama4j/graph/badge.svg?token=U0TE7BGP8L)](https://codecov.io/gh/amithkoujalgi/ollama4j) ![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-raw/amithkoujalgi/ollama4j) ![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-closed-raw/amithkoujalgi/ollama4j) ![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-pr-raw/amithkoujalgi/ollama4j) ![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-pr-closed-raw/amithkoujalgi/ollama4j) ![GitHub Discussions](https://img.shields.io/github/discussions/amithkoujalgi/ollama4j) ![Build Status](https://github.com/amithkoujalgi/ollama4j/actions/workflows/maven-publish.yml/badge.svg)

[//]: # (![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Famithkoujalgi%2Follama4j&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)) [//]: # (![GitHub language count](https://img.shields.io/github/languages/count/amithkoujalgi/ollama4j)) ## Table of Contents - [How does it work?](#how-does-it-work) - [Requirements](#requirements) - [Installation](#installation) - [API Spec](https://amithkoujalgi.github.io/ollama4j/docs/category/apis---model-management) - [Javadoc](https://amithkoujalgi.github.io/ollama4j/apidocs/) - [Development](#development) - [Contributions](#get-involved) - [References](#references) #### How does it work? ```mermaid flowchart LR o4j[Ollama4j] o[Ollama Server] o4j -->|Communicates with| o; m[Models] subgraph Ollama Deployment direction TB o -->|Manages| m end ``` #### Requirements ![Java](https://img.shields.io/badge/Java-11_+-green.svg?style=just-the-message&labelColor=gray) [![][ollama-shield]][ollama-link] **Or** [![][ollama-docker-shield]][ollama-docker] [ollama-link]: https://ollama.ai/ [ollama-shield]: https://img.shields.io/badge/Ollama-Local_Installation-blue.svg?style=just-the-message&labelColor=gray [ollama-docker]: https://hub.docker.com/r/ollama/ollama [ollama-docker-shield]: https://img.shields.io/badge/Ollama-Docker-blue.svg?style=just-the-message&labelColor=gray ## Installation > [!NOTE] > Check the releases [here](https://github.com/amithkoujalgi/ollama4j/releases) and update the dependency version > according to your requirements. ### For Maven #### Using [JitPack](https://jitpack.io/) [//]: # ([![](https://jitpack.io/v/amithkoujalgi/ollama4j.svg)](https://jitpack.io/#amithkoujalgi/ollama4j)) ![JitPack](https://img.shields.io/jitpack/version/io.github.amithkoujalgi/ollama4j?style=for-the-badge&label=From%20JitPack) 1. Add `jitpack.io` repository to your project's `pom.xml` or your `settings.xml`: ```xml jitpack.io https://jitpack.io ``` 2. In your Maven project, add this dependency: ```xml io.github.amithkoujalgi ollama4j 1.0.74 ``` #### Using GitHub's Maven Package Repository [![][ollama4j-releases-shield]][ollama4j-releases-link] [ollama4j-releases-link]: https://github.com/amithkoujalgi/ollama4j/releases [ollama4j-releases-shield]: https://img.shields.io/github/v/release/amithkoujalgi/ollama4j?display_name=release&style=for-the-badge&label=From%20GitHub%20Packages%20 1. Add `GitHub Maven Packages` repository to your project's `pom.xml` or your `settings.xml`: ```xml github GitHub Apache Maven Packages https://maven.pkg.github.com/amithkoujalgi/ollama4j true true ``` 2. Add `GitHub` server to settings.xml. (Usually available at ~/.m2/settings.xml) ```xml github YOUR-USERNAME YOUR-TOKEN ``` 3. In your Maven project, add this dependency: ```xml io.github.amithkoujalgi ollama4j 1.0.74 ``` ##### For Gradle 1. Add the `JitPack` repository to your build file Add it in your root `build.gradle` at the end of repositories: ```groovy dependencyResolutionManagement { repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) repositories { mavenCentral() maven { url 'https://jitpack.io' } } } ``` 2. Add the dependency ```groovy dependencies { implementation 'com.github.amithkoujalgi:ollama4j:Tag' } ``` [//]: # (Latest release:) [//]: # () [//]: # (![Maven Central](https://img.shields.io/maven-central/v/io.github.amithkoujalgi/ollama4j)) [//]: # () [//]: # ([![][lib-shield]][lib]) [lib]: https://central.sonatype.com/artifact/io.github.amithkoujalgi/ollama4j [lib-shield]: https://img.shields.io/badge/ollama4j-get_latest_version-blue.svg?style=just-the-message&labelColor=gray #### API Spec > [!TIP] > Find the full API specifications on the [website](https://amithkoujalgi.github.io/ollama4j/). #### Development Build: ```shell make build ``` Run unit tests: ```shell make ut ``` Run integration tests: ```shell make it ``` #### 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 #### Traction [![Star History Chart](https://api.star-history.com/svg?repos=amithkoujalgi/ollama4j&type=Date)](https://star-history.com/#amithkoujalgi/ollama4j&Date) ### Areas of improvement - [x] Use Java-naming conventions for attributes in the request/response models instead of the snake-case conventions. ( possibly with Jackson-mapper's `@JsonProperty`) - [x] Fix deprecated HTTP client code - [x] Setup logging - [x] Use lombok - [x] Update request body creation with Java objects - [ ] Async APIs for images - [ ] Support for function calling with models like Mistral - [x] generate in sync mode - [ ] generate in async mode - [ ] Add custom headers to requests - [x] Add additional params for `ask` APIs such as: - [x] `options`: additional model parameters for the Modelfile such as `temperature` - Supported [params](https://github.com/jmorganca/ollama/blob/main/docs/modelfile.md#valid-parameters-and-values). - [x] `system`: system prompt to (overrides what is defined in the Modelfile) - [x] `template`: the full prompt or prompt template (overrides what is defined in the Modelfile) - [x] `context`: the context parameter returned from a previous request, which can be used to keep a short conversational memory - [x] `stream`: Add support for streaming responses from the model - [ ] Add test cases - [ ] Handle exceptions better (maybe throw more appropriate exceptions) ### Get Involved Contributions are most welcome! Whether it's reporting a bug, proposing an enhancement, or helping with code - any sort of contribution is much appreciated. ### References - [Ollama REST APIs](https://github.com/jmorganca/ollama/blob/main/docs/api.md) ### Credits The nomenclature and the icon have been adopted from the incredible [Ollama](https://ollama.ai/) project. **Thanks to the amazing contributors**

### Appreciate my work?