Add MessageContent types and simplify list querying (#405)

Changed assistants to use the new shared ListSearchParams.

Author: TheoKanning

api/src/main/java/com/theokanning/openai/assistants/ListAssistant.java

@@ -50,7 +50,7 @@ public class Message {
     /**
      * The content of the message in an array of text and/or images.
      */
-    List<Object> content;
+    List<MessageContent> content;
 
     /**
      * If applicable, the ID of the assistant that authored this message.

api/src/main/java/com/theokanning/openai/assistants/ListAssistantQueryRequest.java

@@ -1,5 +1,8 @@
 package com.theokanning.openai.messages;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.theokanning.openai.messages.content.ImageFile;
+import com.theokanning.openai.messages.content.Text;
 import lombok.Data;
 
 
@@ -15,5 +18,14 @@ public class MessageContent {
      */
     String type;
 
-    // todo handle different content types
+    /**
+     * Text content of the message. Only present if type == text
+     */
+    Text text;
+
+    /**
+     * The image content of a message. Only present if type == image_file
+     */
+    @JsonProperty("image_file")
+    ImageFile imageFile;
 }

api/src/main/java/com/theokanning/openai/messages/Message.java

@@ -0,0 +1,44 @@
+package com.theokanning.openai.messages.content;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ * An annotation for a text Message
+ * <p>
+ * https://platform.openai.com/docs/api-reference/messages/object
+ */
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class Annotation {
+    /**
+     * The type of annotation, either file_citation or file_path
+     */
+    String type;
+
+    /**
+     * The text in the message content that needs to be replaced
+     */
+    String text;
+
+    /**
+     * File citation details, only present when type == file_citation
+     */
+    @JsonProperty("file_citation")
+    FileCitation fileCitation;
+
+    /**
+     * File path details, only present when type == file_path
+     */
+    @JsonProperty("file_path")
+    FilePath filePath;
+
+    @JsonProperty("start_index")
+    int startIndex;
+
+    @JsonProperty("end_index")
+    int endIndex;
+}

api/src/main/java/com/theokanning/openai/messages/MessageContent.java

@@ -0,0 +1,29 @@
+package com.theokanning.openai.messages.content;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ * A citation within the message that points to a specific quote from a specific File associated with the
+ * assistant or the message. Generated when the assistant uses the "retrieval" tool to search files.
+ * <p>
+ * https://platform.openai.com/docs/api-reference/messages/object
+ */
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class FileCitation {
+
+    /**
+     * The ID of the specific File the citation is from.
+     */
+    @JsonProperty("file_id")
+    String fileId;
+
+    /**
+     * The specific quote in the file.
+     */
+    String quote;
+}

api/src/main/java/com/theokanning/openai/messages/content/Annotation.java

@@ -0,0 +1,23 @@
+package com.theokanning.openai.messages.content;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ * A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.
+ * <p>
+ * https://platform.openai.com/docs/api-reference/messages/object
+ */
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class FilePath {
+
+    /**
+     * The ID of the file that was generated
+     */
+    @JsonProperty("file_id")
+    String fileId;
+}

api/src/main/java/com/theokanning/openai/messages/content/FileCitation.java

@@ -0,0 +1,23 @@
+package com.theokanning.openai.messages.content;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ * References an image File int eh content of a message.
+ * <p>
+ * /https://platform.openai.com/docs/api-reference/messages/object
+ */
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class ImageFile {
+
+    /**
+     * The File ID of the image in the message content.
+     */
+    @JsonProperty("file_id")
+    String fileId;
+}

api/src/main/java/com/theokanning/openai/messages/content/FilePath.java

@@ -0,0 +1,28 @@
+package com.theokanning.openai.messages.content;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.util.List;
+
+/**
+ * The text content that is part of a message
+ * <p>
+ * https://platform.openai.com/docs/api-reference/messages/object
+ */
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class Text {
+
+    /**
+     * The data that makes up the text.
+     */
+    String value;
+
+    /**
+     * Text annotations that show additional details
+     */
+    List<Annotation> annotations;
+}

api/src/main/java/com/theokanning/openai/messages/content/ImageFile.java

@@ -18,6 +18,7 @@
 import com.theokanning.openai.finetune.FineTuneEvent;
 import com.theokanning.openai.finetune.FineTuneResult;
 import com.theokanning.openai.image.ImageResult;
+import com.theokanning.openai.messages.Message;
 import com.theokanning.openai.model.Model;
 import com.theokanning.openai.moderation.ModerationRequest;
 import com.theokanning.openai.moderation.ModerationResult;
@@ -50,6 +51,7 @@ public class JsonTest {
             ImageResult.class,
             TranscriptionResult.class,
             TranslationResult.class,
+            Message.class,
             Model.class,
             ModerationRequest.class,
             ModerationResult.class