Merge pull request #35 from sashirestela/release_1_3_0

Release 1.3.0

Author: sashirestela

.devfile.yaml

@@ -1,4 +1,4 @@
-schemaVersion: 2.2.2
+schemaVersion: 2.2.0
 metadata:
   attributes:
     metadata-name-field: generateName
@@ -23,4 +23,4 @@ components:
   - name: m2
     volume:
       size: 5Gi
-commands: []
+commands: []

README.md

@@ -134,8 +134,8 @@ var futureImage = openai.images().create(imageRequest);
 var imageResponse = futureImage.join();
 imageResponse.stream().forEach(img -> System.out.println("\n" + img.getUrl()));
 ```
-#### Chat Completion Service
-Example to call the Chat Completion service to ask a question and wait for an answer. We are printing out it in the console:
+#### Chat Completion Service (blocking mode)
+Example to call the Chat Completion service to ask a question and wait for a full answer. We are printing out it in the console:
 ```java
 var chatRequest = ChatRequest.builder()
     .model("gpt-3.5-turbo-1106")
@@ -149,6 +149,24 @@ var futureChat = openai.chatCompletions().create(chatRequest);
 var chatResponse = futureChat.join();
 System.out.println(chatResponse.firstContent());
 ```
+#### Chat Completion Service (streaming mode)
+Example to call the Chat Completion service to ask a question and wait for an answer in partial message deltas. We are printing out it in the console as soon as each delta is arriving:
+```java
+var chatRequest = ChatRequest.builder()
+    .model("gpt-3.5-turbo-1106")
+    .messages(List.of(
+        new ChatMsgSystem("You are an expert in AI."),
+        new ChatMsgUser("Write a technical article about ChatGPT, no more than 100 words.")))
+    .temperature(0.0)
+    .maxTokens(300)
+    .build();
+var futureChat = openai.chatCompletions().createStream(chatRequest);
+var chatResponse = futureChat.join();
+chatResponse.filter(chatResp -> chatResp.firstContent() != null)
+    .map(ChatResponse::firstContent)
+    .forEach(System.out::print);
+System.out.println();
+```
 #### Chat Completion Service with Functions
 This functionality empowers the Chat Completion service to solve specific problems to our context. In this example we are setting three functions and we are entering a prompt that will require to call one of them (the function ```product```). For setting functions we are using additional classes which implements the interface ```Functional```. Those classes define a field by each function argument, annotating them to describe them and each class must override the ```execute``` method with the function's logic. Note that we are using the ```FunctionExecutor``` utility class to enroll the functions and to execute the function selected by the ```openai.chatCompletions()``` calling:
 ```java
@@ -232,6 +250,26 @@ public static class RunAlarm implements Functional {
     }
 }
 ```
+#### Chat Completion Service with Vision
+Example to call the Chat Completion service to allow the model to take in images and answer questions about them:
+```java
+var chatRequest = ChatRequest.builder()
+    .model("gpt-4-vision-preview")
+    .messages(List.of(
+        new ChatMsgUser(List.of(
+            new ContentPartText(
+                "What do you see in the image? Give in details in no more than 100 words."),
+            new ContentPartImage(new ImageUrl(
+                "https://upload.wikimedia.org/wikipedia/commons/e/eb/Machu_Picchu%2C_Peru.jpg"))))))
+    .temperature(0.0)
+    .maxTokens(500)
+    .build();
+var chatResponse = openai.chatCompletions().createStream(chatRequest).join();
+chatResponse.filter(chatResp -> chatResp.firstContent() != null)
+    .map(chatResp -> chatResp.firstContent())
+    .forEach(System.out::print);
+System.out.println();
+```
 
 ## ✳ Run Examples
 Examples for each OpenAI service have been created in the folder [demo](https://github.com/sashirestela/simple-openai/tree/main/src/demo/java/io/github/sashirestela/openai/demo) and you can follow the next steps to execute them:

pom.xml

@@ -6,7 +6,7 @@
 
   <groupId>io.github.sashirestela</groupId>
   <artifactId>simple-openai</artifactId>
-  <version>1.2.5</version>
+  <version>1.3.0</version>
   <packaging>jar</packaging>
 
   <name>simple-openai</name>

src/demo/java/io/github/sashirestela/openai/demo/ChatServiceDemo.java

@@ -28,9 +28,8 @@ public ChatServiceDemo() {
         modelIdToUse = "gpt-3.5-turbo-1106";
         chatRequest = ChatRequest.builder()
                 .model(modelIdToUse)
-                .messages(List.of(
-                        new ChatMsgSystem("You are an expert in AI."),
-                        new ChatMsgUser("Write a technical article about ChatGPT, no more than 100 words.")))
+                .message(new ChatMsgSystem("You are an expert in AI."))
+                .message(new ChatMsgUser("Write a technical article about ChatGPT, no more than 100 words."))
                 .temperature(0.0)
                 .maxTokens(300)
                 .build();

src/main/java/io/github/sashirestela/openai/domain/assistant/ThreadRunRequest.java

@@ -13,16 +13,15 @@
 
 @Getter
 @Builder
-@JsonInclude(Include.NON_NULL)
+@JsonInclude(Include.NON_EMPTY)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
 public class ThreadRunRequest {
 
     private String assistantId;
     private String model;
     private String instructions;
-    @JsonInclude(Include.NON_EMPTY)
-    @Singular
-    private List<AssistantTool> tools;
+    private String additionalInstructions;
+    @Singular private List<AssistantTool> tools;
     private Map<String, String> metadata;
 
 }

src/main/java/io/github/sashirestela/openai/domain/audio/AudioResponse.java

@@ -12,13 +12,9 @@
 public class AudioResponse {
 
     private String text;
-
     private String task;
-
     private String language;
-
     private Double duration;
-
     private List<Segment> segments;
 
 }

src/main/java/io/github/sashirestela/openai/domain/audio/AudioSpeechRequest.java

@@ -2,29 +2,22 @@
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
-import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.PropertyNamingStrategies;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
 
 import lombok.Builder;
 import lombok.Getter;
 import lombok.NonNull;
 
 @Getter
 @Builder
+@JsonInclude(Include.NON_EMPTY)
+@JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
 public class AudioSpeechRequest {
 
-    @NonNull
-    private String model;
-
-    @NonNull
-    private String input;
-
-    @NonNull
-    private Voice voice;
-
-    @JsonInclude(Include.NON_NULL)
-    @JsonProperty("response_format")
+    @NonNull private String model;
+    @NonNull private String input;
+    @NonNull private Voice voice;
     private SpeechRespFmt responseFormat;
-
-    @JsonInclude(Include.NON_NULL)
     private Double speed;
 }

src/main/java/io/github/sashirestela/openai/domain/audio/AudioTranscribeRequest.java

@@ -4,7 +4,8 @@
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
-import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.PropertyNamingStrategies;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
 
 import lombok.Builder;
 import lombok.Getter;
@@ -13,26 +14,15 @@
 
 @Getter
 @Builder
+@JsonInclude(Include.NON_EMPTY)
+@JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
 public class AudioTranscribeRequest  {
 
-    @NonNull
-    protected Path file;
-
-    @NonNull
-    protected String model;
-
-    @JsonInclude(Include.NON_NULL)
-    protected String prompt;
-
-    @JsonInclude(Include.NON_NULL)
-    protected Double temperature;
-
-    @JsonInclude(Include.NON_NULL)
+    @NonNull private Path file;
+    @NonNull private String model;
+    private String prompt;
+    private Double temperature;
     private String language;
-
-    @With
-    @JsonInclude(Include.NON_NULL)
-    @JsonProperty("response_format")
-    protected AudioRespFmt responseFormat;
+    @With private AudioRespFmt responseFormat;
 
 }

src/main/java/io/github/sashirestela/openai/domain/audio/AudioTranslateRequest.java

@@ -4,7 +4,8 @@
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
-import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.PropertyNamingStrategies;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
 
 import lombok.Builder;
 import lombok.Getter;
@@ -13,23 +14,14 @@
 
 @Getter
 @Builder
+@JsonInclude(Include.NON_EMPTY)
+@JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
 public class AudioTranslateRequest {
 
-    @NonNull
-    protected Path file;
-
-    @NonNull
-    protected String model;
-
-    @JsonInclude(Include.NON_NULL)
-    protected String prompt;
-
-    @JsonInclude(Include.NON_NULL)
-    protected Double temperature;
-
-    @With
-    @JsonInclude(Include.NON_NULL)
-    @JsonProperty("response_format")
-    protected AudioRespFmt responseFormat;
+    @NonNull private Path file;
+    @NonNull private String model;
+    private String prompt;
+    private Double temperature;
+    @With private AudioRespFmt responseFormat;
 
 }

src/main/java/io/github/sashirestela/openai/domain/audio/Segment.java

@@ -2,7 +2,8 @@
 
 import java.util.List;
 
-import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.PropertyNamingStrategies;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
 
 import lombok.Getter;
 import lombok.NoArgsConstructor;
@@ -11,29 +12,18 @@
 @NoArgsConstructor
 @Getter
 @ToString
+@JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
 public class Segment {
 
     private Integer id;
-
     private Integer seek;
-
     private Double start;
-
     private Double end;
-
     private String text;
-
     private List<Integer> tokens;
-
     private Double temperature;
-
-    @JsonProperty("avg_logprob")
-    private Double averageLogProb;
-
-    @JsonProperty("compression_ratio")
+    private Double avgLogprob;
     private Double compressionRatio;
-
-    @JsonProperty("no_speech_prob")
     private Double noSpeechProb;
 
 }