forked from Mirror/ollama4j
updated readme
This commit is contained in:
parent
e2a88b06c5
commit
9658dd2993
21
README.md
21
README.md
@ -27,10 +27,6 @@ A Java library (wrapper/binding) for [Ollama](https://github.com/jmorganca/ollam
|
||||

|
||||

|
||||
|
||||
#### Star History
|
||||
|
||||
[](https://star-history.com/#amithkoujalgi/ollama4j&Date)
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [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:
|
||||
|
||||
```sql
|
||||
-- noinspection SqlResolve
|
||||
SELECT customers.name
|
||||
FROM sales
|
||||
JOIN customers ON sales.customer_id = customers.customer_id
|
||||
@ -318,6 +315,8 @@ GROUP BY customers.name;
|
||||
#### Async API with streaming response
|
||||
|
||||
```java
|
||||
|
||||
@SuppressWarnings("ALL")
|
||||
public class Main {
|
||||
public static void main(String[] args) {
|
||||
String host = "http://localhost:11434/";
|
||||
@ -361,7 +360,11 @@ Run integration tests:
|
||||
make it
|
||||
```
|
||||
|
||||
#### Areas of improvement
|
||||
#### Traction
|
||||
|
||||
[](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`)
|
||||
@ -374,15 +377,15 @@ make it
|
||||
conversational memory
|
||||
- `stream`: Add support for streaming responses from the model
|
||||
- [x] Setup logging
|
||||
- [ ] Use lombok
|
||||
- [x] Use lombok
|
||||
- [ ] Add test cases
|
||||
- [ ] 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
|
||||
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.
|
||||
|
Loading…
x
Reference in New Issue
Block a user