From 0c91db1d031c394dd84d4d13cc88c8c51528c266 Mon Sep 17 00:00:00 2001 From: Amith Koujalgi Date: Wed, 8 Nov 2023 14:49:58 +0530 Subject: [PATCH] updated Readme --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index e4c6d68..1c98e45 100644 --- a/README.md +++ b/README.md @@ -196,6 +196,14 @@ Find the full `Javadoc` (API specifications) [here](https://amithkoujalgi.github - Use Java-naming conventions for attributes in the request/response models instead of the snake-case conventions. ( possibly with Jackson-mapper's `@JsonProperty`) - Fix deprecated HTTP client code +- Add additional params for `ask` APIs such as: + - `options`: additional model parameters for the Modelfile such as `temperature` + - `system`: system prompt to (overrides what is defined in the Modelfile) + - `template`: the full prompt or prompt template (overrides what is defined in the Modelfile) + - `context`: the context parameter returned from a previous request, which can be used to keep a short + conversational memory + - `stream`: Add support for streaming responses from the model + - Setup logging - Add test cases - Handle exceptions better (maybe throw more appropriate exceptions)