Add Model support and new v1 endpoints (#27)

The old endpoints are marked as deprecated
Also marked response fields as public for easier access

Author: TheoKanning

api/src/main/java/com/theokanning/openai/completion/CompletionRequest.java

@@ -20,7 +20,8 @@
 public class CompletionRequest {
 
     /**
-     * The name of the model to use, only used if specifying a fine tuned model.
+     * The name of the model to use.
+     * Required if specifying a fine tuned model or if using the new v1/completions endpoint.
      */
     String model;
 

api/src/main/java/com/theokanning/openai/edit/EditRequest.java

@@ -14,6 +14,12 @@
 @Data
 public class EditRequest {
 
+    /**
+     * The name of the model to use.
+     * Required if using the new v1/edits endpoint.
+     */
+    String model;
+
     /**
      * The input text to use as a starting point for the edit.
      */
@@ -32,14 +38,17 @@ public class EditRequest {
     Integer n;
 
     /**
-     * What sampling temperature to use. Higher values means the model will take more risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer.
+     * What sampling temperature to use. Higher values means the model will take more risks.
+     * Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer.
      *
      * We generally recommend altering this or {@link EditRequest#topP} but not both.
      */
     Double temperature;
 
     /**
-     * An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.
+     * An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of
+     * the tokens with top_p probability mass.So 0.1 means only the tokens comprising the top 10% probability mass are
+     * considered.
      *
      * We generally recommend altering this or {@link EditRequest#temperature} but not both.
      */

api/src/main/java/com/theokanning/openai/edit/EditResult.java

@@ -15,20 +15,20 @@ public class EditResult {
     /**
      * The type of object returned, should be "edit"
      */
-    String object;
+    public String object;
 
     /**
      * The creation time in epoch milliseconds.
      */
-    long created;
+    public long created;
 
     /**
      * A list of generated edits.
      */
-    List<EditChoice> choices;
+    public List<EditChoice> choices;
 
     /**
      * The API usage for this request
      */
-    EditUsage usage;
+    public EditUsage usage;
 }

api/src/main/java/com/theokanning/openai/embedding/EmbeddingRequest.java

@@ -7,7 +7,6 @@
 /**
  * Creates an embedding vector representing the input text.
  *
- * Documentation taken from
  * https://beta.openai.com/docs/api-reference/embeddings/create
  */
 @Builder
@@ -16,6 +15,12 @@
 @Data
 public class EmbeddingRequest {
 
+    /**
+     * The name of the model to use.
+     * Required if using the new v1/embeddings endpoint.
+     */
+    String model;
+
     /**
      * Input text to get embeddings for, encoded as a string or array of tokens.
      * To get embeddings for multiple inputs in a single request, pass an array of strings or array of token arrays.

api/src/main/java/com/theokanning/openai/engine/Engine.java

@@ -7,6 +7,7 @@
  *
  * https://beta.openai.com/docs/api-reference/retrieve-engine
  */
+@Deprecated
 @Data
 public class Engine {
     /**

api/src/main/java/com/theokanning/openai/finetune/FineTuneRequest.java

@@ -1,5 +1,6 @@
 package com.theokanning.openai.finetune;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.*;
 
 import java.util.List;
@@ -83,7 +84,8 @@ public class FineTuneRequest {
      *
      * This parameter is required for multiclass classification.
      */
-    Integer classificationNClasses; // todo verify snake case
+    @JsonProperty("classification_n_classes")
+    Integer classificationNClasses;
 
     /**
      * The positive class in binary classification.

api/src/main/java/com/theokanning/openai/model/Model.java

@@ -0,0 +1,43 @@
+package com.theokanning.openai.model;
+
+import lombok.Data;
+
+import java.util.List;
+
+/**
+ * GPT-3 model details
+ *
+ * https://beta.openai.com/docs/api-reference/models
+ */
+@Data
+public class Model {
+    /**
+     * An identifier for this model, used to specify the model when making completions, etc
+     */
+    public String id;
+
+    /**
+     * The type of object returned, should be "model"
+     */
+    public String object;
+
+    /**
+     * The owner of the GPT-3 model, typically "openai"
+     */
+    public String ownedBy;
+
+    /**
+     * List of permissions for this model
+     */
+    public List<Permission> permission;
+
+    /**
+     * The root model that this and its parent (if applicable) are based on
+     */
+    public String root;
+
+    /**
+     * The parent model that this is based on
+     */
+    public String parent;
+}

api/src/main/java/com/theokanning/openai/model/Permission.java

@@ -0,0 +1,47 @@
+package com.theokanning.openai.model;
+
+import lombok.Data;
+
+/**
+ * GPT-3 model permissions
+ * I couldn't find documentation for the specific permissions, and I've elected to leave them undocumented rather than
+ * write something incorrect.
+ *
+ * https://beta.openai.com/docs/api-reference/models
+ */
+@Data
+public class Permission {
+    /**
+     * An identifier for this model permission
+     */
+    public String id;
+
+    /**
+     * The type of object returned, should be "model_permission"
+     */
+    public String object;
+
+    /**
+     * The creation time in epoch seconds.
+     */
+    public long created;
+
+    public boolean allowCreateEngine;
+
+    public boolean allowSampling;
+
+    public boolean allowLogProbs;
+
+    public boolean allowSearchIndices;
+
+    public boolean allowView;
+
+    public boolean allowFineTuning;
+
+    public String organization;
+
+    public String group;
+
+    public boolean isBlocking;
+
+}

api/src/main/java/com/theokanning/openai/moderation/Moderation.java

@@ -12,19 +12,19 @@ public class Moderation {
     /**
      * Set to true if the model classifies the content as violating OpenAI's content policy, false otherwise
      */
-    boolean flagged;
+    public boolean flagged;
 
     /**
      * Object containing per-category binary content policy violation flags.
      * For each category, the value is true if the model flags the corresponding category as violated, false otherwise.
      */
-    ModerationCategories categories;
+    public ModerationCategories categories;
 
     /**
      * Object containing per-category raw scores output by the model, denoting the model's confidence that the
      * input violates the OpenAI's policy for the category.
      * The value is between 0 and 1, where higher values denote higher confidence.
      * The scores should not be interpreted as probabilities.
      */
-    ModerationCategoryScores categoryScores;
+    public ModerationCategoryScores categoryScores;
 }

api/src/main/java/com/theokanning/openai/moderation/ModerationCategories.java

@@ -14,21 +14,21 @@
 @Data
 public class ModerationCategories {
 
-    boolean hate;
+    public boolean hate;
 
     @JsonProperty("hate/threatening")
-    boolean hateThreatening;
+    public boolean hateThreatening;
 
     @JsonProperty("self-harm")
-    boolean selfHarm;
+    public boolean selfHarm;
 
-    boolean sexual;
+    public boolean sexual;
 
     @JsonProperty("sexual/minors")
-    boolean sexualMinors;
+    public boolean sexualMinors;
 
-    boolean violence;
+    public boolean violence;
 
     @JsonProperty("violence/graphic")
-    boolean violenceGraphic;
+    public boolean violenceGraphic;
 }