nirmato ollama

nirmato-ollama

Unofficial Ollama API client for Kotlin multiplatform.

The implementation follows the OpenAPI definition Ollama API described in Ollama API Docs.

Warning

nirmato-ollama is under development.

Report any issue or bug in the GitHub repository.

Supported Platforms

Target Platform	Target preset
Kotlin/JVM	jvm
Kotlin/WasmJS	wasmJs
Kotlin/JS	js
Linux	linuxX64 linuxArm64
MingwX64	mingwX64
iOS	iosX64 iosArm64 iosSimulatorArm64
MacOS	macosX64 macosArm64
WatchOS	watchosX64 watchosArm64 watchosDeviceArm64 watchosSimulatorArm64
TvOS	tvosX64 tvosArm64 tvosSimulatorArm64

Compatibility table with Ollama API

Version	Ollama API
1.0.x	0.3.3
< 1.0.0	0.3.3

How to use

Generate a completion

val ollama = OllamaClient {
    logging = LoggingConfig(logLevel = LogLevel.All)
    timeout = TimeoutConfig(socket = 30.seconds)
    host = OllamaHost.Local
    retry = RetryStrategy(0)
    engine = CIO.create()
}

val response = ollama.completion {
    model = "tinyllama"
    prompt = "Why is the sky blue?"
}

Getting Started

Gradle

1. Add GitHub Maven Packages repository to your project's settings.gradle.kts

repositories {
    maven {
        name = "GitHub Apache Maven Packages"
        url = uri("https://maven.pkg.github.com/nirmato/nirmato-ollama")
    }
}

2. Add the dependency in your project build.gradle.kt

dependencies {
    implementation("org.nirmato.ollama:nirmato-ollama-client:VERSION")
}

Maven

1. 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/nirmato/nirmato-ollama</url>
        <releases>
            <enabled>true</enabled>
        </releases>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
</repositories>

2. Add the dependency in your project in your Maven project

<dependency>
    <groupId>org.nirmato.ollama</groupId>
    <artifactId>nirmato-ollama-client-[jvm]</artifactId>
    <version>VERSION</version>
</dependency>

Contributions

Please feel free to submit a pull request. Contributions are welcome!

Acknowledgements

JetBrains for making Kotlin.

License

The source code is distributed under Apache License 2.0.