openai 7.12.1 → 7.13.0
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/CHANGELOG.md +7 -0
- package/package.json +1 -1
- package/resources/admin/organization/audit-logs.d.mts +1 -1
- package/resources/admin/organization/audit-logs.d.ts +1 -1
- package/resources/admin/organization/projects/api-keys.d.mts +5 -0
- package/resources/admin/organization/projects/api-keys.d.mts.map +1 -1
- package/resources/admin/organization/projects/api-keys.d.ts +5 -0
- package/resources/admin/organization/projects/api-keys.d.ts.map +1 -1
- package/resources/admin/organization/projects/projects.d.mts +2 -2
- package/resources/admin/organization/projects/projects.d.ts +2 -2
- package/resources/admin/organization/projects/service-accounts/service-accounts.d.mts +13 -0
- package/resources/admin/organization/projects/service-accounts/service-accounts.d.mts.map +1 -1
- package/resources/admin/organization/projects/service-accounts/service-accounts.d.ts +13 -0
- package/resources/admin/organization/projects/service-accounts/service-accounts.d.ts.map +1 -1
- package/resources/admin/organization/projects/service-accounts/service-accounts.js.map +1 -1
- package/resources/admin/organization/projects/service-accounts/service-accounts.mjs.map +1 -1
- package/resources/audio/speech.d.mts +3 -2
- package/resources/audio/speech.d.mts.map +1 -1
- package/resources/audio/speech.d.ts +3 -2
- package/resources/audio/speech.d.ts.map +1 -1
- package/resources/audio/transcriptions.d.mts +10 -10
- package/resources/audio/transcriptions.d.ts +10 -10
- package/resources/audio/translations.d.mts +1 -1
- package/resources/audio/translations.d.ts +1 -1
- package/resources/batches.d.mts +6 -5
- package/resources/batches.d.mts.map +1 -1
- package/resources/batches.d.ts +6 -5
- package/resources/batches.d.ts.map +1 -1
- package/resources/beta/assistants.d.mts +143 -147
- package/resources/beta/assistants.d.mts.map +1 -1
- package/resources/beta/assistants.d.ts +143 -147
- package/resources/beta/assistants.d.ts.map +1 -1
- package/resources/beta/responses/input-tokens.d.mts +11 -11
- package/resources/beta/responses/input-tokens.d.ts +11 -11
- package/resources/beta/responses/responses.d.mts +181 -170
- package/resources/beta/responses/responses.d.mts.map +1 -1
- package/resources/beta/responses/responses.d.ts +181 -170
- package/resources/beta/responses/responses.d.ts.map +1 -1
- package/resources/beta/responses/responses.js +3 -3
- package/resources/beta/responses/responses.js.map +1 -1
- package/resources/beta/responses/responses.mjs +3 -3
- package/resources/beta/responses/responses.mjs.map +1 -1
- package/resources/beta/threads/messages.d.mts +29 -23
- package/resources/beta/threads/messages.d.mts.map +1 -1
- package/resources/beta/threads/messages.d.ts +29 -23
- package/resources/beta/threads/messages.d.ts.map +1 -1
- package/resources/beta/threads/runs/runs.d.mts +39 -35
- package/resources/beta/threads/runs/runs.d.mts.map +1 -1
- package/resources/beta/threads/runs/runs.d.ts +39 -35
- package/resources/beta/threads/runs/runs.d.ts.map +1 -1
- package/resources/beta/threads/runs/runs.js.map +1 -1
- package/resources/beta/threads/runs/runs.mjs.map +1 -1
- package/resources/beta/threads/runs/steps.d.mts +14 -15
- package/resources/beta/threads/runs/steps.d.mts.map +1 -1
- package/resources/beta/threads/runs/steps.d.ts +14 -15
- package/resources/beta/threads/runs/steps.d.ts.map +1 -1
- package/resources/beta/threads/threads.d.mts +53 -50
- package/resources/beta/threads/threads.d.mts.map +1 -1
- package/resources/beta/threads/threads.d.ts +53 -50
- package/resources/beta/threads/threads.d.ts.map +1 -1
- package/resources/beta/threads/threads.js.map +1 -1
- package/resources/beta/threads/threads.mjs.map +1 -1
- package/resources/chat/completions/completions.d.mts +89 -81
- package/resources/chat/completions/completions.d.mts.map +1 -1
- package/resources/chat/completions/completions.d.ts +89 -81
- package/resources/chat/completions/completions.d.ts.map +1 -1
- package/resources/chat/completions/completions.js.map +1 -1
- package/resources/chat/completions/completions.mjs.map +1 -1
- package/resources/completions.d.mts +15 -14
- package/resources/completions.d.mts.map +1 -1
- package/resources/completions.d.ts +15 -14
- package/resources/completions.d.ts.map +1 -1
- package/resources/content-provenance-checks.d.mts +1 -1
- package/resources/content-provenance-checks.d.ts +1 -1
- package/resources/content-provenance-checks.js +1 -1
- package/resources/content-provenance-checks.mjs +1 -1
- package/resources/conversations/items.d.mts +3 -3
- package/resources/conversations/items.d.ts +3 -3
- package/resources/embeddings.d.mts +6 -6
- package/resources/embeddings.d.ts +6 -6
- package/resources/evals/evals.d.mts +1 -1
- package/resources/evals/evals.d.ts +1 -1
- package/resources/evals/evals.js +1 -1
- package/resources/evals/evals.mjs +1 -1
- package/resources/evals/runs/runs.d.mts +62 -57
- package/resources/evals/runs/runs.d.mts.map +1 -1
- package/resources/evals/runs/runs.d.ts +62 -57
- package/resources/evals/runs/runs.d.ts.map +1 -1
- package/resources/evals/runs/runs.js.map +1 -1
- package/resources/evals/runs/runs.mjs.map +1 -1
- package/resources/files.d.mts +5 -5
- package/resources/files.d.ts +5 -5
- package/resources/files.js +5 -5
- package/resources/files.mjs +5 -5
- package/resources/fine-tuning/alpha/graders.d.mts +5 -4
- package/resources/fine-tuning/alpha/graders.d.mts.map +1 -1
- package/resources/fine-tuning/alpha/graders.d.ts +5 -4
- package/resources/fine-tuning/alpha/graders.d.ts.map +1 -1
- package/resources/fine-tuning/checkpoints/permissions.d.mts +8 -4
- package/resources/fine-tuning/checkpoints/permissions.d.mts.map +1 -1
- package/resources/fine-tuning/checkpoints/permissions.d.ts +8 -4
- package/resources/fine-tuning/checkpoints/permissions.d.ts.map +1 -1
- package/resources/fine-tuning/checkpoints/permissions.js +8 -4
- package/resources/fine-tuning/checkpoints/permissions.js.map +1 -1
- package/resources/fine-tuning/checkpoints/permissions.mjs +8 -4
- package/resources/fine-tuning/checkpoints/permissions.mjs.map +1 -1
- package/resources/fine-tuning/jobs/jobs.d.mts +13 -12
- package/resources/fine-tuning/jobs/jobs.d.mts.map +1 -1
- package/resources/fine-tuning/jobs/jobs.d.ts +13 -12
- package/resources/fine-tuning/jobs/jobs.d.ts.map +1 -1
- package/resources/fine-tuning/jobs/jobs.js +2 -2
- package/resources/fine-tuning/jobs/jobs.js.map +1 -1
- package/resources/fine-tuning/jobs/jobs.mjs +2 -2
- package/resources/fine-tuning/jobs/jobs.mjs.map +1 -1
- package/resources/graders/grader-models.d.mts +1 -1
- package/resources/graders/grader-models.d.ts +1 -1
- package/resources/images.d.mts +10 -10
- package/resources/images.d.ts +10 -10
- package/resources/moderations.d.mts +5 -4
- package/resources/moderations.d.mts.map +1 -1
- package/resources/moderations.d.ts +5 -4
- package/resources/moderations.d.ts.map +1 -1
- package/resources/moderations.js +2 -1
- package/resources/moderations.js.map +1 -1
- package/resources/moderations.mjs +2 -1
- package/resources/moderations.mjs.map +1 -1
- package/resources/realtime/calls.d.mts +1 -1
- package/resources/realtime/calls.d.ts +1 -1
- package/resources/realtime/client-secrets.d.mts +4 -4
- package/resources/realtime/client-secrets.d.ts +4 -4
- package/resources/realtime/client-secrets.js +1 -1
- package/resources/realtime/client-secrets.mjs +1 -1
- package/resources/realtime/realtime.d.mts +16 -16
- package/resources/realtime/realtime.d.ts +16 -16
- package/resources/responses/input-tokens.d.mts +9 -9
- package/resources/responses/input-tokens.d.ts +9 -9
- package/resources/responses/responses.d.mts +175 -164
- package/resources/responses/responses.d.mts.map +1 -1
- package/resources/responses/responses.d.ts +175 -164
- package/resources/responses/responses.d.ts.map +1 -1
- package/resources/responses/responses.js +3 -3
- package/resources/responses/responses.js.map +1 -1
- package/resources/responses/responses.mjs +3 -3
- package/resources/responses/responses.mjs.map +1 -1
- package/resources/shared.d.mts +12 -12
- package/resources/shared.d.ts +12 -12
- package/resources/uploads/parts.d.mts +5 -4
- package/resources/uploads/parts.d.mts.map +1 -1
- package/resources/uploads/parts.d.ts +5 -4
- package/resources/uploads/parts.d.ts.map +1 -1
- package/resources/uploads/parts.js +5 -4
- package/resources/uploads/parts.js.map +1 -1
- package/resources/uploads/parts.mjs +5 -4
- package/resources/uploads/parts.mjs.map +1 -1
- package/resources/uploads/uploads.d.mts +11 -11
- package/resources/uploads/uploads.d.ts +11 -11
- package/resources/uploads/uploads.js +9 -9
- package/resources/uploads/uploads.mjs +9 -9
- package/resources/vector-stores/file-batches.d.mts +11 -11
- package/resources/vector-stores/file-batches.d.ts +11 -11
- package/resources/vector-stores/files.d.mts +8 -8
- package/resources/vector-stores/files.d.ts +8 -8
- package/resources/vector-stores/files.js +3 -3
- package/resources/vector-stores/files.mjs +3 -3
- package/resources/vector-stores/vector-stores.d.mts +3 -3
- package/resources/vector-stores/vector-stores.d.ts +3 -3
- package/resources/webhooks/webhooks.d.mts +6 -2
- package/resources/webhooks/webhooks.d.mts.map +1 -1
- package/resources/webhooks/webhooks.d.ts +6 -2
- package/resources/webhooks/webhooks.d.ts.map +1 -1
- package/src/resources/admin/organization/audit-logs.ts +1 -1
- package/src/resources/admin/organization/projects/api-keys.ts +6 -0
- package/src/resources/admin/organization/projects/projects.ts +2 -2
- package/src/resources/admin/organization/projects/service-accounts/service-accounts.ts +15 -0
- package/src/resources/audio/speech.ts +3 -2
- package/src/resources/audio/transcriptions.ts +10 -10
- package/src/resources/audio/translations.ts +1 -1
- package/src/resources/batches.ts +6 -5
- package/src/resources/beta/assistants.ts +143 -147
- package/src/resources/beta/responses/input-tokens.ts +11 -11
- package/src/resources/beta/responses/responses.ts +181 -170
- package/src/resources/beta/threads/messages.ts +29 -23
- package/src/resources/beta/threads/runs/runs.ts +39 -35
- package/src/resources/beta/threads/runs/steps.ts +14 -15
- package/src/resources/beta/threads/threads.ts +53 -50
- package/src/resources/chat/completions/completions.ts +89 -81
- package/src/resources/completions.ts +15 -14
- package/src/resources/content-provenance-checks.ts +1 -1
- package/src/resources/conversations/items.ts +3 -3
- package/src/resources/embeddings.ts +6 -6
- package/src/resources/evals/evals.ts +1 -1
- package/src/resources/evals/runs/runs.ts +62 -57
- package/src/resources/files.ts +5 -5
- package/src/resources/fine-tuning/alpha/graders.ts +5 -4
- package/src/resources/fine-tuning/checkpoints/permissions.ts +8 -4
- package/src/resources/fine-tuning/jobs/jobs.ts +13 -12
- package/src/resources/graders/grader-models.ts +1 -1
- package/src/resources/images.ts +10 -10
- package/src/resources/moderations.ts +5 -4
- package/src/resources/realtime/calls.ts +1 -1
- package/src/resources/realtime/client-secrets.ts +4 -4
- package/src/resources/realtime/realtime.ts +16 -16
- package/src/resources/responses/input-tokens.ts +9 -9
- package/src/resources/responses/responses.ts +175 -164
- package/src/resources/shared.ts +12 -12
- package/src/resources/uploads/parts.ts +5 -4
- package/src/resources/uploads/uploads.ts +11 -11
- package/src/resources/vector-stores/file-batches.ts +11 -11
- package/src/resources/vector-stores/files.ts +8 -8
- package/src/resources/vector-stores/vector-stores.ts +3 -3
- package/src/resources/webhooks/webhooks.ts +6 -2
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/images.d.mts
CHANGED
|
@@ -36,7 +36,7 @@ export declare class Images extends APIResource {
|
|
|
36
36
|
edit(body: ImageEditParamsBase, options?: RequestOptions): APIPromise<Stream<ImageEditStreamEvent> | ImagesResponse>;
|
|
37
37
|
/**
|
|
38
38
|
* Creates an image given a prompt.
|
|
39
|
-
* [Learn more](https://
|
|
39
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/images-vision).
|
|
40
40
|
*
|
|
41
41
|
* @example
|
|
42
42
|
* ```ts
|
|
@@ -426,7 +426,7 @@ export interface ImageCreateVariationParams {
|
|
|
426
426
|
/**
|
|
427
427
|
* A unique identifier representing your end-user, which can help OpenAI to monitor
|
|
428
428
|
* and detect abuse.
|
|
429
|
-
* [Learn more](https://
|
|
429
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
430
430
|
*/
|
|
431
431
|
user?: string;
|
|
432
432
|
}
|
|
@@ -542,14 +542,14 @@ export interface ImageEditParamsBase {
|
|
|
542
542
|
size?: (string & {}) | '256x256' | '512x512' | '1024x1024' | '1536x1024' | '1024x1536' | 'auto' | null;
|
|
543
543
|
/**
|
|
544
544
|
* Edit the image in streaming mode. Defaults to `false`. See the
|
|
545
|
-
* [Image generation guide](https://
|
|
545
|
+
* [Image generation guide](https://developers.openai.com/api/docs/guides/image-generation)
|
|
546
546
|
* for more information.
|
|
547
547
|
*/
|
|
548
548
|
stream?: boolean | null;
|
|
549
549
|
/**
|
|
550
550
|
* A unique identifier representing your end-user, which can help OpenAI to monitor
|
|
551
551
|
* and detect abuse.
|
|
552
|
-
* [Learn more](https://
|
|
552
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
553
553
|
*/
|
|
554
554
|
user?: string;
|
|
555
555
|
}
|
|
@@ -560,7 +560,7 @@ export declare namespace ImageEditParams {
|
|
|
560
560
|
export interface ImageEditParamsNonStreaming extends ImageEditParamsBase {
|
|
561
561
|
/**
|
|
562
562
|
* Edit the image in streaming mode. Defaults to `false`. See the
|
|
563
|
-
* [Image generation guide](https://
|
|
563
|
+
* [Image generation guide](https://developers.openai.com/api/docs/guides/image-generation)
|
|
564
564
|
* for more information.
|
|
565
565
|
*/
|
|
566
566
|
stream?: false | null;
|
|
@@ -568,7 +568,7 @@ export interface ImageEditParamsNonStreaming extends ImageEditParamsBase {
|
|
|
568
568
|
export interface ImageEditParamsStreaming extends ImageEditParamsBase {
|
|
569
569
|
/**
|
|
570
570
|
* Edit the image in streaming mode. Defaults to `false`. See the
|
|
571
|
-
* [Image generation guide](https://
|
|
571
|
+
* [Image generation guide](https://developers.openai.com/api/docs/guides/image-generation)
|
|
572
572
|
* for more information.
|
|
573
573
|
*/
|
|
574
574
|
stream: true;
|
|
@@ -669,7 +669,7 @@ export interface ImageGenerateParamsBase {
|
|
|
669
669
|
size?: (string & {}) | 'auto' | '1024x1024' | '1536x1024' | '1024x1536' | '256x256' | '512x512' | '1792x1024' | '1024x1792' | null;
|
|
670
670
|
/**
|
|
671
671
|
* Generate the image in streaming mode. Defaults to `false`. See the
|
|
672
|
-
* [Image generation guide](https://
|
|
672
|
+
* [Image generation guide](https://developers.openai.com/api/docs/guides/image-generation)
|
|
673
673
|
* for more information. This parameter is only supported for the GPT image models.
|
|
674
674
|
*/
|
|
675
675
|
stream?: boolean | null;
|
|
@@ -683,7 +683,7 @@ export interface ImageGenerateParamsBase {
|
|
|
683
683
|
/**
|
|
684
684
|
* A unique identifier representing your end-user, which can help OpenAI to monitor
|
|
685
685
|
* and detect abuse.
|
|
686
|
-
* [Learn more](https://
|
|
686
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
687
687
|
*/
|
|
688
688
|
user?: string;
|
|
689
689
|
}
|
|
@@ -694,7 +694,7 @@ export declare namespace ImageGenerateParams {
|
|
|
694
694
|
export interface ImageGenerateParamsNonStreaming extends ImageGenerateParamsBase {
|
|
695
695
|
/**
|
|
696
696
|
* Generate the image in streaming mode. Defaults to `false`. See the
|
|
697
|
-
* [Image generation guide](https://
|
|
697
|
+
* [Image generation guide](https://developers.openai.com/api/docs/guides/image-generation)
|
|
698
698
|
* for more information. This parameter is only supported for the GPT image models.
|
|
699
699
|
*/
|
|
700
700
|
stream?: false | null;
|
|
@@ -702,7 +702,7 @@ export interface ImageGenerateParamsNonStreaming extends ImageGenerateParamsBase
|
|
|
702
702
|
export interface ImageGenerateParamsStreaming extends ImageGenerateParamsBase {
|
|
703
703
|
/**
|
|
704
704
|
* Generate the image in streaming mode. Defaults to `false`. See the
|
|
705
|
-
* [Image generation guide](https://
|
|
705
|
+
* [Image generation guide](https://developers.openai.com/api/docs/guides/image-generation)
|
|
706
706
|
* for more information. This parameter is only supported for the GPT image models.
|
|
707
707
|
*/
|
|
708
708
|
stream: true;
|
package/resources/images.d.ts
CHANGED
|
@@ -36,7 +36,7 @@ export declare class Images extends APIResource {
|
|
|
36
36
|
edit(body: ImageEditParamsBase, options?: RequestOptions): APIPromise<Stream<ImageEditStreamEvent> | ImagesResponse>;
|
|
37
37
|
/**
|
|
38
38
|
* Creates an image given a prompt.
|
|
39
|
-
* [Learn more](https://
|
|
39
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/images-vision).
|
|
40
40
|
*
|
|
41
41
|
* @example
|
|
42
42
|
* ```ts
|
|
@@ -426,7 +426,7 @@ export interface ImageCreateVariationParams {
|
|
|
426
426
|
/**
|
|
427
427
|
* A unique identifier representing your end-user, which can help OpenAI to monitor
|
|
428
428
|
* and detect abuse.
|
|
429
|
-
* [Learn more](https://
|
|
429
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
430
430
|
*/
|
|
431
431
|
user?: string;
|
|
432
432
|
}
|
|
@@ -542,14 +542,14 @@ export interface ImageEditParamsBase {
|
|
|
542
542
|
size?: (string & {}) | '256x256' | '512x512' | '1024x1024' | '1536x1024' | '1024x1536' | 'auto' | null;
|
|
543
543
|
/**
|
|
544
544
|
* Edit the image in streaming mode. Defaults to `false`. See the
|
|
545
|
-
* [Image generation guide](https://
|
|
545
|
+
* [Image generation guide](https://developers.openai.com/api/docs/guides/image-generation)
|
|
546
546
|
* for more information.
|
|
547
547
|
*/
|
|
548
548
|
stream?: boolean | null;
|
|
549
549
|
/**
|
|
550
550
|
* A unique identifier representing your end-user, which can help OpenAI to monitor
|
|
551
551
|
* and detect abuse.
|
|
552
|
-
* [Learn more](https://
|
|
552
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
553
553
|
*/
|
|
554
554
|
user?: string;
|
|
555
555
|
}
|
|
@@ -560,7 +560,7 @@ export declare namespace ImageEditParams {
|
|
|
560
560
|
export interface ImageEditParamsNonStreaming extends ImageEditParamsBase {
|
|
561
561
|
/**
|
|
562
562
|
* Edit the image in streaming mode. Defaults to `false`. See the
|
|
563
|
-
* [Image generation guide](https://
|
|
563
|
+
* [Image generation guide](https://developers.openai.com/api/docs/guides/image-generation)
|
|
564
564
|
* for more information.
|
|
565
565
|
*/
|
|
566
566
|
stream?: false | null;
|
|
@@ -568,7 +568,7 @@ export interface ImageEditParamsNonStreaming extends ImageEditParamsBase {
|
|
|
568
568
|
export interface ImageEditParamsStreaming extends ImageEditParamsBase {
|
|
569
569
|
/**
|
|
570
570
|
* Edit the image in streaming mode. Defaults to `false`. See the
|
|
571
|
-
* [Image generation guide](https://
|
|
571
|
+
* [Image generation guide](https://developers.openai.com/api/docs/guides/image-generation)
|
|
572
572
|
* for more information.
|
|
573
573
|
*/
|
|
574
574
|
stream: true;
|
|
@@ -669,7 +669,7 @@ export interface ImageGenerateParamsBase {
|
|
|
669
669
|
size?: (string & {}) | 'auto' | '1024x1024' | '1536x1024' | '1024x1536' | '256x256' | '512x512' | '1792x1024' | '1024x1792' | null;
|
|
670
670
|
/**
|
|
671
671
|
* Generate the image in streaming mode. Defaults to `false`. See the
|
|
672
|
-
* [Image generation guide](https://
|
|
672
|
+
* [Image generation guide](https://developers.openai.com/api/docs/guides/image-generation)
|
|
673
673
|
* for more information. This parameter is only supported for the GPT image models.
|
|
674
674
|
*/
|
|
675
675
|
stream?: boolean | null;
|
|
@@ -683,7 +683,7 @@ export interface ImageGenerateParamsBase {
|
|
|
683
683
|
/**
|
|
684
684
|
* A unique identifier representing your end-user, which can help OpenAI to monitor
|
|
685
685
|
* and detect abuse.
|
|
686
|
-
* [Learn more](https://
|
|
686
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
|
|
687
687
|
*/
|
|
688
688
|
user?: string;
|
|
689
689
|
}
|
|
@@ -694,7 +694,7 @@ export declare namespace ImageGenerateParams {
|
|
|
694
694
|
export interface ImageGenerateParamsNonStreaming extends ImageGenerateParamsBase {
|
|
695
695
|
/**
|
|
696
696
|
* Generate the image in streaming mode. Defaults to `false`. See the
|
|
697
|
-
* [Image generation guide](https://
|
|
697
|
+
* [Image generation guide](https://developers.openai.com/api/docs/guides/image-generation)
|
|
698
698
|
* for more information. This parameter is only supported for the GPT image models.
|
|
699
699
|
*/
|
|
700
700
|
stream?: false | null;
|
|
@@ -702,7 +702,7 @@ export interface ImageGenerateParamsNonStreaming extends ImageGenerateParamsBase
|
|
|
702
702
|
export interface ImageGenerateParamsStreaming extends ImageGenerateParamsBase {
|
|
703
703
|
/**
|
|
704
704
|
* Generate the image in streaming mode. Defaults to `false`. See the
|
|
705
|
-
* [Image generation guide](https://
|
|
705
|
+
* [Image generation guide](https://developers.openai.com/api/docs/guides/image-generation)
|
|
706
706
|
* for more information. This parameter is only supported for the GPT image models.
|
|
707
707
|
*/
|
|
708
708
|
stream: true;
|
|
@@ -7,7 +7,8 @@ import { RequestOptions } from "../internal/request-options.mjs";
|
|
|
7
7
|
export declare class Moderations extends APIResource {
|
|
8
8
|
/**
|
|
9
9
|
* Classifies if text and/or image inputs are potentially harmful. Learn more in
|
|
10
|
-
* the
|
|
10
|
+
* the
|
|
11
|
+
* [moderation guide](https://developers.openai.com/api/docs/guides/moderation).
|
|
11
12
|
*/
|
|
12
13
|
create(body: ModerationCreateParams, options?: RequestOptions): APIPromise<ModerationCreateResponse>;
|
|
13
14
|
}
|
|
@@ -286,9 +287,9 @@ export interface ModerationCreateParams {
|
|
|
286
287
|
input: string | Array<string> | Array<ModerationMultiModalInput>;
|
|
287
288
|
/**
|
|
288
289
|
* The content moderation model you would like to use. Learn more in
|
|
289
|
-
* [the moderation guide](https://
|
|
290
|
-
* learn about available models
|
|
291
|
-
* [here](https://
|
|
290
|
+
* [the moderation guide](https://developers.openai.com/api/docs/guides/moderation),
|
|
291
|
+
* and learn about available models
|
|
292
|
+
* [here](https://developers.openai.com/api/docs/guides/moderation).
|
|
292
293
|
*/
|
|
293
294
|
model?: (string & {}) | ModerationModel;
|
|
294
295
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"moderations.d.mts","sourceRoot":"","sources":["../src/resources/moderations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C
|
|
1
|
+
{"version":3,"file":"moderations.d.mts","sourceRoot":"","sources":["../src/resources/moderations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAGrG;AAED,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC;IAElC;;OAEG;IACH,4BAA4B,EAAE,UAAU,CAAC,yBAAyB,CAAC;IAEnE;;OAEG;IACH,eAAe,EAAE,UAAU,CAAC,cAAc,CAAC;IAE3C;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,yBAAiB,UAAU,CAAC;IAC1B;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,UAAU,EAAE,OAAO,CAAC;QAEpB;;;WAGG;QACH,wBAAwB,EAAE,OAAO,CAAC;QAElC;;;;;WAKG;QACH,IAAI,EAAE,OAAO,CAAC;QAEd;;;;WAIG;QACH,kBAAkB,EAAE,OAAO,CAAC;QAE5B;;;;WAIG;QACH,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;QAExB;;;;WAIG;QACH,iBAAiB,EAAE,OAAO,GAAG,IAAI,CAAC;QAElC;;;WAGG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB;;;;WAIG;QACH,wBAAwB,EAAE,OAAO,CAAC;QAElC;;;WAGG;QACH,kBAAkB,EAAE,OAAO,CAAC;QAE5B;;;;WAIG;QACH,MAAM,EAAE,OAAO,CAAC;QAEhB;;WAEG;QACH,eAAe,EAAE,OAAO,CAAC;QAEzB;;WAEG;QACH,QAAQ,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,kBAAkB,EAAE,OAAO,CAAC;KAC7B;IAED;;OAEG;IACH,UAAiB,yBAAyB;QACxC;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;WAEG;QACH,wBAAwB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAExC;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpB;;WAEG;QACH,kBAAkB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAElC;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEvB;;WAEG;QACH,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEjC;;WAEG;QACH,WAAW,EAAE,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC;QAErC;;WAEG;QACH,wBAAwB,EAAE,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC;QAElD;;WAEG;QACH,kBAAkB,EAAE,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC;QAE5C;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC;QAEhC;;WAEG;QACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC;QAElC;;WAEG;QACH,kBAAkB,EAAE,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC;KAC7C;IAED;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,wBAAwB,EAAE,MAAM,CAAC;QAEjC;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,wBAAwB,EAAE,MAAM,CAAC;QAEjC;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,SAAS,EAAE,uBAAuB,CAAC,QAAQ,CAAC;IAE5C;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;CACnB;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,MAAM,eAAe,GACvB,wBAAwB,GACxB,4BAA4B,GAC5B,wBAAwB,GACxB,wBAAwB,CAAC;AAE7B;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,uBAAuB,GAAG,mBAAmB,CAAC;AAEtF;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAEjE;;;;;OAKG;IACH,KAAK,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,eAAe,CAAC;CACzC;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -7,7 +7,8 @@ import { RequestOptions } from "../internal/request-options.js";
|
|
|
7
7
|
export declare class Moderations extends APIResource {
|
|
8
8
|
/**
|
|
9
9
|
* Classifies if text and/or image inputs are potentially harmful. Learn more in
|
|
10
|
-
* the
|
|
10
|
+
* the
|
|
11
|
+
* [moderation guide](https://developers.openai.com/api/docs/guides/moderation).
|
|
11
12
|
*/
|
|
12
13
|
create(body: ModerationCreateParams, options?: RequestOptions): APIPromise<ModerationCreateResponse>;
|
|
13
14
|
}
|
|
@@ -286,9 +287,9 @@ export interface ModerationCreateParams {
|
|
|
286
287
|
input: string | Array<string> | Array<ModerationMultiModalInput>;
|
|
287
288
|
/**
|
|
288
289
|
* The content moderation model you would like to use. Learn more in
|
|
289
|
-
* [the moderation guide](https://
|
|
290
|
-
* learn about available models
|
|
291
|
-
* [here](https://
|
|
290
|
+
* [the moderation guide](https://developers.openai.com/api/docs/guides/moderation),
|
|
291
|
+
* and learn about available models
|
|
292
|
+
* [here](https://developers.openai.com/api/docs/guides/moderation).
|
|
292
293
|
*/
|
|
293
294
|
model?: (string & {}) | ModerationModel;
|
|
294
295
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"moderations.d.ts","sourceRoot":"","sources":["../src/resources/moderations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C
|
|
1
|
+
{"version":3,"file":"moderations.d.ts","sourceRoot":"","sources":["../src/resources/moderations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAGrG;AAED,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC;IAElC;;OAEG;IACH,4BAA4B,EAAE,UAAU,CAAC,yBAAyB,CAAC;IAEnE;;OAEG;IACH,eAAe,EAAE,UAAU,CAAC,cAAc,CAAC;IAE3C;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,yBAAiB,UAAU,CAAC;IAC1B;;OAEG;IACH,UAAiB,UAAU;QACzB;;;WAGG;QACH,UAAU,EAAE,OAAO,CAAC;QAEpB;;;WAGG;QACH,wBAAwB,EAAE,OAAO,CAAC;QAElC;;;;;WAKG;QACH,IAAI,EAAE,OAAO,CAAC;QAEd;;;;WAIG;QACH,kBAAkB,EAAE,OAAO,CAAC;QAE5B;;;;WAIG;QACH,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;QAExB;;;;WAIG;QACH,iBAAiB,EAAE,OAAO,GAAG,IAAI,CAAC;QAElC;;;WAGG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB;;;;WAIG;QACH,wBAAwB,EAAE,OAAO,CAAC;QAElC;;;WAGG;QACH,kBAAkB,EAAE,OAAO,CAAC;QAE5B;;;;WAIG;QACH,MAAM,EAAE,OAAO,CAAC;QAEhB;;WAEG;QACH,eAAe,EAAE,OAAO,CAAC;QAEzB;;WAEG;QACH,QAAQ,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,kBAAkB,EAAE,OAAO,CAAC;KAC7B;IAED;;OAEG;IACH,UAAiB,yBAAyB;QACxC;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;WAEG;QACH,wBAAwB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAExC;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpB;;WAEG;QACH,kBAAkB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAElC;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEvB;;WAEG;QACH,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEjC;;WAEG;QACH,WAAW,EAAE,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC;QAErC;;WAEG;QACH,wBAAwB,EAAE,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC;QAElD;;WAEG;QACH,kBAAkB,EAAE,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC;QAE5C;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC;QAEhC;;WAEG;QACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC;QAElC;;WAEG;QACH,kBAAkB,EAAE,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC;KAC7C;IAED;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,wBAAwB,EAAE,MAAM,CAAC;QAEjC;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,wBAAwB,EAAE,MAAM,CAAC;QAEjC;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,SAAS,EAAE,uBAAuB,CAAC,QAAQ,CAAC;IAE5C;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;CACnB;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,MAAM,eAAe,GACvB,wBAAwB,GACxB,4BAA4B,GAC5B,wBAAwB,GACxB,wBAAwB,CAAC;AAE7B;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,uBAAuB,GAAG,mBAAmB,CAAC;AAEtF;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAEjE;;;;;OAKG;IACH,KAAK,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,eAAe,CAAC;CACzC;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
package/resources/moderations.js
CHANGED
|
@@ -9,7 +9,8 @@ const resource_1 = require("../core/resource.js");
|
|
|
9
9
|
class Moderations extends resource_1.APIResource {
|
|
10
10
|
/**
|
|
11
11
|
* Classifies if text and/or image inputs are potentially harmful. Learn more in
|
|
12
|
-
* the
|
|
12
|
+
* the
|
|
13
|
+
* [moderation guide](https://developers.openai.com/api/docs/guides/moderation).
|
|
13
14
|
*/
|
|
14
15
|
create(body, options) {
|
|
15
16
|
return this._client.post('/moderations', { body, ...options, __security: { bearerAuth: true } });
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"moderations.js","sourceRoot":"","sources":["../src/resources/moderations.ts"],"names":[],"mappings":";AAAA,qFAAqF;;;AAErF,kDAA+C;AAI/C;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C
|
|
1
|
+
{"version":3,"file":"moderations.js","sourceRoot":"","sources":["../src/resources/moderations.ts"],"names":[],"mappings":";AAAA,qFAAqF;;;AAErF,kDAA+C;AAI/C;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;OAIG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,UAAU,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;IACnG,CAAC;CACF;AATD,kCASC"}
|
|
@@ -6,7 +6,8 @@ import { APIResource } from "../core/resource.mjs";
|
|
|
6
6
|
export class Moderations extends APIResource {
|
|
7
7
|
/**
|
|
8
8
|
* Classifies if text and/or image inputs are potentially harmful. Learn more in
|
|
9
|
-
* the
|
|
9
|
+
* the
|
|
10
|
+
* [moderation guide](https://developers.openai.com/api/docs/guides/moderation).
|
|
10
11
|
*/
|
|
11
12
|
create(body, options) {
|
|
12
13
|
return this._client.post('/moderations', { body, ...options, __security: { bearerAuth: true } });
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"moderations.mjs","sourceRoot":"","sources":["../src/resources/moderations.ts"],"names":[],"mappings":"AAAA,qFAAqF;AAErF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C
|
|
1
|
+
{"version":3,"file":"moderations.mjs","sourceRoot":"","sources":["../src/resources/moderations.ts"],"names":[],"mappings":"AAAA,qFAAqF;AAErF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;OAIG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,UAAU,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;IACnG,CAAC;CACF"}
|
|
@@ -122,7 +122,7 @@ export interface CallAcceptParams {
|
|
|
122
122
|
parallel_tool_calls?: boolean;
|
|
123
123
|
/**
|
|
124
124
|
* Reference to a prompt template and its variables.
|
|
125
|
-
* [Learn more](https://
|
|
125
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
126
126
|
*/
|
|
127
127
|
prompt?: ResponsesAPI.ResponsePrompt | null;
|
|
128
128
|
/**
|
|
@@ -122,7 +122,7 @@ export interface CallAcceptParams {
|
|
|
122
122
|
parallel_tool_calls?: boolean;
|
|
123
123
|
/**
|
|
124
124
|
* Reference to a prompt template and its variables.
|
|
125
|
-
* [Learn more](https://
|
|
125
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
126
126
|
*/
|
|
127
127
|
prompt?: ResponsesAPI.ResponsePrompt | null;
|
|
128
128
|
/**
|
|
@@ -17,7 +17,7 @@ export declare class ClientSecrets extends APIResource {
|
|
|
17
17
|
* will be applied to any sessions created using that client secret, but these can
|
|
18
18
|
* also be overridden by the client connection.
|
|
19
19
|
*
|
|
20
|
-
* [Learn more about authentication with client secrets over WebRTC](https://
|
|
20
|
+
* [Learn more about authentication with client secrets over WebRTC](https://developers.openai.com/api/docs/guides/realtime-webrtc).
|
|
21
21
|
*
|
|
22
22
|
* Returns the created client secret and the effective session object. The client
|
|
23
23
|
* secret is a string that looks like `ek_1234`.
|
|
@@ -94,7 +94,7 @@ export interface RealtimeSessionCreateResponse {
|
|
|
94
94
|
output_modalities?: Array<'text' | 'audio'>;
|
|
95
95
|
/**
|
|
96
96
|
* Reference to a prompt template and its variables.
|
|
97
|
-
* [Learn more](https://
|
|
97
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
98
98
|
*/
|
|
99
99
|
prompt?: ResponsesAPI.ResponsePrompt | null;
|
|
100
100
|
/**
|
|
@@ -318,7 +318,7 @@ export declare namespace RealtimeSessionCreateResponse {
|
|
|
318
318
|
/**
|
|
319
319
|
* Give the model access to additional tools via remote Model Context Protocol
|
|
320
320
|
* (MCP) servers.
|
|
321
|
-
* [Learn more about MCP](https://
|
|
321
|
+
* [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
322
322
|
*/
|
|
323
323
|
interface McpTool {
|
|
324
324
|
/**
|
|
@@ -347,7 +347,7 @@ export declare namespace RealtimeSessionCreateResponse {
|
|
|
347
347
|
* Identifier for service connectors, like those available in ChatGPT. One of
|
|
348
348
|
* `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
|
|
349
349
|
* service connectors
|
|
350
|
-
* [here](https://
|
|
350
|
+
* [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
|
|
351
351
|
*
|
|
352
352
|
* Currently supported `connector_id` values are:
|
|
353
353
|
*
|
|
@@ -17,7 +17,7 @@ export declare class ClientSecrets extends APIResource {
|
|
|
17
17
|
* will be applied to any sessions created using that client secret, but these can
|
|
18
18
|
* also be overridden by the client connection.
|
|
19
19
|
*
|
|
20
|
-
* [Learn more about authentication with client secrets over WebRTC](https://
|
|
20
|
+
* [Learn more about authentication with client secrets over WebRTC](https://developers.openai.com/api/docs/guides/realtime-webrtc).
|
|
21
21
|
*
|
|
22
22
|
* Returns the created client secret and the effective session object. The client
|
|
23
23
|
* secret is a string that looks like `ek_1234`.
|
|
@@ -94,7 +94,7 @@ export interface RealtimeSessionCreateResponse {
|
|
|
94
94
|
output_modalities?: Array<'text' | 'audio'>;
|
|
95
95
|
/**
|
|
96
96
|
* Reference to a prompt template and its variables.
|
|
97
|
-
* [Learn more](https://
|
|
97
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
98
98
|
*/
|
|
99
99
|
prompt?: ResponsesAPI.ResponsePrompt | null;
|
|
100
100
|
/**
|
|
@@ -318,7 +318,7 @@ export declare namespace RealtimeSessionCreateResponse {
|
|
|
318
318
|
/**
|
|
319
319
|
* Give the model access to additional tools via remote Model Context Protocol
|
|
320
320
|
* (MCP) servers.
|
|
321
|
-
* [Learn more about MCP](https://
|
|
321
|
+
* [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
322
322
|
*/
|
|
323
323
|
interface McpTool {
|
|
324
324
|
/**
|
|
@@ -347,7 +347,7 @@ export declare namespace RealtimeSessionCreateResponse {
|
|
|
347
347
|
* Identifier for service connectors, like those available in ChatGPT. One of
|
|
348
348
|
* `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
|
|
349
349
|
* service connectors
|
|
350
|
-
* [here](https://
|
|
350
|
+
* [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
|
|
351
351
|
*
|
|
352
352
|
* Currently supported `connector_id` values are:
|
|
353
353
|
*
|
|
@@ -16,7 +16,7 @@ class ClientSecrets extends resource_1.APIResource {
|
|
|
16
16
|
* will be applied to any sessions created using that client secret, but these can
|
|
17
17
|
* also be overridden by the client connection.
|
|
18
18
|
*
|
|
19
|
-
* [Learn more about authentication with client secrets over WebRTC](https://
|
|
19
|
+
* [Learn more about authentication with client secrets over WebRTC](https://developers.openai.com/api/docs/guides/realtime-webrtc).
|
|
20
20
|
*
|
|
21
21
|
* Returns the created client secret and the effective session object. The client
|
|
22
22
|
* secret is a string that looks like `ek_1234`.
|
|
@@ -13,7 +13,7 @@ export class ClientSecrets extends APIResource {
|
|
|
13
13
|
* will be applied to any sessions created using that client secret, but these can
|
|
14
14
|
* also be overridden by the client connection.
|
|
15
15
|
*
|
|
16
|
-
* [Learn more about authentication with client secrets over WebRTC](https://
|
|
16
|
+
* [Learn more about authentication with client secrets over WebRTC](https://developers.openai.com/api/docs/guides/realtime-webrtc).
|
|
17
17
|
*
|
|
18
18
|
* Returns the created client secret and the effective session object. The client
|
|
19
19
|
* secret is a string that looks like `ek_1234`.
|
|
@@ -46,7 +46,7 @@ export interface AudioTranscription {
|
|
|
46
46
|
/**
|
|
47
47
|
* An optional text to guide the model's style or continue a previous audio
|
|
48
48
|
* segment. For `whisper-1`, the
|
|
49
|
-
* [prompt is a list of keywords](https://
|
|
49
|
+
* [prompt is a list of keywords](https://developers.openai.com/api/docs/guides/speech-to-text#prompting).
|
|
50
50
|
* For `gpt-4o-transcribe` models (excluding `gpt-4o-transcribe-diarize`), the
|
|
51
51
|
* prompt is a free text string, for example "expect words related to technology".
|
|
52
52
|
* Prompt is not supported with `gpt-realtime-whisper` in GA Realtime sessions.
|
|
@@ -964,7 +964,7 @@ export type NoiseReductionType = 'near_field' | 'far_field';
|
|
|
964
964
|
* trigger the server to stop generating audio and emit a
|
|
965
965
|
* `output_audio_buffer.cleared` event. This event should be preceded by a
|
|
966
966
|
* `response.cancel` client event to stop the generation of the current response.
|
|
967
|
-
* [Learn more](https://
|
|
967
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
|
|
968
968
|
*/
|
|
969
969
|
export interface OutputAudioBufferClearEvent {
|
|
970
970
|
/**
|
|
@@ -1041,7 +1041,7 @@ export interface RealtimeAudioConfigInput {
|
|
|
1041
1041
|
* `null` to turn off once on. Input audio transcription is not native to the
|
|
1042
1042
|
* model, since the model consumes audio directly. Transcription runs
|
|
1043
1043
|
* asynchronously through
|
|
1044
|
-
* [the /audio/transcriptions endpoint](https://
|
|
1044
|
+
* [the /audio/transcriptions endpoint](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
|
|
1045
1045
|
* and should be treated as guidance of input audio content rather than precisely
|
|
1046
1046
|
* what the model heard. The client can optionally set the language and prompt for
|
|
1047
1047
|
* transcription, these offer additional guidance to the transcription service.
|
|
@@ -1858,7 +1858,7 @@ export declare namespace RealtimeResponseCreateAudioOutput {
|
|
|
1858
1858
|
/**
|
|
1859
1859
|
* Give the model access to additional tools via remote Model Context Protocol
|
|
1860
1860
|
* (MCP) servers.
|
|
1861
|
-
* [Learn more about MCP](https://
|
|
1861
|
+
* [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
1862
1862
|
*/
|
|
1863
1863
|
export interface RealtimeResponseCreateMcpTool {
|
|
1864
1864
|
/**
|
|
@@ -1887,7 +1887,7 @@ export interface RealtimeResponseCreateMcpTool {
|
|
|
1887
1887
|
* Identifier for service connectors, like those available in ChatGPT. One of
|
|
1888
1888
|
* `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
|
|
1889
1889
|
* service connectors
|
|
1890
|
-
* [here](https://
|
|
1890
|
+
* [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
|
|
1891
1891
|
*
|
|
1892
1892
|
* Currently supported `connector_id` values are:
|
|
1893
1893
|
*
|
|
@@ -2062,7 +2062,7 @@ export interface RealtimeResponseCreateParams {
|
|
|
2062
2062
|
parallel_tool_calls?: boolean;
|
|
2063
2063
|
/**
|
|
2064
2064
|
* Reference to a prompt template and its variables.
|
|
2065
|
-
* [Learn more](https://
|
|
2065
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
2066
2066
|
*/
|
|
2067
2067
|
prompt?: ResponsesAPI.ResponsePrompt | null;
|
|
2068
2068
|
/**
|
|
@@ -2242,7 +2242,7 @@ export declare namespace RealtimeServerEvent {
|
|
|
2242
2242
|
* **WebRTC/SIP Only:** Emitted when the server begins streaming audio to the
|
|
2243
2243
|
* client. This event is emitted after an audio content part has been added
|
|
2244
2244
|
* (`response.content_part.added`) to the response.
|
|
2245
|
-
* [Learn more](https://
|
|
2245
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
|
|
2246
2246
|
*/
|
|
2247
2247
|
interface OutputAudioBufferStarted {
|
|
2248
2248
|
/**
|
|
@@ -2262,7 +2262,7 @@ export declare namespace RealtimeServerEvent {
|
|
|
2262
2262
|
* **WebRTC/SIP Only:** Emitted when the output audio buffer has been completely
|
|
2263
2263
|
* drained on the server, and no more audio is forthcoming. This event is emitted
|
|
2264
2264
|
* after the full response data has been sent to the client (`response.done`).
|
|
2265
|
-
* [Learn more](https://
|
|
2265
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
|
|
2266
2266
|
*/
|
|
2267
2267
|
interface OutputAudioBufferStopped {
|
|
2268
2268
|
/**
|
|
@@ -2284,7 +2284,7 @@ export declare namespace RealtimeServerEvent {
|
|
|
2284
2284
|
* (`input_audio_buffer.speech_started`), or when the client has emitted the
|
|
2285
2285
|
* `output_audio_buffer.clear` event to manually cut off the current audio
|
|
2286
2286
|
* response.
|
|
2287
|
-
* [Learn more](https://
|
|
2287
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
|
|
2288
2288
|
*/
|
|
2289
2289
|
interface OutputAudioBufferCleared {
|
|
2290
2290
|
/**
|
|
@@ -2339,7 +2339,7 @@ export interface RealtimeSession {
|
|
|
2339
2339
|
* `null` to turn off once on. Input audio transcription is not native to the
|
|
2340
2340
|
* model, since the model consumes audio directly. Transcription runs
|
|
2341
2341
|
* asynchronously through
|
|
2342
|
-
* [the /audio/transcriptions endpoint](https://
|
|
2342
|
+
* [the /audio/transcriptions endpoint](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
|
|
2343
2343
|
* and should be treated as guidance of input audio content rather than precisely
|
|
2344
2344
|
* what the model heard. The client can optionally set the language and prompt for
|
|
2345
2345
|
* transcription, these offer additional guidance to the transcription service.
|
|
@@ -2385,7 +2385,7 @@ export interface RealtimeSession {
|
|
|
2385
2385
|
output_audio_format?: 'pcm16' | 'g711_ulaw' | 'g711_alaw';
|
|
2386
2386
|
/**
|
|
2387
2387
|
* Reference to a prompt template and its variables.
|
|
2388
|
-
* [Learn more](https://
|
|
2388
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
2389
2389
|
*/
|
|
2390
2390
|
prompt?: ResponsesAPI.ResponsePrompt | null;
|
|
2391
2391
|
/**
|
|
@@ -2625,7 +2625,7 @@ export interface RealtimeSessionCreateRequest {
|
|
|
2625
2625
|
parallel_tool_calls?: boolean;
|
|
2626
2626
|
/**
|
|
2627
2627
|
* Reference to a prompt template and its variables.
|
|
2628
|
-
* [Learn more](https://
|
|
2628
|
+
* [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
|
|
2629
2629
|
*/
|
|
2630
2630
|
prompt?: ResponsesAPI.ResponsePrompt | null;
|
|
2631
2631
|
/**
|
|
@@ -2685,14 +2685,14 @@ export type RealtimeToolsConfig = Array<RealtimeToolsConfigUnion>;
|
|
|
2685
2685
|
/**
|
|
2686
2686
|
* Give the model access to additional tools via remote Model Context Protocol
|
|
2687
2687
|
* (MCP) servers.
|
|
2688
|
-
* [Learn more about MCP](https://
|
|
2688
|
+
* [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
2689
2689
|
*/
|
|
2690
2690
|
export type RealtimeToolsConfigUnion = RealtimeFunctionTool | RealtimeToolsConfigUnion.Mcp;
|
|
2691
2691
|
export declare namespace RealtimeToolsConfigUnion {
|
|
2692
2692
|
/**
|
|
2693
2693
|
* Give the model access to additional tools via remote Model Context Protocol
|
|
2694
2694
|
* (MCP) servers.
|
|
2695
|
-
* [Learn more about MCP](https://
|
|
2695
|
+
* [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
|
|
2696
2696
|
*/
|
|
2697
2697
|
interface Mcp {
|
|
2698
2698
|
/**
|
|
@@ -2721,7 +2721,7 @@ export declare namespace RealtimeToolsConfigUnion {
|
|
|
2721
2721
|
* Identifier for service connectors, like those available in ChatGPT. One of
|
|
2722
2722
|
* `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
|
|
2723
2723
|
* service connectors
|
|
2724
|
-
* [here](https://
|
|
2724
|
+
* [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
|
|
2725
2725
|
*
|
|
2726
2726
|
* Currently supported `connector_id` values are:
|
|
2727
2727
|
*
|
|
@@ -2888,7 +2888,7 @@ export interface RealtimeTranscriptionSessionAudioInput {
|
|
|
2888
2888
|
* `null` to turn off once on. Input audio transcription is not native to the
|
|
2889
2889
|
* model, since the model consumes audio directly. Transcription runs
|
|
2890
2890
|
* asynchronously through
|
|
2891
|
-
* [the /audio/transcriptions endpoint](https://
|
|
2891
|
+
* [the /audio/transcriptions endpoint](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
|
|
2892
2892
|
* and should be treated as guidance of input audio content rather than precisely
|
|
2893
2893
|
* what the model heard. The client can optionally set the language and prompt for
|
|
2894
2894
|
* transcription, these offer additional guidance to the transcription service.
|