update api to 2024.7

Author: PlexPt

src/main/java/com/plexpt/chatgpt/entity/chat/ChatChoice.java

@@ -2,7 +2,6 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
-
 import lombok.Data;
 
 /**
@@ -30,17 +29,38 @@ public class ChatChoice {
     //      "logprobs": null,
     //      "finish_reason": "tool_calls"
     //    }
-    private long index;
+    private Integer index;
     /**
      * 请求参数stream为true返回是delta
      */
-    @JsonProperty("delta")
     private Message delta;
     /**
      * 请求参数stream为false返回是message
      */
-    @JsonProperty("message")
     private Message message;
+    /**
+     * The reason the model stopped generating tokens. This will be stop if the model hit a natural stop point or a provided stop sequence, length if the maximum number of tokens specified in the request was reached, content_filter if content was omitted due to a flag from our content filters, tool_calls if the model called a tool, or function_call (deprecated) if the model called a function.
+     * 用于指示模型停止生成令牌的原因。这个参数在响应体中返回，用于解释生成过程为什么终止。
+     * <p>
+     * 可能的值
+     * stop：
+     * <p>
+     * 模型达到了一个自然的停止点或遇到了提供的停止序列。
+     * 例如，生成的文本包含一个定义的停止序列（如 "END"），或者模型认为已经生成了一个完整的句子或段落。
+     * length：
+     * <p>
+     * 达到了请求中指定的最大令牌数。
+     * 例如，请求中设置了 max_tokens 为 50，当生成的令牌数量达到 50 时，模型停止生成。
+     * content_filter：
+     * <p>
+     * 由于内容过滤器的标志，部分内容被省略。
+     * 例如，生成的文本可能包含不适当的内容，触发了内容过滤器，导致生成过程提前终止。
+     * tool_calls：
+     * <p>
+     * 模型调用了一个工具。
+     * 这种情况通常用于增强模型的功能，如调用外部API或执行特定任务。
+     */
     @JsonProperty("finish_reason")
     private String finishReason;
+
 }

src/main/java/com/plexpt/chatgpt/entity/chat/ChatCompletion.java

@@ -14,6 +14,7 @@
  * chat
  *
  * @author plexpt
+ * @link https://platform.openai.com/docs/overview
  */
 @Data
 @Builder
@@ -35,126 +36,152 @@ public class ChatCompletion {
      * <p>
      * 不要同时改这个和topP
      */
-    @Builder.Default
-    private double temperature = 0.9;
+    private Double temperature;
 
     /**
      * 0-1
      * 建议0.9
      * 不要同时改这个和temperature
      */
     @JsonProperty("top_p")
-    @Builder.Default
-    private double topP = 0.9;
-
+    private Double topP;
 
-    /**
-     * auto
-     */
-    String function_call;
 
     @JsonProperty("tool_choice")
     String toolChoice;
 
     List<ChatTool> tools;
 
-    List<ChatFunction> functions;
-
     /**
      * 结果数。
      */
     @Builder.Default
-    private Integer n = 1;
+    Integer n = 1;
 
 
     /**
      * 是否流式输出.
      * default:false
      */
     @Builder.Default
-    private boolean stream = false;
+    Boolean stream = false;
     /**
      * 停用词
+     * <p>
+     * stop 参数用于指定 API 生成令牌时应停止的序列。该参数可以是字符串、字符串数组或 null，最多可以包含 4 个序列。这是一个可选参数，默认值为 null。
+     * <p>
+     * 参数说明
+     * 类型：string、array 或 null
+     * 可选：是
+     * 默认值：null
+     * 用途：指定在生成的文本中，API 遇到这些序列时停止生成后续令牌
+     * 使用场景
+     * 单个停止序列：
+     * <p>
+     * 如果指定一个字符串，API 在生成文本时遇到该字符串就会停止。例如，如果设置 stop 参数为 "END", 当生成的文本包含 "END" 时，API 将停止生成后续文本。
+     * 多个停止序列：
+     * <p>
+     * 如果指定一个字符串数组，API 在生成文本时遇到任何一个字符串都会停止。例如，如果设置 stop 参数为 ["END", "STOP"], 当生成的文本包含 "END" 或 "STOP" 时，API 将停止生成后续文本。
+     * 不使用停止序列：
+     * <p>
+     * 如果将 stop 参数设置为 null 或不设置，API 将根据其默认行为生成文本，直到达到最大令牌限制或结束标记。
      */
-    private List<String> stop;
+    List<String> stop;
     /**
      * 3.5 最大支持4096
      * 4.0 最大32k
      */
     @JsonProperty("max_tokens")
-    private Integer maxTokens;
+    Integer maxTokens;
 
 
+    /**
+     * Optional
+     * Defaults to 0
+     * Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far,
+     * increasing the model's likelihood to talk about new topics.
+     */
     @JsonProperty("presence_penalty")
-    private double presencePenalty;
+    Double presencePenalty;
 
     /**
-     * -2.0 ~~ 2.0
+     * -2.0 ~~ 2.0 Defaults to 0
      */
     @JsonProperty("frequency_penalty")
-    private double frequencyPenalty;
+    Double frequencyPenalty;
 
+    /**
+     * Optional
+     * Defaults to null
+     */
     @JsonProperty("logit_bias")
-    private Map logitBias;
+    Map logitBias;
     /**
      * 用户唯一值，确保接口不被重复调用
      */
-    private String user;
+    String user;
 
     /**
      * 返回格式  当前只有gpt-3.5-turbo-1106和gpt-4-1106-preview 支持json_object格式返回
      */
     @JsonProperty("response_format")
-    private ResponseFormat responseFormat;
+    ResponseFormat responseFormat;
 
+    /**
+     * boolean or null
+     * <p>
+     * Optional
+     * Defaults to false
+     */
+    Boolean logprobs;
+
+    /**
+     * integer or null
+     * <p>
+     * Optional
+     */
+    @JsonProperty("top_logprobs")
+    Integer topLogprobs;
 
-    @Getter
-    @AllArgsConstructor
-    public enum Model {
+    Integer seed;
+
+    /**
+     * Specifies the latency tier to use for processing the request. This parameter is relevant for customers subscribed to the scale tier service:
+     * <p>
+     * If set to 'auto', the system will utilize scale tier credits until they are exhausted.
+     * If set to 'default', the request will be processed using the default service tier with a lower uptime SLA and no latency guarentee.
+     * When this parameter is set, the response body will include the service_tier utilized.
+     */
+    @JsonProperty("service_tier")
+    String serviceTier;
+
+    @JsonProperty("stream_options")
+    StreamOption streamOptions;
+
+    @JsonProperty("parallel_tool_calls")
+    Boolean parallelToolCalls;
+
+    /**
+     * model
+     */
+    public interface Model {
         /**
          * gpt-3.5-turbo
          */
-        GPT_3_5_TURBO("gpt-3.5-turbo"),
-        GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613"),
-        GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k"),
-        /**
-         * 临时模型，不建议使用
-         */
-        GPT_3_5_TURBO_0301("gpt-3.5-turbo-0301"),
-        GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106"),
-        GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125"),
-        GPT_3_5_TURBO_INSTRUCT("gpt-3.5-turbo-instruct"),
+        String GPT_3_5_TURBO = "gpt-3.5-turbo";
+        String GPT_3_5_TURBO_16K = "gpt-3.5-turbo-16k";
+        String GPT_3_5_TURBO_INSTRUCT = "gpt-3.5-turbo-instruct";
         /**
          * GPT4.0
          */
-        GPT_4("gpt-4"),
-        GPT4Turbo("gpt-4-1106-preview"),
-        GPT4Turbo0125("gpt-4-0125-preview"),
-        GPT_4VP("gpt-4-vision-preview"),
-        GPT_4V("gpt-4-vision-preview"),
-        GPT_4o("gpt-4o"),
-        /**
-         * 临时模型，不建议使用
-         */
-        GPT_4_0314("gpt-4-0314"),
-        /**
-         * 支持函数
-         */
-        GPT_4_0613("gpt-4-0613"),
-        /**
-         * GPT4.0 超长上下文
-         */
-        GPT_4_32K("gpt-4-32k"),
+        String GPT4 = "gpt-4";
+        String GPT4V = "gpt-4-vision-preview";
+        String GPT4o = "gpt-4o";
         /**
          * GPT4.0 超长上下文
          */
-        GPT_4_32K_0613("gpt-4-32k-0613"),
-        /**
-         * 临时模型，不建议使用
-         */
-        GPT_4_32K_0314("gpt-4-32k-0314"),
-        ;
-        private String name;
+        String GPT_4_32K = "gpt-4-32k";
+
     }
 
     public int countTokens() {

src/main/java/com/plexpt/chatgpt/entity/chat/ChatCompletionResponse.java

@@ -17,11 +17,12 @@
 public class ChatCompletionResponse {
     private String id;
     private String object;
-    private long created;
+    private Long created;
     private String model;
     @JsonProperty("system_fingerprint")
     private String systemFingerprint;
     private List<ChatChoice> choices;
     private Usage usage;
+    Object logprobs;
 
 }

src/main/java/com/plexpt/chatgpt/entity/chat/ChatToolFunction.java

@@ -3,10 +3,7 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonInclude;
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Data;
-import lombok.NoArgsConstructor;
+import lombok.*;
 
 import java.util.List;
 
@@ -18,6 +15,11 @@
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class ChatToolFunction {
 
+    /**
+     * Required
+     * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
+     */
+    @NonNull
     String name;
 
     String description;

src/main/java/com/plexpt/chatgpt/entity/chat/CompletionUseage.java

@@ -0,0 +1,40 @@
+package com.plexpt.chatgpt.entity.chat;
+
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ *
+ * completion_tokens
+ * integer
+ *
+ * Number of tokens in the generated completion.
+ *
+ * prompt_tokens
+ * integer
+ *
+ * Number of tokens in the prompt.
+ *
+ * total_tokens
+ * integer
+ *
+ * Total number of tokens used in the request (prompt + completion).
+ *
+ * @author pt
+ */
+@Data
+@AllArgsConstructor
+@NoArgsConstructor(force = true)
+@JsonInclude(JsonInclude.Include.NON_NULL)
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class CompletionUseage {
+
+    Integer completion_tokens;
+    Integer prompt_tokens;
+    Integer total_tokens;
+
+}

src/main/java/com/plexpt/chatgpt/entity/chat/Message.java

@@ -24,8 +24,6 @@ public class Message {
     private String content;
     private String name;
 
-    @JsonProperty("function_call")
-    private FunctionCallResult functionCall;
 
     @JsonProperty("tool_calls")
     private List<ToolCallResult> toolCalls;

src/main/java/com/plexpt/chatgpt/entity/chat/ResponseFormat.java

@@ -5,11 +5,6 @@
 import lombok.*;
 import lombok.extern.slf4j.Slf4j;
 
-/**
- * @author hq
- * @version 1.0
- * @date 2023/12/11
- */
 
 @Data
 @Builder

src/main/java/com/plexpt/chatgpt/entity/chat/StreamOption.java

@@ -0,0 +1,20 @@
+package com.plexpt.chatgpt.entity.chat;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+
+@Data
+@AllArgsConstructor
+@NoArgsConstructor(force = true)
+@JsonInclude(JsonInclude.Include.NON_NULL)
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class StreamOption {
+
+    public Boolean include_usage;
+
+}

src/main/java/com/plexpt/chatgpt/entity/chat/ToolCallResult.java

@@ -8,6 +8,7 @@
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class ToolCallResult {
 
+    Integer index;
     String id;
 
     String type;