Support list api keys

Author: qianmoQ

README.md

@@ -18,6 +18,30 @@
 
 </div>
 
+# How to use?
+
+```java
+<properties>
+    <openai.version>LATEST</openai.version>
+</properties>
+
+<dependencies>
+    <dependency>
+        <groupId>org.devlive.sdk</groupId>
+        <artifactId>openai-java-sdk</artifactId>
+        <version>${openai.version}</version>
+        <exclusions>
+            <exclusion>
+                <groupId>org.slf4j</groupId>
+                <artifactId>slf4j-simple</artifactId>
+            </exclusion>
+        </exclusions>
+    </dependency>
+</dependencies>
+```
+
+`LATEST` By default the latest version will be used.
+
 # Feature
 
 ---

docs/docs/reference/users.md

@@ -0,0 +1,45 @@
+---
+title: User
+---
+
+!!! 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.
+
+### List keys
+
+---
+
+Lists the currently available api keys, and provides basic information about each one such as the owner and availability.
+
+```java
+client.getKeys();
+```
+
+Returns:
+
+```json
+{
+  "object": "list",
+  "data": [
+    {
+      "sensitive_id": "sk-xxx",
+      "object": "api_key",
+      "name": "Open API Key",
+      "created": 1688363358,
+      "last_use": 1688522702,
+      "publishable": false
+    }
+  ]
+}
+```
+

docs/mkdocs.yml

@@ -44,6 +44,7 @@ markdown_extensions:
 nav:
   - index.md
   - Reference:
+      - reference/users.md
       - reference/models.md
       - reference/completions.md
       - reference/completions_chat.md

src/main/java/org/devlive/sdk/openai/DefaultApi.java

@@ -7,6 +7,7 @@
 import org.devlive.sdk.openai.response.CompleteChatResponse;
 import org.devlive.sdk.openai.response.CompleteResponse;
 import org.devlive.sdk.openai.response.ModelResponse;
+import org.devlive.sdk.openai.response.UserKeyResponse;
 import retrofit2.http.Body;
 import retrofit2.http.GET;
 import retrofit2.http.POST;
@@ -39,4 +40,10 @@ public interface DefaultApi
      */
     @POST(value = "v1/chat/completions")
     Single<CompleteChatResponse> fetchChatCompletions(@Body CompletionChatEntity configure);
+
+    /**
+     * Get all keys
+     */
+    @GET(value = "dashboard/user/api_keys")
+    Single<UserKeyResponse> fetchUserAPIKeys();
 }

src/main/java/org/devlive/sdk/openai/DefaultClient.java

@@ -6,6 +6,7 @@
 import org.devlive.sdk.openai.response.CompleteChatResponse;
 import org.devlive.sdk.openai.response.CompleteResponse;
 import org.devlive.sdk.openai.response.ModelResponse;
+import org.devlive.sdk.openai.response.UserKeyResponse;
 
 public abstract class DefaultClient
 {
@@ -34,4 +35,10 @@ public CompleteChatResponse createChatCompletion(CompletionChatEntity configure)
         return this.api.fetchChatCompletions(configure)
                 .blockingGet();
     }
+
+    public UserKeyResponse getKeys()
+    {
+        return this.api.fetchUserAPIKeys()
+                .blockingGet();
+    }
 }

src/main/java/org/devlive/sdk/openai/entity/UserKeyEntity.java

@@ -0,0 +1,39 @@
+package org.devlive.sdk.openai.entity;
+
+import com.fasterxml.jackson.annotation.JsonFormat;
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import lombok.ToString;
+
+@Data
+@Builder
+@ToString
+@NoArgsConstructor
+@AllArgsConstructor
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class UserKeyEntity
+{
+    @JsonProperty(value = "sensitive_id")
+    private String sensitiveId;
+
+    @JsonProperty(value = "object")
+    private String object;
+
+    @JsonProperty(value = "name")
+    private String name;
+
+    @JsonProperty(value = "created")
+    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
+    private String createTime;
+
+    @JsonProperty(value = "last_use")
+    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
+    private String lastUseTime;
+
+    @JsonProperty(value = "publishable")
+    private boolean publishable;
+}

src/main/java/org/devlive/sdk/openai/response/UserKeyResponse.java

@@ -0,0 +1,25 @@
+package org.devlive.sdk.openai.response;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import lombok.ToString;
+import org.devlive.sdk.openai.entity.UserKeyEntity;
+
+import java.util.List;
+
+@Data
+@ToString
+@NoArgsConstructor
+@AllArgsConstructor
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class UserKeyResponse
+{
+    @JsonProperty(value = "object")
+    private String object;
+
+    @JsonProperty(value = "data")
+    private List<UserKeyEntity> keys;
+}

src/test/java/org/devlive/sdk/openai/OpenAiClientTest.java

@@ -112,4 +112,10 @@ public void testCreateChatCompletion()
                 .toString()
                 .contains("openai-java-sdk"));
     }
+
+    @Test
+    public void testGetKeys()
+    {
+        Assert.assertNotNull(client.getKeys());
+    }
 }