spec 1.0.3 + build

huangjiaju · Feb 16, 2022 · 6f51f4a · 6f51f4a
1 parent 95e1f25
commit 6f51f4a
Show file tree

Hide file tree

Showing 16 changed files with 118 additions and 46 deletions.
diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION
@@ -1 +1 @@
-5.3.1
+5.4.0
diff --git a/api.ts b/api.ts
@@ -4,7 +4,7 @@
  * OpenAI API
  * APIs for sampling from and fine-tuning language models
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.0.3
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -32,25 +32,25 @@ export interface CreateAnswerRequest {
  * @type {string}
  * @memberof CreateAnswerRequest
  */
- 'model'?: string;
+ 'model': string;
  /**
  * Question to get answered.
  * @type {string}
  * @memberof CreateAnswerRequest
  */
- 'question'?: string;
+ 'question': string;
  /**
  * List of (question, answer) pairs that will help steer the model towards the tone and answer format you\'d like. We recommend adding 2 to 3 examples.
  * @type {Array<any>}
  * @memberof CreateAnswerRequest
  */
- 'examples'?: Array<any>;
+ 'examples': Array<any>;
  /**
  * A text snippet containing the contextual information used to generate the answers for the `examples` you provide.
  * @type {string}
  * @memberof CreateAnswerRequest
  */
- 'examples_context'?: string;
+ 'examples_context': string;
  /**
  * List of documents from which the answer for the input `question` should be derived. If this is an empty list, the question will be answered based on the question-answer examples. You should specify either `documents` or a `file`, but not both. 
  * @type {Array<string>}
@@ -129,6 +129,12 @@ export interface CreateAnswerRequest {
  * @memberof CreateAnswerRequest
  */
  'expand'?: Array<any> | null;
+ /**
+ * A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse. 
+ * @type {string}
+ * @memberof CreateAnswerRequest
+ */
+ 'user'?: string;
 }
 /**
  * 
@@ -203,13 +209,13 @@ export interface CreateClassificationRequest {
  * @type {string}
  * @memberof CreateClassificationRequest
  */
- 'model'?: string;
+ 'model': string;
  /**
  * Query to be classified.
  * @type {string}
  * @memberof CreateClassificationRequest
  */
- 'query'?: string;
+ 'query': string;
  /**
  * A list of examples with labels, in the following format: `[[\"The movie is so interesting.\", \"Positive\"], [\"It is quite boring.\", \"Negative\"], ...]` All the label strings will be normalized to be capitalized. You should specify either `examples` or `file`, but not both. 
  * @type {Array<any>}
@@ -276,6 +282,12 @@ export interface CreateClassificationRequest {
  * @memberof CreateClassificationRequest
  */
  'expand'?: Array<any> | null;
+ /**
+ * A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse. 
+ * @type {string}
+ * @memberof CreateClassificationRequest
+ */
+ 'user'?: string;
 }
 /**
  * 
@@ -429,6 +441,12 @@ export interface CreateCompletionFromModelRequest {
  * @memberof CreateCompletionFromModelRequest
  */
  'logit_bias'?: object | null;
+ /**
+ * A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse. 
+ * @type {string}
+ * @memberof CreateCompletionFromModelRequest
+ */
+ 'user'?: string;
  /**
  * ID of the model to use for completion.
  * @type {string}
@@ -533,6 +551,12 @@ export interface CreateCompletionRequest {
  * @memberof CreateCompletionRequest
  */
  'logit_bias'?: object | null;
+ /**
+ * A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse. 
+ * @type {string}
+ * @memberof CreateCompletionRequest
+ */
+ 'user'?: string;
 }
 /**
  * 
@@ -640,11 +664,17 @@ export interface CreateCompletionResponseLogprobs {
  */
 export interface CreateEmbeddingRequest {
  /**
- * 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. Each input must not exceed 2048 tokens in length. We suggest replacing newlines (`\\n`) in your input with a single space, as we have observed inferior results when newlines are present. 
+ * 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. Each input must not exceed 2048 tokens in length. Unless your are embedding code, we suggest replacing newlines (`\\n`) in your input with a single space, as we have observed inferior results when newlines are present. 
  * @type {string | Array<string> | Array<number> | Array<any>}
  * @memberof CreateEmbeddingRequest
  */
- 'input'?: string | Array<string> | Array<number> | Array<any>;
+ 'input': string | Array<string> | Array<number> | Array<any>;
+ /**
+ * A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse. 
+ * @type {string}
+ * @memberof CreateEmbeddingRequest
+ */
+ 'user'?: string;
 }
 /**
  * 
@@ -707,7 +737,7 @@ export interface CreateFineTuneRequest {
  * @type {string}
  * @memberof CreateFineTuneRequest
  */
- 'training_file'?: string;
+ 'training_file': string;
  /**
  * The ID of an uploaded file that contains validation data. If you provide this file, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in the [fine-tuning results file](/docs/guides/fine-tuning/analyzing-your-fine-tuned-model). Your train and validation data should be mutually exclusive. Your dataset must be formatted as a JSONL file, where each validation example is a JSON object with the keys \"prompt\" and \"completion\". Additionally, you must upload your file with the purpose `fine-tune`. See the [fine-tuning guide](/docs/guides/fine-tuning/creating-training-data) for more details. 
  * @type {string}
@@ -775,6 +805,12 @@ export interface CreateFineTuneRequest {
  * @interface CreateSearchRequest
  */
 export interface CreateSearchRequest {
+ /**
+ * Query to search against the documents.
+ * @type {string}
+ * @memberof CreateSearchRequest
+ */
+ 'query': string;
  /**
  * Up to 200 documents to search over, provided as a list of strings. The maximum document length (in tokens) is 2034 minus the number of tokens in the query. You should specify either `documents` or a `file`, but not both. 
  * @type {Array<string>}
@@ -787,12 +823,6 @@ export interface CreateSearchRequest {
  * @memberof CreateSearchRequest
  */
  'file'?: string | null;
- /**
- * Query to search against the documents.
- * @type {string}
- * @memberof CreateSearchRequest
- */
- 'query'?: string;
  /**
  * The maximum number of documents to be re-ranked and returned by search. This flag only takes effect when `file` is set. 
  * @type {number}
@@ -805,6 +835,12 @@ export interface CreateSearchRequest {
  * @memberof CreateSearchRequest
  */
  'return_metadata'?: boolean | null;
+ /**
+ * A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse. 
+ * @type {string}
+ * @memberof CreateSearchRequest
+ */
+ 'user'?: string;
 }
 /**
  * 

diff --git a/base.ts b/base.ts
@@ -4,7 +4,7 @@
  * OpenAI API
  * APIs for sampling from and fine-tuning language models
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.0.3
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/common.ts b/common.ts
@@ -4,7 +4,7 @@
  * OpenAI API
  * APIs for sampling from and fine-tuning language models
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.0.3
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/configuration.ts b/configuration.ts
@@ -4,7 +4,7 @@
  * OpenAI API
  * APIs for sampling from and fine-tuning language models
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.0.3
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/dist/api.d.ts b/dist/api.d.ts
@@ -2,7 +2,7 @@
  * OpenAI API
  * APIs for sampling from and fine-tuning language models
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.0.3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -23,25 +23,25 @@ export interface CreateAnswerRequest {
  * @type {string}
  * @memberof CreateAnswerRequest
  */
- 'model'?: string;
+ 'model': string;
  /**
  * Question to get answered.
  * @type {string}
  * @memberof CreateAnswerRequest
  */
- 'question'?: string;
+ 'question': string;
  /**
  * List of (question, answer) pairs that will help steer the model towards the tone and answer format you\'d like. We recommend adding 2 to 3 examples.
  * @type {Array<any>}
  * @memberof CreateAnswerRequest
  */
- 'examples'?: Array<any>;
+ 'examples': Array<any>;
  /**
  * A text snippet containing the contextual information used to generate the answers for the `examples` you provide.
  * @type {string}
  * @memberof CreateAnswerRequest
  */
- 'examples_context'?: string;
+ 'examples_context': string;
  /**
  * List of documents from which the answer for the input `question` should be derived. If this is an empty list, the question will be answered based on the question-answer examples. You should specify either `documents` or a `file`, but not both.
  * @type {Array<string>}
@@ -120,6 +120,12 @@ export interface CreateAnswerRequest {
  * @memberof CreateAnswerRequest
  */
  'expand'?: Array<any> | null;
+ /**
+ * A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse.
+ * @type {string}
+ * @memberof CreateAnswerRequest
+ */
+ 'user'?: string;
 }
 /**
  *
@@ -194,13 +200,13 @@ export interface CreateClassificationRequest {
  * @type {string}
  * @memberof CreateClassificationRequest
  */
- 'model'?: string;
+ 'model': string;
  /**
  * Query to be classified.
  * @type {string}
  * @memberof CreateClassificationRequest
  */
- 'query'?: string;
+ 'query': string;
  /**
  * A list of examples with labels, in the following format: `[[\"The movie is so interesting.\", \"Positive\"], [\"It is quite boring.\", \"Negative\"], ...]` All the label strings will be normalized to be capitalized. You should specify either `examples` or `file`, but not both.
  * @type {Array<any>}
@@ -267,6 +273,12 @@ export interface CreateClassificationRequest {
  * @memberof CreateClassificationRequest
  */
  'expand'?: Array<any> | null;
+ /**
+ * A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse.
+ * @type {string}
+ * @memberof CreateClassificationRequest
+ */
+ 'user'?: string;
 }
 /**
  *
@@ -420,6 +432,12 @@ export interface CreateCompletionFromModelRequest {
  * @memberof CreateCompletionFromModelRequest
  */
  'logit_bias'?: object | null;
+ /**
+ * A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse.
+ * @type {string}
+ * @memberof CreateCompletionFromModelRequest
+ */
+ 'user'?: string;
  /**
  * ID of the model to use for completion.
  * @type {string}
@@ -524,6 +542,12 @@ export interface CreateCompletionRequest {
  * @memberof CreateCompletionRequest
  */
  'logit_bias'?: object | null;
+ /**
+ * A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse.
+ * @type {string}
+ * @memberof CreateCompletionRequest
+ */
+ 'user'?: string;
 }
 /**
  *
@@ -631,11 +655,17 @@ export interface CreateCompletionResponseLogprobs {
  */
 export interface CreateEmbeddingRequest {
  /**
- * 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. Each input must not exceed 2048 tokens in length. We suggest replacing newlines (`\\n`) in your input with a single space, as we have observed inferior results when newlines are present.
+ * 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. Each input must not exceed 2048 tokens in length. Unless your are embedding code, we suggest replacing newlines (`\\n`) in your input with a single space, as we have observed inferior results when newlines are present.
  * @type {string | Array<string> | Array<number> | Array<any>}
  * @memberof CreateEmbeddingRequest
  */
- 'input'?: string | Array<string> | Array<number> | Array<any>;
+ 'input': string | Array<string> | Array<number> | Array<any>;
+ /**
+ * A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse.
+ * @type {string}
+ * @memberof CreateEmbeddingRequest
+ */
+ 'user'?: string;
 }
 /**
  *
@@ -698,7 +728,7 @@ export interface CreateFineTuneRequest {
  * @type {string}
  * @memberof CreateFineTuneRequest
  */
- 'training_file'?: string;
+ 'training_file': string;
  /**
  * The ID of an uploaded file that contains validation data. If you provide this file, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in the [fine-tuning results file](/docs/guides/fine-tuning/analyzing-your-fine-tuned-model). Your train and validation data should be mutually exclusive. Your dataset must be formatted as a JSONL file, where each validation example is a JSON object with the keys \"prompt\" and \"completion\". Additionally, you must upload your file with the purpose `fine-tune`. See the [fine-tuning guide](/docs/guides/fine-tuning/creating-training-data) for more details.
  * @type {string}
@@ -766,6 +796,12 @@ export interface CreateFineTuneRequest {
  * @interface CreateSearchRequest
  */
 export interface CreateSearchRequest {
+ /**
+ * Query to search against the documents.
+ * @type {string}
+ * @memberof CreateSearchRequest
+ */
+ 'query': string;
  /**
  * Up to 200 documents to search over, provided as a list of strings. The maximum document length (in tokens) is 2034 minus the number of tokens in the query. You should specify either `documents` or a `file`, but not both.
  * @type {Array<string>}
@@ -778,12 +814,6 @@ export interface CreateSearchRequest {
  * @memberof CreateSearchRequest
  */
  'file'?: string | null;
- /**
- * Query to search against the documents.
- * @type {string}
- * @memberof CreateSearchRequest
- */
- 'query'?: string;
  /**
  * The maximum number of documents to be re-ranked and returned by search. This flag only takes effect when `file` is set.
  * @type {number}
@@ -796,6 +826,12 @@ export interface CreateSearchRequest {
  * @memberof CreateSearchRequest
  */
  'return_metadata'?: boolean | null;
+ /**
+ * A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse.
+ * @type {string}
+ * @memberof CreateSearchRequest
+ */
+ 'user'?: string;
 }
 /**
  *

diff --git a/dist/api.js b/dist/api.js
@@ -5,7 +5,7 @@
  * OpenAI API
  * APIs for sampling from and fine-tuning language models
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.0.3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

diff --git a/dist/base.d.ts b/dist/base.d.ts
@@ -2,7 +2,7 @@
  * OpenAI API
  * APIs for sampling from and fine-tuning language models
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.0.3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).