Merge pull request #8 from flashvayne/develop

update

Author: flashvayne

README.md

@@ -7,34 +7,69 @@ Use chatgpt in springboot project easily.
 This starter is based on Openai Official Apis.
 
 ## Usage
-1.Add maven dependency.
+### 1.Add maven dependency.
 ```pom
 <dependency>
     <groupId>io.github.flashvayne</groupId>
     <artifactId>chatgpt-spring-boot-starter</artifactId>
-    <version>1.0.1</version>
+    <version>1.0.2</version>
 </dependency>
 ```
-2.Set chatgpt properties in your application.yml
+### 2.Set chatgpt properties in your application.yml
+
 ```yml
 chatgpt:
-  api-key: xxxxxxxxxxx   #your api-key. It can be generated in the link https://platform.openai.com/account/api-keys
-# some properties as below have default values. Of course, you can change them.
-#  max-tokens: 300           # The maximum number of tokens to generate in the completion.The token count of your prompt plus max_tokens cannot exceed the model's context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096).
-#  model: text-davinci-003   # GPT-3 models can understand and generate natural language. We offer four main models with different levels of power suitable for different tasks. Davinci is the most capable model, and Ada is the fastest.
-#  temperature: 0.0          # What sampling temperature to use. Higher values means the model will take more risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer.We generally recommend altering this or top_p but not both.
-#  top-p: 1.0                # An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.We generally recommend altering this or temperature but not both.
+  api-key: xxxxxxxxxxx   #api-key. It can be generated here https://platform.openai.com/account/api-keys
+# some properties as below have default values. For descriptions of these fields, please refer to https://platform.openai.com/docs/api-reference/completions/create and https://platform.openai.com/docs/api-reference/chat/create
+#  url: https://api.openai.com/v1/completions
+#  model: text-davinci-003
+#  max-tokens: 500
+#  temperature: 0.0
+#  top-p: 1.0
+#  multi:
+#    url: https://api.openai.com/v1/chat/completions
+#    model: gpt-3.5-turbo
+#    max-tokens: 500
+#    temperature: 0.0
+#    top-p: 1.0
 ```
-3.Inject bean ChatgptService anywhere you require it, and invoke its method to send message to chatgpt and get the response.
+### 3.Inject bean ChatgptService anywhere you require it, and invoke its method to send message to chatgpt and get the response.
+#### 3.1 Single message
 ```java
 @Autowired
 private ChatgptService chatgptService;
 
 public void test(){
+    String responseMessage = chatgptService.multiChat(Arrays.asList(new MultiChatMessage("user","how are you?")));
+    System.out.print(responseMessage); //\n\nAs an AI language model, I don't have feelings, but I'm functioning well. Thank you for asking. How can I assist you today?
+}
+
+public void test2(){
     String responseMessage = chatgptService.sendMessage("how are you");
     System.out.print(responseMessage); //I'm doing well, thank you. How about you?
 }
 ```
+#### 3.2 Multi message. You can take a series of messages (including the conversation history) as input , and return a response message as output.
+```java
+@Autowired
+private ChatgptService chatgptService;
+
+public void testMultiChat(){
+    List<MultiChatMessage> messages = Arrays.asList(
+            new MultiChatMessage("system","You are a helpful assistant."),
+            new MultiChatMessage("user","Who won the world series in 2020?"),
+            new MultiChatMessage("assistant","The Los Angeles Dodgers won the World Series in 2020."),
+            new MultiChatMessage("user","Where was it played?"));
+    String responseMessage = chatgptService.multiChat(messages);
+    System.out.print(responseMessage); //The 2020 World Series was played at Globe Life Field in Arlington, Texas.
+}
+```
+Messages must be an array of message objects, where each object has a role (either "system", "user", or "assistant") and content (the content of the message). Conversations can be as short as 1 message or fill many pages.
+
++ The system message helps set the behavior of the assistant. In the example above, the assistant was instructed with "You are a helpful assistant." 
++ The user messages help instruct the assistant. They can be generated by the end users of an application, or set by a developer as an instruction.
++ The assistant messages help store prior responses. They can also be written by a developer to help give examples of desired behavior.
+For more details, please refer to [chat format](https://platform.openai.com/docs/guides/chat/introduction)
 
 ## Demo project：
 [demo-chatgpt-spring-boot-starter](https://github.com/flashvayne/demo-chatgpt-spring-boot-starter)

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>io.github.flashvayne</groupId>
     <artifactId>chatgpt-spring-boot-starter</artifactId>
-    <version>1.0.1</version>
+    <version>1.0.2</version>
 
     <name>chatgpt-spring-boot-starter</name>
     <description>a starter to use chatgpt in springboot project easily</description>

src/main/java/io/github/flashvayne/chatgpt/dto/ChatRequest.java

@@ -1,22 +1,27 @@
 package io.github.flashvayne.chatgpt.dto;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.AllArgsConstructor;
 import lombok.Data;
+import lombok.NoArgsConstructor;
 
+import java.util.Map;
+
+/**
+ * ChatRequest is used to construct request body.
+ * For descriptions of all fields, please refer to <a href="https://platform.openai.com/docs/api-reference/completions/create">Create completion</a>
+ */
 @Data
+@NoArgsConstructor
 @AllArgsConstructor
+@JsonInclude(JsonInclude.Include.NON_NULL)
 public class ChatRequest {
 
     private String model;
 
     private String prompt;
 
-    /**
-     * The maximum number of tokens to generate in the completion.
-     * The token count of your prompt plus max_tokens cannot exceed the model's context length.
-     * Most models have a context length of 2048 tokens (except for the newest models, which support 4096).
-     */
     @JsonProperty("max_tokens")
     private Integer maxTokens;
 
@@ -25,4 +30,38 @@ public class ChatRequest {
     @JsonProperty("top_p")
     private Double topP;
 
+    private String suffix;
+
+    private Integer n;
+
+    private Boolean stream;
+
+    private Integer logprobs;
+
+    private Boolean echo;
+
+    private String stop;
+
+    @JsonProperty("presence_penalty")
+    private Double presencePenalty;
+
+    @JsonProperty("frequency_penalty")
+    private Double frequencyPenalty;
+
+    @JsonProperty("best_of")
+    private Integer bestOf;
+
+    @JsonProperty("logit_bias")
+    private Map<String, Integer> logitBias;
+
+    private String user;
+
+    public ChatRequest(String model, String prompt, Integer maxTokens, Double temperature, Double topP) {
+        this.model = model;
+        this.prompt = prompt;
+        this.maxTokens = maxTokens;
+        this.temperature = temperature;
+        this.topP = topP;
+    }
+
 }

src/main/java/io/github/flashvayne/chatgpt/dto/chat/MultiChatMessage.java

@@ -0,0 +1,13 @@
+package io.github.flashvayne.chatgpt.dto.chat;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class MultiChatMessage {
+    private String role;
+    private String content;
+}

src/main/java/io/github/flashvayne/chatgpt/dto/chat/MultiChatRequest.java

@@ -0,0 +1,63 @@
+package io.github.flashvayne.chatgpt.dto.chat;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.util.List;
+import java.util.Map;
+
+/**
+ * MultiChatRequest is used to construct request body.
+ * For descriptions of all fields, please refer to <a href="https://platform.openai.com/docs/api-reference/chat/create">Create chat completion</a>
+ */
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class MultiChatRequest {
+    private String model;
+
+    private List<MultiChatMessage> messages;
+
+    /**
+     * The maximum number of tokens to generate in the completion.
+     * The token count of your prompt plus max_tokens cannot exceed the model's context length.
+     * Most models have a context length of 2048 tokens (except for the newest models, which support 4096).
+     */
+    @JsonProperty("max_tokens")
+    private Integer maxTokens;
+
+    private Double temperature;
+
+    @JsonProperty("top_p")
+    private Double topP;
+
+    private Integer n;
+
+    private Boolean stream;
+
+    private String stop;
+
+    @JsonProperty("presence_penalty")
+    private Double presencePenalty;
+
+    @JsonProperty("frequency_penalty")
+    private Double frequencyPenalty;
+
+    @JsonProperty("logit_bias")
+    private Map<String, Integer> logitBias;
+
+    private String user;
+
+    public MultiChatRequest(String model, List<MultiChatMessage> messages, Integer maxTokens, Double temperature, Double topP) {
+        this.model = model;
+        this.messages = messages;
+        this.maxTokens = maxTokens;
+        this.temperature = temperature;
+        this.topP = topP;
+    }
+
+}

src/main/java/io/github/flashvayne/chatgpt/dto/chat/MultiChatResponse.java

@@ -0,0 +1,21 @@
+package io.github.flashvayne.chatgpt.dto.chat;
+
+import io.github.flashvayne.chatgpt.dto.Usage;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.time.LocalDate;
+import java.util.List;
+
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class MultiChatResponse {
+    private String id;
+    private String object;
+    private LocalDate created;
+    private String model;
+    private List<MultiResponseChoice> choices;
+    private Usage usage;
+}

src/main/java/io/github/flashvayne/chatgpt/dto/chat/MultiResponseChoice.java

@@ -0,0 +1,18 @@
+package io.github.flashvayne.chatgpt.dto.chat;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class MultiResponseChoice {
+    private MultiChatMessage message;
+
+    @JsonProperty("finish_reason")
+    private String finishReason;
+
+    private Integer index;
+}

src/main/java/io/github/flashvayne/chatgpt/property/ChatgptProperties.java

@@ -7,16 +7,24 @@
 @ConfigurationProperties(prefix = "chatgpt")
 public class ChatgptProperties {
 
-    //apiKey
     private String apiKey = "";
 
+    private String url = "https://api.openai.com/v1/completions";
+
     private String model = "text-davinci-003";
 
     private Integer maxTokens = 500;
 
     private Double temperature = 0.0;
 
     private Double topP = 1.0;
+
+    private MultiChatProperties multi;
+
+    public ChatgptProperties() {
+        this.multi = new MultiChatProperties();
+    }
+
     public String getApiKey() {
         return apiKey;
     }
@@ -25,6 +33,14 @@ public void setApiKey(String apiKey) {
         this.apiKey = apiKey;
     }
 
+    public String getUrl() {
+        return url;
+    }
+
+    public void setUrl(String url) {
+        this.url = url;
+    }
+
     public String getModel() {
         return model;
     }
@@ -56,4 +72,12 @@ public Double getTopP() {
     public void setTopP(Double topP) {
         this.topP = topP;
     }
+
+    public MultiChatProperties getMulti() {
+        return multi;
+    }
+
+    public void setMulti(MultiChatProperties multi) {
+        this.multi = multi;
+    }
 }

src/main/java/io/github/flashvayne/chatgpt/property/MultiChatProperties.java

@@ -0,0 +1,54 @@
+package io.github.flashvayne.chatgpt.property;
+
+public class MultiChatProperties {
+
+    private String url = "https://api.openai.com/v1/chat/completions";
+
+    private String model = "gpt-3.5-turbo";
+
+    private Integer maxTokens = 500;
+
+    private Double temperature = 0.0;
+
+    private Double topP = 1.0;
+
+    public String getUrl() {
+        return url;
+    }
+
+    public void setUrl(String url) {
+        this.url = url;
+    }
+
+    public String getModel() {
+        return model;
+    }
+
+    public void setModel(String model) {
+        this.model = model;
+    }
+
+    public Integer getMaxTokens() {
+        return maxTokens;
+    }
+
+    public void setMaxTokens(Integer maxTokens) {
+        this.maxTokens = maxTokens;
+    }
+
+    public Double getTemperature() {
+        return temperature;
+    }
+
+    public void setTemperature(Double temperature) {
+        this.temperature = temperature;
+    }
+
+    public Double getTopP() {
+        return topP;
+    }
+
+    public void setTopP(Double topP) {
+        this.topP = topP;
+    }
+}