#9 fix Message List 查询，缺少参数 [run_id]

api/src/main/java/com/theokanning/openai/assistants/message/MessageListSearchParameters.java

@@ -0,0 +1,58 @@
+package com.theokanning.openai.assistants.message;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.theokanning.openai.ListSearchParameters;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ * @author LiangTao
+ * @date 2024年05月09 16:05
+ **/
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+@Builder
+public class MessageListSearchParameters {
+    /**
+     * A limit on the number of objects to be returned.
+     * Limit can range between 1 and 100, and the default is 20
+     */
+
+    Integer limit;
+
+    /**
+     * Sort order by the 'created_at' timestamp of the objects.
+     * 'asc' for ascending order and 'desc' for descending order.
+     */
+    ListSearchParameters.Order order;
+
+    /**
+     * A cursor for use in pagination. after is an object ID that defines your place in the list.
+     * For instance, if you make a list request and receive 100 objects, ending with obj_foo,
+     * your subsequent call can include after=obj_foo in order to fetch the next page of the list
+     */
+    String after;
+
+    /**
+     * A cursor for use in pagination. before is an object ID that defines your place in the list.
+     * For instance, if you make a list request and receive 100 objects, ending with obj_foo,
+     * your subsequent call can include before=obj_foo in order to fetch the previous page of the list.
+     */
+    String before;
+    /**
+     * Filter messages by the run ID that generated them.
+     */
+    @JsonProperty("run_id")
+    private String runId;
+
+    public enum Order {
+        @JsonProperty("asc")
+        ASCENDING,
+
+        @JsonProperty("desc")
+        DESCENDING
+    }
+}

example/src/main/java/example/AssistantExample.java

@@ -7,6 +7,7 @@
 import com.theokanning.openai.assistants.StreamEvent;
 import com.theokanning.openai.assistants.assistant.*;
 import com.theokanning.openai.assistants.message.Message;
+import com.theokanning.openai.assistants.message.MessageListSearchParameters;
 import com.theokanning.openai.assistants.message.MessageRequest;
 import com.theokanning.openai.assistants.run.*;
 import com.theokanning.openai.assistants.run_step.RunStep;
@@ -94,7 +95,8 @@ static void assistantToolCall() {
 
         System.out.println(retrievedRun);
 
-        OpenAiResponse<Message> response = service.listMessages(threadId, new ListSearchParameters());
+        OpenAiResponse<Message> response = service.listMessages(threadId, MessageListSearchParameters.builder()
+                .runId(retrievedRun.getId()).build());
         List<Message> messages = response.getData();
         messages.forEach(message -> {
             System.out.println(message.getContent());
@@ -238,7 +240,7 @@ static void fileSearchExample() throws UnsupportedEncodingException {
         for (RunStep runStep : runSteps) {
             System.out.println(runStep.getStepDetails());
         }
-        service.listMessages(threadId, new ListSearchParameters()).getData().forEach(message -> {
+        service.listMessages(threadId, new MessageListSearchParameters()).getData().forEach(message -> {
             System.out.println(message.getContent());
         });
     }
@@ -277,7 +279,7 @@ static void codeInterpreterExample() {
         for (RunStep runStep : runSteps) {
             System.out.println(runStep.getStepDetails());
         }
-        service.listMessages(threadId, new ListSearchParameters()).getData().forEach(message -> {
+        service.listMessages(threadId, new MessageListSearchParameters()).getData().forEach(message -> {
             System.out.println(message.getContent());
         });
     }

service/src/main/java/com/theokanning/openai/service/OpenAiService.java

@@ -11,6 +11,7 @@
 import com.theokanning.openai.assistants.assistant.ModifyAssistantRequest;
 import com.theokanning.openai.assistants.assistant.VectorStoreFileRequest;
 import com.theokanning.openai.assistants.message.Message;
+import com.theokanning.openai.assistants.message.MessageListSearchParameters;
 import com.theokanning.openai.assistants.message.MessageRequest;
 import com.theokanning.openai.assistants.message.ModifyMessageRequest;
 import com.theokanning.openai.assistants.run.*;
@@ -465,7 +466,7 @@ public Message modifyMessage(String threadId, String messageId, ModifyMessageReq
         return execute(api.modifyMessage(threadId, messageId, request));
     }
 
-    public OpenAiResponse<Message> listMessages(String threadId, ListSearchParameters params) {
+    public OpenAiResponse<Message> listMessages(String threadId, MessageListSearchParameters params) {
         Map<String, Object> queryParameters = mapper.convertValue(params, new TypeReference<Map<String, Object>>() {
         });
         return execute(api.listMessages(threadId, queryParameters));

service/src/test/java/com/theokanning/openai/service/MessageTest.java

@@ -1,9 +1,9 @@
 package com.theokanning.openai.service;
 
 import com.theokanning.openai.DeleteResult;
-import com.theokanning.openai.ListSearchParameters;
 import com.theokanning.openai.assistants.assistant.CodeInterpreterTool;
 import com.theokanning.openai.assistants.message.Message;
+import com.theokanning.openai.assistants.message.MessageListSearchParameters;
 import com.theokanning.openai.assistants.message.MessageRequest;
 import com.theokanning.openai.assistants.message.ModifyMessageRequest;
 import com.theokanning.openai.assistants.thread.Attachment;
@@ -102,7 +102,7 @@ void listMessages() {
         createTestMessage(separateThreadId);
         createTestMessage(separateThreadId);
         createTestMessage(separateThreadId);
-        List<Message> messages = service.listMessages(separateThreadId, new ListSearchParameters()).getData();
+        List<Message> messages = service.listMessages(separateThreadId, new MessageListSearchParameters()).getData();
         assertEquals(3, messages.size());
         DeleteResult deleteResult = service.deleteThread(separateThreadId);
         assertTrue(deleteResult.isDeleted());

service/src/test/java/com/theokanning/openai/service/assistants/AssistantToolTest.java

@@ -1,11 +1,11 @@
 package com.theokanning.openai.service.assistants;
 
-import com.theokanning.openai.ListSearchParameters;
 import com.theokanning.openai.OpenAiResponse;
 import com.theokanning.openai.assistants.assistant.Assistant;
 import com.theokanning.openai.assistants.assistant.AssistantRequest;
 import com.theokanning.openai.assistants.assistant.FunctionTool;
 import com.theokanning.openai.assistants.message.Message;
+import com.theokanning.openai.assistants.message.MessageListSearchParameters;
 import com.theokanning.openai.assistants.message.MessageRequest;
 import com.theokanning.openai.assistants.run.*;
 import com.theokanning.openai.assistants.thread.Thread;
@@ -114,10 +114,15 @@ void weatherFunctionCallTest() {
             retrievedRun = service.retrieveRun(threadId, run.getId());
         }
         assertEquals("completed", retrievedRun.getStatus());
-        OpenAiResponse<Message> response = service.listMessages(threadId, new ListSearchParameters());
+        OpenAiResponse<Message> response = service.listMessages(threadId, MessageListSearchParameters.builder()
+                .runId(retrievedRun.getId())
+                .limit(1)
+                .build()
+        );
         List<Message> messages = response.getData();
         assertNotNull(messages);
-        assertEquals(2, messages.size());
+        //test message query parameters is correct
+        assertEquals(1, messages.size());
     }
 
 }