Merge branch 'TheoKanning:main' into main

api/src/main/java/com/theokanning/openai/ListSearchParameters.java

@@ -0,0 +1,51 @@
+package com.theokanning.openai;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ * Common options when getting a list of objects
+ */
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@Data
+public class ListSearchParameters {
+    /**
+     * 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.
+     */
+    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;
+
+    public enum Order {
+        @JsonProperty("asc")
+        ASCENDING,
+
+        @JsonProperty("desc")
+        DESCENDING
+    }
+}

api/src/main/java/com/theokanning/openai/OpenAiResponse.java

@@ -1,5 +1,6 @@
 package com.theokanning.openai;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.Data;
 
 import java.util.List;
@@ -18,4 +19,22 @@ public class OpenAiResponse<T> {
      * The type of object returned, should be "list"
      */
     public String object;
+
+    /**
+     * The first id included
+     */
+    @JsonProperty("first_id")
+    public String firstId;
+
+    /**
+     * The last id included
+     */
+    @JsonProperty("last_id")
+    public String lastId;
+
+    /**
+     * True if there are objects after lastId
+     */
+    @JsonProperty("has_more")
+    public boolean hasMore;
 }

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

@@ -0,0 +1,67 @@
+package com.theokanning.openai.assistants;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.*;
+
+import java.util.List;
+import java.util.Map;
+
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@Data
+public class Assistant {
+
+    /**
+     * The identifier, which can be referenced in API endpoints.
+     */
+    String id;
+
+    /**
+     * The object type which is always 'assistant'
+     */
+    String object;
+
+    /**
+     * The Unix timestamp(in seconds) for when the assistant was created
+     */
+    @JsonProperty("created_at")
+    Integer createdAt;
+
+    /**
+     * The name of the assistant. The maximum length is 256
+     */
+    String name;
+
+    /**
+     * The description of the assistant.
+     */
+    String description;
+
+    /**
+     * ID of the model to use
+     */
+    @NonNull
+    String model;
+
+    /**
+     * The system instructions that the assistant uses.
+     */
+    String instructions;
+
+    /**
+     * A list of tools enabled on the assistant.
+     */
+    List<Tool> tools;
+
+    /**
+     * A list of file IDs attached to this assistant.
+     */
+    @JsonProperty("file_ids")
+    List<String> fileIds;
+
+    /**
+     * Set of 16 key-value pairs that can be attached to an object.
+     */
+    Map<String, String> metadata;
+}

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

@@ -0,0 +1,30 @@
+package com.theokanning.openai.assistants;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Data;
+
+@Data
+public class AssistantFile {
+
+    /**
+     * The identifier of the Assistant File
+     */
+    String id;
+
+    /**
+     * The object type, which is always assistant.file.
+     */
+    String object;
+
+    /**
+     * The Unix timestamp (in seconds) for when the assistant file was created.
+     */
+    @JsonProperty("created_at")
+    String createdAt;
+
+    /**
+     * The assistant ID that the file is attached to
+     */
+    @JsonProperty("assistant_id")
+    String assistantId;
+}

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

@@ -0,0 +1,17 @@
+package com.theokanning.openai.assistants;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@Data
+public class AssistantFileRequest {
+
+    @JsonProperty("file_id")
+    String fileId;
+}

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

@@ -0,0 +1,28 @@
+package com.theokanning.openai.assistants;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.util.Map;
+
+/**
+ * @description:
+ * @author: vacuity
+ * @create: 2023-11-20 10:09
+ **/
+
+
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@Data
+public class AssistantFunction {
+
+    private String description;
+
+    private String name;
+
+    private Map<String, Object> parameters;
+}

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

@@ -0,0 +1,52 @@
+package com.theokanning.openai.assistants;
+
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.*;
+
+import java.util.List;
+import java.util.Map;
+
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@Data
+public class AssistantRequest {
+
+    /**
+     * ID of the model to use
+     */
+    @NonNull
+    String model;
+
+    /**
+     * The name of the assistant. The maximum length is 256
+     */
+    String name;
+
+    /**
+     * The description of the assistant.
+     */
+    String description;
+
+    /**
+     * The system instructions that the assistant uses.
+     */
+    String instructions;
+
+    /**
+     * A list of tools enabled on the assistant.
+     */
+    List<Tool> tools;
+
+    /**
+     * A list of file IDs attached to this assistant.
+     */
+    @JsonProperty("file_ids")
+    List<String> fileIds;
+
+    /**
+     * Set of 16 key-value pairs that can be attached to an object.
+     */
+    Map<String, String> metadata;
+}

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

@@ -0,0 +1,12 @@
+package com.theokanning.openai.assistants;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public enum AssistantSortOrder {
+
+    @JsonProperty("asc")
+    ASC,
+
+    @JsonProperty("desc")
+    DESC
+}

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

@@ -0,0 +1,15 @@
+package com.theokanning.openai.assistants;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public enum AssistantToolsEnum {
+
+    @JsonProperty("code_interpreter")
+    CODE_INTERPRETER,
+
+    @JsonProperty("function")
+    FUNCTION,
+
+    @JsonProperty("retrieval")
+    RETRIEVAL
+}

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

@@ -0,0 +1,51 @@
+package com.theokanning.openai.assistants;
+
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.*;
+
+import java.util.List;
+import java.util.Map;
+
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@Data
+public class ModifyAssistantRequest {
+
+    /**
+     * ID of the model to use
+     */
+    String model;
+
+    /**
+     * The name of the assistant. The maximum length is 256
+     */
+    String name;
+
+    /**
+     * The description of the assistant.
+     */
+    String description;
+
+    /**
+     * The system instructions that the assistant uses.
+     */
+    String instructions;
+
+    /**
+     * A list of tools enabled on the assistant.
+     */
+    List<Tool> tools;
+
+    /**
+     * A list of file IDs attached to this assistant.
+     */
+    @JsonProperty("file_ids")
+    List<String> fileIds;
+
+    /**
+     * Set of 16 key-value pairs that can be attached to an object.
+     */
+    Map<String, String> metadata;
+}

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

@@ -0,0 +1,20 @@
+package com.theokanning.openai.assistants;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@NoArgsConstructor
+@AllArgsConstructor
+@Data
+public class Tool {
+     /**
+      * The type of tool being defined
+      */
+     AssistantToolsEnum type;
+
+     /**
+      * Function definition, only used if type is "function"
+      */
+     AssistantFunction function;
+}