Merge branch 'main' into chatfunction-parameters

.github/workflows/pull_request.yml

@@ -0,0 +1,21 @@
+name: Compile
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  compile:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up JDK 1.8
+      uses: actions/setup-java@v3
+      with:
+        distribution: temurin
+        java-version: 8
+
+    - name: Compile
+      run: ./gradlew compileJava compileTestJava

.github/workflows/test.yml

@@ -3,8 +3,6 @@ name: Test
 on:
   push:
     branches: [ main ]
-  pull_request:
-    branches: [ main ]
 
 jobs:
   test:

README.md

@@ -21,12 +21,13 @@ as well as an example project using the service.
 - [Embeddings](https://platform.openai.com/docs/api-reference/embeddings)
 - [Audio](https://platform.openai.com/docs/api-reference/audio)
 - [Files](https://platform.openai.com/docs/api-reference/files)
-- [Fine-tunes](https://platform.openai.com/docs/api-reference/fine-tunes)
+- [Fine-tuning](https://platform.openai.com/docs/api-reference/fine-tuning)
 - [Images](https://platform.openai.com/docs/api-reference/images)
 - [Moderations](https://platform.openai.com/docs/api-reference/moderations)
 
 #### Deprecated by OpenAI
 - [Engines](https://platform.openai.com/docs/api-reference/engines)
+- [Legacy Fine-Tunes](https://platform.openai.com/docs/guides/legacy-fine-tuning)
 
 ## Importing
 

api/build.gradle

@@ -4,6 +4,7 @@ apply plugin: "com.vanniktech.maven.publish"
 dependencies {
     api libs.jacksonAnnotations
     api libs.jacksonDatabind
+    api libs.jtokkit
     compileOnly libs.lombok
     annotationProcessor libs.lombok
 

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

@@ -0,0 +1,24 @@
+package com.theokanning.openai.assistants;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Data;
+
+@Data
+public class Assistant extends AssistantBase {
+
+    /**
+     * 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;
+}

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

@@ -0,0 +1,55 @@
+package com.theokanning.openai.assistants;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import lombok.NonNull;
+
+import java.util.List;
+import java.util.Map;
+
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@Data
+public class AssistantBase {
+
+    /**
+     * 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> fields;
+
+    /**
+     * 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/AssistantRequest.java

@@ -0,0 +1,6 @@
+package com.theokanning.openai.assistants;
+
+
+public class AssistantRequest extends AssistantBase {
+
+}

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/ListAssistant.java

@@ -0,0 +1,16 @@
+package com.theokanning.openai.assistants;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.theokanning.openai.OpenAiResponse;
+
+public class ListAssistant<T extends AssistantBase> extends OpenAiResponse<T> {
+
+    @JsonProperty("first_id")
+    String firstId;
+
+    @JsonProperty("last_id")
+    String lastId;
+
+    @JsonProperty("has_more")
+    boolean hasMore;
+}

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

@@ -0,0 +1,39 @@
+package com.theokanning.openai.assistants;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@Data
+public class ListAssistantQueryRequest {
+    /**
+     * 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.
+     */
+    AssistantSortOrder 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;
+}

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

@@ -0,0 +1,12 @@
+package com.theokanning.openai.assistants;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@NoArgsConstructor
+@AllArgsConstructor
+@Data
+public class Tool {
+     AssistantToolsEnum type;
+}

api/src/main/java/com/theokanning/openai/audio/CreateSpeechRequest.java

@@ -0,0 +1,45 @@
+package com.theokanning.openai.audio;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import lombok.NonNull;
+
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@Data
+public class CreateSpeechRequest {
+
+    /**
+     * The name of the model to use.
+     */
+    @NonNull
+    String model;
+
+    /**
+     * The text to generate audio for. The maximum length is 4096 characters.
+     */
+    @NonNull
+    String input;
+
+    /**
+     * The voice to use when generating the audio.
+     */
+    @NonNull
+    String voice;
+
+    /**
+     * The format to audio in. Supported formats are mp3, opus, aac, and flac. Defaults to mp3.
+     */
+    @JsonProperty("response_format")
+    String responseFormat;
+
+    /**
+     * The speed of the generated audio. Select a value from 0.25 to 4.0. Defaults to 1.0.
+     */
+    Double speed;
+}

api/src/main/java/com/theokanning/openai/billing/BillingUsage.java

@@ -0,0 +1,29 @@
+package com.theokanning.openai.billing;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Data;
+
+import java.math.BigDecimal;
+import java.util.List;
+
+/**
+ * Amount consumption information
+ *
+ */
+@Data
+public class BillingUsage {
+
+    @JsonProperty("object")
+    private String object;
+    /**
+     * Account expenditure details
+     */
+    @JsonProperty("daily_costs")
+    private List<DailyCost> dailyCosts;
+    /**
+     * Total usage amount: cents
+     */
+    @JsonProperty("total_usage")
+    private BigDecimal totalUsage;
+
+}