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
|
@@ -128,10 +128,10 @@ export interface Assistant {
|
|
|
128
128
|
|
|
129
129
|
/**
|
|
130
130
|
* ID of the model to use. You can use the
|
|
131
|
-
* [List models](https://
|
|
132
|
-
* see all of your available models, or see our
|
|
133
|
-
* [Model overview](https://
|
|
134
|
-
* them.
|
|
131
|
+
* [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
|
|
132
|
+
* API to see all of your available models, or see our
|
|
133
|
+
* [Model overview](https://developers.openai.com/api/docs/models) for descriptions
|
|
134
|
+
* of them.
|
|
135
135
|
*/
|
|
136
136
|
model: string;
|
|
137
137
|
|
|
@@ -154,14 +154,14 @@ export interface Assistant {
|
|
|
154
154
|
|
|
155
155
|
/**
|
|
156
156
|
* Specifies the format that the model must output. Compatible with
|
|
157
|
-
* [GPT-4o](https://
|
|
158
|
-
* [GPT-4 Turbo](https://
|
|
159
|
-
*
|
|
157
|
+
* [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
|
|
158
|
+
* [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
|
|
159
|
+
* all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
|
|
160
160
|
*
|
|
161
161
|
* Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
|
|
162
162
|
* Outputs which ensures the model will match your supplied JSON schema. Learn more
|
|
163
163
|
* in the
|
|
164
|
-
* [Structured Outputs guide](https://
|
|
164
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
165
165
|
*
|
|
166
166
|
* Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
|
|
167
167
|
* message the model generates is valid JSON.
|
|
@@ -217,9 +217,9 @@ export namespace Assistant {
|
|
|
217
217
|
export namespace ToolResources {
|
|
218
218
|
export interface CodeInterpreter {
|
|
219
219
|
/**
|
|
220
|
-
* A list of [file](https://
|
|
221
|
-
* available to the `code_interpreter`` tool. There can be a maximum of 20
|
|
222
|
-
* associated with the tool.
|
|
220
|
+
* A list of [file](https://developers.openai.com/api/reference/resources/files)
|
|
221
|
+
* IDs made available to the `code_interpreter`` tool. There can be a maximum of 20
|
|
222
|
+
* files associated with the tool.
|
|
223
223
|
*/
|
|
224
224
|
file_ids?: Array<string>;
|
|
225
225
|
}
|
|
@@ -227,7 +227,7 @@ export namespace Assistant {
|
|
|
227
227
|
export interface FileSearch {
|
|
228
228
|
/**
|
|
229
229
|
* The ID of the
|
|
230
|
-
* [vector store](https://
|
|
230
|
+
* [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
|
|
231
231
|
* attached to this assistant. There can be a maximum of 1 vector store attached to
|
|
232
232
|
* the assistant.
|
|
233
233
|
*/
|
|
@@ -263,7 +263,7 @@ export interface AssistantDeleted {
|
|
|
263
263
|
*
|
|
264
264
|
* We may add additional events over time, so we recommend handling unknown events
|
|
265
265
|
* gracefully in your code. See the
|
|
266
|
-
* [Assistants API quickstart](https://
|
|
266
|
+
* [Assistants API quickstart](https://developers.openai.com/api/docs/assistants/migration)
|
|
267
267
|
* to learn how to integrate the Assistants API with streaming.
|
|
268
268
|
*/
|
|
269
269
|
export type AssistantStreamEvent =
|
|
@@ -295,13 +295,13 @@ export type AssistantStreamEvent =
|
|
|
295
295
|
export namespace AssistantStreamEvent {
|
|
296
296
|
/**
|
|
297
297
|
* Occurs when a new
|
|
298
|
-
* [thread](https://
|
|
298
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration) is
|
|
299
299
|
* created.
|
|
300
300
|
*/
|
|
301
301
|
export interface ThreadCreated {
|
|
302
302
|
/**
|
|
303
303
|
* Represents a thread that contains
|
|
304
|
-
* [messages](https://
|
|
304
|
+
* [messages](https://developers.openai.com/api/docs/assistants/migration).
|
|
305
305
|
*/
|
|
306
306
|
data: ThreadsAPI.Thread;
|
|
307
307
|
|
|
@@ -315,12 +315,12 @@ export namespace AssistantStreamEvent {
|
|
|
315
315
|
|
|
316
316
|
/**
|
|
317
317
|
* Occurs when a new
|
|
318
|
-
* [run](https://
|
|
318
|
+
* [run](https://developers.openai.com/api/docs/assistants/migration) is created.
|
|
319
319
|
*/
|
|
320
320
|
export interface ThreadRunCreated {
|
|
321
321
|
/**
|
|
322
322
|
* Represents an execution run on a
|
|
323
|
-
* [thread](https://
|
|
323
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
324
324
|
*/
|
|
325
325
|
data: RunsAPI.Run;
|
|
326
326
|
|
|
@@ -328,13 +328,13 @@ export namespace AssistantStreamEvent {
|
|
|
328
328
|
}
|
|
329
329
|
|
|
330
330
|
/**
|
|
331
|
-
* Occurs when a [run](https://
|
|
331
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
332
332
|
* moves to a `queued` status.
|
|
333
333
|
*/
|
|
334
334
|
export interface ThreadRunQueued {
|
|
335
335
|
/**
|
|
336
336
|
* Represents an execution run on a
|
|
337
|
-
* [thread](https://
|
|
337
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
338
338
|
*/
|
|
339
339
|
data: RunsAPI.Run;
|
|
340
340
|
|
|
@@ -342,13 +342,13 @@ export namespace AssistantStreamEvent {
|
|
|
342
342
|
}
|
|
343
343
|
|
|
344
344
|
/**
|
|
345
|
-
* Occurs when a [run](https://
|
|
345
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
346
346
|
* moves to an `in_progress` status.
|
|
347
347
|
*/
|
|
348
348
|
export interface ThreadRunInProgress {
|
|
349
349
|
/**
|
|
350
350
|
* Represents an execution run on a
|
|
351
|
-
* [thread](https://
|
|
351
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
352
352
|
*/
|
|
353
353
|
data: RunsAPI.Run;
|
|
354
354
|
|
|
@@ -356,13 +356,13 @@ export namespace AssistantStreamEvent {
|
|
|
356
356
|
}
|
|
357
357
|
|
|
358
358
|
/**
|
|
359
|
-
* Occurs when a [run](https://
|
|
359
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
360
360
|
* moves to a `requires_action` status.
|
|
361
361
|
*/
|
|
362
362
|
export interface ThreadRunRequiresAction {
|
|
363
363
|
/**
|
|
364
364
|
* Represents an execution run on a
|
|
365
|
-
* [thread](https://
|
|
365
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
366
366
|
*/
|
|
367
367
|
data: RunsAPI.Run;
|
|
368
368
|
|
|
@@ -370,13 +370,13 @@ export namespace AssistantStreamEvent {
|
|
|
370
370
|
}
|
|
371
371
|
|
|
372
372
|
/**
|
|
373
|
-
* Occurs when a [run](https://
|
|
373
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
374
374
|
* is completed.
|
|
375
375
|
*/
|
|
376
376
|
export interface ThreadRunCompleted {
|
|
377
377
|
/**
|
|
378
378
|
* Represents an execution run on a
|
|
379
|
-
* [thread](https://
|
|
379
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
380
380
|
*/
|
|
381
381
|
data: RunsAPI.Run;
|
|
382
382
|
|
|
@@ -384,13 +384,13 @@ export namespace AssistantStreamEvent {
|
|
|
384
384
|
}
|
|
385
385
|
|
|
386
386
|
/**
|
|
387
|
-
* Occurs when a [run](https://
|
|
387
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
388
388
|
* ends with status `incomplete`.
|
|
389
389
|
*/
|
|
390
390
|
export interface ThreadRunIncomplete {
|
|
391
391
|
/**
|
|
392
392
|
* Represents an execution run on a
|
|
393
|
-
* [thread](https://
|
|
393
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
394
394
|
*/
|
|
395
395
|
data: RunsAPI.Run;
|
|
396
396
|
|
|
@@ -398,13 +398,13 @@ export namespace AssistantStreamEvent {
|
|
|
398
398
|
}
|
|
399
399
|
|
|
400
400
|
/**
|
|
401
|
-
* Occurs when a [run](https://
|
|
401
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
402
402
|
* fails.
|
|
403
403
|
*/
|
|
404
404
|
export interface ThreadRunFailed {
|
|
405
405
|
/**
|
|
406
406
|
* Represents an execution run on a
|
|
407
|
-
* [thread](https://
|
|
407
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
408
408
|
*/
|
|
409
409
|
data: RunsAPI.Run;
|
|
410
410
|
|
|
@@ -412,13 +412,13 @@ export namespace AssistantStreamEvent {
|
|
|
412
412
|
}
|
|
413
413
|
|
|
414
414
|
/**
|
|
415
|
-
* Occurs when a [run](https://
|
|
415
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
416
416
|
* moves to a `cancelling` status.
|
|
417
417
|
*/
|
|
418
418
|
export interface ThreadRunCancelling {
|
|
419
419
|
/**
|
|
420
420
|
* Represents an execution run on a
|
|
421
|
-
* [thread](https://
|
|
421
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
422
422
|
*/
|
|
423
423
|
data: RunsAPI.Run;
|
|
424
424
|
|
|
@@ -426,13 +426,13 @@ export namespace AssistantStreamEvent {
|
|
|
426
426
|
}
|
|
427
427
|
|
|
428
428
|
/**
|
|
429
|
-
* Occurs when a [run](https://
|
|
429
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
430
430
|
* is cancelled.
|
|
431
431
|
*/
|
|
432
432
|
export interface ThreadRunCancelled {
|
|
433
433
|
/**
|
|
434
434
|
* Represents an execution run on a
|
|
435
|
-
* [thread](https://
|
|
435
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
436
436
|
*/
|
|
437
437
|
data: RunsAPI.Run;
|
|
438
438
|
|
|
@@ -440,13 +440,13 @@ export namespace AssistantStreamEvent {
|
|
|
440
440
|
}
|
|
441
441
|
|
|
442
442
|
/**
|
|
443
|
-
* Occurs when a [run](https://
|
|
443
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
444
444
|
* expires.
|
|
445
445
|
*/
|
|
446
446
|
export interface ThreadRunExpired {
|
|
447
447
|
/**
|
|
448
448
|
* Represents an execution run on a
|
|
449
|
-
* [thread](https://
|
|
449
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
450
450
|
*/
|
|
451
451
|
data: RunsAPI.Run;
|
|
452
452
|
|
|
@@ -455,8 +455,8 @@ export namespace AssistantStreamEvent {
|
|
|
455
455
|
|
|
456
456
|
/**
|
|
457
457
|
* Occurs when a
|
|
458
|
-
* [run step](https://
|
|
459
|
-
*
|
|
458
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) is
|
|
459
|
+
* created.
|
|
460
460
|
*/
|
|
461
461
|
export interface ThreadRunStepCreated {
|
|
462
462
|
/**
|
|
@@ -469,8 +469,8 @@ export namespace AssistantStreamEvent {
|
|
|
469
469
|
|
|
470
470
|
/**
|
|
471
471
|
* Occurs when a
|
|
472
|
-
* [run step](https://
|
|
473
|
-
*
|
|
472
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) moves to
|
|
473
|
+
* an `in_progress` state.
|
|
474
474
|
*/
|
|
475
475
|
export interface ThreadRunStepInProgress {
|
|
476
476
|
/**
|
|
@@ -483,8 +483,8 @@ export namespace AssistantStreamEvent {
|
|
|
483
483
|
|
|
484
484
|
/**
|
|
485
485
|
* Occurs when parts of a
|
|
486
|
-
* [run step](https://
|
|
487
|
-
*
|
|
486
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) are
|
|
487
|
+
* being streamed.
|
|
488
488
|
*/
|
|
489
489
|
export interface ThreadRunStepDelta {
|
|
490
490
|
/**
|
|
@@ -498,8 +498,8 @@ export namespace AssistantStreamEvent {
|
|
|
498
498
|
|
|
499
499
|
/**
|
|
500
500
|
* Occurs when a
|
|
501
|
-
* [run step](https://
|
|
502
|
-
*
|
|
501
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) is
|
|
502
|
+
* completed.
|
|
503
503
|
*/
|
|
504
504
|
export interface ThreadRunStepCompleted {
|
|
505
505
|
/**
|
|
@@ -512,8 +512,7 @@ export namespace AssistantStreamEvent {
|
|
|
512
512
|
|
|
513
513
|
/**
|
|
514
514
|
* Occurs when a
|
|
515
|
-
* [run step](https://
|
|
516
|
-
* fails.
|
|
515
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) fails.
|
|
517
516
|
*/
|
|
518
517
|
export interface ThreadRunStepFailed {
|
|
519
518
|
/**
|
|
@@ -526,8 +525,8 @@ export namespace AssistantStreamEvent {
|
|
|
526
525
|
|
|
527
526
|
/**
|
|
528
527
|
* Occurs when a
|
|
529
|
-
* [run step](https://
|
|
530
|
-
*
|
|
528
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) is
|
|
529
|
+
* cancelled.
|
|
531
530
|
*/
|
|
532
531
|
export interface ThreadRunStepCancelled {
|
|
533
532
|
/**
|
|
@@ -540,8 +539,7 @@ export namespace AssistantStreamEvent {
|
|
|
540
539
|
|
|
541
540
|
/**
|
|
542
541
|
* Occurs when a
|
|
543
|
-
* [run step](https://
|
|
544
|
-
* expires.
|
|
542
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) expires.
|
|
545
543
|
*/
|
|
546
544
|
export interface ThreadRunStepExpired {
|
|
547
545
|
/**
|
|
@@ -554,13 +552,13 @@ export namespace AssistantStreamEvent {
|
|
|
554
552
|
|
|
555
553
|
/**
|
|
556
554
|
* Occurs when a
|
|
557
|
-
* [message](https://
|
|
555
|
+
* [message](https://developers.openai.com/api/docs/assistants/migration) is
|
|
558
556
|
* created.
|
|
559
557
|
*/
|
|
560
558
|
export interface ThreadMessageCreated {
|
|
561
559
|
/**
|
|
562
560
|
* Represents a message within a
|
|
563
|
-
* [thread](https://
|
|
561
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
564
562
|
*/
|
|
565
563
|
data: MessagesAPI.Message;
|
|
566
564
|
|
|
@@ -569,13 +567,13 @@ export namespace AssistantStreamEvent {
|
|
|
569
567
|
|
|
570
568
|
/**
|
|
571
569
|
* Occurs when a
|
|
572
|
-
* [message](https://
|
|
573
|
-
*
|
|
570
|
+
* [message](https://developers.openai.com/api/docs/assistants/migration) moves to
|
|
571
|
+
* an `in_progress` state.
|
|
574
572
|
*/
|
|
575
573
|
export interface ThreadMessageInProgress {
|
|
576
574
|
/**
|
|
577
575
|
* Represents a message within a
|
|
578
|
-
* [thread](https://
|
|
576
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
579
577
|
*/
|
|
580
578
|
data: MessagesAPI.Message;
|
|
581
579
|
|
|
@@ -584,8 +582,8 @@ export namespace AssistantStreamEvent {
|
|
|
584
582
|
|
|
585
583
|
/**
|
|
586
584
|
* Occurs when parts of a
|
|
587
|
-
* [Message](https://
|
|
588
|
-
*
|
|
585
|
+
* [Message](https://developers.openai.com/api/docs/assistants/migration) are being
|
|
586
|
+
* streamed.
|
|
589
587
|
*/
|
|
590
588
|
export interface ThreadMessageDelta {
|
|
591
589
|
/**
|
|
@@ -599,13 +597,13 @@ export namespace AssistantStreamEvent {
|
|
|
599
597
|
|
|
600
598
|
/**
|
|
601
599
|
* Occurs when a
|
|
602
|
-
* [message](https://
|
|
600
|
+
* [message](https://developers.openai.com/api/docs/assistants/migration) is
|
|
603
601
|
* completed.
|
|
604
602
|
*/
|
|
605
603
|
export interface ThreadMessageCompleted {
|
|
606
604
|
/**
|
|
607
605
|
* Represents a message within a
|
|
608
|
-
* [thread](https://
|
|
606
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
609
607
|
*/
|
|
610
608
|
data: MessagesAPI.Message;
|
|
611
609
|
|
|
@@ -614,13 +612,13 @@ export namespace AssistantStreamEvent {
|
|
|
614
612
|
|
|
615
613
|
/**
|
|
616
614
|
* Occurs when a
|
|
617
|
-
* [message](https://
|
|
615
|
+
* [message](https://developers.openai.com/api/docs/assistants/migration) ends
|
|
618
616
|
* before it is completed.
|
|
619
617
|
*/
|
|
620
618
|
export interface ThreadMessageIncomplete {
|
|
621
619
|
/**
|
|
622
620
|
* Represents a message within a
|
|
623
|
-
* [thread](https://
|
|
621
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
624
622
|
*/
|
|
625
623
|
data: MessagesAPI.Message;
|
|
626
624
|
|
|
@@ -629,8 +627,8 @@ export namespace AssistantStreamEvent {
|
|
|
629
627
|
|
|
630
628
|
/**
|
|
631
629
|
* Occurs when an
|
|
632
|
-
* [error](https://
|
|
633
|
-
* This can happen due to an internal server error or a timeout.
|
|
630
|
+
* [error](https://developers.openai.com/api/docs/guides/error-codes#api-errors)
|
|
631
|
+
* occurs. This can happen due to an internal server error or a timeout.
|
|
634
632
|
*/
|
|
635
633
|
export interface ErrorEvent {
|
|
636
634
|
data: Shared.ErrorObject;
|
|
@@ -672,7 +670,7 @@ export namespace FileSearchTool {
|
|
|
672
670
|
*
|
|
673
671
|
* Note that the file search tool may output fewer than `max_num_results` results.
|
|
674
672
|
* See the
|
|
675
|
-
* [file search tool documentation](https://
|
|
673
|
+
* [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
|
|
676
674
|
* for more information.
|
|
677
675
|
*/
|
|
678
676
|
max_num_results?: number;
|
|
@@ -682,7 +680,7 @@ export namespace FileSearchTool {
|
|
|
682
680
|
* will use the `auto` ranker and a score_threshold of 0.
|
|
683
681
|
*
|
|
684
682
|
* See the
|
|
685
|
-
* [file search tool documentation](https://
|
|
683
|
+
* [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
|
|
686
684
|
* for more information.
|
|
687
685
|
*/
|
|
688
686
|
ranking_options?: FileSearch.RankingOptions;
|
|
@@ -694,7 +692,7 @@ export namespace FileSearchTool {
|
|
|
694
692
|
* will use the `auto` ranker and a score_threshold of 0.
|
|
695
693
|
*
|
|
696
694
|
* See the
|
|
697
|
-
* [file search tool documentation](https://
|
|
695
|
+
* [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
|
|
698
696
|
* for more information.
|
|
699
697
|
*/
|
|
700
698
|
export interface RankingOptions {
|
|
@@ -724,7 +722,7 @@ export interface FunctionTool {
|
|
|
724
722
|
|
|
725
723
|
/**
|
|
726
724
|
* Occurs when a
|
|
727
|
-
* [message](https://
|
|
725
|
+
* [message](https://developers.openai.com/api/docs/assistants/migration) is
|
|
728
726
|
* created.
|
|
729
727
|
*/
|
|
730
728
|
export type MessageStreamEvent =
|
|
@@ -737,13 +735,13 @@ export type MessageStreamEvent =
|
|
|
737
735
|
export namespace MessageStreamEvent {
|
|
738
736
|
/**
|
|
739
737
|
* Occurs when a
|
|
740
|
-
* [message](https://
|
|
738
|
+
* [message](https://developers.openai.com/api/docs/assistants/migration) is
|
|
741
739
|
* created.
|
|
742
740
|
*/
|
|
743
741
|
export interface ThreadMessageCreated {
|
|
744
742
|
/**
|
|
745
743
|
* Represents a message within a
|
|
746
|
-
* [thread](https://
|
|
744
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
747
745
|
*/
|
|
748
746
|
data: MessagesAPI.Message;
|
|
749
747
|
|
|
@@ -752,13 +750,13 @@ export namespace MessageStreamEvent {
|
|
|
752
750
|
|
|
753
751
|
/**
|
|
754
752
|
* Occurs when a
|
|
755
|
-
* [message](https://
|
|
756
|
-
*
|
|
753
|
+
* [message](https://developers.openai.com/api/docs/assistants/migration) moves to
|
|
754
|
+
* an `in_progress` state.
|
|
757
755
|
*/
|
|
758
756
|
export interface ThreadMessageInProgress {
|
|
759
757
|
/**
|
|
760
758
|
* Represents a message within a
|
|
761
|
-
* [thread](https://
|
|
759
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
762
760
|
*/
|
|
763
761
|
data: MessagesAPI.Message;
|
|
764
762
|
|
|
@@ -767,8 +765,8 @@ export namespace MessageStreamEvent {
|
|
|
767
765
|
|
|
768
766
|
/**
|
|
769
767
|
* Occurs when parts of a
|
|
770
|
-
* [Message](https://
|
|
771
|
-
*
|
|
768
|
+
* [Message](https://developers.openai.com/api/docs/assistants/migration) are being
|
|
769
|
+
* streamed.
|
|
772
770
|
*/
|
|
773
771
|
export interface ThreadMessageDelta {
|
|
774
772
|
/**
|
|
@@ -782,13 +780,13 @@ export namespace MessageStreamEvent {
|
|
|
782
780
|
|
|
783
781
|
/**
|
|
784
782
|
* Occurs when a
|
|
785
|
-
* [message](https://
|
|
783
|
+
* [message](https://developers.openai.com/api/docs/assistants/migration) is
|
|
786
784
|
* completed.
|
|
787
785
|
*/
|
|
788
786
|
export interface ThreadMessageCompleted {
|
|
789
787
|
/**
|
|
790
788
|
* Represents a message within a
|
|
791
|
-
* [thread](https://
|
|
789
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
792
790
|
*/
|
|
793
791
|
data: MessagesAPI.Message;
|
|
794
792
|
|
|
@@ -797,13 +795,13 @@ export namespace MessageStreamEvent {
|
|
|
797
795
|
|
|
798
796
|
/**
|
|
799
797
|
* Occurs when a
|
|
800
|
-
* [message](https://
|
|
798
|
+
* [message](https://developers.openai.com/api/docs/assistants/migration) ends
|
|
801
799
|
* before it is completed.
|
|
802
800
|
*/
|
|
803
801
|
export interface ThreadMessageIncomplete {
|
|
804
802
|
/**
|
|
805
803
|
* Represents a message within a
|
|
806
|
-
* [thread](https://
|
|
804
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
807
805
|
*/
|
|
808
806
|
data: MessagesAPI.Message;
|
|
809
807
|
|
|
@@ -813,8 +811,8 @@ export namespace MessageStreamEvent {
|
|
|
813
811
|
|
|
814
812
|
/**
|
|
815
813
|
* Occurs when a
|
|
816
|
-
* [run step](https://
|
|
817
|
-
*
|
|
814
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) is
|
|
815
|
+
* created.
|
|
818
816
|
*/
|
|
819
817
|
export type RunStepStreamEvent =
|
|
820
818
|
| RunStepStreamEvent.ThreadRunStepCreated
|
|
@@ -828,8 +826,8 @@ export type RunStepStreamEvent =
|
|
|
828
826
|
export namespace RunStepStreamEvent {
|
|
829
827
|
/**
|
|
830
828
|
* Occurs when a
|
|
831
|
-
* [run step](https://
|
|
832
|
-
*
|
|
829
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) is
|
|
830
|
+
* created.
|
|
833
831
|
*/
|
|
834
832
|
export interface ThreadRunStepCreated {
|
|
835
833
|
/**
|
|
@@ -842,8 +840,8 @@ export namespace RunStepStreamEvent {
|
|
|
842
840
|
|
|
843
841
|
/**
|
|
844
842
|
* Occurs when a
|
|
845
|
-
* [run step](https://
|
|
846
|
-
*
|
|
843
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) moves to
|
|
844
|
+
* an `in_progress` state.
|
|
847
845
|
*/
|
|
848
846
|
export interface ThreadRunStepInProgress {
|
|
849
847
|
/**
|
|
@@ -856,8 +854,8 @@ export namespace RunStepStreamEvent {
|
|
|
856
854
|
|
|
857
855
|
/**
|
|
858
856
|
* Occurs when parts of a
|
|
859
|
-
* [run step](https://
|
|
860
|
-
*
|
|
857
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) are
|
|
858
|
+
* being streamed.
|
|
861
859
|
*/
|
|
862
860
|
export interface ThreadRunStepDelta {
|
|
863
861
|
/**
|
|
@@ -871,8 +869,8 @@ export namespace RunStepStreamEvent {
|
|
|
871
869
|
|
|
872
870
|
/**
|
|
873
871
|
* Occurs when a
|
|
874
|
-
* [run step](https://
|
|
875
|
-
*
|
|
872
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) is
|
|
873
|
+
* completed.
|
|
876
874
|
*/
|
|
877
875
|
export interface ThreadRunStepCompleted {
|
|
878
876
|
/**
|
|
@@ -885,8 +883,7 @@ export namespace RunStepStreamEvent {
|
|
|
885
883
|
|
|
886
884
|
/**
|
|
887
885
|
* Occurs when a
|
|
888
|
-
* [run step](https://
|
|
889
|
-
* fails.
|
|
886
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) fails.
|
|
890
887
|
*/
|
|
891
888
|
export interface ThreadRunStepFailed {
|
|
892
889
|
/**
|
|
@@ -899,8 +896,8 @@ export namespace RunStepStreamEvent {
|
|
|
899
896
|
|
|
900
897
|
/**
|
|
901
898
|
* Occurs when a
|
|
902
|
-
* [run step](https://
|
|
903
|
-
*
|
|
899
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) is
|
|
900
|
+
* cancelled.
|
|
904
901
|
*/
|
|
905
902
|
export interface ThreadRunStepCancelled {
|
|
906
903
|
/**
|
|
@@ -913,8 +910,7 @@ export namespace RunStepStreamEvent {
|
|
|
913
910
|
|
|
914
911
|
/**
|
|
915
912
|
* Occurs when a
|
|
916
|
-
* [run step](https://
|
|
917
|
-
* expires.
|
|
913
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) expires.
|
|
918
914
|
*/
|
|
919
915
|
export interface ThreadRunStepExpired {
|
|
920
916
|
/**
|
|
@@ -928,7 +924,7 @@ export namespace RunStepStreamEvent {
|
|
|
928
924
|
|
|
929
925
|
/**
|
|
930
926
|
* Occurs when a new
|
|
931
|
-
* [run](https://
|
|
927
|
+
* [run](https://developers.openai.com/api/docs/assistants/migration) is created.
|
|
932
928
|
*/
|
|
933
929
|
export type RunStreamEvent =
|
|
934
930
|
| RunStreamEvent.ThreadRunCreated
|
|
@@ -945,12 +941,12 @@ export type RunStreamEvent =
|
|
|
945
941
|
export namespace RunStreamEvent {
|
|
946
942
|
/**
|
|
947
943
|
* Occurs when a new
|
|
948
|
-
* [run](https://
|
|
944
|
+
* [run](https://developers.openai.com/api/docs/assistants/migration) is created.
|
|
949
945
|
*/
|
|
950
946
|
export interface ThreadRunCreated {
|
|
951
947
|
/**
|
|
952
948
|
* Represents an execution run on a
|
|
953
|
-
* [thread](https://
|
|
949
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
954
950
|
*/
|
|
955
951
|
data: RunsAPI.Run;
|
|
956
952
|
|
|
@@ -958,13 +954,13 @@ export namespace RunStreamEvent {
|
|
|
958
954
|
}
|
|
959
955
|
|
|
960
956
|
/**
|
|
961
|
-
* Occurs when a [run](https://
|
|
957
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
962
958
|
* moves to a `queued` status.
|
|
963
959
|
*/
|
|
964
960
|
export interface ThreadRunQueued {
|
|
965
961
|
/**
|
|
966
962
|
* Represents an execution run on a
|
|
967
|
-
* [thread](https://
|
|
963
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
968
964
|
*/
|
|
969
965
|
data: RunsAPI.Run;
|
|
970
966
|
|
|
@@ -972,13 +968,13 @@ export namespace RunStreamEvent {
|
|
|
972
968
|
}
|
|
973
969
|
|
|
974
970
|
/**
|
|
975
|
-
* Occurs when a [run](https://
|
|
971
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
976
972
|
* moves to an `in_progress` status.
|
|
977
973
|
*/
|
|
978
974
|
export interface ThreadRunInProgress {
|
|
979
975
|
/**
|
|
980
976
|
* Represents an execution run on a
|
|
981
|
-
* [thread](https://
|
|
977
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
982
978
|
*/
|
|
983
979
|
data: RunsAPI.Run;
|
|
984
980
|
|
|
@@ -986,13 +982,13 @@ export namespace RunStreamEvent {
|
|
|
986
982
|
}
|
|
987
983
|
|
|
988
984
|
/**
|
|
989
|
-
* Occurs when a [run](https://
|
|
985
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
990
986
|
* moves to a `requires_action` status.
|
|
991
987
|
*/
|
|
992
988
|
export interface ThreadRunRequiresAction {
|
|
993
989
|
/**
|
|
994
990
|
* Represents an execution run on a
|
|
995
|
-
* [thread](https://
|
|
991
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
996
992
|
*/
|
|
997
993
|
data: RunsAPI.Run;
|
|
998
994
|
|
|
@@ -1000,13 +996,13 @@ export namespace RunStreamEvent {
|
|
|
1000
996
|
}
|
|
1001
997
|
|
|
1002
998
|
/**
|
|
1003
|
-
* Occurs when a [run](https://
|
|
999
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
1004
1000
|
* is completed.
|
|
1005
1001
|
*/
|
|
1006
1002
|
export interface ThreadRunCompleted {
|
|
1007
1003
|
/**
|
|
1008
1004
|
* Represents an execution run on a
|
|
1009
|
-
* [thread](https://
|
|
1005
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
1010
1006
|
*/
|
|
1011
1007
|
data: RunsAPI.Run;
|
|
1012
1008
|
|
|
@@ -1014,13 +1010,13 @@ export namespace RunStreamEvent {
|
|
|
1014
1010
|
}
|
|
1015
1011
|
|
|
1016
1012
|
/**
|
|
1017
|
-
* Occurs when a [run](https://
|
|
1013
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
1018
1014
|
* ends with status `incomplete`.
|
|
1019
1015
|
*/
|
|
1020
1016
|
export interface ThreadRunIncomplete {
|
|
1021
1017
|
/**
|
|
1022
1018
|
* Represents an execution run on a
|
|
1023
|
-
* [thread](https://
|
|
1019
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
1024
1020
|
*/
|
|
1025
1021
|
data: RunsAPI.Run;
|
|
1026
1022
|
|
|
@@ -1028,13 +1024,13 @@ export namespace RunStreamEvent {
|
|
|
1028
1024
|
}
|
|
1029
1025
|
|
|
1030
1026
|
/**
|
|
1031
|
-
* Occurs when a [run](https://
|
|
1027
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
1032
1028
|
* fails.
|
|
1033
1029
|
*/
|
|
1034
1030
|
export interface ThreadRunFailed {
|
|
1035
1031
|
/**
|
|
1036
1032
|
* Represents an execution run on a
|
|
1037
|
-
* [thread](https://
|
|
1033
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
1038
1034
|
*/
|
|
1039
1035
|
data: RunsAPI.Run;
|
|
1040
1036
|
|
|
@@ -1042,13 +1038,13 @@ export namespace RunStreamEvent {
|
|
|
1042
1038
|
}
|
|
1043
1039
|
|
|
1044
1040
|
/**
|
|
1045
|
-
* Occurs when a [run](https://
|
|
1041
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
1046
1042
|
* moves to a `cancelling` status.
|
|
1047
1043
|
*/
|
|
1048
1044
|
export interface ThreadRunCancelling {
|
|
1049
1045
|
/**
|
|
1050
1046
|
* Represents an execution run on a
|
|
1051
|
-
* [thread](https://
|
|
1047
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
1052
1048
|
*/
|
|
1053
1049
|
data: RunsAPI.Run;
|
|
1054
1050
|
|
|
@@ -1056,13 +1052,13 @@ export namespace RunStreamEvent {
|
|
|
1056
1052
|
}
|
|
1057
1053
|
|
|
1058
1054
|
/**
|
|
1059
|
-
* Occurs when a [run](https://
|
|
1055
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
1060
1056
|
* is cancelled.
|
|
1061
1057
|
*/
|
|
1062
1058
|
export interface ThreadRunCancelled {
|
|
1063
1059
|
/**
|
|
1064
1060
|
* Represents an execution run on a
|
|
1065
|
-
* [thread](https://
|
|
1061
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
1066
1062
|
*/
|
|
1067
1063
|
data: RunsAPI.Run;
|
|
1068
1064
|
|
|
@@ -1070,13 +1066,13 @@ export namespace RunStreamEvent {
|
|
|
1070
1066
|
}
|
|
1071
1067
|
|
|
1072
1068
|
/**
|
|
1073
|
-
* Occurs when a [run](https://
|
|
1069
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
1074
1070
|
* expires.
|
|
1075
1071
|
*/
|
|
1076
1072
|
export interface ThreadRunExpired {
|
|
1077
1073
|
/**
|
|
1078
1074
|
* Represents an execution run on a
|
|
1079
|
-
* [thread](https://
|
|
1075
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
1080
1076
|
*/
|
|
1081
1077
|
data: RunsAPI.Run;
|
|
1082
1078
|
|
|
@@ -1086,13 +1082,13 @@ export namespace RunStreamEvent {
|
|
|
1086
1082
|
|
|
1087
1083
|
/**
|
|
1088
1084
|
* Occurs when a new
|
|
1089
|
-
* [thread](https://
|
|
1085
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration) is
|
|
1090
1086
|
* created.
|
|
1091
1087
|
*/
|
|
1092
1088
|
export interface ThreadStreamEvent {
|
|
1093
1089
|
/**
|
|
1094
1090
|
* Represents a thread that contains
|
|
1095
|
-
* [messages](https://
|
|
1091
|
+
* [messages](https://developers.openai.com/api/docs/assistants/migration).
|
|
1096
1092
|
*/
|
|
1097
1093
|
data: ThreadsAPI.Thread;
|
|
1098
1094
|
|
|
@@ -1107,10 +1103,10 @@ export interface ThreadStreamEvent {
|
|
|
1107
1103
|
export interface AssistantCreateParams {
|
|
1108
1104
|
/**
|
|
1109
1105
|
* ID of the model to use. You can use the
|
|
1110
|
-
* [List models](https://
|
|
1111
|
-
* see all of your available models, or see our
|
|
1112
|
-
* [Model overview](https://
|
|
1113
|
-
* them.
|
|
1106
|
+
* [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
|
|
1107
|
+
* API to see all of your available models, or see our
|
|
1108
|
+
* [Model overview](https://developers.openai.com/api/docs/models) for descriptions
|
|
1109
|
+
* of them.
|
|
1114
1110
|
*/
|
|
1115
1111
|
model: (string & {}) | Shared.ChatModel;
|
|
1116
1112
|
|
|
@@ -1145,21 +1141,21 @@ export interface AssistantCreateParams {
|
|
|
1145
1141
|
* are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
1146
1142
|
* reasoning effort can result in faster responses and fewer tokens used on
|
|
1147
1143
|
* reasoning in a response. Not all reasoning models support every value. See the
|
|
1148
|
-
* [reasoning guide](https://
|
|
1144
|
+
* [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
|
|
1149
1145
|
* model-specific support.
|
|
1150
1146
|
*/
|
|
1151
1147
|
reasoning_effort?: Shared.ReasoningEffort | null;
|
|
1152
1148
|
|
|
1153
1149
|
/**
|
|
1154
1150
|
* Specifies the format that the model must output. Compatible with
|
|
1155
|
-
* [GPT-4o](https://
|
|
1156
|
-
* [GPT-4 Turbo](https://
|
|
1157
|
-
*
|
|
1151
|
+
* [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
|
|
1152
|
+
* [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
|
|
1153
|
+
* all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
|
|
1158
1154
|
*
|
|
1159
1155
|
* Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
|
|
1160
1156
|
* Outputs which ensures the model will match your supplied JSON schema. Learn more
|
|
1161
1157
|
* in the
|
|
1162
|
-
* [Structured Outputs guide](https://
|
|
1158
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
1163
1159
|
*
|
|
1164
1160
|
* Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
|
|
1165
1161
|
* message the model generates is valid JSON.
|
|
@@ -1222,9 +1218,9 @@ export namespace AssistantCreateParams {
|
|
|
1222
1218
|
export namespace ToolResources {
|
|
1223
1219
|
export interface CodeInterpreter {
|
|
1224
1220
|
/**
|
|
1225
|
-
* A list of [file](https://
|
|
1226
|
-
* available to the `code_interpreter` tool. There can be a maximum of 20
|
|
1227
|
-
* associated with the tool.
|
|
1221
|
+
* A list of [file](https://developers.openai.com/api/reference/resources/files)
|
|
1222
|
+
* IDs made available to the `code_interpreter` tool. There can be a maximum of 20
|
|
1223
|
+
* files associated with the tool.
|
|
1228
1224
|
*/
|
|
1229
1225
|
file_ids?: Array<string>;
|
|
1230
1226
|
}
|
|
@@ -1232,7 +1228,7 @@ export namespace AssistantCreateParams {
|
|
|
1232
1228
|
export interface FileSearch {
|
|
1233
1229
|
/**
|
|
1234
1230
|
* The
|
|
1235
|
-
* [vector store](https://
|
|
1231
|
+
* [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
|
|
1236
1232
|
* attached to this assistant. There can be a maximum of 1 vector store attached to
|
|
1237
1233
|
* the assistant.
|
|
1238
1234
|
*/
|
|
@@ -1240,7 +1236,7 @@ export namespace AssistantCreateParams {
|
|
|
1240
1236
|
|
|
1241
1237
|
/**
|
|
1242
1238
|
* A helper to create a
|
|
1243
|
-
* [vector store](https://
|
|
1239
|
+
* [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
|
|
1244
1240
|
* with file_ids and attach it to this assistant. There can be a maximum of 1
|
|
1245
1241
|
* vector store attached to the assistant.
|
|
1246
1242
|
*/
|
|
@@ -1256,10 +1252,10 @@ export namespace AssistantCreateParams {
|
|
|
1256
1252
|
chunking_strategy?: VectorStore.Auto | VectorStore.Static;
|
|
1257
1253
|
|
|
1258
1254
|
/**
|
|
1259
|
-
* A list of [file](https://
|
|
1260
|
-
* add to the vector store. For vector stores created before Nov 2025, there
|
|
1261
|
-
* a maximum of 10,000 files in a vector store. For vector stores created
|
|
1262
|
-
* in Nov 2025, the limit is 100,000,000 files.
|
|
1255
|
+
* A list of [file](https://developers.openai.com/api/reference/resources/files)
|
|
1256
|
+
* IDs to add to the vector store. For vector stores created before Nov 2025, there
|
|
1257
|
+
* can be a maximum of 10,000 files in a vector store. For vector stores created
|
|
1258
|
+
* starting in Nov 2025, the limit is 100,000,000 files.
|
|
1263
1259
|
*/
|
|
1264
1260
|
file_ids?: Array<string>;
|
|
1265
1261
|
|
|
@@ -1340,10 +1336,10 @@ export interface AssistantUpdateParams {
|
|
|
1340
1336
|
|
|
1341
1337
|
/**
|
|
1342
1338
|
* ID of the model to use. You can use the
|
|
1343
|
-
* [List models](https://
|
|
1344
|
-
* see all of your available models, or see our
|
|
1345
|
-
* [Model overview](https://
|
|
1346
|
-
* them.
|
|
1339
|
+
* [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
|
|
1340
|
+
* API to see all of your available models, or see our
|
|
1341
|
+
* [Model overview](https://developers.openai.com/api/docs/models) for descriptions
|
|
1342
|
+
* of them.
|
|
1347
1343
|
*/
|
|
1348
1344
|
model?:
|
|
1349
1345
|
| (string & {})
|
|
@@ -1400,21 +1396,21 @@ export interface AssistantUpdateParams {
|
|
|
1400
1396
|
* are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
1401
1397
|
* reasoning effort can result in faster responses and fewer tokens used on
|
|
1402
1398
|
* reasoning in a response. Not all reasoning models support every value. See the
|
|
1403
|
-
* [reasoning guide](https://
|
|
1399
|
+
* [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
|
|
1404
1400
|
* model-specific support.
|
|
1405
1401
|
*/
|
|
1406
1402
|
reasoning_effort?: Shared.ReasoningEffort | null;
|
|
1407
1403
|
|
|
1408
1404
|
/**
|
|
1409
1405
|
* Specifies the format that the model must output. Compatible with
|
|
1410
|
-
* [GPT-4o](https://
|
|
1411
|
-
* [GPT-4 Turbo](https://
|
|
1412
|
-
*
|
|
1406
|
+
* [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
|
|
1407
|
+
* [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
|
|
1408
|
+
* all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
|
|
1413
1409
|
*
|
|
1414
1410
|
* Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
|
|
1415
1411
|
* Outputs which ensures the model will match your supplied JSON schema. Learn more
|
|
1416
1412
|
* in the
|
|
1417
|
-
* [Structured Outputs guide](https://
|
|
1413
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
1418
1414
|
*
|
|
1419
1415
|
* Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
|
|
1420
1416
|
* message the model generates is valid JSON.
|
|
@@ -1478,9 +1474,9 @@ export namespace AssistantUpdateParams {
|
|
|
1478
1474
|
export interface CodeInterpreter {
|
|
1479
1475
|
/**
|
|
1480
1476
|
* Overrides the list of
|
|
1481
|
-
* [file](https://
|
|
1482
|
-
* to the `code_interpreter` tool. There can be a maximum of 20 files
|
|
1483
|
-
* with the tool.
|
|
1477
|
+
* [file](https://developers.openai.com/api/reference/resources/files) IDs made
|
|
1478
|
+
* available to the `code_interpreter` tool. There can be a maximum of 20 files
|
|
1479
|
+
* associated with the tool.
|
|
1484
1480
|
*/
|
|
1485
1481
|
file_ids?: Array<string>;
|
|
1486
1482
|
}
|
|
@@ -1488,7 +1484,7 @@ export namespace AssistantUpdateParams {
|
|
|
1488
1484
|
export interface FileSearch {
|
|
1489
1485
|
/**
|
|
1490
1486
|
* Overrides the
|
|
1491
|
-
* [vector store](https://
|
|
1487
|
+
* [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
|
|
1492
1488
|
* attached to this assistant. There can be a maximum of 1 vector store attached to
|
|
1493
1489
|
* the assistant.
|
|
1494
1490
|
*/
|