openai 3.0.0 → 3.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/VERSION +1 -1
- package/api.ts +381 -76
- package/base.ts +1 -1
- package/common.ts +23 -13
- package/configuration.ts +1 -1
- package/dist/api.d.ts +344 -76
- package/dist/api.js +69 -5
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +20 -14
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
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.
|
|
5
|
+
* The version of the OpenAPI document: 1.0.6
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -73,7 +73,7 @@ export interface CreateAnswerRequest {
|
|
|
73
73
|
*/
|
|
74
74
|
'temperature'?: number | null;
|
|
75
75
|
/**
|
|
76
|
-
* Include the log probabilities on the `logprobs` most likely tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response. The maximum value for `logprobs` is 5. If you need more than this, please contact
|
|
76
|
+
* Include the log probabilities on the `logprobs` most likely tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response. The maximum value for `logprobs` is 5. If you need more than this, please contact us through our [Help center](https://help.openai.com) and describe your use case. When `logprobs` is set, `completion` will be automatically added into `expand` to get the logprobs.
|
|
77
77
|
* @type {number}
|
|
78
78
|
* @memberof CreateAnswerRequest
|
|
79
79
|
*/
|
|
@@ -244,7 +244,7 @@ export interface CreateClassificationRequest {
|
|
|
244
244
|
*/
|
|
245
245
|
'temperature'?: number | null;
|
|
246
246
|
/**
|
|
247
|
-
* Include the log probabilities on the `logprobs` most likely tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response. The maximum value for `logprobs` is 5. If you need more than this, please contact
|
|
247
|
+
* Include the log probabilities on the `logprobs` most likely tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response. The maximum value for `logprobs` is 5. If you need more than this, please contact us through our [Help center](https://help.openai.com) and describe your use case. When `logprobs` is set, `completion` will be automatically added into `expand` to get the logprobs.
|
|
248
248
|
* @type {number}
|
|
249
249
|
* @memberof CreateClassificationRequest
|
|
250
250
|
*/
|
|
@@ -409,7 +409,7 @@ export interface CreateCompletionRequest {
|
|
|
409
409
|
*/
|
|
410
410
|
'stream'?: boolean | null;
|
|
411
411
|
/**
|
|
412
|
-
* Include the log probabilities on the `logprobs` most likely tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response. The maximum value for `logprobs` is 5. If you need more than this, please contact
|
|
412
|
+
* Include the log probabilities on the `logprobs` most likely tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response. The maximum value for `logprobs` is 5. If you need more than this, please contact us through our [Help center](https://help.openai.com) and describe your use case.
|
|
413
413
|
* @type {number}
|
|
414
414
|
* @memberof CreateCompletionRequest
|
|
415
415
|
*/
|
|
@@ -480,31 +480,37 @@ export interface CreateCompletionResponse {
|
|
|
480
480
|
* @type {string}
|
|
481
481
|
* @memberof CreateCompletionResponse
|
|
482
482
|
*/
|
|
483
|
-
'id'
|
|
483
|
+
'id': string;
|
|
484
484
|
/**
|
|
485
485
|
*
|
|
486
486
|
* @type {string}
|
|
487
487
|
* @memberof CreateCompletionResponse
|
|
488
488
|
*/
|
|
489
|
-
'object'
|
|
489
|
+
'object': string;
|
|
490
490
|
/**
|
|
491
491
|
*
|
|
492
492
|
* @type {number}
|
|
493
493
|
* @memberof CreateCompletionResponse
|
|
494
494
|
*/
|
|
495
|
-
'created'
|
|
495
|
+
'created': number;
|
|
496
496
|
/**
|
|
497
497
|
*
|
|
498
498
|
* @type {string}
|
|
499
499
|
* @memberof CreateCompletionResponse
|
|
500
500
|
*/
|
|
501
|
-
'model'
|
|
501
|
+
'model': string;
|
|
502
502
|
/**
|
|
503
503
|
*
|
|
504
504
|
* @type {Array<CreateCompletionResponseChoicesInner>}
|
|
505
505
|
* @memberof CreateCompletionResponse
|
|
506
506
|
*/
|
|
507
|
-
'choices'
|
|
507
|
+
'choices': Array<CreateCompletionResponseChoicesInner>;
|
|
508
|
+
/**
|
|
509
|
+
*
|
|
510
|
+
* @type {CreateCompletionResponseUsage}
|
|
511
|
+
* @memberof CreateCompletionResponse
|
|
512
|
+
*/
|
|
513
|
+
'usage'?: CreateCompletionResponseUsage;
|
|
508
514
|
}
|
|
509
515
|
/**
|
|
510
516
|
*
|
|
@@ -568,6 +574,31 @@ export interface CreateCompletionResponseChoicesInnerLogprobs {
|
|
|
568
574
|
*/
|
|
569
575
|
'text_offset'?: Array<number>;
|
|
570
576
|
}
|
|
577
|
+
/**
|
|
578
|
+
*
|
|
579
|
+
* @export
|
|
580
|
+
* @interface CreateCompletionResponseUsage
|
|
581
|
+
*/
|
|
582
|
+
export interface CreateCompletionResponseUsage {
|
|
583
|
+
/**
|
|
584
|
+
*
|
|
585
|
+
* @type {number}
|
|
586
|
+
* @memberof CreateCompletionResponseUsage
|
|
587
|
+
*/
|
|
588
|
+
'prompt_tokens': number;
|
|
589
|
+
/**
|
|
590
|
+
*
|
|
591
|
+
* @type {number}
|
|
592
|
+
* @memberof CreateCompletionResponseUsage
|
|
593
|
+
*/
|
|
594
|
+
'completion_tokens': number;
|
|
595
|
+
/**
|
|
596
|
+
*
|
|
597
|
+
* @type {number}
|
|
598
|
+
* @memberof CreateCompletionResponseUsage
|
|
599
|
+
*/
|
|
600
|
+
'total_tokens': number;
|
|
601
|
+
}
|
|
571
602
|
/**
|
|
572
603
|
*
|
|
573
604
|
* @export
|
|
@@ -622,31 +653,37 @@ export interface CreateEditResponse {
|
|
|
622
653
|
* @type {string}
|
|
623
654
|
* @memberof CreateEditResponse
|
|
624
655
|
*/
|
|
625
|
-
'id'
|
|
656
|
+
'id': string;
|
|
626
657
|
/**
|
|
627
658
|
*
|
|
628
659
|
* @type {string}
|
|
629
660
|
* @memberof CreateEditResponse
|
|
630
661
|
*/
|
|
631
|
-
'object'
|
|
662
|
+
'object': string;
|
|
632
663
|
/**
|
|
633
664
|
*
|
|
634
665
|
* @type {number}
|
|
635
666
|
* @memberof CreateEditResponse
|
|
636
667
|
*/
|
|
637
|
-
'created'
|
|
668
|
+
'created': number;
|
|
638
669
|
/**
|
|
639
670
|
*
|
|
640
671
|
* @type {string}
|
|
641
672
|
* @memberof CreateEditResponse
|
|
642
673
|
*/
|
|
643
|
-
'model'
|
|
674
|
+
'model': string;
|
|
644
675
|
/**
|
|
645
676
|
*
|
|
646
677
|
* @type {Array<CreateCompletionResponseChoicesInner>}
|
|
647
678
|
* @memberof CreateEditResponse
|
|
648
679
|
*/
|
|
649
|
-
'choices'
|
|
680
|
+
'choices': Array<CreateCompletionResponseChoicesInner>;
|
|
681
|
+
/**
|
|
682
|
+
*
|
|
683
|
+
* @type {CreateCompletionResponseUsage}
|
|
684
|
+
* @memberof CreateEditResponse
|
|
685
|
+
*/
|
|
686
|
+
'usage': CreateCompletionResponseUsage;
|
|
650
687
|
}
|
|
651
688
|
/**
|
|
652
689
|
*
|
|
@@ -675,7 +712,7 @@ export interface CreateEmbeddingRequest {
|
|
|
675
712
|
}
|
|
676
713
|
/**
|
|
677
714
|
* @type CreateEmbeddingRequestInput
|
|
678
|
-
* 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
|
|
715
|
+
* 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 you 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.
|
|
679
716
|
* @export
|
|
680
717
|
*/
|
|
681
718
|
export declare type CreateEmbeddingRequestInput = Array<any> | Array<number> | Array<string> | string;
|
|
@@ -690,19 +727,25 @@ export interface CreateEmbeddingResponse {
|
|
|
690
727
|
* @type {string}
|
|
691
728
|
* @memberof CreateEmbeddingResponse
|
|
692
729
|
*/
|
|
693
|
-
'object'
|
|
730
|
+
'object': string;
|
|
694
731
|
/**
|
|
695
732
|
*
|
|
696
733
|
* @type {string}
|
|
697
734
|
* @memberof CreateEmbeddingResponse
|
|
698
735
|
*/
|
|
699
|
-
'model'
|
|
736
|
+
'model': string;
|
|
700
737
|
/**
|
|
701
738
|
*
|
|
702
739
|
* @type {Array<CreateEmbeddingResponseDataInner>}
|
|
703
740
|
* @memberof CreateEmbeddingResponse
|
|
704
741
|
*/
|
|
705
|
-
'data'
|
|
742
|
+
'data': Array<CreateEmbeddingResponseDataInner>;
|
|
743
|
+
/**
|
|
744
|
+
*
|
|
745
|
+
* @type {CreateEmbeddingResponseUsage}
|
|
746
|
+
* @memberof CreateEmbeddingResponse
|
|
747
|
+
*/
|
|
748
|
+
'usage': CreateEmbeddingResponseUsage;
|
|
706
749
|
}
|
|
707
750
|
/**
|
|
708
751
|
*
|
|
@@ -715,19 +758,38 @@ export interface CreateEmbeddingResponseDataInner {
|
|
|
715
758
|
* @type {number}
|
|
716
759
|
* @memberof CreateEmbeddingResponseDataInner
|
|
717
760
|
*/
|
|
718
|
-
'index'
|
|
761
|
+
'index': number;
|
|
719
762
|
/**
|
|
720
763
|
*
|
|
721
764
|
* @type {string}
|
|
722
765
|
* @memberof CreateEmbeddingResponseDataInner
|
|
723
766
|
*/
|
|
724
|
-
'object'
|
|
767
|
+
'object': string;
|
|
725
768
|
/**
|
|
726
769
|
*
|
|
727
770
|
* @type {Array<number>}
|
|
728
771
|
* @memberof CreateEmbeddingResponseDataInner
|
|
729
772
|
*/
|
|
730
|
-
'embedding'
|
|
773
|
+
'embedding': Array<number>;
|
|
774
|
+
}
|
|
775
|
+
/**
|
|
776
|
+
*
|
|
777
|
+
* @export
|
|
778
|
+
* @interface CreateEmbeddingResponseUsage
|
|
779
|
+
*/
|
|
780
|
+
export interface CreateEmbeddingResponseUsage {
|
|
781
|
+
/**
|
|
782
|
+
*
|
|
783
|
+
* @type {number}
|
|
784
|
+
* @memberof CreateEmbeddingResponseUsage
|
|
785
|
+
*/
|
|
786
|
+
'prompt_tokens': number;
|
|
787
|
+
/**
|
|
788
|
+
*
|
|
789
|
+
* @type {number}
|
|
790
|
+
* @memberof CreateEmbeddingResponseUsage
|
|
791
|
+
*/
|
|
792
|
+
'total_tokens': number;
|
|
731
793
|
}
|
|
732
794
|
/**
|
|
733
795
|
*
|
|
@@ -748,7 +810,7 @@ export interface CreateFineTuneRequest {
|
|
|
748
810
|
*/
|
|
749
811
|
'validation_file'?: string | null;
|
|
750
812
|
/**
|
|
751
|
-
* The name of the base model to fine-tune. You can select one of \"ada\", \"babbage\", \"curie\",
|
|
813
|
+
* The name of the base model to fine-tune. You can select one of \"ada\", \"babbage\", \"curie\", \"davinci\", or a fine-tuned model created after 2022-04-21. To learn more about these models, see the [Models](https://beta.openai.com/docs/models) documentation.
|
|
752
814
|
* @type {string}
|
|
753
815
|
* @memberof CreateFineTuneRequest
|
|
754
816
|
*/
|
|
@@ -808,6 +870,179 @@ export interface CreateFineTuneRequest {
|
|
|
808
870
|
*/
|
|
809
871
|
'suffix'?: string | null;
|
|
810
872
|
}
|
|
873
|
+
/**
|
|
874
|
+
*
|
|
875
|
+
* @export
|
|
876
|
+
* @interface CreateModerationRequest
|
|
877
|
+
*/
|
|
878
|
+
export interface CreateModerationRequest {
|
|
879
|
+
/**
|
|
880
|
+
*
|
|
881
|
+
* @type {CreateModerationRequestInput}
|
|
882
|
+
* @memberof CreateModerationRequest
|
|
883
|
+
*/
|
|
884
|
+
'input': CreateModerationRequestInput;
|
|
885
|
+
/**
|
|
886
|
+
* Two content moderations models are available: `text-moderation-stable` and `text-moderation-latest`. The default is `text-moderation-latest` which will be automatically upgraded over time. This ensures you are always using our most accurate model. If you use `text-moderation-stable`, we will provide advanced notice before updating the model. Accuracy of `text-moderation-stable` may be slightly lower than for `text-moderation-latest`.
|
|
887
|
+
* @type {string}
|
|
888
|
+
* @memberof CreateModerationRequest
|
|
889
|
+
*/
|
|
890
|
+
'model'?: string;
|
|
891
|
+
}
|
|
892
|
+
/**
|
|
893
|
+
* @type CreateModerationRequestInput
|
|
894
|
+
* The input text to classify
|
|
895
|
+
* @export
|
|
896
|
+
*/
|
|
897
|
+
export declare type CreateModerationRequestInput = Array<string> | string;
|
|
898
|
+
/**
|
|
899
|
+
*
|
|
900
|
+
* @export
|
|
901
|
+
* @interface CreateModerationResponse
|
|
902
|
+
*/
|
|
903
|
+
export interface CreateModerationResponse {
|
|
904
|
+
/**
|
|
905
|
+
*
|
|
906
|
+
* @type {string}
|
|
907
|
+
* @memberof CreateModerationResponse
|
|
908
|
+
*/
|
|
909
|
+
'id': string;
|
|
910
|
+
/**
|
|
911
|
+
*
|
|
912
|
+
* @type {string}
|
|
913
|
+
* @memberof CreateModerationResponse
|
|
914
|
+
*/
|
|
915
|
+
'model': string;
|
|
916
|
+
/**
|
|
917
|
+
*
|
|
918
|
+
* @type {Array<CreateModerationResponseResultsInner>}
|
|
919
|
+
* @memberof CreateModerationResponse
|
|
920
|
+
*/
|
|
921
|
+
'results': Array<CreateModerationResponseResultsInner>;
|
|
922
|
+
}
|
|
923
|
+
/**
|
|
924
|
+
*
|
|
925
|
+
* @export
|
|
926
|
+
* @interface CreateModerationResponseResultsInner
|
|
927
|
+
*/
|
|
928
|
+
export interface CreateModerationResponseResultsInner {
|
|
929
|
+
/**
|
|
930
|
+
*
|
|
931
|
+
* @type {boolean}
|
|
932
|
+
* @memberof CreateModerationResponseResultsInner
|
|
933
|
+
*/
|
|
934
|
+
'flagged': boolean;
|
|
935
|
+
/**
|
|
936
|
+
*
|
|
937
|
+
* @type {CreateModerationResponseResultsInnerCategories}
|
|
938
|
+
* @memberof CreateModerationResponseResultsInner
|
|
939
|
+
*/
|
|
940
|
+
'categories': CreateModerationResponseResultsInnerCategories;
|
|
941
|
+
/**
|
|
942
|
+
*
|
|
943
|
+
* @type {CreateModerationResponseResultsInnerCategoryScores}
|
|
944
|
+
* @memberof CreateModerationResponseResultsInner
|
|
945
|
+
*/
|
|
946
|
+
'category_scores': CreateModerationResponseResultsInnerCategoryScores;
|
|
947
|
+
}
|
|
948
|
+
/**
|
|
949
|
+
*
|
|
950
|
+
* @export
|
|
951
|
+
* @interface CreateModerationResponseResultsInnerCategories
|
|
952
|
+
*/
|
|
953
|
+
export interface CreateModerationResponseResultsInnerCategories {
|
|
954
|
+
/**
|
|
955
|
+
*
|
|
956
|
+
* @type {boolean}
|
|
957
|
+
* @memberof CreateModerationResponseResultsInnerCategories
|
|
958
|
+
*/
|
|
959
|
+
'hate': boolean;
|
|
960
|
+
/**
|
|
961
|
+
*
|
|
962
|
+
* @type {boolean}
|
|
963
|
+
* @memberof CreateModerationResponseResultsInnerCategories
|
|
964
|
+
*/
|
|
965
|
+
'hate/threatening': boolean;
|
|
966
|
+
/**
|
|
967
|
+
*
|
|
968
|
+
* @type {boolean}
|
|
969
|
+
* @memberof CreateModerationResponseResultsInnerCategories
|
|
970
|
+
*/
|
|
971
|
+
'self-harm': boolean;
|
|
972
|
+
/**
|
|
973
|
+
*
|
|
974
|
+
* @type {boolean}
|
|
975
|
+
* @memberof CreateModerationResponseResultsInnerCategories
|
|
976
|
+
*/
|
|
977
|
+
'sexual': boolean;
|
|
978
|
+
/**
|
|
979
|
+
*
|
|
980
|
+
* @type {boolean}
|
|
981
|
+
* @memberof CreateModerationResponseResultsInnerCategories
|
|
982
|
+
*/
|
|
983
|
+
'sexual/minors': boolean;
|
|
984
|
+
/**
|
|
985
|
+
*
|
|
986
|
+
* @type {boolean}
|
|
987
|
+
* @memberof CreateModerationResponseResultsInnerCategories
|
|
988
|
+
*/
|
|
989
|
+
'violence': boolean;
|
|
990
|
+
/**
|
|
991
|
+
*
|
|
992
|
+
* @type {boolean}
|
|
993
|
+
* @memberof CreateModerationResponseResultsInnerCategories
|
|
994
|
+
*/
|
|
995
|
+
'violence/graphic': boolean;
|
|
996
|
+
}
|
|
997
|
+
/**
|
|
998
|
+
*
|
|
999
|
+
* @export
|
|
1000
|
+
* @interface CreateModerationResponseResultsInnerCategoryScores
|
|
1001
|
+
*/
|
|
1002
|
+
export interface CreateModerationResponseResultsInnerCategoryScores {
|
|
1003
|
+
/**
|
|
1004
|
+
*
|
|
1005
|
+
* @type {number}
|
|
1006
|
+
* @memberof CreateModerationResponseResultsInnerCategoryScores
|
|
1007
|
+
*/
|
|
1008
|
+
'hate': number;
|
|
1009
|
+
/**
|
|
1010
|
+
*
|
|
1011
|
+
* @type {number}
|
|
1012
|
+
* @memberof CreateModerationResponseResultsInnerCategoryScores
|
|
1013
|
+
*/
|
|
1014
|
+
'hate/threatening': number;
|
|
1015
|
+
/**
|
|
1016
|
+
*
|
|
1017
|
+
* @type {number}
|
|
1018
|
+
* @memberof CreateModerationResponseResultsInnerCategoryScores
|
|
1019
|
+
*/
|
|
1020
|
+
'self-harm': number;
|
|
1021
|
+
/**
|
|
1022
|
+
*
|
|
1023
|
+
* @type {number}
|
|
1024
|
+
* @memberof CreateModerationResponseResultsInnerCategoryScores
|
|
1025
|
+
*/
|
|
1026
|
+
'sexual': number;
|
|
1027
|
+
/**
|
|
1028
|
+
*
|
|
1029
|
+
* @type {number}
|
|
1030
|
+
* @memberof CreateModerationResponseResultsInnerCategoryScores
|
|
1031
|
+
*/
|
|
1032
|
+
'sexual/minors': number;
|
|
1033
|
+
/**
|
|
1034
|
+
*
|
|
1035
|
+
* @type {number}
|
|
1036
|
+
* @memberof CreateModerationResponseResultsInnerCategoryScores
|
|
1037
|
+
*/
|
|
1038
|
+
'violence': number;
|
|
1039
|
+
/**
|
|
1040
|
+
*
|
|
1041
|
+
* @type {number}
|
|
1042
|
+
* @memberof CreateModerationResponseResultsInnerCategoryScores
|
|
1043
|
+
*/
|
|
1044
|
+
'violence/graphic': number;
|
|
1045
|
+
}
|
|
811
1046
|
/**
|
|
812
1047
|
*
|
|
813
1048
|
* @export
|
|
@@ -912,19 +1147,19 @@ export interface DeleteFileResponse {
|
|
|
912
1147
|
* @type {string}
|
|
913
1148
|
* @memberof DeleteFileResponse
|
|
914
1149
|
*/
|
|
915
|
-
'id'
|
|
1150
|
+
'id': string;
|
|
916
1151
|
/**
|
|
917
1152
|
*
|
|
918
1153
|
* @type {string}
|
|
919
1154
|
* @memberof DeleteFileResponse
|
|
920
1155
|
*/
|
|
921
|
-
'object'
|
|
1156
|
+
'object': string;
|
|
922
1157
|
/**
|
|
923
1158
|
*
|
|
924
1159
|
* @type {boolean}
|
|
925
1160
|
* @memberof DeleteFileResponse
|
|
926
1161
|
*/
|
|
927
|
-
'deleted'
|
|
1162
|
+
'deleted': boolean;
|
|
928
1163
|
}
|
|
929
1164
|
/**
|
|
930
1165
|
*
|
|
@@ -937,19 +1172,19 @@ export interface DeleteModelResponse {
|
|
|
937
1172
|
* @type {string}
|
|
938
1173
|
* @memberof DeleteModelResponse
|
|
939
1174
|
*/
|
|
940
|
-
'id'
|
|
1175
|
+
'id': string;
|
|
941
1176
|
/**
|
|
942
1177
|
*
|
|
943
1178
|
* @type {string}
|
|
944
1179
|
* @memberof DeleteModelResponse
|
|
945
1180
|
*/
|
|
946
|
-
'object'
|
|
1181
|
+
'object': string;
|
|
947
1182
|
/**
|
|
948
1183
|
*
|
|
949
1184
|
* @type {boolean}
|
|
950
1185
|
* @memberof DeleteModelResponse
|
|
951
1186
|
*/
|
|
952
|
-
'deleted'
|
|
1187
|
+
'deleted': boolean;
|
|
953
1188
|
}
|
|
954
1189
|
/**
|
|
955
1190
|
*
|
|
@@ -962,25 +1197,25 @@ export interface Engine {
|
|
|
962
1197
|
* @type {string}
|
|
963
1198
|
* @memberof Engine
|
|
964
1199
|
*/
|
|
965
|
-
'id'
|
|
1200
|
+
'id': string;
|
|
966
1201
|
/**
|
|
967
1202
|
*
|
|
968
1203
|
* @type {string}
|
|
969
1204
|
* @memberof Engine
|
|
970
1205
|
*/
|
|
971
|
-
'object'
|
|
1206
|
+
'object': string;
|
|
972
1207
|
/**
|
|
973
1208
|
*
|
|
974
1209
|
* @type {number}
|
|
975
1210
|
* @memberof Engine
|
|
976
1211
|
*/
|
|
977
|
-
'created'
|
|
1212
|
+
'created': number | null;
|
|
978
1213
|
/**
|
|
979
1214
|
*
|
|
980
1215
|
* @type {boolean}
|
|
981
1216
|
* @memberof Engine
|
|
982
1217
|
*/
|
|
983
|
-
'ready'
|
|
1218
|
+
'ready': boolean;
|
|
984
1219
|
}
|
|
985
1220
|
/**
|
|
986
1221
|
*
|
|
@@ -993,73 +1228,73 @@ export interface FineTune {
|
|
|
993
1228
|
* @type {string}
|
|
994
1229
|
* @memberof FineTune
|
|
995
1230
|
*/
|
|
996
|
-
'id'
|
|
1231
|
+
'id': string;
|
|
997
1232
|
/**
|
|
998
1233
|
*
|
|
999
1234
|
* @type {string}
|
|
1000
1235
|
* @memberof FineTune
|
|
1001
1236
|
*/
|
|
1002
|
-
'object'
|
|
1237
|
+
'object': string;
|
|
1003
1238
|
/**
|
|
1004
1239
|
*
|
|
1005
1240
|
* @type {number}
|
|
1006
1241
|
* @memberof FineTune
|
|
1007
1242
|
*/
|
|
1008
|
-
'created_at'
|
|
1243
|
+
'created_at': number;
|
|
1009
1244
|
/**
|
|
1010
1245
|
*
|
|
1011
1246
|
* @type {number}
|
|
1012
1247
|
* @memberof FineTune
|
|
1013
1248
|
*/
|
|
1014
|
-
'updated_at'
|
|
1249
|
+
'updated_at': number;
|
|
1015
1250
|
/**
|
|
1016
1251
|
*
|
|
1017
1252
|
* @type {string}
|
|
1018
1253
|
* @memberof FineTune
|
|
1019
1254
|
*/
|
|
1020
|
-
'model'
|
|
1255
|
+
'model': string;
|
|
1021
1256
|
/**
|
|
1022
1257
|
*
|
|
1023
1258
|
* @type {string}
|
|
1024
1259
|
* @memberof FineTune
|
|
1025
1260
|
*/
|
|
1026
|
-
'fine_tuned_model'
|
|
1261
|
+
'fine_tuned_model': string | null;
|
|
1027
1262
|
/**
|
|
1028
1263
|
*
|
|
1029
1264
|
* @type {string}
|
|
1030
1265
|
* @memberof FineTune
|
|
1031
1266
|
*/
|
|
1032
|
-
'organization_id'
|
|
1267
|
+
'organization_id': string;
|
|
1033
1268
|
/**
|
|
1034
1269
|
*
|
|
1035
1270
|
* @type {string}
|
|
1036
1271
|
* @memberof FineTune
|
|
1037
1272
|
*/
|
|
1038
|
-
'status'
|
|
1273
|
+
'status': string;
|
|
1039
1274
|
/**
|
|
1040
1275
|
*
|
|
1041
1276
|
* @type {object}
|
|
1042
1277
|
* @memberof FineTune
|
|
1043
1278
|
*/
|
|
1044
|
-
'hyperparams'
|
|
1279
|
+
'hyperparams': object;
|
|
1045
1280
|
/**
|
|
1046
1281
|
*
|
|
1047
1282
|
* @type {Array<OpenAIFile>}
|
|
1048
1283
|
* @memberof FineTune
|
|
1049
1284
|
*/
|
|
1050
|
-
'training_files'
|
|
1285
|
+
'training_files': Array<OpenAIFile>;
|
|
1051
1286
|
/**
|
|
1052
1287
|
*
|
|
1053
1288
|
* @type {Array<OpenAIFile>}
|
|
1054
1289
|
* @memberof FineTune
|
|
1055
1290
|
*/
|
|
1056
|
-
'validation_files'
|
|
1291
|
+
'validation_files': Array<OpenAIFile>;
|
|
1057
1292
|
/**
|
|
1058
1293
|
*
|
|
1059
1294
|
* @type {Array<OpenAIFile>}
|
|
1060
1295
|
* @memberof FineTune
|
|
1061
1296
|
*/
|
|
1062
|
-
'result_files'
|
|
1297
|
+
'result_files': Array<OpenAIFile>;
|
|
1063
1298
|
/**
|
|
1064
1299
|
*
|
|
1065
1300
|
* @type {Array<FineTuneEvent>}
|
|
@@ -1078,25 +1313,25 @@ export interface FineTuneEvent {
|
|
|
1078
1313
|
* @type {string}
|
|
1079
1314
|
* @memberof FineTuneEvent
|
|
1080
1315
|
*/
|
|
1081
|
-
'object'
|
|
1316
|
+
'object': string;
|
|
1082
1317
|
/**
|
|
1083
1318
|
*
|
|
1084
1319
|
* @type {number}
|
|
1085
1320
|
* @memberof FineTuneEvent
|
|
1086
1321
|
*/
|
|
1087
|
-
'created_at'
|
|
1322
|
+
'created_at': number;
|
|
1088
1323
|
/**
|
|
1089
1324
|
*
|
|
1090
1325
|
* @type {string}
|
|
1091
1326
|
* @memberof FineTuneEvent
|
|
1092
1327
|
*/
|
|
1093
|
-
'level'
|
|
1328
|
+
'level': string;
|
|
1094
1329
|
/**
|
|
1095
1330
|
*
|
|
1096
1331
|
* @type {string}
|
|
1097
1332
|
* @memberof FineTuneEvent
|
|
1098
1333
|
*/
|
|
1099
|
-
'message'
|
|
1334
|
+
'message': string;
|
|
1100
1335
|
}
|
|
1101
1336
|
/**
|
|
1102
1337
|
*
|
|
@@ -1109,13 +1344,13 @@ export interface ListEnginesResponse {
|
|
|
1109
1344
|
* @type {string}
|
|
1110
1345
|
* @memberof ListEnginesResponse
|
|
1111
1346
|
*/
|
|
1112
|
-
'object'
|
|
1347
|
+
'object': string;
|
|
1113
1348
|
/**
|
|
1114
1349
|
*
|
|
1115
1350
|
* @type {Array<Engine>}
|
|
1116
1351
|
* @memberof ListEnginesResponse
|
|
1117
1352
|
*/
|
|
1118
|
-
'data'
|
|
1353
|
+
'data': Array<Engine>;
|
|
1119
1354
|
}
|
|
1120
1355
|
/**
|
|
1121
1356
|
*
|
|
@@ -1128,13 +1363,13 @@ export interface ListFilesResponse {
|
|
|
1128
1363
|
* @type {string}
|
|
1129
1364
|
* @memberof ListFilesResponse
|
|
1130
1365
|
*/
|
|
1131
|
-
'object'
|
|
1366
|
+
'object': string;
|
|
1132
1367
|
/**
|
|
1133
1368
|
*
|
|
1134
1369
|
* @type {Array<OpenAIFile>}
|
|
1135
1370
|
* @memberof ListFilesResponse
|
|
1136
1371
|
*/
|
|
1137
|
-
'data'
|
|
1372
|
+
'data': Array<OpenAIFile>;
|
|
1138
1373
|
}
|
|
1139
1374
|
/**
|
|
1140
1375
|
*
|
|
@@ -1147,13 +1382,13 @@ export interface ListFineTuneEventsResponse {
|
|
|
1147
1382
|
* @type {string}
|
|
1148
1383
|
* @memberof ListFineTuneEventsResponse
|
|
1149
1384
|
*/
|
|
1150
|
-
'object'
|
|
1385
|
+
'object': string;
|
|
1151
1386
|
/**
|
|
1152
1387
|
*
|
|
1153
1388
|
* @type {Array<FineTuneEvent>}
|
|
1154
1389
|
* @memberof ListFineTuneEventsResponse
|
|
1155
1390
|
*/
|
|
1156
|
-
'data'
|
|
1391
|
+
'data': Array<FineTuneEvent>;
|
|
1157
1392
|
}
|
|
1158
1393
|
/**
|
|
1159
1394
|
*
|
|
@@ -1166,13 +1401,13 @@ export interface ListFineTunesResponse {
|
|
|
1166
1401
|
* @type {string}
|
|
1167
1402
|
* @memberof ListFineTunesResponse
|
|
1168
1403
|
*/
|
|
1169
|
-
'object'
|
|
1404
|
+
'object': string;
|
|
1170
1405
|
/**
|
|
1171
1406
|
*
|
|
1172
1407
|
* @type {Array<FineTune>}
|
|
1173
1408
|
* @memberof ListFineTunesResponse
|
|
1174
1409
|
*/
|
|
1175
|
-
'data'
|
|
1410
|
+
'data': Array<FineTune>;
|
|
1176
1411
|
}
|
|
1177
1412
|
/**
|
|
1178
1413
|
*
|
|
@@ -1185,13 +1420,13 @@ export interface ListModelsResponse {
|
|
|
1185
1420
|
* @type {string}
|
|
1186
1421
|
* @memberof ListModelsResponse
|
|
1187
1422
|
*/
|
|
1188
|
-
'object'
|
|
1423
|
+
'object': string;
|
|
1189
1424
|
/**
|
|
1190
1425
|
*
|
|
1191
1426
|
* @type {Array<Model>}
|
|
1192
1427
|
* @memberof ListModelsResponse
|
|
1193
1428
|
*/
|
|
1194
|
-
'data'
|
|
1429
|
+
'data': Array<Model>;
|
|
1195
1430
|
}
|
|
1196
1431
|
/**
|
|
1197
1432
|
*
|
|
@@ -1204,25 +1439,25 @@ export interface Model {
|
|
|
1204
1439
|
* @type {string}
|
|
1205
1440
|
* @memberof Model
|
|
1206
1441
|
*/
|
|
1207
|
-
'id'
|
|
1442
|
+
'id': string;
|
|
1208
1443
|
/**
|
|
1209
1444
|
*
|
|
1210
1445
|
* @type {string}
|
|
1211
1446
|
* @memberof Model
|
|
1212
1447
|
*/
|
|
1213
|
-
'object'
|
|
1448
|
+
'object': string;
|
|
1214
1449
|
/**
|
|
1215
1450
|
*
|
|
1216
1451
|
* @type {number}
|
|
1217
1452
|
* @memberof Model
|
|
1218
1453
|
*/
|
|
1219
|
-
'created'
|
|
1454
|
+
'created': number;
|
|
1220
1455
|
/**
|
|
1221
1456
|
*
|
|
1222
1457
|
* @type {string}
|
|
1223
1458
|
* @memberof Model
|
|
1224
1459
|
*/
|
|
1225
|
-
'owned_by'
|
|
1460
|
+
'owned_by': string;
|
|
1226
1461
|
}
|
|
1227
1462
|
/**
|
|
1228
1463
|
*
|
|
@@ -1235,37 +1470,37 @@ export interface OpenAIFile {
|
|
|
1235
1470
|
* @type {string}
|
|
1236
1471
|
* @memberof OpenAIFile
|
|
1237
1472
|
*/
|
|
1238
|
-
'id'
|
|
1473
|
+
'id': string;
|
|
1239
1474
|
/**
|
|
1240
1475
|
*
|
|
1241
1476
|
* @type {string}
|
|
1242
1477
|
* @memberof OpenAIFile
|
|
1243
1478
|
*/
|
|
1244
|
-
'object'
|
|
1479
|
+
'object': string;
|
|
1245
1480
|
/**
|
|
1246
1481
|
*
|
|
1247
1482
|
* @type {number}
|
|
1248
1483
|
* @memberof OpenAIFile
|
|
1249
1484
|
*/
|
|
1250
|
-
'bytes'
|
|
1485
|
+
'bytes': number;
|
|
1251
1486
|
/**
|
|
1252
1487
|
*
|
|
1253
1488
|
* @type {number}
|
|
1254
1489
|
* @memberof OpenAIFile
|
|
1255
1490
|
*/
|
|
1256
|
-
'created_at'
|
|
1491
|
+
'created_at': number;
|
|
1257
1492
|
/**
|
|
1258
1493
|
*
|
|
1259
1494
|
* @type {string}
|
|
1260
1495
|
* @memberof OpenAIFile
|
|
1261
1496
|
*/
|
|
1262
|
-
'filename'
|
|
1497
|
+
'filename': string;
|
|
1263
1498
|
/**
|
|
1264
1499
|
*
|
|
1265
1500
|
* @type {string}
|
|
1266
1501
|
* @memberof OpenAIFile
|
|
1267
1502
|
*/
|
|
1268
|
-
'purpose'
|
|
1503
|
+
'purpose': string;
|
|
1269
1504
|
/**
|
|
1270
1505
|
*
|
|
1271
1506
|
* @type {string}
|
|
@@ -1337,12 +1572,12 @@ export declare const OpenAIApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1337
1572
|
/**
|
|
1338
1573
|
*
|
|
1339
1574
|
* @summary Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
|
|
1340
|
-
* @param {
|
|
1575
|
+
* @param {File} file Name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be uploaded. If the `purpose` is set to \\\"fine-tune\\\", each line is a JSON record with \\\"prompt\\\" and \\\"completion\\\" fields representing your [training examples](/docs/guides/fine-tuning/prepare-training-data).
|
|
1341
1576
|
* @param {string} purpose The intended purpose of the uploaded documents. Use \\\"fine-tune\\\" for [Fine-tuning](/docs/api-reference/fine-tunes). This allows us to validate the format of the uploaded file.
|
|
1342
1577
|
* @param {*} [options] Override http request option.
|
|
1343
1578
|
* @throws {RequiredError}
|
|
1344
1579
|
*/
|
|
1345
|
-
createFile: (file:
|
|
1580
|
+
createFile: (file: File, purpose: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1346
1581
|
/**
|
|
1347
1582
|
*
|
|
1348
1583
|
* @summary Creates a job that fine-tunes a specified model from a given dataset. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete. [Learn more about Fine-tuning](/docs/guides/fine-tuning)
|
|
@@ -1351,6 +1586,14 @@ export declare const OpenAIApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1351
1586
|
* @throws {RequiredError}
|
|
1352
1587
|
*/
|
|
1353
1588
|
createFineTune: (createFineTuneRequest: CreateFineTuneRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1589
|
+
/**
|
|
1590
|
+
*
|
|
1591
|
+
* @summary Classifies if text violates OpenAI\'s Content Policy
|
|
1592
|
+
* @param {CreateModerationRequest} createModerationRequest
|
|
1593
|
+
* @param {*} [options] Override http request option.
|
|
1594
|
+
* @throws {RequiredError}
|
|
1595
|
+
*/
|
|
1596
|
+
createModeration: (createModerationRequest: CreateModerationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1354
1597
|
/**
|
|
1355
1598
|
*
|
|
1356
1599
|
* @summary The search endpoint computes similarity scores between provided query and documents. Documents can be passed directly to the API if there are no more than 200 of them. To go beyond the 200 document limit, documents can be processed offline and then used for efficient retrieval at query time. When `file` is set, the search endpoint searches over all the documents in the given file and returns up to the `max_rerank` number of documents. These documents will be returned along with their search scores. The similarity score is a positive score that usually ranges from 0 to 300 (but can sometimes go higher), where a score above 200 usually means the document is semantically similar to the query.
|
|
@@ -1515,12 +1758,12 @@ export declare const OpenAIApiFp: (configuration?: Configuration) => {
|
|
|
1515
1758
|
/**
|
|
1516
1759
|
*
|
|
1517
1760
|
* @summary Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
|
|
1518
|
-
* @param {
|
|
1761
|
+
* @param {File} file Name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be uploaded. If the `purpose` is set to \\\"fine-tune\\\", each line is a JSON record with \\\"prompt\\\" and \\\"completion\\\" fields representing your [training examples](/docs/guides/fine-tuning/prepare-training-data).
|
|
1519
1762
|
* @param {string} purpose The intended purpose of the uploaded documents. Use \\\"fine-tune\\\" for [Fine-tuning](/docs/api-reference/fine-tunes). This allows us to validate the format of the uploaded file.
|
|
1520
1763
|
* @param {*} [options] Override http request option.
|
|
1521
1764
|
* @throws {RequiredError}
|
|
1522
1765
|
*/
|
|
1523
|
-
createFile(file:
|
|
1766
|
+
createFile(file: File, purpose: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OpenAIFile>>;
|
|
1524
1767
|
/**
|
|
1525
1768
|
*
|
|
1526
1769
|
* @summary Creates a job that fine-tunes a specified model from a given dataset. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete. [Learn more about Fine-tuning](/docs/guides/fine-tuning)
|
|
@@ -1529,6 +1772,14 @@ export declare const OpenAIApiFp: (configuration?: Configuration) => {
|
|
|
1529
1772
|
* @throws {RequiredError}
|
|
1530
1773
|
*/
|
|
1531
1774
|
createFineTune(createFineTuneRequest: CreateFineTuneRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FineTune>>;
|
|
1775
|
+
/**
|
|
1776
|
+
*
|
|
1777
|
+
* @summary Classifies if text violates OpenAI\'s Content Policy
|
|
1778
|
+
* @param {CreateModerationRequest} createModerationRequest
|
|
1779
|
+
* @param {*} [options] Override http request option.
|
|
1780
|
+
* @throws {RequiredError}
|
|
1781
|
+
*/
|
|
1782
|
+
createModeration(createModerationRequest: CreateModerationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateModerationResponse>>;
|
|
1532
1783
|
/**
|
|
1533
1784
|
*
|
|
1534
1785
|
* @summary The search endpoint computes similarity scores between provided query and documents. Documents can be passed directly to the API if there are no more than 200 of them. To go beyond the 200 document limit, documents can be processed offline and then used for efficient retrieval at query time. When `file` is set, the search endpoint searches over all the documents in the given file and returns up to the `max_rerank` number of documents. These documents will be returned along with their search scores. The similarity score is a positive score that usually ranges from 0 to 300 (but can sometimes go higher), where a score above 200 usually means the document is semantically similar to the query.
|
|
@@ -1693,12 +1944,12 @@ export declare const OpenAIApiFactory: (configuration?: Configuration, basePath?
|
|
|
1693
1944
|
/**
|
|
1694
1945
|
*
|
|
1695
1946
|
* @summary Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
|
|
1696
|
-
* @param {
|
|
1947
|
+
* @param {File} file Name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be uploaded. If the `purpose` is set to \\\"fine-tune\\\", each line is a JSON record with \\\"prompt\\\" and \\\"completion\\\" fields representing your [training examples](/docs/guides/fine-tuning/prepare-training-data).
|
|
1697
1948
|
* @param {string} purpose The intended purpose of the uploaded documents. Use \\\"fine-tune\\\" for [Fine-tuning](/docs/api-reference/fine-tunes). This allows us to validate the format of the uploaded file.
|
|
1698
1949
|
* @param {*} [options] Override http request option.
|
|
1699
1950
|
* @throws {RequiredError}
|
|
1700
1951
|
*/
|
|
1701
|
-
createFile(file:
|
|
1952
|
+
createFile(file: File, purpose: string, options?: any): AxiosPromise<OpenAIFile>;
|
|
1702
1953
|
/**
|
|
1703
1954
|
*
|
|
1704
1955
|
* @summary Creates a job that fine-tunes a specified model from a given dataset. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete. [Learn more about Fine-tuning](/docs/guides/fine-tuning)
|
|
@@ -1707,6 +1958,14 @@ export declare const OpenAIApiFactory: (configuration?: Configuration, basePath?
|
|
|
1707
1958
|
* @throws {RequiredError}
|
|
1708
1959
|
*/
|
|
1709
1960
|
createFineTune(createFineTuneRequest: CreateFineTuneRequest, options?: any): AxiosPromise<FineTune>;
|
|
1961
|
+
/**
|
|
1962
|
+
*
|
|
1963
|
+
* @summary Classifies if text violates OpenAI\'s Content Policy
|
|
1964
|
+
* @param {CreateModerationRequest} createModerationRequest
|
|
1965
|
+
* @param {*} [options] Override http request option.
|
|
1966
|
+
* @throws {RequiredError}
|
|
1967
|
+
*/
|
|
1968
|
+
createModeration(createModerationRequest: CreateModerationRequest, options?: any): AxiosPromise<CreateModerationResponse>;
|
|
1710
1969
|
/**
|
|
1711
1970
|
*
|
|
1712
1971
|
* @summary The search endpoint computes similarity scores between provided query and documents. Documents can be passed directly to the API if there are no more than 200 of them. To go beyond the 200 document limit, documents can be processed offline and then used for efficient retrieval at query time. When `file` is set, the search endpoint searches over all the documents in the given file and returns up to the `max_rerank` number of documents. These documents will be returned along with their search scores. The similarity score is a positive score that usually ranges from 0 to 300 (but can sometimes go higher), where a score above 200 usually means the document is semantically similar to the query.
|
|
@@ -1879,13 +2138,13 @@ export declare class OpenAIApi extends BaseAPI {
|
|
|
1879
2138
|
/**
|
|
1880
2139
|
*
|
|
1881
2140
|
* @summary Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
|
|
1882
|
-
* @param {
|
|
2141
|
+
* @param {File} file Name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be uploaded. If the `purpose` is set to \\\"fine-tune\\\", each line is a JSON record with \\\"prompt\\\" and \\\"completion\\\" fields representing your [training examples](/docs/guides/fine-tuning/prepare-training-data).
|
|
1883
2142
|
* @param {string} purpose The intended purpose of the uploaded documents. Use \\\"fine-tune\\\" for [Fine-tuning](/docs/api-reference/fine-tunes). This allows us to validate the format of the uploaded file.
|
|
1884
2143
|
* @param {*} [options] Override http request option.
|
|
1885
2144
|
* @throws {RequiredError}
|
|
1886
2145
|
* @memberof OpenAIApi
|
|
1887
2146
|
*/
|
|
1888
|
-
createFile(file:
|
|
2147
|
+
createFile(file: File, purpose: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OpenAIFile, any>>;
|
|
1889
2148
|
/**
|
|
1890
2149
|
*
|
|
1891
2150
|
* @summary Creates a job that fine-tunes a specified model from a given dataset. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete. [Learn more about Fine-tuning](/docs/guides/fine-tuning)
|
|
@@ -1895,6 +2154,15 @@ export declare class OpenAIApi extends BaseAPI {
|
|
|
1895
2154
|
* @memberof OpenAIApi
|
|
1896
2155
|
*/
|
|
1897
2156
|
createFineTune(createFineTuneRequest: CreateFineTuneRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FineTune, any>>;
|
|
2157
|
+
/**
|
|
2158
|
+
*
|
|
2159
|
+
* @summary Classifies if text violates OpenAI\'s Content Policy
|
|
2160
|
+
* @param {CreateModerationRequest} createModerationRequest
|
|
2161
|
+
* @param {*} [options] Override http request option.
|
|
2162
|
+
* @throws {RequiredError}
|
|
2163
|
+
* @memberof OpenAIApi
|
|
2164
|
+
*/
|
|
2165
|
+
createModeration(createModerationRequest: CreateModerationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateModerationResponse, any>>;
|
|
1898
2166
|
/**
|
|
1899
2167
|
*
|
|
1900
2168
|
* @summary The search endpoint computes similarity scores between provided query and documents. Documents can be passed directly to the API if there are no more than 200 of them. To go beyond the 200 document limit, documents can be processed offline and then used for efficient retrieval at query time. When `file` is set, the search endpoint searches over all the documents in the given file and returns up to the `max_rerank` number of documents. These documents will be returned along with their search scores. The similarity score is a positive score that usually ranges from 0 to 300 (but can sometimes go higher), where a score above 200 usually means the document is semantically similar to the query.
|