📦️ Create a release: 0.0.7

k33g · k33g · commit 080d492baf82 · 2024-08-17T22:47:33.000+02:00
diff --git a/README.md b/README.md
@@ -102,7 +102,7 @@ Add this section to your `pom.xml` file:
     <dependency>
         <groupId>org.parakeetnest.parakeet4j</groupId>
         <artifactId>parakeet4j</artifactId>
-        <version>0.0.6</version>
+        <version>0.0.7</version>
     </dependency>
 </dependencies>
 ```
diff --git a/RELEASE.md b/RELEASE.md
@@ -4,24 +4,12 @@
 > - create a tag on GitHub
 > - pull
 
-### What's new (v0.0.6)
+### What's new (v0.0.7)
 
-#### Completion 
+#### Protected endpoint
 
-Verbose mode:
-```java
-Options options = new Options()
-        .setTemperature(0.0)
-        .setRepeatLastN(2)
-        .setVerbose(true);
-```
+If your Ollama endpoint is protected with a header token, you can specify the token like this:
 
-#### Memory Persistent Vector Store
-
-Add additional data to a vector record:
 ```java
-vectorRecord.setText("THIS IS THE CHUNK NUM "+Integer.toString(index.get()));
-vectorRecord.setReference("THIS IS THE CHUNK DOC REF");
-vectorRecord.setMetaData("THIS IS THE CHUNK META DATA");
+query.setTokenHeaderName("X-TOKEN").setTokenHeaderValue("john doe");
 ```
-
diff --git a/docs/01-generate.md b/docs/01-generate.md
@@ -234,4 +234,10 @@ output:
 }
 ```
 
+## Protected endpoint
 
+If your Ollama endpoint is protected with a header token, you can specify the token like this:
+
+```java
+query.setTokenHeaderName("X-TOKEN").setTokenHeaderValue("john doe");
+```
diff --git a/docs/02-chat.md b/docs/02-chat.md
@@ -285,3 +285,11 @@ output:
   "evalDuration" : 499293000
 }
 ```
+
+## Protected endpoint
+
+If your Ollama endpoint is protected with a header token, you can specify the token like this:
+
+```java
+queryChat.setTokenHeaderName("X-TOKEN").setTokenHeaderValue("john doe");
+```
diff --git a/docs/03-embeddings-rag.md b/docs/03-embeddings-rag.md
@@ -299,4 +299,12 @@ making him the crew's unsung guardian in the cosmos. His best friend is Spiderma
 vectorRecord.setText("THIS IS THE CHUNK NUM "+Integer.toString(index.get()));
 vectorRecord.setReference("THIS IS THE CHUNK DOC REF");
 vectorRecord.setMetaData("THIS IS THE CHUNK META DATA");
+```
+
+## Protected endpoint
+
+If your Ollama endpoint is protected with a header token, you can specify the token like this:
+
+```java
+query4Embedding.setTokenHeaderName("X-TOKEN").setTokenHeaderValue("john snow");
 ```
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
   <groupId>org.parakeetnest.parakeet4j</groupId>
   <artifactId>parakeet4j</artifactId>
-  <version>0.0.6</version>
+  <version>0.0.7</version>
   <!--
   <version>1.0-SNAPSHOT</version>
   -->
diff --git a/src/main/java/examples/chat/DemoChatStreamToken.java b/src/main/java/examples/chat/DemoChatStreamToken.java
@@ -0,0 +1,47 @@
+package examples.chat;
+
+import org.parakeetnest.parakeet4j.llm.Message;
+import org.parakeetnest.parakeet4j.llm.Options;
+import org.parakeetnest.parakeet4j.llm.Query;
+
+import java.util.List;
+
+import static org.parakeetnest.parakeet4j.completion.Completion.ChatStream;
+
+public class DemoChatStreamToken
+{
+    public static void main( String[] args )
+    {
+        Options options = new Options()
+                .setTemperature(0.0)
+                .setRepeatLastN(2)
+                .setVerbose(true);
+
+        var systemContent = "You are a useful AI agent, expert with the Star Trek franchise.";
+        var userContent = "Who is Jean-Luc Picard?";
+
+        List<Message> messages = List.of(
+                new Message("system", systemContent),
+                new Message("user", userContent)
+        );
+
+        Query queryChat = new Query("tinyllama", options).setMessages(messages);
+
+        queryChat.setTokenHeaderName("X-TOKEN").setTokenHeaderValue("john doe");
+
+        ChatStream("https://ollamak33g.eu.loclx.io", queryChat,
+                chunk -> {
+                    System.out.print(chunk.getMessage().getContent());
+                    //return new Exception("😡"); //=> it stops the stream
+                    return null;
+                },
+                answer -> {
+                    System.out.println();
+                    System.out.println("--------------------------------------");
+                    System.out.println("😛: " + answer.getMessage().getContent());
+                },
+                err -> {
+                    System.out.println("😡: " + err.getMessage());
+                });
+    }
+}
diff --git a/src/main/java/examples/embeddings/DemoEmbeddingsCreationToken.java b/src/main/java/examples/embeddings/DemoEmbeddingsCreationToken.java
@@ -0,0 +1,29 @@
+package examples.embeddings;
+
+import org.parakeetnest.parakeet4j.llm.Query4Embedding;
+
+import static org.parakeetnest.parakeet4j.embeddings.Embeddings.CreateEmbedding;
+
+public class DemoEmbeddingsCreationToken
+{
+    public static void main( String[] args )
+    {
+        var content = "The best Pizza of the world is the pineapple pizza.";
+        Query4Embedding query4Embedding = new Query4Embedding("all-minilm",content);
+
+        query4Embedding.setTokenHeaderName("X-TOKEN").setTokenHeaderValue("john snow");
+
+        CreateEmbedding("https://ollamak33g.eu.loclx.io", query4Embedding, "pineapple-pizza",
+                vectorRecord -> {
+                    System.out.println(vectorRecord.getId() + ": " + vectorRecord.getPrompt());
+
+                    for (double item : vectorRecord.getEmbedding()) {
+                        System.out.print(item);
+                        System.out.print(" ");
+                    }
+                },
+                err -> {
+                    System.out.println("😡: " + err.getMessage());
+                });
+    }
+}
diff --git a/src/main/java/org/parakeetnest/parakeet4j/completion/Completion.java b/src/main/java/org/parakeetnest/parakeet4j/completion/Completion.java
@@ -51,11 +51,24 @@ private static ResultAnswer completion(String ollamaUrl, String kindOfCompletion
             //System.out.println("🔴🟥:" + jsonOllamaPayload.getJsonArray("tools").encodePrettily());
 
             // Create HTTP request
-            HttpRequest request = HttpRequest.newBuilder()
-                    .uri(new URI(ollamaUrl+"/api/"+kindOfCompletion))
-                    .header("Content-Type", "application/json; charset=utf-8")
-                    .POST(HttpRequest.BodyPublishers.ofString(jsonOllamaPayload.toString()))
-                    .build();
+            HttpRequest request;
+
+
+            if (query.getTokenHeaderName() != null && query.getTokenHeaderValue() != null) {
+                request = HttpRequest.newBuilder()
+                        .uri(new URI(ollamaUrl+"/api/"+kindOfCompletion))
+                        .header("Content-Type", "application/json; charset=utf-8")
+                        .header(query.getTokenHeaderName(), query.getTokenHeaderValue())
+                        .POST(HttpRequest.BodyPublishers.ofString(jsonOllamaPayload.toString()))
+                        .build();
+            } else {
+                request = HttpRequest.newBuilder()
+                        .uri(new URI(ollamaUrl+"/api/"+kindOfCompletion))
+                        .header("Content-Type", "application/json; charset=utf-8")
+                        .POST(HttpRequest.BodyPublishers.ofString(jsonOllamaPayload.toString()))
+                        .build();
+            }
+
 
             // Send the request and get the answer
             HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
@@ -309,11 +322,22 @@ private static ResultAnswer completionStream(String ollamaUrl, String kindOfComp
             JsonObject jsonOllamaPayload = new JsonObject(Json.encode(query));
 
             // Create HTTP request
-            HttpRequest request = HttpRequest.newBuilder()
-                    .uri(new URI(ollamaUrl+"/api/"+kindOfCompletion))
-                    .header("Content-Type", "application/json; charset=utf-8")
-                    .POST(HttpRequest.BodyPublishers.ofString(jsonOllamaPayload.toString()))
-                    .build();
+            HttpRequest request;
+
+            if (query.getTokenHeaderName() != null && query.getTokenHeaderValue() != null) {
+                request = HttpRequest.newBuilder()
+                        .uri(new URI(ollamaUrl+"/api/"+kindOfCompletion))
+                        .header("Content-Type", "application/json; charset=utf-8")
+                        .header(query.getTokenHeaderName(), query.getTokenHeaderValue())
+                        .POST(HttpRequest.BodyPublishers.ofString(jsonOllamaPayload.toString()))
+                        .build();
+            } else {
+                request = HttpRequest.newBuilder()
+                        .uri(new URI(ollamaUrl+"/api/"+kindOfCompletion))
+                        .header("Content-Type", "application/json; charset=utf-8")
+                        .POST(HttpRequest.BodyPublishers.ofString(jsonOllamaPayload.toString()))
+                        .build();
+            }
 
             // Send the request and get the stream answer
             //HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
diff --git a/src/main/java/org/parakeetnest/parakeet4j/embeddings/Embeddings.java b/src/main/java/org/parakeetnest/parakeet4j/embeddings/Embeddings.java
@@ -60,11 +60,22 @@ private static ResultVectorRecord createEmbedding(String ollamaUrl, Query4Embedd
             JsonObject jsonOllamaPayload = new JsonObject(Json.encode(query));
 
             // Create HTTP request
-            HttpRequest request = HttpRequest.newBuilder()
-                    .uri(new URI(ollamaUrl+"/api/embeddings"))
-                    .header("Content-Type", "application/json; charset=utf-8")
-                    .POST(HttpRequest.BodyPublishers.ofString(jsonOllamaPayload.toString()))
-                    .build();
+            HttpRequest request;
+
+            if (query.getTokenHeaderName() != null && query.getTokenHeaderValue() != null) {
+                request = HttpRequest.newBuilder()
+                        .uri(new URI(ollamaUrl+"/api/embeddings"))
+                        .header("Content-Type", "application/json; charset=utf-8")
+                        .header(query.getTokenHeaderName(), query.getTokenHeaderValue())
+                        .POST(HttpRequest.BodyPublishers.ofString(jsonOllamaPayload.toString()))
+                        .build();
+            } else {
+                request = HttpRequest.newBuilder()
+                        .uri(new URI(ollamaUrl+"/api/embeddings"))
+                        .header("Content-Type", "application/json; charset=utf-8")
+                        .POST(HttpRequest.BodyPublishers.ofString(jsonOllamaPayload.toString()))
+                        .build();
+            }
 
             // Send the request and get the answer
             HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
diff --git a/src/main/java/org/parakeetnest/parakeet4j/llm/Options.java b/src/main/java/org/parakeetnest/parakeet4j/llm/Options.java
@@ -22,6 +22,8 @@ public class Options {
     private double mirostatEta;
     private boolean penalizeNewline;
 
+
+
     public Options() {
         this.verbose = false;
     }
diff --git a/src/main/java/org/parakeetnest/parakeet4j/llm/Query.java b/src/main/java/org/parakeetnest/parakeet4j/llm/Query.java
@@ -38,6 +38,9 @@ public Query(String model, Options options, List<Message> messages) {
 
     private List<Tool> tools;
 
+    private String tokenHeaderName;
+    private String tokenHeaderValue;
+
     public String toJsonString() {
         var jsonObject = new JsonObject();
         jsonObject.put("model", model);
@@ -55,6 +58,24 @@ public String toJsonString() {
         return jsonObject.encodePrettily();
     }
 
+    public String getTokenHeaderName() {
+        return tokenHeaderName;
+    }
+
+    public Query setTokenHeaderName(String tokenHeaderName) {
+        this.tokenHeaderName = tokenHeaderName;
+        return this;
+    }
+
+    public String getTokenHeaderValue() {
+        return tokenHeaderValue;
+    }
+
+    public Query setTokenHeaderValue(String tokenHeaderValue) {
+        this.tokenHeaderValue = tokenHeaderValue;
+        return this;
+    }
+
     // Getters and Setters
     public String getModel() {
         return model;
diff --git a/src/main/java/org/parakeetnest/parakeet4j/llm/Query4Embedding.java b/src/main/java/org/parakeetnest/parakeet4j/llm/Query4Embedding.java
@@ -4,6 +4,9 @@ public class Query4Embedding {
     private String prompt;
     private String model;
 
+    private String tokenHeaderName;
+    private String tokenHeaderValue;
+
     public Query4Embedding() {}
 
     public Query4Embedding(String model) {
@@ -22,6 +25,25 @@ public Query4Embedding(String prompt, String model) {
     }
     */
 
+    public String getTokenHeaderName() {
+        return tokenHeaderName;
+    }
+
+    public Query4Embedding setTokenHeaderName(String tokenHeaderName) {
+        this.tokenHeaderName = tokenHeaderName;
+        return this;
+    }
+
+    public String getTokenHeaderValue() {
+        return tokenHeaderValue;
+    }
+
+    public Query4Embedding setTokenHeaderValue(String tokenHeaderValue) {
+        this.tokenHeaderValue = tokenHeaderValue;
+        return this;
+    }
+
+
     public String getPrompt() {
         return prompt;
     }

Original file line number	Diff line number	Diff line change
`@@ -234,4 +234,10 @@ output:`
`234`	`234`	`}`
`235`	`235`	```
`236`	`236`
	`237`	`+## Protected endpoint`
`237`	`238`
	`239`	`+If your Ollama endpoint is protected with a header token, you can specify the token like this:`
	`240`	`+`
	`241`	+```java
	`242`	`+query.setTokenHeaderName("X-TOKEN").setTokenHeaderValue("john doe");`
	`243`	+```