[Assistants] Support assistant (#42)

Author: qianmoQ

.github/workflows/publish-docs.yml

@@ -12,7 +12,6 @@ jobs:
       - uses: actions/setup-python@v2
         with:
           python-version: 3.x
-      - run: cd docs/ && pip install git+https://${GH_TOKEN}@github.com/qianmoq/mkdocs-material-insiders.git
       - run: cd docs/ && pip install -r requirements.txt
       - run: cd docs/ && mkdocs gh-deploy --force
 

.gitignore

@@ -5,3 +5,4 @@ target/
 pom.xml.versionsBackup
 
 BaseTest.java
+site/

README.md

@@ -43,7 +43,7 @@
 
 ```java
 <properties>
-    <openai.version>1.9.0</openai.version>
+    <openai.version>2023.12.1</openai.version>
 </properties>
 
 <dependencies>

README.zh_CN.md

@@ -43,7 +43,7 @@
 
 ```java
 <properties>
-    <openai.version>1.9.0</openai.version>
+    <openai.version>2023.12.1</openai.version>
 </properties>
 
 <dependencies>

docs/docs/reference/openai/assistants.md

@@ -0,0 +1,277 @@
+---
+title: Assistants <span style="font-weight:bold; margin-left:10px; color:red;">Beta</span>
+---
+
+!!! Note
+
+    Please build the client before calling, the build code is as follows:
+
+    ```java
+    OpenAiClient client = OpenAiClient.builder()
+            .apiHost("https://api.openai.com")
+            .apiKey(System.getProperty("openai.token"))
+            .build();
+    ```
+
+    `System.getProperty("openai.token")` is the key to access the API authorization.
+
+### Create assistant
+
+---
+
+Create an assistant with a model and instructions.
+
+```java
+AssistantsEntity entity = AssistantsEntity.builder()
+        .name("Math Tutor")
+        .model(CompletionModel.GPT_35_TURBO)
+        .instructions("You are a personal math tutor. When asked a question, write and run Python code to answer the question.")
+        .build();
+client.
+
+createAssistants(entity);
+```
+
+Returns:
+
+```json
+{
+  "id": "asst_abc123",
+  "object": "assistant",
+  "created_at": 1698984975,
+  "name": "Math Tutor",
+  "description": null,
+  "model": "gpt-4",
+  "instructions": "You are a personal math tutor. When asked a question, write and run Python code to answer the question.",
+  "tools": [
+    {
+      "type": "code_interpreter"
+    }
+  ],
+  "file_ids": [],
+  "metadata": {}
+}
+```
+
+### Create assistant file
+
+---
+
+Create an assistant file by attaching a File to an assistant.
+
+```java
+client.createAssistantsFile("file-jNuKdx61rNQ0FUhuPFpMNmGZ","asst_xv9N9dNXstuV8OVLElLqgV7U")
+```
+
+Returns:
+
+```json
+{
+  "id": "file-abc123",
+  "object": "assistant.file",
+  "created_at": 1699055364,
+  "assistant_id": "asst_abc123"
+}
+```
+
+### List assistants
+
+---
+
+Returns a list of assistants.
+
+```java
+client.listAssistants(null);
+
+// With query params
+QueryEntity configure = QueryEntity.builder()
+        .limit(2)
+        .build();
+client.
+
+assistants(configure);
+```
+
+Returns:
+
+```json
+{
+  "object": "list",
+  "data": [
+    {
+      "id": "asst_abc123",
+      "object": "assistant",
+      "created_at": 1698982736,
+      "name": "Coding Tutor",
+      "description": null,
+      "model": "gpt-4",
+      "instructions": "You are a helpful assistant designed to make me better at coding!",
+      "tools": [],
+      "file_ids": [],
+      "metadata": {}
+    }
+  ],
+  "first_id": "asst_abc123",
+  "last_id": "asst_abc789",
+  "has_more": false
+}
+```
+
+### List assistant files
+
+---
+
+Returns a list of assistant files.
+
+```java
+client.assistantsFiles("asst_xv9N9dNXstuV8OVLElLqgV7U"));
+```
+
+Returns:
+
+```json
+{
+  "object": "list",
+  "data": [
+    {
+      "id": "file-abc123",
+      "object": "assistant.file",
+      "created_at": 1699060412,
+      "assistant_id": "asst_abc123"
+    }
+  ],
+  "first_id": "file-abc123",
+  "last_id": "file-abc456",
+  "has_more": false
+}
+```
+
+### Retrieve assistant
+
+---
+
+Retrieves an assistant.
+
+```java
+client.retrieveAssistant("asst_xv9N9dNXstuV8OVLElLqgV7U");
+```
+
+Returns:
+
+```json
+{
+  "id": "asst_abc123",
+  "object": "assistant",
+  "created_at": 1698984975,
+  "name": "Math Tutor",
+  "description": null,
+  "model": "gpt-4",
+  "instructions": "You are a personal math tutor. When asked a question, write and run Python code to answer the question.",
+  "tools": [
+    {
+      "type": "code_interpreter"
+    }
+  ],
+  "file_ids": [],
+  "metadata": {}
+}
+```
+
+### Retrieve assistant file
+
+---
+
+Retrieves an assistant file.
+
+```java
+client.retrieveAssistantFile("asst_xv9N9dNXstuV8OVLElLqgV7U","file-jNuKdx61rNQ0FUhuPFpMNmGZ");
+```
+
+Returns:
+
+```json
+{
+  "id": "file-abc123",
+  "object": "assistant.file",
+  "created_at": 1699055364,
+  "assistant_id": "asst_abc123"
+}
+```
+
+### Modify assistant
+
+---
+
+Modifies an assistant.
+
+```java
+AssistantsEntity entity = AssistantsEntity.builder()
+        .name("Math Tutor 1")
+        .model(CompletionModel.GPT_35_TURBO)
+        .instructions("You are a personal math tutor. When asked a question, write and run Python code to answer the question.")
+        .build();
+client.
+
+updateAssistant("asst_xv9N9dNXstuV8OVLElLqgV7U",entity);
+```
+
+Returns:
+
+```json
+{
+  "id": "asst_abc123",
+  "object": "assistant",
+  "created_at": 1698984975,
+  "name": "Math Tutor 1",
+  "description": null,
+  "model": "gpt-4",
+  "instructions": "You are a personal math tutor. When asked a question, write and run Python code to answer the question.",
+  "tools": [
+    {
+      "type": "code_interpreter"
+    }
+  ],
+  "file_ids": [],
+  "metadata": {}
+}
+```
+
+### Delete assistant
+
+---
+
+Deletes an assistant.
+
+```java
+client.deleteAssistant("asst_xv9N9dNXstuV8OVLElLqgV7U");
+```
+
+Returns:
+
+```json
+{
+  "id": "asst_abc123",
+  "object": "assistant.deleted",
+  "deleted": true
+}
+```
+
+### Delete assistant file
+
+---
+
+Deletes an assistant file.
+
+```java
+client.deleteAssistantFile("asst_xv9N9dNXstuV8OVLElLqgV7U","file-jNuKdx61rNQ0FUhuPFpMNmGZ");
+```
+
+Returns:
+
+```json
+{
+  "id": "file-abc123",
+  "object": "assistant.file.deleted",
+  "deleted": true
+}
+```