Skip to content

Commit 6f51f4a

Browse files
committed
spec 1.0.3 + build
1 parent 95e1f25 commit 6f51f4a

File tree

16 files changed

+118
-46
lines changed

16 files changed

+118
-46
lines changed

.openapi-generator/VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
5.3.1
1+
5.4.0

api.ts

Lines changed: 52 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* OpenAI API
55
* APIs for sampling from and fine-tuning language models
66
*
7-
* The version of the OpenAPI document: 1.0.0
7+
* The version of the OpenAPI document: 1.0.3
88
*
99
*
1010
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -32,25 +32,25 @@ export interface CreateAnswerRequest {
3232
* @type {string}
3333
* @memberof CreateAnswerRequest
3434
*/
35-
'model'?: string;
35+
'model': string;
3636
/**
3737
* Question to get answered.
3838
* @type {string}
3939
* @memberof CreateAnswerRequest
4040
*/
41-
'question'?: string;
41+
'question': string;
4242
/**
4343
* 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.
4444
* @type {Array<any>}
4545
* @memberof CreateAnswerRequest
4646
*/
47-
'examples'?: Array<any>;
47+
'examples': Array<any>;
4848
/**
4949
* A text snippet containing the contextual information used to generate the answers for the `examples` you provide.
5050
* @type {string}
5151
* @memberof CreateAnswerRequest
5252
*/
53-
'examples_context'?: string;
53+
'examples_context': string;
5454
/**
5555
* 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.
5656
* @type {Array<string>}
@@ -129,6 +129,12 @@ export interface CreateAnswerRequest {
129129
* @memberof CreateAnswerRequest
130130
*/
131131
'expand'?: Array<any> | null;
132+
/**
133+
* A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse.
134+
* @type {string}
135+
* @memberof CreateAnswerRequest
136+
*/
137+
'user'?: string;
132138
}
133139
/**
134140
*
@@ -203,13 +209,13 @@ export interface CreateClassificationRequest {
203209
* @type {string}
204210
* @memberof CreateClassificationRequest
205211
*/
206-
'model'?: string;
212+
'model': string;
207213
/**
208214
* Query to be classified.
209215
* @type {string}
210216
* @memberof CreateClassificationRequest
211217
*/
212-
'query'?: string;
218+
'query': string;
213219
/**
214220
* 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.
215221
* @type {Array<any>}
@@ -276,6 +282,12 @@ export interface CreateClassificationRequest {
276282
* @memberof CreateClassificationRequest
277283
*/
278284
'expand'?: Array<any> | null;
285+
/**
286+
* A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse.
287+
* @type {string}
288+
* @memberof CreateClassificationRequest
289+
*/
290+
'user'?: string;
279291
}
280292
/**
281293
*
@@ -429,6 +441,12 @@ export interface CreateCompletionFromModelRequest {
429441
* @memberof CreateCompletionFromModelRequest
430442
*/
431443
'logit_bias'?: object | null;
444+
/**
445+
* A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse.
446+
* @type {string}
447+
* @memberof CreateCompletionFromModelRequest
448+
*/
449+
'user'?: string;
432450
/**
433451
* ID of the model to use for completion.
434452
* @type {string}
@@ -533,6 +551,12 @@ export interface CreateCompletionRequest {
533551
* @memberof CreateCompletionRequest
534552
*/
535553
'logit_bias'?: object | null;
554+
/**
555+
* A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse.
556+
* @type {string}
557+
* @memberof CreateCompletionRequest
558+
*/
559+
'user'?: string;
536560
}
537561
/**
538562
*
@@ -640,11 +664,17 @@ export interface CreateCompletionResponseLogprobs {
640664
*/
641665
export interface CreateEmbeddingRequest {
642666
/**
643-
* 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.
667+
* 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.
644668
* @type {string | Array<string> | Array<number> | Array<any>}
645669
* @memberof CreateEmbeddingRequest
646670
*/
647-
'input'?: string | Array<string> | Array<number> | Array<any>;
671+
'input': string | Array<string> | Array<number> | Array<any>;
672+
/**
673+
* A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse.
674+
* @type {string}
675+
* @memberof CreateEmbeddingRequest
676+
*/
677+
'user'?: string;
648678
}
649679
/**
650680
*
@@ -707,7 +737,7 @@ export interface CreateFineTuneRequest {
707737
* @type {string}
708738
* @memberof CreateFineTuneRequest
709739
*/
710-
'training_file'?: string;
740+
'training_file': string;
711741
/**
712742
* 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.
713743
* @type {string}
@@ -775,6 +805,12 @@ export interface CreateFineTuneRequest {
775805
* @interface CreateSearchRequest
776806
*/
777807
export interface CreateSearchRequest {
808+
/**
809+
* Query to search against the documents.
810+
* @type {string}
811+
* @memberof CreateSearchRequest
812+
*/
813+
'query': string;
778814
/**
779815
* 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.
780816
* @type {Array<string>}
@@ -787,12 +823,6 @@ export interface CreateSearchRequest {
787823
* @memberof CreateSearchRequest
788824
*/
789825
'file'?: string | null;
790-
/**
791-
* Query to search against the documents.
792-
* @type {string}
793-
* @memberof CreateSearchRequest
794-
*/
795-
'query'?: string;
796826
/**
797827
* The maximum number of documents to be re-ranked and returned by search. This flag only takes effect when `file` is set.
798828
* @type {number}
@@ -805,6 +835,12 @@ export interface CreateSearchRequest {
805835
* @memberof CreateSearchRequest
806836
*/
807837
'return_metadata'?: boolean | null;
838+
/**
839+
* A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse.
840+
* @type {string}
841+
* @memberof CreateSearchRequest
842+
*/
843+
'user'?: string;
808844
}
809845
/**
810846
*

base.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* OpenAI API
55
* APIs for sampling from and fine-tuning language models
66
*
7-
* The version of the OpenAPI document: 1.0.0
7+
* The version of the OpenAPI document: 1.0.3
88
*
99
*
1010
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

common.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* OpenAI API
55
* APIs for sampling from and fine-tuning language models
66
*
7-
* The version of the OpenAPI document: 1.0.0
7+
* The version of the OpenAPI document: 1.0.3
88
*
99
*
1010
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

configuration.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* OpenAI API
55
* APIs for sampling from and fine-tuning language models
66
*
7-
* The version of the OpenAPI document: 1.0.0
7+
* The version of the OpenAPI document: 1.0.3
88
*
99
*
1010
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

dist/api.d.ts

Lines changed: 52 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* OpenAI API
33
* APIs for sampling from and fine-tuning language models
44
*
5-
* The version of the OpenAPI document: 1.0.0
5+
* The version of the OpenAPI document: 1.0.3
66
*
77
*
88
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -23,25 +23,25 @@ export interface CreateAnswerRequest {
2323
* @type {string}
2424
* @memberof CreateAnswerRequest
2525
*/
26-
'model'?: string;
26+
'model': string;
2727
/**
2828
* Question to get answered.
2929
* @type {string}
3030
* @memberof CreateAnswerRequest
3131
*/
32-
'question'?: string;
32+
'question': string;
3333
/**
3434
* 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.
3535
* @type {Array<any>}
3636
* @memberof CreateAnswerRequest
3737
*/
38-
'examples'?: Array<any>;
38+
'examples': Array<any>;
3939
/**
4040
* A text snippet containing the contextual information used to generate the answers for the `examples` you provide.
4141
* @type {string}
4242
* @memberof CreateAnswerRequest
4343
*/
44-
'examples_context'?: string;
44+
'examples_context': string;
4545
/**
4646
* 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.
4747
* @type {Array<string>}
@@ -120,6 +120,12 @@ export interface CreateAnswerRequest {
120120
* @memberof CreateAnswerRequest
121121
*/
122122
'expand'?: Array<any> | null;
123+
/**
124+
* A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse.
125+
* @type {string}
126+
* @memberof CreateAnswerRequest
127+
*/
128+
'user'?: string;
123129
}
124130
/**
125131
*
@@ -194,13 +200,13 @@ export interface CreateClassificationRequest {
194200
* @type {string}
195201
* @memberof CreateClassificationRequest
196202
*/
197-
'model'?: string;
203+
'model': string;
198204
/**
199205
* Query to be classified.
200206
* @type {string}
201207
* @memberof CreateClassificationRequest
202208
*/
203-
'query'?: string;
209+
'query': string;
204210
/**
205211
* 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.
206212
* @type {Array<any>}
@@ -267,6 +273,12 @@ export interface CreateClassificationRequest {
267273
* @memberof CreateClassificationRequest
268274
*/
269275
'expand'?: Array<any> | null;
276+
/**
277+
* A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse.
278+
* @type {string}
279+
* @memberof CreateClassificationRequest
280+
*/
281+
'user'?: string;
270282
}
271283
/**
272284
*
@@ -420,6 +432,12 @@ export interface CreateCompletionFromModelRequest {
420432
* @memberof CreateCompletionFromModelRequest
421433
*/
422434
'logit_bias'?: object | null;
435+
/**
436+
* A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse.
437+
* @type {string}
438+
* @memberof CreateCompletionFromModelRequest
439+
*/
440+
'user'?: string;
423441
/**
424442
* ID of the model to use for completion.
425443
* @type {string}
@@ -524,6 +542,12 @@ export interface CreateCompletionRequest {
524542
* @memberof CreateCompletionRequest
525543
*/
526544
'logit_bias'?: object | null;
545+
/**
546+
* A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse.
547+
* @type {string}
548+
* @memberof CreateCompletionRequest
549+
*/
550+
'user'?: string;
527551
}
528552
/**
529553
*
@@ -631,11 +655,17 @@ export interface CreateCompletionResponseLogprobs {
631655
*/
632656
export interface CreateEmbeddingRequest {
633657
/**
634-
* 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.
658+
* 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.
635659
* @type {string | Array<string> | Array<number> | Array<any>}
636660
* @memberof CreateEmbeddingRequest
637661
*/
638-
'input'?: string | Array<string> | Array<number> | Array<any>;
662+
'input': string | Array<string> | Array<number> | Array<any>;
663+
/**
664+
* A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse.
665+
* @type {string}
666+
* @memberof CreateEmbeddingRequest
667+
*/
668+
'user'?: string;
639669
}
640670
/**
641671
*
@@ -698,7 +728,7 @@ export interface CreateFineTuneRequest {
698728
* @type {string}
699729
* @memberof CreateFineTuneRequest
700730
*/
701-
'training_file'?: string;
731+
'training_file': string;
702732
/**
703733
* 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.
704734
* @type {string}
@@ -766,6 +796,12 @@ export interface CreateFineTuneRequest {
766796
* @interface CreateSearchRequest
767797
*/
768798
export interface CreateSearchRequest {
799+
/**
800+
* Query to search against the documents.
801+
* @type {string}
802+
* @memberof CreateSearchRequest
803+
*/
804+
'query': string;
769805
/**
770806
* 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.
771807
* @type {Array<string>}
@@ -778,12 +814,6 @@ export interface CreateSearchRequest {
778814
* @memberof CreateSearchRequest
779815
*/
780816
'file'?: string | null;
781-
/**
782-
* Query to search against the documents.
783-
* @type {string}
784-
* @memberof CreateSearchRequest
785-
*/
786-
'query'?: string;
787817
/**
788818
* The maximum number of documents to be re-ranked and returned by search. This flag only takes effect when `file` is set.
789819
* @type {number}
@@ -796,6 +826,12 @@ export interface CreateSearchRequest {
796826
* @memberof CreateSearchRequest
797827
*/
798828
'return_metadata'?: boolean | null;
829+
/**
830+
* A unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse.
831+
* @type {string}
832+
* @memberof CreateSearchRequest
833+
*/
834+
'user'?: string;
799835
}
800836
/**
801837
*

dist/api.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
* OpenAI API
66
* APIs for sampling from and fine-tuning language models
77
*
8-
* The version of the OpenAPI document: 1.0.0
8+
* The version of the OpenAPI document: 1.0.3
99
*
1010
*
1111
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

dist/base.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* OpenAI API
33
* APIs for sampling from and fine-tuning language models
44
*
5-
* The version of the OpenAPI document: 1.0.0
5+
* The version of the OpenAPI document: 1.0.3
66
*
77
*
88
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

0 commit comments

Comments
 (0)