feat(batch): add support to batch api

api/src/main/java/com/theokanning/openai/batch/Batch.java

@@ -0,0 +1,143 @@
+package com.theokanning.openai.batch;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import lombok.NonNull;
+
+import java.util.List;
+import java.util.Map;
+
+/**
+ * @Author: acone.wu
+ * @date: 2024/5/15 13:51
+ */
+@NoArgsConstructor
+@AllArgsConstructor
+@Data
+public class Batch {
+
+    @NonNull
+    private String id;
+
+    /**
+     * The time frame within which the batch should be processed.
+     */
+    @NonNull
+    @JsonProperty("completion_window")
+    private String completionWindow;
+
+    /**
+     * The Unix timestamp (in seconds) for when the batch was created.
+     */
+    @NonNull
+    @JsonProperty("created_at")
+    private Integer createdAt;
+
+    /**
+     * The OpenAI API endpoint used by the batch.
+     */
+    @NonNull
+    private String endpoint;
+
+    /**
+     * The ID of the input file for the batch.
+     */
+    @NonNull
+    @JsonProperty("input_file_id")
+    private String inputFileId;
+
+    /**
+     * The object type, which is always `batch`.
+     */
+    private String object = "batch";
+
+    /**
+     * The current status of the batch.
+     * */
+    private Status status;
+
+    /**
+     * The Unix timestamp (in seconds) for when the batch was cancelled.
+     * */
+    @JsonProperty("cancelled_at")
+    private Integer cancelledAt;
+
+    /**
+     * The Unix timestamp (in seconds) for when the batch started cancelling.
+     * */
+    @JsonProperty("cancelling_at")
+    private Integer cancellingAt;
+
+    /**
+     * The Unix timestamp (in seconds) for when the batch was completed.
+     * */
+    @JsonProperty("completed_at")
+    private Integer completedAt;
+
+    /**
+     * The ID of the file containing the outputs of requests with errors.
+     * */
+    @JsonProperty("error_file_id")
+    private String errorFileId;
+
+    /**
+     * Errors associated with batch processing.
+     * */
+    private Errors errors;
+
+    /**
+     * The Unix timestamp (in seconds) for when the batch expired.
+     * */
+    @JsonProperty("expired_at")
+    private Integer expiredAt;
+
+    /**
+     * The Unix timestamp (in seconds) for when the batch will expire.
+     * */
+    @JsonProperty("expires_at")
+    private Integer expiresAt;
+
+    /**
+     * The Unix timestamp (in seconds) for when the batch failed.
+     * */
+    @JsonProperty("failed_at")
+    private Integer failedAt;
+
+    /**
+     * The Unix timestamp (in seconds) for when the batch started finalizing.
+     * */
+    @JsonProperty("finalizing_at")
+    private Integer finalizingAt;
+
+    /**
+     * The Unix timestamp (in seconds) for when the batch started processing.
+     * */
+    @JsonProperty("in_progress_at")
+    private Integer inProgressAt;
+
+    /**
+     * Metadata for storing additional information about the object.
+     * */
+    private Map<String, Object> metadata;
+
+    /**
+     * The ID of the file containing the outputs of successfully executed requests.
+     * */
+    @JsonProperty("output_file_id")
+    private String outputFileId;
+
+    /**
+     * The request counts for different statuses within the batch.
+     * */
+    @JsonProperty("request_counts")
+    private BatchRequestCounts requestCounts;
+
+    @Data
+    public static class Errors {
+        private List<BatchError> data;
+
+        private String object;
+    }
+}

api/src/main/java/com/theokanning/openai/batch/BatchError.java

@@ -0,0 +1,31 @@
+package com.theokanning.openai.batch;
+
+import lombok.Data;
+
+/**
+ * @Author: acone.wu
+ * @date: 2024/5/15 13:50
+ */
+@Data
+public class BatchError {
+
+    /**
+     * An error code identifying the error type.
+     */
+    String code;
+
+    /**
+     * The line number of the input file where the error occurred, if applicable
+     */
+    Integer line;
+
+    /**
+     * A human-readable message providing more details about the error.
+     */
+    String message;
+
+    /**
+     * The name of the parameter that caused the error, if applicable.
+     */
+    String param;
+}

api/src/main/java/com/theokanning/openai/batch/BatchListRequest.java

@@ -0,0 +1,34 @@
+package com.theokanning.openai.batch;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ * @Author: acone.wu
+ * @date: 2024/5/15 16:12
+ */
+@NoArgsConstructor
+@AllArgsConstructor
+@Builder
+@Data
+public class BatchListRequest {
+
+    /**
+     * A cursor for use in pagination.
+     * <p>
+     * `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.
+     */
+    private String after;
+
+    /**
+     * A limit on the number of objects to be returned.
+     * <p>
+     * Limit can range between 1 and 100, and the default is 20.
+     */
+    private Integer limit;
+}

api/src/main/java/com/theokanning/openai/batch/BatchListResult.java

@@ -0,0 +1,28 @@
+package com.theokanning.openai.batch;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Data;
+
+import java.util.List;
+
+/**
+ * @Author: acone.wu
+ * @date: 2024/5/15 16:07
+ */
+@Data
+public class BatchListResult {
+
+    private String object;
+
+    private List<Batch> data;
+
+    @JsonProperty("first_id")
+    private String firstId;
+
+    @JsonProperty("last_id")
+    private String lastId;
+
+    @JsonProperty("has_more")
+    private Boolean hasMore;
+
+}

api/src/main/java/com/theokanning/openai/batch/BatchRequestCounts.java

@@ -0,0 +1,26 @@
+package com.theokanning.openai.batch;
+
+import lombok.Data;
+
+/**
+ * @Author: acone.wu
+ * @date: 2024/5/15 15:36
+ */
+@Data
+public class BatchRequestCounts {
+
+    /**
+     * Number of requests that have been completed successfully.
+     * */
+    private Integer completed;
+
+    /**
+     * Number of requests that have failed.
+     * */
+    private Integer failed;
+
+    /**
+     * Total number of requests in the batch.
+     * */
+    private Integer total;
+}

api/src/main/java/com/theokanning/openai/batch/CreateBatchRequest.java

@@ -0,0 +1,46 @@
+package com.theokanning.openai.batch;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.*;
+
+import java.util.Map;
+
+/**
+ * @Author: acone.wu
+ * @date: 2024/5/14 21:11
+ */
+@NoArgsConstructor
+@AllArgsConstructor
+@Builder
+@Data
+public class CreateBatchRequest {
+
+    /**
+     * The ID of an uploaded file that contains requests for the new batch.
+     * <p>
+     * See upload file for how to upload a file.
+     * <p>
+     * Your input file must be formatted as a JSONL file, and must be uploaded with the purpose batch. The file can contain up to 50,000 requests, and can be up to 100 MB in size.
+     */
+    @NonNull
+    @JsonProperty("input_file_id")
+    String inputFileId;
+
+    /**
+     * The endpoint to be used for all requests in the batch. Currently /v1/chat/completions, /v1/embeddings, and /v1/completions are supported. Note that /v1/embeddings batches are also restricted to a maximum of 50,000 embedding inputs across all requests in the batch.
+     */
+    @NonNull
+    String endpoint;
+
+    /**
+     * The time frame within which the batch should be processed. Currently only 24h is supported.
+     */
+    @NonNull
+    @JsonProperty("completion_window")
+    String compWindow = "24h";
+
+    /**
+     * Optional custom metadata for the batch.
+     */
+    Map<String, Object> metadata;
+}

api/src/main/java/com/theokanning/openai/batch/Status.java

@@ -0,0 +1,23 @@
+package com.theokanning.openai.batch;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonValue;
+
+/**
+ * @Author: acone.wu
+ * @date: 2024/5/15 15:40
+ */
+public enum Status {
+    VALIDATING, FAILED, IN_PROGRESS, FINALIZING, COMPLETED, EXPIRED, CANCELLING, CANCELLED
+    ;
+
+    @JsonCreator
+    public static Status fromValue(String value) {
+        return Status.valueOf(value.toUpperCase());
+    }
+
+    @JsonValue
+    public String toValue() {
+        return this.name().toLowerCase();
+    }
+}

client/src/main/java/com/theokanning/openai/client/OpenAiApi.java

@@ -7,6 +7,9 @@
 import com.theokanning.openai.audio.CreateSpeechRequest;
 import com.theokanning.openai.audio.TranscriptionResult;
 import com.theokanning.openai.audio.TranslationResult;
+import com.theokanning.openai.batch.Batch;
+import com.theokanning.openai.batch.BatchListResult;
+import com.theokanning.openai.batch.CreateBatchRequest;
 import com.theokanning.openai.billing.BillingUsage;
 import com.theokanning.openai.billing.Subscription;
 import com.theokanning.openai.completion.CompletionRequest;
@@ -321,4 +324,16 @@ public interface OpenAiApi {
     @Headers("OpenAI-Beta: assistants=v1")
     @GET("/v1/threads/{thread_id}/runs/{run_id}/steps")
     Single<OpenAiResponse<RunStep>> listRunSteps(@Path("thread_id") String threadId, @Path("run_id") String runId, @QueryMap Map<String, String> listSearchParameters);
+
+    @POST("/v1/batches")
+    Single<Batch> createBatch(@Body CreateBatchRequest createBatchRequest);
+
+    @GET("/v1/batches/{batch_id}")
+    Single<Batch> retrieveBatch(@Path("batch_id") String batchId);
+
+    @GET("/v1/batches")
+    Single<BatchListResult> listBatches(@QueryMap Map<String, String> listSearchParameters);
+
+    @POST("/v1/batches/{batch_id}/cancel")
+    Single<Batch> cancelBatch(@Path("batch_id") String batchId);
 }