|
2 | 2 | * OpenAI API
|
3 | 3 | * APIs for sampling from and fine-tuning language models
|
4 | 4 | *
|
5 |
| - * The version of the OpenAPI document: 1.0.3 |
| 5 | + * The version of the OpenAPI document: 1.0.4 |
6 | 6 | *
|
7 | 7 | *
|
8 | 8 | * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
@@ -361,7 +361,13 @@ export interface CreateCompletionFromModelRequest {
|
361 | 361 | */
|
362 | 362 | 'prompt'?: string | Array<string> | Array<number> | Array<any> | null;
|
363 | 363 | /**
|
364 |
| - * The maximum number of [tokens](/tokenizer) to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model\'s context length. Most models have a context length of 2048 tokens (except `code-davinci-001`, which supports 4096). |
| 364 | + * The suffix that comes after a completion of inserted text, encoded as a string or array of strings. |
| 365 | + * @type {string | Array<string>} |
| 366 | + * @memberof CreateCompletionFromModelRequest |
| 367 | + */ |
| 368 | + 'suffix'?: string | Array<string> | null; |
| 369 | + /** |
| 370 | + * The maximum number of [tokens](/tokenizer) to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model\'s context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096). |
365 | 371 | * @type {number}
|
366 | 372 | * @memberof CreateCompletionFromModelRequest
|
367 | 373 | */
|
@@ -471,7 +477,13 @@ export interface CreateCompletionRequest {
|
471 | 477 | */
|
472 | 478 | 'prompt'?: string | Array<string> | Array<number> | Array<any> | null;
|
473 | 479 | /**
|
474 |
| - * The maximum number of [tokens](/tokenizer) to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model\'s context length. Most models have a context length of 2048 tokens (except `code-davinci-001`, which supports 4096). |
| 480 | + * The suffix that comes after a completion of inserted text, encoded as a string or array of strings. |
| 481 | + * @type {string | Array<string>} |
| 482 | + * @memberof CreateCompletionRequest |
| 483 | + */ |
| 484 | + 'suffix'?: string | Array<string> | null; |
| 485 | + /** |
| 486 | + * The maximum number of [tokens](/tokenizer) to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model\'s context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096). |
475 | 487 | * @type {number}
|
476 | 488 | * @memberof CreateCompletionRequest
|
477 | 489 | */
|
@@ -648,6 +660,74 @@ export interface CreateCompletionResponseLogprobs {
|
648 | 660 | */
|
649 | 661 | 'text_offset'?: Array<number>;
|
650 | 662 | }
|
| 663 | +/** |
| 664 | + * |
| 665 | + * @export |
| 666 | + * @interface CreateEditRequest |
| 667 | + */ |
| 668 | +export interface CreateEditRequest { |
| 669 | + /** |
| 670 | + * The input text to use as a starting point for the edit. |
| 671 | + * @type {string} |
| 672 | + * @memberof CreateEditRequest |
| 673 | + */ |
| 674 | + 'input'?: string | null; |
| 675 | + /** |
| 676 | + * The instruction that tells the model how to edit the prompt. |
| 677 | + * @type {string} |
| 678 | + * @memberof CreateEditRequest |
| 679 | + */ |
| 680 | + 'instruction': string; |
| 681 | + /** |
| 682 | + * What [sampling temperature](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277) 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 `top_p` but not both. |
| 683 | + * @type {number} |
| 684 | + * @memberof CreateEditRequest |
| 685 | + */ |
| 686 | + 'temperature'?: number | null; |
| 687 | + /** |
| 688 | + * 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 `temperature` but not both. |
| 689 | + * @type {number} |
| 690 | + * @memberof CreateEditRequest |
| 691 | + */ |
| 692 | + 'top_p'?: number | null; |
| 693 | +} |
| 694 | +/** |
| 695 | + * |
| 696 | + * @export |
| 697 | + * @interface CreateEditResponse |
| 698 | + */ |
| 699 | +export interface CreateEditResponse { |
| 700 | + /** |
| 701 | + * |
| 702 | + * @type {string} |
| 703 | + * @memberof CreateEditResponse |
| 704 | + */ |
| 705 | + 'id'?: string; |
| 706 | + /** |
| 707 | + * |
| 708 | + * @type {string} |
| 709 | + * @memberof CreateEditResponse |
| 710 | + */ |
| 711 | + 'object'?: string; |
| 712 | + /** |
| 713 | + * |
| 714 | + * @type {number} |
| 715 | + * @memberof CreateEditResponse |
| 716 | + */ |
| 717 | + 'created'?: number; |
| 718 | + /** |
| 719 | + * |
| 720 | + * @type {string} |
| 721 | + * @memberof CreateEditResponse |
| 722 | + */ |
| 723 | + 'model'?: string; |
| 724 | + /** |
| 725 | + * |
| 726 | + * @type {Array<CreateCompletionResponseChoices>} |
| 727 | + * @memberof CreateEditResponse |
| 728 | + */ |
| 729 | + 'choices'?: Array<CreateCompletionResponseChoices>; |
| 730 | +} |
651 | 731 | /**
|
652 | 732 | *
|
653 | 733 | * @export
|
@@ -789,6 +869,12 @@ export interface CreateFineTuneRequest {
|
789 | 869 | * @memberof CreateFineTuneRequest
|
790 | 870 | */
|
791 | 871 | 'classification_betas'?: Array<number> | null;
|
| 872 | + /** |
| 873 | + * A string of up to 40 characters that will be added to your fine-tuned model name. For example, a `suffix` of \"custom-model-name\" would produce a model name like `ada:ft-your-org:custom-model-name-2022-02-15-04-21-04`. |
| 874 | + * @type {string} |
| 875 | + * @memberof CreateFineTuneRequest |
| 876 | + */ |
| 877 | + 'suffix'?: string | null; |
792 | 878 | }
|
793 | 879 | /**
|
794 | 880 | *
|
@@ -908,6 +994,31 @@ export interface DeleteFileResponse {
|
908 | 994 | */
|
909 | 995 | 'deleted'?: boolean;
|
910 | 996 | }
|
| 997 | +/** |
| 998 | + * |
| 999 | + * @export |
| 1000 | + * @interface DeleteModelResponse |
| 1001 | + */ |
| 1002 | +export interface DeleteModelResponse { |
| 1003 | + /** |
| 1004 | + * |
| 1005 | + * @type {string} |
| 1006 | + * @memberof DeleteModelResponse |
| 1007 | + */ |
| 1008 | + 'id'?: string; |
| 1009 | + /** |
| 1010 | + * |
| 1011 | + * @type {string} |
| 1012 | + * @memberof DeleteModelResponse |
| 1013 | + */ |
| 1014 | + 'object'?: string; |
| 1015 | + /** |
| 1016 | + * |
| 1017 | + * @type {boolean} |
| 1018 | + * @memberof DeleteModelResponse |
| 1019 | + */ |
| 1020 | + 'deleted'?: boolean; |
| 1021 | +} |
911 | 1022 | /**
|
912 | 1023 | *
|
913 | 1024 | * @export
|
@@ -1232,6 +1343,15 @@ export declare const OpenAIApiAxiosParamCreator: (configuration?: Configuration)
|
1232 | 1343 | * @throws {RequiredError}
|
1233 | 1344 | */
|
1234 | 1345 | createCompletionFromModel: (createCompletionFromModelRequest: CreateCompletionFromModelRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
| 1346 | + /** |
| 1347 | + * |
| 1348 | + * @summary Creates a new edit for the provided input, instruction, and parameters |
| 1349 | + * @param {string} engineId The ID of the engine to use for this request |
| 1350 | + * @param {CreateEditRequest} createEditRequest |
| 1351 | + * @param {*} [options] Override http request option. |
| 1352 | + * @throws {RequiredError} |
| 1353 | + */ |
| 1354 | + createEdit: (engineId: string, createEditRequest: CreateEditRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>; |
1235 | 1355 | /**
|
1236 | 1356 | *
|
1237 | 1357 | * @summary Creates an embedding vector representing the input text.
|
@@ -1275,6 +1395,14 @@ export declare const OpenAIApiAxiosParamCreator: (configuration?: Configuration)
|
1275 | 1395 | * @throws {RequiredError}
|
1276 | 1396 | */
|
1277 | 1397 | deleteFile: (fileId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
| 1398 | + /** |
| 1399 | + * |
| 1400 | + * @summary Delete a fine-tuned model. You must have the Owner role in your organization. |
| 1401 | + * @param {string} model The model to delete |
| 1402 | + * @param {*} [options] Override http request option. |
| 1403 | + * @throws {RequiredError} |
| 1404 | + */ |
| 1405 | + deleteModel: (model: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; |
1278 | 1406 | /**
|
1279 | 1407 | *
|
1280 | 1408 | * @summary Returns the contents of the specified file
|
@@ -1384,6 +1512,15 @@ export declare const OpenAIApiFp: (configuration?: Configuration) => {
|
1384 | 1512 | * @throws {RequiredError}
|
1385 | 1513 | */
|
1386 | 1514 | createCompletionFromModel(createCompletionFromModelRequest: CreateCompletionFromModelRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCompletionResponse>>;
|
| 1515 | + /** |
| 1516 | + * |
| 1517 | + * @summary Creates a new edit for the provided input, instruction, and parameters |
| 1518 | + * @param {string} engineId The ID of the engine to use for this request |
| 1519 | + * @param {CreateEditRequest} createEditRequest |
| 1520 | + * @param {*} [options] Override http request option. |
| 1521 | + * @throws {RequiredError} |
| 1522 | + */ |
| 1523 | + createEdit(engineId: string, createEditRequest: CreateEditRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEditResponse>>; |
1387 | 1524 | /**
|
1388 | 1525 | *
|
1389 | 1526 | * @summary Creates an embedding vector representing the input text.
|
@@ -1427,6 +1564,14 @@ export declare const OpenAIApiFp: (configuration?: Configuration) => {
|
1427 | 1564 | * @throws {RequiredError}
|
1428 | 1565 | */
|
1429 | 1566 | deleteFile(fileId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteFileResponse>>;
|
| 1567 | + /** |
| 1568 | + * |
| 1569 | + * @summary Delete a fine-tuned model. You must have the Owner role in your organization. |
| 1570 | + * @param {string} model The model to delete |
| 1571 | + * @param {*} [options] Override http request option. |
| 1572 | + * @throws {RequiredError} |
| 1573 | + */ |
| 1574 | + deleteModel(model: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteModelResponse>>; |
1430 | 1575 | /**
|
1431 | 1576 | *
|
1432 | 1577 | * @summary Returns the contents of the specified file
|
@@ -1536,6 +1681,15 @@ export declare const OpenAIApiFactory: (configuration?: Configuration, basePath?
|
1536 | 1681 | * @throws {RequiredError}
|
1537 | 1682 | */
|
1538 | 1683 | createCompletionFromModel(createCompletionFromModelRequest: CreateCompletionFromModelRequest, options?: any): AxiosPromise<CreateCompletionResponse>;
|
| 1684 | + /** |
| 1685 | + * |
| 1686 | + * @summary Creates a new edit for the provided input, instruction, and parameters |
| 1687 | + * @param {string} engineId The ID of the engine to use for this request |
| 1688 | + * @param {CreateEditRequest} createEditRequest |
| 1689 | + * @param {*} [options] Override http request option. |
| 1690 | + * @throws {RequiredError} |
| 1691 | + */ |
| 1692 | + createEdit(engineId: string, createEditRequest: CreateEditRequest, options?: any): AxiosPromise<CreateEditResponse>; |
1539 | 1693 | /**
|
1540 | 1694 | *
|
1541 | 1695 | * @summary Creates an embedding vector representing the input text.
|
@@ -1579,6 +1733,14 @@ export declare const OpenAIApiFactory: (configuration?: Configuration, basePath?
|
1579 | 1733 | * @throws {RequiredError}
|
1580 | 1734 | */
|
1581 | 1735 | deleteFile(fileId: string, options?: any): AxiosPromise<DeleteFileResponse>;
|
| 1736 | + /** |
| 1737 | + * |
| 1738 | + * @summary Delete a fine-tuned model. You must have the Owner role in your organization. |
| 1739 | + * @param {string} model The model to delete |
| 1740 | + * @param {*} [options] Override http request option. |
| 1741 | + * @throws {RequiredError} |
| 1742 | + */ |
| 1743 | + deleteModel(model: string, options?: any): AxiosPromise<DeleteModelResponse>; |
1582 | 1744 | /**
|
1583 | 1745 | *
|
1584 | 1746 | * @summary Returns the contents of the specified file
|
@@ -1695,6 +1857,16 @@ export declare class OpenAIApi extends BaseAPI {
|
1695 | 1857 | * @memberof OpenAIApi
|
1696 | 1858 | */
|
1697 | 1859 | createCompletionFromModel(createCompletionFromModelRequest: CreateCompletionFromModelRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCompletionResponse, any>>;
|
| 1860 | + /** |
| 1861 | + * |
| 1862 | + * @summary Creates a new edit for the provided input, instruction, and parameters |
| 1863 | + * @param {string} engineId The ID of the engine to use for this request |
| 1864 | + * @param {CreateEditRequest} createEditRequest |
| 1865 | + * @param {*} [options] Override http request option. |
| 1866 | + * @throws {RequiredError} |
| 1867 | + * @memberof OpenAIApi |
| 1868 | + */ |
| 1869 | + createEdit(engineId: string, createEditRequest: CreateEditRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateEditResponse, any>>; |
1698 | 1870 | /**
|
1699 | 1871 | *
|
1700 | 1872 | * @summary Creates an embedding vector representing the input text.
|
@@ -1743,6 +1915,15 @@ export declare class OpenAIApi extends BaseAPI {
|
1743 | 1915 | * @memberof OpenAIApi
|
1744 | 1916 | */
|
1745 | 1917 | deleteFile(fileId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteFileResponse, any>>;
|
| 1918 | + /** |
| 1919 | + * |
| 1920 | + * @summary Delete a fine-tuned model. You must have the Owner role in your organization. |
| 1921 | + * @param {string} model The model to delete |
| 1922 | + * @param {*} [options] Override http request option. |
| 1923 | + * @throws {RequiredError} |
| 1924 | + * @memberof OpenAIApi |
| 1925 | + */ |
| 1926 | + deleteModel(model: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteModelResponse, any>>; |
1746 | 1927 | /**
|
1747 | 1928 | *
|
1748 | 1929 | * @summary Returns the contents of the specified file
|
|
0 commit comments