Mirror/ollama4j
1
0
Fork 1
mirror of https://github.com/amithkoujalgi/ollama4j.git synced 2025-05-15 11:57:12 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
Amith Koujalgi 2023-12-17 11:24:27 +05:30
parent e2a88b06c5
commit 9658dd2993
1 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -27,10 +27,6 @@ A Java library (wrapper/binding) for [Ollama](https://github.com/jmorganca/ollam
![GitHub last commit](https://img.shields.io/github/last-commit/amithkoujalgi/ollama4j?color=red&style=plastic) ![GitHub last commit](https://img.shields.io/github/last-commit/amithkoujalgi/ollama4j?color=red&style=plastic)
![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) ![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)
#### Star History
[![Star History Chart](https://api.star-history.com/svg?repos=amithkoujalgi/ollama4j&type=Date)](https://star-history.com/#amithkoujalgi/ollama4j&Date)
## Table of Contents ## Table of Contents
- [Requirements](#requirements) - [Requirements](#requirements)
@ -309,6 +305,7 @@ containing a database schema from within this library for demonstration purposes
You'd then get a response from the model: You'd then get a response from the model:
```sql ```sql
-- noinspection SqlResolve
SELECT customers.name SELECT customers.name
FROM sales FROM sales
JOIN customers ON sales.customer_id = customers.customer_id JOIN customers ON sales.customer_id = customers.customer_id
@ -318,6 +315,8 @@ GROUP BY customers.name;
#### Async API with streaming response #### Async API with streaming response
```java ```java
@SuppressWarnings("ALL")
public class Main { public class Main {
public static void main(String[] args) { public static void main(String[] args) {
String host = "http://localhost:11434/"; String host = "http://localhost:11434/";
@ -361,7 +360,11 @@ Run integration tests:
make it make it
``` ```
#### Areas of improvement #### 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. ( - [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`)
@ -374,15 +377,15 @@ make it
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
- [ ] Use lombok - [x] Use lombok
- [ ] Add test cases - [ ] Add test cases
- [ ] Handle exceptions better (maybe throw more appropriate exceptions) - [ ] Handle exceptions better (maybe throw more appropriate exceptions)
#### 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 project. The nomenclature and the icon have been adopted from the incredible [Ollama](https://ollama.ai/) project.