forked from Mirror/ollama4j
updated links
This commit is contained in:
Amith Koujalgi
parent
cfa8aa14d7
commit
da273402b5
4
Makefile
4
Makefile
@ -1,10 +1,10 @@
|
||||
build:
|
||||
mvn -B clean install
|
||||
|
||||
ut:
|
||||
unit-tests:
|
||||
mvn clean test -Punit-tests
|
||||
|
||||
it:
|
||||
integration-tests:
|
||||
mvn clean verify -Pintegration-tests
|
||||
|
||||
doxygen:
|
||||
|
||||
130
README.md
130
README.md
@ -1,46 +1,46 @@
|
||||
### Ollama4j
|
||||
|
||||
<p align="center">
|
||||
<img src='https://raw.githubusercontent.com/amithkoujalgi/ollama4j/65a9d526150da8fcd98e2af6a164f055572bf722/ollama4j.jpeg' width='100' alt="ollama4j-icon">
|
||||
<img src='https://raw.githubusercontent.com/ollama4j/ollama4j/65a9d526150da8fcd98e2af6a164f055572bf722/ollama4j.jpeg' width='100' alt="ollama4j-icon">
|
||||
</p>
|
||||
|
||||
|
||||
A Java library (wrapper/binding) for [Ollama](https://ollama.ai/) server.
|
||||
|
||||
Find more details on the [website](https://amithkoujalgi.github.io/ollama4j/).
|
||||
Find more details on the [website](https://ollama4j.github.io/ollama4j/).
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
[//]: # ()
|
||||
[//]: # ()
|
||||
|
||||
[//]: # ()
|
||||
[//]: # ()
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
[//]: # ()
|
||||
[//]: # ()
|
||||
[//]: # ()
|
||||
|
||||
|
||||
|
||||
[](https://codecov.io/gh/amithkoujalgi/ollama4j)
|
||||
|
||||
|
||||
[](https://codecov.io/gh/ollama4j/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/)
|
||||
- [API Spec](https://ollama4j.github.io/ollama4j/docs/category/apis---model-management)
|
||||
- [Javadoc](https://ollama4j.github.io/ollama4j/apidocs/)
|
||||
- [Development](#development)
|
||||
- [Contributions](#get-involved)
|
||||
- [References](#references)
|
||||
@ -79,37 +79,21 @@ Find more details on the [website](https://amithkoujalgi.github.io/ollama4j/).
|
||||
> We have migrated the package repository from Maven Central to GitHub package repository due to technical issues with
|
||||
> publishing. Please update your repository settings to get latest version of Ollama4j.
|
||||
>
|
||||
> Track the releases [here](https://github.com/amithkoujalgi/ollama4j/releases) and update the dependency version
|
||||
> Track the releases [here](https://github.com/ollama4j/ollama4j/releases) and update the dependency version
|
||||
> according to your requirements.
|
||||
|
||||
### For Maven
|
||||
|
||||
#### Using [JitPack](https://jitpack.io/)
|
||||
#### Using [Maven Central](https://central.sonatype.com/)
|
||||
|
||||
[//]: # ([](https://jitpack.io/#amithkoujalgi/ollama4j))
|
||||
|
||||
|
||||
|
||||
1. Add `jitpack.io` repository to your project's `pom.xml` or your `settings.xml`:
|
||||
|
||||
```xml
|
||||
|
||||
<repositories>
|
||||
<repository>
|
||||
<id>jitpack.io</id>
|
||||
<url>https://jitpack.io</url>
|
||||
</repository>
|
||||
</repositories>
|
||||
```
|
||||
|
||||
2. In your Maven project, add this dependency:
|
||||
1In your Maven project, add this dependency:
|
||||
|
||||
```xml
|
||||
|
||||
<dependency>
|
||||
<groupId>io.github.amithkoujalgi</groupId>
|
||||
<groupId>io.github.ollama4j</groupId>
|
||||
<artifactId>ollama4j</artifactId>
|
||||
<version>1.0.74</version>
|
||||
<version>1.0.78</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
@ -117,9 +101,9 @@ Find more details on the [website](https://amithkoujalgi.github.io/ollama4j/).
|
||||
|
||||
[![][ollama4j-releases-shield]][ollama4j-releases-link]
|
||||
|
||||
[ollama4j-releases-link]: https://github.com/amithkoujalgi/ollama4j/releases
|
||||
[ollama4j-releases-link]: https://github.com/ollama4j/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
|
||||
[ollama4j-releases-shield]: https://img.shields.io/github/v/release/ollama4j/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`:
|
||||
|
||||
@ -129,7 +113,7 @@ Find more details on the [website](https://amithkoujalgi.github.io/ollama4j/).
|
||||
<repository>
|
||||
<id>github</id>
|
||||
<name>GitHub Apache Maven Packages</name>
|
||||
<url>https://maven.pkg.github.com/amithkoujalgi/ollama4j</url>
|
||||
<url>https://maven.pkg.github.com/ollama4j/ollama4j</url>
|
||||
<releases>
|
||||
<enabled>true</enabled>
|
||||
</releases>
|
||||
@ -163,33 +147,19 @@ Find more details on the [website](https://amithkoujalgi.github.io/ollama4j/).
|
||||
```xml
|
||||
|
||||
<dependency>
|
||||
<groupId>io.github.amithkoujalgi</groupId>
|
||||
<groupId>io.github.ollama4j</groupId>
|
||||
<artifactId>ollama4j</artifactId>
|
||||
<version>1.0.74</version>
|
||||
<version>1.0.78</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
##### 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
|
||||
1. Add the dependency
|
||||
|
||||
```groovy
|
||||
dependencies {
|
||||
implementation 'com.github.amithkoujalgi:ollama4j:Tag'
|
||||
implementation 'com.github.ollama4j:ollama4j:Tag'
|
||||
}
|
||||
```
|
||||
|
||||
@ -197,20 +167,20 @@ dependencies {
|
||||
|
||||
[//]: # ()
|
||||
|
||||
[//]: # ()
|
||||
[//]: # ()
|
||||
|
||||
[//]: # ()
|
||||
|
||||
[//]: # ([![][lib-shield]][lib])
|
||||
|
||||
[lib]: https://central.sonatype.com/artifact/io.github.amithkoujalgi/ollama4j
|
||||
[lib]: https://central.sonatype.com/artifact/io.github.ollama4j/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/).
|
||||
> Find the full API specifications on the [website](https://ollama4j.github.io/ollama4j/).
|
||||
|
||||
#### Development
|
||||
|
||||
@ -223,13 +193,13 @@ make build
|
||||
Run unit tests:
|
||||
|
||||
```shell
|
||||
make ut
|
||||
make unit-tests
|
||||
```
|
||||
|
||||
Run integration tests:
|
||||
|
||||
```shell
|
||||
make it
|
||||
make integration-tests
|
||||
```
|
||||
|
||||
#### Releases
|
||||
@ -248,7 +218,7 @@ Newer artifacts are published via GitHub Actions CI workflow when a new release
|
||||
|
||||
#### Traction
|
||||
|
||||
[](https://star-history.com/#amithkoujalgi/ollama4j&Date)
|
||||
[](https://star-history.com/#ollama4j/ollama4j&Date)
|
||||
|
||||
### Areas of improvement
|
||||
|
||||
@ -280,24 +250,24 @@ Newer artifacts are published via GitHub Actions CI workflow when a new release
|
||||
|
||||
<div align="center">
|
||||
|
||||
<a href=""></a>
|
||||
<a href=""></a>
|
||||
<a href=""></a>
|
||||
<a href=""></a>
|
||||
<a href=""></a>
|
||||
<a href=""></a>
|
||||
<a href=""></a>
|
||||
<a href=""></a>
|
||||
<a href=""></a>
|
||||
<a href=""></a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
[//]: # ()
|
||||
[//]: # ()
|
||||
|
||||
[//]: # ()
|
||||
[//]: # ()
|
||||
|
||||
[//]: # ()
|
||||
[//]: # ()
|
||||
|
||||
[//]: # ()
|
||||
[//]: # ()
|
||||
|
||||
[//]: # ()
|
||||
[//]: # ()
|
||||
|
||||
|
||||
Contributions are most welcome! Whether it's reporting a bug, proposing an enhancement, or helping
|
||||
@ -316,8 +286,8 @@ project.
|
||||
**Thanks to the amazing contributors**
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/amithkoujalgi/ollama4j/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=amithkoujalgi/ollama4j" />
|
||||
<a href="https://github.com/ollama4j/ollama4j/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=ollama4j/ollama4j" />
|
||||
</a>
|
||||
</p>
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user