[Release] Released for 1.2.0 (#10)

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,74 @@
+---
+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
+    }
+  ]
+}
+```
+
+### Create a key
+
+---
+
+Create a new key.
+
+```java
+UserKeyEntity configure=UserKeyEntity.builder()
+        .name("Create first key")
+        .action("create")
+        .build();
+client.createUserAPIKey(configure)
+```
+
+Return:
+
+```json
+{
+  "result": "success",
+  "key": {
+    "sensitive_id": "sk-xxx",
+    "object": "api_key",
+    "name": "Test",
+    "created": 1688525108,
+    "last_use": null,
+    "publishable": false
+  }
+}
+```

docs/docs/released.md

@@ -5,6 +5,16 @@ hide:
   - navigation
 ---
 
+### 1.2.0
+
+---
+
+- Support report error message
+- Supports custom `OkHttpClient`
+- Add a default interceptor
+- Support list api keys
+- Support create new api key
+
 ### 1.1.0
 
 ---

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

pom.xml

@@ -5,7 +5,7 @@
 
     <groupId>org.devlive.sdk</groupId>
     <artifactId>openai-java-sdk</artifactId>
-    <version>1.2.0-SNAPSHOT</version>
+    <version>1.2.0</version>
 
     <name>openai-java-sdk</name>
     <description>

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

@@ -4,9 +4,11 @@
 import org.devlive.sdk.openai.entity.CompletionChatEntity;
 import org.devlive.sdk.openai.entity.CompletionEntity;
 import org.devlive.sdk.openai.entity.ModelEntity;
+import org.devlive.sdk.openai.entity.UserKeyEntity;
 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 +41,16 @@ 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();
+
+    /**
+     * Create a key for the given
+     */
+    @POST(value = "dashboard/user/api_keys")
+    Single<UserKeyResponse> fetchCreateUserAPIKey(@Body UserKeyEntity configure);
 }

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

@@ -3,9 +3,11 @@
 import org.devlive.sdk.openai.entity.CompletionChatEntity;
 import org.devlive.sdk.openai.entity.CompletionEntity;
 import org.devlive.sdk.openai.entity.ModelEntity;
+import org.devlive.sdk.openai.entity.UserKeyEntity;
 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 +36,16 @@ public CompleteChatResponse createChatCompletion(CompletionChatEntity configure)
         return this.api.fetchChatCompletions(configure)
                 .blockingGet();
     }
+
+    public UserKeyResponse getKeys()
+    {
+        return this.api.fetchUserAPIKeys()
+                .blockingGet();
+    }
+
+    public UserKeyResponse createUserAPIKey(UserKeyEntity configure)
+    {
+        return this.api.fetchCreateUserAPIKey(configure)
+                .blockingGet();
+    }
 }

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

@@ -8,7 +8,6 @@
 import okhttp3.OkHttpClient;
 import org.apache.commons.lang3.ObjectUtils;
 import org.apache.commons.lang3.StringUtils;
-import org.devlive.sdk.openai.exception.ParamException;
 import org.devlive.sdk.openai.interceptor.DefaultInterceptor;
 import retrofit2.Retrofit;
 import retrofit2.adapter.rxjava2.RxJava2CallAdapterFactory;
@@ -102,30 +101,21 @@ public OpenAiClientBuilder unit(TimeUnit unit)
 
         public OpenAiClientBuilder client(OkHttpClient client)
         {
-            DefaultInterceptor interceptor = new DefaultInterceptor();
-            interceptor.setApiKey(this.apiKey);
             if (ObjectUtils.isEmpty(client)) {
                 log.warn("No client, creating default client");
                 client = new OkHttpClient.Builder()
-                        .addInterceptor(interceptor)
                         .connectTimeout(this.timeout, this.unit)
                         .writeTimeout(this.timeout, this.unit)
                         .readTimeout(this.timeout, this.unit)
                         .callTimeout(this.timeout, this.unit)
                         .build();
             }
-
-            if (client.interceptors().size() <= 0) {
-                throw new ParamException("No interceptors available");
-            }
-
-            long count = client.interceptors()
-                    .stream()
-                    .filter(inter -> inter instanceof DefaultInterceptor)
-                    .count();
-            if (count <= 0) {
-                throw new ParamException("Must inject DefaultInterceptor");
-            }
+            // Add default interceptor
+            DefaultInterceptor interceptor = new DefaultInterceptor();
+            interceptor.setApiKey(this.apiKey);
+            client = client.newBuilder()
+                    .addInterceptor(interceptor)
+                    .build();
             this.client = client;
             return this;
         }

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

@@ -0,0 +1,45 @@
+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;
+
+    /**
+     * When creating a key use
+     */
+    @JsonProperty(value = "action")
+    private String action;
+}

src/main/java/org/devlive/sdk/openai/interceptor/DefaultInterceptor.java

@@ -6,8 +6,10 @@
 import lombok.extern.slf4j.Slf4j;
 import okhttp3.Interceptor;
 import okhttp3.Request;
+import okhttp3.RequestBody;
 import okhttp3.Response;
 import okhttp3.ResponseBody;
+import okio.Buffer;
 import org.apache.commons.lang3.ObjectUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.devlive.sdk.openai.exception.AuthorizedException;
@@ -50,6 +52,14 @@ public Response intercept(Chain chain) throws IOException
 
         Request original = chain.request();
         Request request = this.headers(original);
+
+        RequestBody requestBody = request.body();
+        if (ObjectUtils.isNotEmpty(requestBody)) {
+            Buffer buffer = new Buffer();
+            requestBody.writeTo(buffer);
+            log.debug("Request body {}", buffer.readUtf8());
+        }
+
         Response response = chain.proceed(request);
         if (!response.isSuccessful()) {
             log.error("Failed to intercept request");
@@ -72,7 +82,7 @@ public Response intercept(Chain chain) throws IOException
         }
 
         // Has error
-        if (response.code() == 404 || response.code() == 400) {
+        if (response.code() == 404 || response.code() == 400 || response.code() == 403) {
             ResponseBody body = response.body();
             if (ObjectUtils.isEmpty(body)) {
                 throw new NullPointerException("Failed to intercept request because no body");