[OpenAi] Support create completion

qianmoQ · qianmoQ · commit dc930973e342 · 2023-07-04T15:52:31.000+08:00
diff --git a/docs/docs/reference/completions.md b/docs/docs/reference/completions.md
@@ -0,0 +1,69 @@
+---
+title: Completions
+---
+
+!!! 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 completion
+
+---
+
+Creates a completion for the provided prompt and parameters.
+
+```java
+CompletionEntity configure = CompletionEntity.builder()
+        .model(CompleteModel.TEXT_DAVINCI_003.getName())
+        .prompt("How to create a completion")
+        .temperature(2D)
+        .build();
+client.createCompletion(configure);
+```
+
+Body:
+
+|        Name        |      Type      | Required |
+|:------------------:|:--------------:|----------|
+|      `model`       |    `String`    | Yes      |
+|      `prompt`      |    `String`    | Yes      |
+|   `temperature`    |    `Number`    | No       |
+|    `maxTokens`     |    `Number`    | No       |
+|       `topP`       |    `Number`    | No       |
+|      `bestOf`      |    `Number`    | No       |
+| `frequencyPenalty` |    `Number`    | No       |
+| `presencePenalty`  |    `Number`    | No       |
+|       `stop`       | `List<String>` | No       |
+
+Returns:
+
+```json
+{
+  "id": "cmpl-uqkvlQyYK7bGYrRHQ0eXlWi7",
+  "object": "text_completion",
+  "created": 1589478378,
+  "model": "text-davinci-003",
+  "choices": [
+    {
+      "text": "\n\nThis is indeed a test",
+      "index": 0,
+      "logprobs": null,
+      "finish_reason": "length"
+    }
+  ],
+  "usage": {
+    "prompt_tokens": 5,
+    "completion_tokens": 7,
+    "total_tokens": 12
+  }
+}
+```
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -45,4 +45,5 @@ nav:
   - index.md
   - Reference:
       - reference/models.md
+      - reference/completions.md
   - powered_by.md
diff --git a/src/main/java/org/devlive/sdk/openai/DefaultApi.java b/src/main/java/org/devlive/sdk/openai/DefaultApi.java
@@ -1,7 +1,7 @@
 package org.devlive.sdk.openai;
 
 import io.reactivex.Single;
-import org.devlive.sdk.openai.entity.CompleteEntity;
+import org.devlive.sdk.openai.entity.CompletionEntity;
 import org.devlive.sdk.openai.entity.ModelEntity;
 import org.devlive.sdk.openai.response.CompleteResponse;
 import org.devlive.sdk.openai.response.ModelResponse;
@@ -30,5 +30,5 @@ public interface DefaultApi
      * Creates a completion for the provided prompt and parameters.
      */
     @POST(value = "v1/completions")
-    Single<CompleteResponse> fetchCompletions(@Body CompleteEntity configure);
+    Single<CompleteResponse> fetchCompletions(@Body CompletionEntity configure);
 }
diff --git a/src/main/java/org/devlive/sdk/openai/DefaultClient.java b/src/main/java/org/devlive/sdk/openai/DefaultClient.java
@@ -1,6 +1,6 @@
 package org.devlive.sdk.openai;
 
-import org.devlive.sdk.openai.entity.CompleteEntity;
+import org.devlive.sdk.openai.entity.CompletionEntity;
 import org.devlive.sdk.openai.entity.ModelEntity;
 import org.devlive.sdk.openai.response.CompleteResponse;
 import org.devlive.sdk.openai.response.ModelResponse;
@@ -21,7 +21,7 @@ ModelEntity getModel(String model)
                 .blockingGet();
     }
 
-    CompleteResponse createComplete(CompleteEntity configure)
+    CompleteResponse createCompletion(CompletionEntity configure)
     {
         return this.api.fetchCompletions(configure)
                 .blockingGet();
diff --git a/src/main/java/org/devlive/sdk/openai/entity/CompletionEntity.java b/src/main/java/org/devlive/sdk/openai/entity/CompletionEntity.java
@@ -9,7 +9,7 @@
 import org.apache.commons.lang3.ObjectUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.devlive.sdk.openai.exception.ParamException;
-import org.devlive.sdk.openai.model.CompleteModel;
+import org.devlive.sdk.openai.model.CompletionModel;
 import org.devlive.sdk.openai.utils.EnumsUtils;
 
 import java.util.List;
@@ -19,7 +19,7 @@
 @ToString
 @AllArgsConstructor
 @JsonIgnoreProperties(ignoreUnknown = true)
-public class CompleteEntity
+public class CompletionEntity
 {
     @JsonProperty(value = "model")
     private String model;
@@ -48,10 +48,10 @@ public class CompleteEntity
     @JsonProperty(value = "stop")
     private List<String> stop;
 
-    private CompleteEntity(CompleteEntityBuilder builder)
+    private CompletionEntity(CompletionEntityBuilder builder)
     {
         if (ObjectUtils.isEmpty(builder.model)) {
-            builder.model(CompleteModel.TEXT_DAVINCI_003.getName());
+            builder.model(CompletionModel.TEXT_DAVINCI_003.getName());
         }
         this.model = builder.model;
 
@@ -92,18 +92,18 @@ private CompleteEntity(CompleteEntityBuilder builder)
         this.stop = builder.stop;
     }
 
-    public static class CompleteEntityBuilder
+    public static class CompletionEntityBuilder
     {
-        public CompleteEntityBuilder model(String model)
+        public CompletionEntityBuilder model(String model)
         {
             if (StringUtils.isEmpty(model)) {
-                model = CompleteModel.TEXT_DAVINCI_003.getName();
+                model = CompletionModel.TEXT_DAVINCI_003.getName();
             }
             this.model = model;
             return this;
         }
 
-        public CompleteEntityBuilder prompt(String prompt)
+        public CompletionEntityBuilder prompt(String prompt)
         {
             if (StringUtils.isEmpty(prompt)) {
                 throw new ParamException("Invalid prompt must not be empty");
@@ -112,7 +112,7 @@ public CompleteEntityBuilder prompt(String prompt)
             return this;
         }
 
-        public CompleteEntityBuilder temperature(Double temperature)
+        public CompletionEntityBuilder temperature(Double temperature)
         {
             if (temperature < 0 || temperature > 2) {
                 throw new ParamException(String.format("Invalid temperature: %s , between 0 and 2", temperature));
@@ -121,17 +121,17 @@ public CompleteEntityBuilder temperature(Double temperature)
             return this;
         }
 
-        public CompleteEntityBuilder maxTokens(Integer maxTokens)
+        public CompletionEntityBuilder maxTokens(Integer maxTokens)
         {
-            CompleteModel completeModel = EnumsUtils.getCompleteModel(this.model);
-            if (ObjectUtils.isNotEmpty(this.model) && maxTokens > completeModel.getMaxTokens()) {
-                throw new ParamException(String.format("Invalid maxTokens: %s, Cannot be larger than the model default configuration %s", maxTokens, completeModel.getMaxTokens()));
+            CompletionModel completionModel = EnumsUtils.getCompleteModel(this.model);
+            if (ObjectUtils.isNotEmpty(this.model) && maxTokens > completionModel.getMaxTokens()) {
+                throw new ParamException(String.format("Invalid maxTokens: %s, Cannot be larger than the model default configuration %s", maxTokens, completionModel.getMaxTokens()));
             }
             this.maxTokens = maxTokens;
             return this;
         }
 
-        public CompleteEntityBuilder frequencyPenalty(Double frequencyPenalty)
+        public CompletionEntityBuilder frequencyPenalty(Double frequencyPenalty)
         {
             if (frequencyPenalty < -2.0 || frequencyPenalty > 2.0) {
                 throw new ParamException(String.format("Invalid frequencyPenalty: %s , between -2.0 and 2.0", frequencyPenalty));
@@ -140,7 +140,7 @@ public CompleteEntityBuilder frequencyPenalty(Double frequencyPenalty)
             return this;
         }
 
-        public CompleteEntityBuilder presencePenalty(Double presencePenalty)
+        public CompletionEntityBuilder presencePenalty(Double presencePenalty)
         {
             if (presencePenalty < -2.0 || presencePenalty > 2.0) {
                 throw new ParamException(String.format("Invalid presencePenalty: %s , between -2.0 and 2.0", presencePenalty));
@@ -149,9 +149,9 @@ public CompleteEntityBuilder presencePenalty(Double presencePenalty)
             return this;
         }
 
-        public CompleteEntity build()
+        public CompletionEntity build()
         {
-            return new CompleteEntity(this);
+            return new CompletionEntity(this);
         }
     }
 }
diff --git a/src/main/java/org/devlive/sdk/openai/model/CompletionModel.java b/src/main/java/org/devlive/sdk/openai/model/CompletionModel.java
@@ -1,6 +1,6 @@
 package org.devlive.sdk.openai.model;
 
-public enum CompleteModel
+public enum CompletionModel
 {
     TEXT_DAVINCI_003("text-davinci-003",
             "Most capable model in the GPT-3 series. Can perform any task the other GPT-3 models can, often with higher quality, longer output and better instruction-following. It can process up to 4,000 tokens per request.",
@@ -16,7 +16,7 @@ public enum CompleteModel
     private final String strengths;
     private final int maxTokens;
 
-    CompleteModel(String name, String description, String strengths, int maxTokens)
+    CompletionModel(String name, String description, String strengths, int maxTokens)
     {
         this.name = name;
         this.description = description;
diff --git a/src/main/java/org/devlive/sdk/openai/utils/EnumsUtils.java b/src/main/java/org/devlive/sdk/openai/utils/EnumsUtils.java
@@ -1,6 +1,6 @@
 package org.devlive.sdk.openai.utils;
 
-import org.devlive.sdk.openai.model.CompleteModel;
+import org.devlive.sdk.openai.model.CompletionModel;
 
 import java.util.Arrays;
 import java.util.Optional;
@@ -11,9 +11,9 @@ private EnumsUtils()
     {
     }
 
-    public static CompleteModel getCompleteModel(final String name)
+    public static CompletionModel getCompleteModel(final String name)
     {
-        Optional<CompleteModel> optional = Arrays.stream(CompleteModel.values())
+        Optional<CompletionModel> optional = Arrays.stream(CompletionModel.values())
                 .filter(item -> item.getName().equals(name))
                 .findFirst();
         return optional.isPresent() ? optional.get() : null;
diff --git a/src/test/java/org/devlive/sdk/openai/OpenAiClientTest.java b/src/test/java/org/devlive/sdk/openai/OpenAiClientTest.java
@@ -1,8 +1,8 @@
 package org.devlive.sdk.openai;
 
-import org.devlive.sdk.openai.entity.CompleteEntity;
+import org.devlive.sdk.openai.entity.CompletionEntity;
 import org.devlive.sdk.openai.exception.AuthorizedException;
-import org.devlive.sdk.openai.model.CompleteModel;
+import org.devlive.sdk.openai.model.CompletionModel;
 import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Test;
@@ -49,13 +49,13 @@ public void testGetModel()
     }
 
     @Test
-    public void testCreateComplete()
+    public void testCreateCompletion()
     {
-        CompleteEntity configure = CompleteEntity.builder()
-                .model(CompleteModel.TEXT_DAVINCI_003.getName())
-                .prompt("How to create a complete")
+        CompletionEntity configure = CompletionEntity.builder()
+                .model(CompletionModel.TEXT_DAVINCI_003.getName())
+                .prompt("How to create a completion")
                 .temperature(2D)
                 .build();
-        Assert.assertTrue(client.createComplete(configure).getChoices().size() > 0);
+        Assert.assertTrue(client.createCompletion(configure).getChoices().size() > 0);
     }
 }
diff --git a/src/test/java/org/devlive/sdk/openai/entity/CompletionEntityTest.java b/src/test/java/org/devlive/sdk/openai/entity/CompletionEntityTest.java

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`package org.devlive.sdk.openai;`
`2`	`2`
`3`		`-import org.devlive.sdk.openai.entity.CompleteEntity;`
	`3`	`+import org.devlive.sdk.openai.entity.CompletionEntity;`
`4`	`4`	`import org.devlive.sdk.openai.entity.ModelEntity;`
`5`	`5`	`import org.devlive.sdk.openai.response.CompleteResponse;`
`6`	`6`	`import org.devlive.sdk.openai.response.ModelResponse;`
`@@ -21,7 +21,7 @@ ModelEntity getModel(String model)`
`21`	`21`	`.blockingGet();`
`22`	`22`	`}`
`23`	`23`
`24`		`- CompleteResponse createComplete(CompleteEntity configure)`
	`24`	`+ CompleteResponse createCompletion(CompletionEntity configure)`
`25`	`25`	`{`
`26`	`26`	`return this.api.fetchCompletions(configure)`
`27`	`27`	`.blockingGet();`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`import org.apache.commons.lang3.ObjectUtils;`
`10`	`10`	`import org.apache.commons.lang3.StringUtils;`
`11`	`11`	`import org.devlive.sdk.openai.exception.ParamException;`
`12`		`-import org.devlive.sdk.openai.model.CompleteModel;`
	`12`	`+import org.devlive.sdk.openai.model.CompletionModel;`
`13`	`13`	`import org.devlive.sdk.openai.utils.EnumsUtils;`
`14`	`14`
`15`	`15`	`import java.util.List;`
`@@ -19,7 +19,7 @@`
`19`	`19`	`@ToString`
`20`	`20`	`@AllArgsConstructor`
`21`	`21`	`@JsonIgnoreProperties(ignoreUnknown = true)`
`22`		`-public class CompleteEntity`
	`22`	`+public class CompletionEntity`
`23`	`23`	`{`
`24`	`24`	`@JsonProperty(value = "model")`
`25`	`25`	`private String model;`
`@@ -48,10 +48,10 @@ public class CompleteEntity`
`48`	`48`	`@JsonProperty(value = "stop")`
`49`	`49`	`private List<String> stop;`
`50`	`50`
`51`		`- private CompleteEntity(CompleteEntityBuilder builder)`
	`51`	`+ private CompletionEntity(CompletionEntityBuilder builder)`
`52`	`52`	`{`
`53`	`53`	`if (ObjectUtils.isEmpty(builder.model)) {`
`54`		`- builder.model(CompleteModel.TEXT_DAVINCI_003.getName());`
	`54`	`+ builder.model(CompletionModel.TEXT_DAVINCI_003.getName());`
`55`	`55`	`}`
`56`	`56`	`this.model = builder.model;`
`57`	`57`
`@@ -92,18 +92,18 @@ private CompleteEntity(CompleteEntityBuilder builder)`
`92`	`92`	`this.stop = builder.stop;`
`93`	`93`	`}`
`94`	`94`
`95`		`- public static class CompleteEntityBuilder`
	`95`	`+ public static class CompletionEntityBuilder`
`96`	`96`	`{`
`97`		`- public CompleteEntityBuilder model(String model)`
	`97`	`+ public CompletionEntityBuilder model(String model)`
`98`	`98`	`{`
`99`	`99`	`if (StringUtils.isEmpty(model)) {`
`100`		`- model = CompleteModel.TEXT_DAVINCI_003.getName();`
	`100`	`+ model = CompletionModel.TEXT_DAVINCI_003.getName();`
`101`	`101`	`}`
`102`	`102`	`this.model = model;`
`103`	`103`	`return this;`
`104`	`104`	`}`
`105`	`105`
`106`		`- public CompleteEntityBuilder prompt(String prompt)`
	`106`	`+ public CompletionEntityBuilder prompt(String prompt)`
`107`	`107`	`{`
`108`	`108`	`if (StringUtils.isEmpty(prompt)) {`
`109`	`109`	`throw new ParamException("Invalid prompt must not be empty");`
`@@ -112,7 +112,7 @@ public CompleteEntityBuilder prompt(String prompt)`
`112`	`112`	`return this;`
`113`	`113`	`}`
`114`	`114`
`115`		`- public CompleteEntityBuilder temperature(Double temperature)`
	`115`	`+ public CompletionEntityBuilder temperature(Double temperature)`
`116`	`116`	`{`
`117`	`117`	`if (temperature < 0 \|\| temperature > 2) {`
`118`	`118`	`throw new ParamException(String.format("Invalid temperature: %s , between 0 and 2", temperature));`
`@@ -121,17 +121,17 @@ public CompleteEntityBuilder temperature(Double temperature)`
`121`	`121`	`return this;`
`122`	`122`	`}`
`123`	`123`
`124`		`- public CompleteEntityBuilder maxTokens(Integer maxTokens)`
	`124`	`+ public CompletionEntityBuilder maxTokens(Integer maxTokens)`
`125`	`125`	`{`
`126`		`- CompleteModel completeModel = EnumsUtils.getCompleteModel(this.model);`
`127`		`- if (ObjectUtils.isNotEmpty(this.model) && maxTokens > completeModel.getMaxTokens()) {`
`128`		`- throw new ParamException(String.format("Invalid maxTokens: %s, Cannot be larger than the model default configuration %s", maxTokens, completeModel.getMaxTokens()));`
	`126`	`+ CompletionModel completionModel = EnumsUtils.getCompleteModel(this.model);`
	`127`	`+ if (ObjectUtils.isNotEmpty(this.model) && maxTokens > completionModel.getMaxTokens()) {`
	`128`	`+ throw new ParamException(String.format("Invalid maxTokens: %s, Cannot be larger than the model default configuration %s", maxTokens, completionModel.getMaxTokens()));`
`129`	`129`	`}`
`130`	`130`	`this.maxTokens = maxTokens;`
`131`	`131`	`return this;`
`132`	`132`	`}`
`133`	`133`
`134`		`- public CompleteEntityBuilder frequencyPenalty(Double frequencyPenalty)`
	`134`	`+ public CompletionEntityBuilder frequencyPenalty(Double frequencyPenalty)`
`135`	`135`	`{`
`136`	`136`	`if (frequencyPenalty < -2.0 \|\| frequencyPenalty > 2.0) {`
`137`	`137`	`throw new ParamException(String.format("Invalid frequencyPenalty: %s , between -2.0 and 2.0", frequencyPenalty));`
`@@ -140,7 +140,7 @@ public CompleteEntityBuilder frequencyPenalty(Double frequencyPenalty)`
`140`	`140`	`return this;`
`141`	`141`	`}`
`142`	`142`
`143`		`- public CompleteEntityBuilder presencePenalty(Double presencePenalty)`
	`143`	`+ public CompletionEntityBuilder presencePenalty(Double presencePenalty)`
`144`	`144`	`{`
`145`	`145`	`if (presencePenalty < -2.0 \|\| presencePenalty > 2.0) {`
`146`	`146`	`throw new ParamException(String.format("Invalid presencePenalty: %s , between -2.0 and 2.0", presencePenalty));`
`@@ -149,9 +149,9 @@ public CompleteEntityBuilder presencePenalty(Double presencePenalty)`
`149`	`149`	`return this;`
`150`	`150`	`}`
`151`	`151`
`152`		`- public CompleteEntity build()`
	`152`	`+ public CompletionEntity build()`
`153`	`153`	`{`
`154`		`- return new CompleteEntity(this);`
	`154`	`+ return new CompletionEntity(this);`
`155`	`155`	`}`
`156`	`156`	`}`
`157`	`157`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`package org.devlive.sdk.openai.model;`
`2`	`2`
`3`		`-public enum CompleteModel`
	`3`	`+public enum CompletionModel`
`4`	`4`	`{`
`5`	`5`	`TEXT_DAVINCI_003("text-davinci-003",`
`6`	`6`	`"Most capable model in the GPT-3 series. Can perform any task the other GPT-3 models can, often with higher quality, longer output and better instruction-following. It can process up to 4,000 tokens per request.",`
`@@ -16,7 +16,7 @@ public enum CompleteModel`
`16`	`16`	`private final String strengths;`
`17`	`17`	`private final int maxTokens;`
`18`	`18`
`19`		`- CompleteModel(String name, String description, String strengths, int maxTokens)`
	`19`	`+ CompletionModel(String name, String description, String strengths, int maxTokens)`
`20`	`20`	`{`
`21`	`21`	`this.name = name;`
`22`	`22`	`this.description = description;`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`package org.devlive.sdk.openai.utils;`
`2`	`2`
`3`		`-import org.devlive.sdk.openai.model.CompleteModel;`
	`3`	`+import org.devlive.sdk.openai.model.CompletionModel;`
`4`	`4`
`5`	`5`	`import java.util.Arrays;`
`6`	`6`	`import java.util.Optional;`
`@@ -11,9 +11,9 @@ private EnumsUtils()`
`11`	`11`	`{`
`12`	`12`	`}`
`13`	`13`
`14`		`- public static CompleteModel getCompleteModel(final String name)`
	`14`	`+ public static CompletionModel getCompleteModel(final String name)`
`15`	`15`	`{`
`16`		`- Optional<CompleteModel> optional = Arrays.stream(CompleteModel.values())`
	`16`	`+ Optional<CompletionModel> optional = Arrays.stream(CompletionModel.values())`
`17`	`17`	`.filter(item -> item.getName().equals(name))`
`18`	`18`	`.findFirst();`
`19`	`19`	`return optional.isPresent() ? optional.get() : null;`