feature 1.1.3 assistant api——run开发

Author: Grt1228

README.md

@@ -79,6 +79,7 @@ WebSocket参考：[OpenAIWebSocketEventSourceListener](https://github.com/Grt122
 - 支持全部OpenAI的Api
 
 # 📑 更新日志
+- [x] 1.1.3   支持Assistant、Run、Thread、Message Api
 - [x] 1.1.2-beta0   支持附加图片的ChatCompletion、指定返回数据格式、Tool Call、Dall-e-3生成图片、FineTuneJob、文本转语音TTS。官方文档示例：[chatgpt-java.unfbx.com](https://chatgpt-java.unfbx.com/docs/category/-%E6%A0%B8%E5%BF%83%E5%8A%9F%E8%83%BD) 。测试案例[OpenAiClientTest](https://github.com/Grt1228/chatgpt-java/blob/develop/src/test/java/com/unfbx/chatgpt/v1_1_2/OpenAiClientTest.java)
 - [x] 1.1.1-beta0   function call改成GPT插件模式调用更加简单的调用方式.参考实现[PluginTest](https://github.com/Grt1228/chatgpt-java/blob/develop/src/test/java/com/unfbx/chatgpt/PluginTest.java)
 - [x] 1.0.15  moderations接口更新，代码优化，序列化修复。

README_EN.md

@@ -65,6 +65,8 @@ WebSocket Reference：[OpenAIWebSocketEventSourceListener](https://github.com/Gr
 - Supports all OpenAI APIs.
 
 # 📑 Update Log
+- [x] 1.1.3   Upgrade to support Assistant、Run、Thread、Message Api
+- [x] 1.1.2-beta0   Upgrade to support chat completion with picture GPT-4V、return JSON model、Tool Call、Dall-e-3、Fine Tune Job、TTS.
 - [x] 1.1.1-beta0   function call update to GPT plugin model, so easy use the plugin api. eg: [PluginTest](https://github.com/Grt1228/chatgpt-java/blob/develop/src/test/java/com/unfbx/chatgpt/PluginTest.java)
 - [x] 1.0.15  moderations api update,code fix,bug fix
 - [x] 1.0.14  Upgrade to support the latest version gpt-3.5—0614、gpt-4.0—0614 models, support function-calling full test e.g.：[OpenAiClientFunctionTest](https://github.com/Grt1228/chatgpt-java/blob/main/src/test/java/com/unfbx/chatgpt/OpenAiClientFunctionTest.java)

pom.xml

@@ -5,7 +5,7 @@
 
     <groupId>com.unfbx</groupId>
     <artifactId>chatgpt-java</artifactId>
-    <version>1.1.2-beta0</version>
+    <version>1.1.3</version>
     <name>chatgpt-java</name>
     <description>OpenAI Java SDK, OpenAI Api for Java. ChatGPT Java SDK .</description>
     <url>https://chatgpt-java.unfbx.com</url>

src/main/java/com/unfbx/chatgpt/OpenAiApi.java

@@ -668,7 +668,7 @@ Single<AssistantListResponse<MessageResponse>> messages(@Path("thread_id") Strin
      */
     @GET("v1/threads/{thread_id}/messages/{message_id}/files")
     @Headers("OpenAI-Beta: assistants=v1")
-    Single<AssistantListResponse<MessageResponse>> messageFiles(@Path("thread_id") String threadId, @Path("message_id") String messageId,
+    Single<AssistantListResponse<MessageFileResponse>> messageFiles(@Path("thread_id") String threadId, @Path("message_id") String messageId,
                                                                 @Query("limit") Integer limit, @Query("order") String order, @Query("before") String before, @Query("after") String after);
 
 

src/main/java/com/unfbx/chatgpt/OpenAiClient.java

@@ -7,6 +7,11 @@
 import com.unfbx.chatgpt.constant.OpenAIConst;
 import com.unfbx.chatgpt.entity.Tts.TextToSpeech;
 import com.unfbx.chatgpt.entity.assistant.*;
+import com.unfbx.chatgpt.entity.assistant.message.MessageFileResponse;
+import com.unfbx.chatgpt.entity.assistant.message.MessageResponse;
+import com.unfbx.chatgpt.entity.assistant.message.ModifyMessage;
+import com.unfbx.chatgpt.entity.assistant.run.*;
+import com.unfbx.chatgpt.entity.assistant.thread.ThreadMessage;
 import com.unfbx.chatgpt.entity.billing.BillingUsage;
 import com.unfbx.chatgpt.entity.billing.CreditGrantsResponse;
 import com.unfbx.chatgpt.entity.billing.Subscription;
@@ -32,6 +37,7 @@
 import com.unfbx.chatgpt.entity.fineTune.job.FineTuneJobListResponse;
 import com.unfbx.chatgpt.entity.fineTune.job.FineTuneJobResponse;
 import com.unfbx.chatgpt.entity.images.*;
+import com.unfbx.chatgpt.entity.images.Image;
 import com.unfbx.chatgpt.entity.models.Model;
 import com.unfbx.chatgpt.entity.models.ModelResponse;
 import com.unfbx.chatgpt.entity.moderations.Moderation;
@@ -61,6 +67,8 @@
 import retrofit2.Retrofit;
 import retrofit2.adapter.rxjava2.RxJava2CallAdapterFactory;
 import retrofit2.converter.jackson.JacksonConverterFactory;
+import retrofit2.http.*;
+import retrofit2.http.Headers;
 
 import java.time.LocalDate;
 import java.util.*;
@@ -112,6 +120,12 @@ public class OpenAiClient {
     @Getter
     private OpenAiAuthInterceptor authInterceptor;
 
+    /**
+     * 默认的分页参数
+     */
+    @Getter
+    private PageRequest pageRequest = PageRequest.builder().build();
+
     /**
      * 构造器
      *
@@ -1111,6 +1125,7 @@ public DeleteResponse deleteAssistantFile(String assistantId, String fileId) {
      * @return 助手文件列表
      */
     public AssistantListResponse<AssistantFileResponse> assistantFiles(String assistantId, PageRequest pageRequest) {
+        pageRequest = Optional.ofNullable(pageRequest).orElse(this.getPageRequest());
         Single<AssistantListResponse<AssistantFileResponse>> deleteResponse = this.openAiApi.assistantFiles(assistantId, pageRequest.getLimit(), pageRequest.getOrder(), pageRequest.getBefore(), pageRequest.getAfter());
         return deleteResponse.blockingGet();
     }
@@ -1160,6 +1175,223 @@ public DeleteResponse deleteThread(String threadId) {
         return this.openAiApi.deleteThread(threadId).blockingGet();
     }
 
+    /**
+     * 为线程创建消息
+     *
+     * @param threadId 线程id
+     * @param message  message参数
+     * @return
+     * @since 1.1.3
+     */
+    public MessageResponse message(String threadId, ThreadMessage message) {
+        return this.openAiApi.message(threadId, message).blockingGet();
+    }
+
+    /**
+     * 检索某一个线程对应的消息详细信息
+     *
+     * @param threadId  线程id
+     * @param messageId 消息id
+     * @return
+     * @since 1.1.3
+     */
+    public MessageResponse retrieveMessage(String threadId, String messageId) {
+        return this.openAiApi.retrieveMessage(threadId, messageId).blockingGet();
+    }
+
+    /**
+     * 修改某一个线程对应的消息
+     *
+     * @param threadId  线程id
+     * @param messageId 消息id
+     * @param message   消息体
+     * @return
+     * @since 1.1.3
+     */
+    public MessageResponse modifyMessage(String threadId, String messageId, ModifyMessage message) {
+        return this.openAiApi.modifyMessage(threadId, messageId, message).blockingGet();
+    }
+
+    /**
+     * 获取某一个线程的消息集合
+     *
+     * @param threadId    线程id
+     * @param pageRequest 分页信息
+     * @return
+     * @since 1.1.3
+     */
+    public AssistantListResponse<MessageResponse> messages(String threadId, PageRequest pageRequest) {
+        pageRequest = Optional.ofNullable(pageRequest).orElse(this.getPageRequest());
+        return this.openAiApi.messages(threadId,
+                pageRequest.getLimit(),
+                pageRequest.getOrder(),
+                pageRequest.getBefore(),
+                pageRequest.getAfter()).blockingGet();
+    }
+
+    /**
+     * 检索某一个线程对应某一个消息的一个文件信息
+     *
+     * @param threadId  线程id
+     * @param messageId 消息id
+     * @param fileId    文件id
+     * @return
+     * @since 1.1.3
+     */
+    public MessageFileResponse retrieveMessageFile(String threadId, String messageId, String fileId) {
+        return this.openAiApi.retrieveMessageFile(threadId, messageId, fileId).blockingGet();
+    }
+
+    /**
+     * messageFiles集合
+     *
+     * @param threadId    线程id
+     * @param messageId   消息id
+     * @param pageRequest 分页信息
+     * @return
+     * @since 1.1.3
+     */
+    public AssistantListResponse<MessageFileResponse> messageFiles(String threadId, String messageId, PageRequest pageRequest) {
+        pageRequest = Optional.ofNullable(pageRequest).orElse(this.getPageRequest());
+        return this.openAiApi.messageFiles(threadId, messageId,
+                pageRequest.getLimit(),
+                pageRequest.getOrder(),
+                pageRequest.getBefore(),
+                pageRequest.getAfter()).blockingGet();
+    }
+
+
+    /**
+     * 创建Run
+     *
+     * @param threadId 线程id
+     * @param run      run
+     * @return
+     * @since 1.1.3
+     */
+    public RunResponse run(String threadId, Run run) {
+        return this.openAiApi.run(threadId, run).blockingGet();
+    }
+
+
+    /**
+     * 检索run详细信息
+     *
+     * @param threadId 线程id
+     * @param runId    run_id
+     * @return
+     * @since 1.1.3
+     */
+    public RunResponse retrieveRun(String threadId, String runId) {
+        return this.openAiApi.retrieveRun(threadId, runId).blockingGet();
+    }
+
+    /**
+     * 修改某一个run
+     *
+     * @param threadId 线程id
+     * @param runId    run_id
+     * @param run      消息体
+     * @return
+     * @since 1.1.3
+     */
+    public RunResponse modifyRun(String threadId, String runId, ModifyRun run) {
+        return this.openAiApi.modifyRun(threadId, runId, run).blockingGet();
+    }
+
+
+    /**
+     * 获取某一个线程的run集合
+     *
+     * @param threadId    线程id
+     * @param pageRequest 分页信息
+     * @return
+     * @since 1.1.3
+     */
+    public AssistantListResponse<RunResponse> runs(String threadId, PageRequest pageRequest) {
+        pageRequest = Optional.ofNullable(pageRequest).orElse(this.getPageRequest());
+        return this.openAiApi.runs(threadId,
+                pageRequest.getLimit(),
+                pageRequest.getOrder(),
+                pageRequest.getBefore(),
+                pageRequest.getAfter()).blockingGet();
+    }
+
+
+    /**
+     * 获取某一个线程的run集合
+     *
+     * @param threadId    线程id
+     * @param runId       run id
+     * @param toolOutputs 为其提交输出的工具列表。
+     * @return
+     * @since 1.1.3
+     */
+    public RunResponse submitToolOutputs(String threadId, String runId, ToolOutputBody toolOutputs) {
+        return this.openAiApi.submitToolOutputs(threadId, runId, toolOutputs).blockingGet();
+    }
+
+
+    /**
+     * 取消正在进行中的run
+     *
+     * @param threadId 线程id
+     * @param runId    run id
+     * @return
+     * @since 1.1.3
+     */
+    public RunResponse cancelRun(String threadId, String runId) {
+        return this.openAiApi.cancelRun(threadId, runId).blockingGet();
+    }
+
+
+    /**
+     * 创建一个线程并在一个请求中运行它
+     *
+     * @param threadRun 对象
+     * @return
+     * @since 1.1.3
+     */
+    public RunResponse threadRun(ThreadRun threadRun) {
+        return this.openAiApi.threadRun(threadRun).blockingGet();
+    }
+
+    /**
+     * 检索run step详细信息
+     *
+     * @param threadId 线程id
+     * @param runId    run_id
+     * @param stepId   step_id
+     * @return
+     * @since 1.1.3
+     */
+    public RunStepResponse retrieveRunStep(String threadId, String runId, String stepId) {
+        if (StrUtil.isBlank(stepId)) {
+            log.error("step id不能为空");
+            throw new BaseException(CommonError.PARAM_ERROR);
+        }
+        return this.openAiApi.retrieveRunStep(threadId, runId, stepId).blockingGet();
+    }
+
+
+    /**
+     * 获取某一个线程的run step集合
+     *
+     * @param threadId    线程id
+     * @param runId       run_id
+     * @param pageRequest 分页信息
+     * @return
+     * @since 1.1.3
+     */
+    public AssistantListResponse<RunStepResponse> runSteps(String threadId, String runId, PageRequest pageRequest) {
+        pageRequest = Optional.ofNullable(pageRequest).orElse(this.getPageRequest());
+        return this.openAiApi.runSteps(threadId, runId,
+                pageRequest.getLimit(),
+                pageRequest.getOrder(),
+                pageRequest.getBefore(),
+                pageRequest.getAfter()).blockingGet();
+    }
+
 
     public static final class Builder {
         /**

src/main/java/com/unfbx/chatgpt/entity/assistant/run/RunStepResponse.java

@@ -2,10 +2,7 @@
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Getter;
-import lombok.NoArgsConstructor;
+import lombok.*;
 import lombok.extern.slf4j.Slf4j;
 
 import java.io.Serializable;
@@ -18,7 +15,7 @@
  * @since 1.1.3
  * 2023-11-20
  */
-@Getter
+@Data
 @Slf4j
 @Builder
 @JsonInclude(JsonInclude.Include.NON_NULL)