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
|
@@ -76,10 +76,10 @@ export interface Assistant {
|
|
|
76
76
|
metadata: Shared.Metadata | null;
|
|
77
77
|
/**
|
|
78
78
|
* ID of the model to use. You can use the
|
|
79
|
-
* [List models](https://
|
|
80
|
-
* see all of your available models, or see our
|
|
81
|
-
* [Model overview](https://
|
|
82
|
-
* them.
|
|
79
|
+
* [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
|
|
80
|
+
* API to see all of your available models, or see our
|
|
81
|
+
* [Model overview](https://developers.openai.com/api/docs/models) for descriptions
|
|
82
|
+
* of them.
|
|
83
83
|
*/
|
|
84
84
|
model: string;
|
|
85
85
|
/**
|
|
@@ -98,14 +98,14 @@ export interface Assistant {
|
|
|
98
98
|
tools: Array<AssistantTool>;
|
|
99
99
|
/**
|
|
100
100
|
* Specifies the format that the model must output. Compatible with
|
|
101
|
-
* [GPT-4o](https://
|
|
102
|
-
* [GPT-4 Turbo](https://
|
|
103
|
-
*
|
|
101
|
+
* [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
|
|
102
|
+
* [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
|
|
103
|
+
* all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
|
|
104
104
|
*
|
|
105
105
|
* Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
|
|
106
106
|
* Outputs which ensures the model will match your supplied JSON schema. Learn more
|
|
107
107
|
* in the
|
|
108
|
-
* [Structured Outputs guide](https://
|
|
108
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
109
109
|
*
|
|
110
110
|
* Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
|
|
111
111
|
* message the model generates is valid JSON.
|
|
@@ -155,16 +155,16 @@ export declare namespace Assistant {
|
|
|
155
155
|
namespace ToolResources {
|
|
156
156
|
interface CodeInterpreter {
|
|
157
157
|
/**
|
|
158
|
-
* A list of [file](https://
|
|
159
|
-
* available to the `code_interpreter`` tool. There can be a maximum of 20
|
|
160
|
-
* associated with the tool.
|
|
158
|
+
* A list of [file](https://developers.openai.com/api/reference/resources/files)
|
|
159
|
+
* IDs made available to the `code_interpreter`` tool. There can be a maximum of 20
|
|
160
|
+
* files associated with the tool.
|
|
161
161
|
*/
|
|
162
162
|
file_ids?: Array<string>;
|
|
163
163
|
}
|
|
164
164
|
interface FileSearch {
|
|
165
165
|
/**
|
|
166
166
|
* The ID of the
|
|
167
|
-
* [vector store](https://
|
|
167
|
+
* [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
|
|
168
168
|
* attached to this assistant. There can be a maximum of 1 vector store attached to
|
|
169
169
|
* the assistant.
|
|
170
170
|
*/
|
|
@@ -196,20 +196,20 @@ export interface AssistantDeleted {
|
|
|
196
196
|
*
|
|
197
197
|
* We may add additional events over time, so we recommend handling unknown events
|
|
198
198
|
* gracefully in your code. See the
|
|
199
|
-
* [Assistants API quickstart](https://
|
|
199
|
+
* [Assistants API quickstart](https://developers.openai.com/api/docs/assistants/migration)
|
|
200
200
|
* to learn how to integrate the Assistants API with streaming.
|
|
201
201
|
*/
|
|
202
202
|
export type AssistantStreamEvent = AssistantStreamEvent.ThreadCreated | AssistantStreamEvent.ThreadRunCreated | AssistantStreamEvent.ThreadRunQueued | AssistantStreamEvent.ThreadRunInProgress | AssistantStreamEvent.ThreadRunRequiresAction | AssistantStreamEvent.ThreadRunCompleted | AssistantStreamEvent.ThreadRunIncomplete | AssistantStreamEvent.ThreadRunFailed | AssistantStreamEvent.ThreadRunCancelling | AssistantStreamEvent.ThreadRunCancelled | AssistantStreamEvent.ThreadRunExpired | AssistantStreamEvent.ThreadRunStepCreated | AssistantStreamEvent.ThreadRunStepInProgress | AssistantStreamEvent.ThreadRunStepDelta | AssistantStreamEvent.ThreadRunStepCompleted | AssistantStreamEvent.ThreadRunStepFailed | AssistantStreamEvent.ThreadRunStepCancelled | AssistantStreamEvent.ThreadRunStepExpired | AssistantStreamEvent.ThreadMessageCreated | AssistantStreamEvent.ThreadMessageInProgress | AssistantStreamEvent.ThreadMessageDelta | AssistantStreamEvent.ThreadMessageCompleted | AssistantStreamEvent.ThreadMessageIncomplete | AssistantStreamEvent.ErrorEvent;
|
|
203
203
|
export declare namespace AssistantStreamEvent {
|
|
204
204
|
/**
|
|
205
205
|
* Occurs when a new
|
|
206
|
-
* [thread](https://
|
|
206
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration) is
|
|
207
207
|
* created.
|
|
208
208
|
*/
|
|
209
209
|
interface ThreadCreated {
|
|
210
210
|
/**
|
|
211
211
|
* Represents a thread that contains
|
|
212
|
-
* [messages](https://
|
|
212
|
+
* [messages](https://developers.openai.com/api/docs/assistants/migration).
|
|
213
213
|
*/
|
|
214
214
|
data: ThreadsAPI.Thread;
|
|
215
215
|
event: 'thread.created';
|
|
@@ -220,128 +220,128 @@ export declare namespace AssistantStreamEvent {
|
|
|
220
220
|
}
|
|
221
221
|
/**
|
|
222
222
|
* Occurs when a new
|
|
223
|
-
* [run](https://
|
|
223
|
+
* [run](https://developers.openai.com/api/docs/assistants/migration) is created.
|
|
224
224
|
*/
|
|
225
225
|
interface ThreadRunCreated {
|
|
226
226
|
/**
|
|
227
227
|
* Represents an execution run on a
|
|
228
|
-
* [thread](https://
|
|
228
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
229
229
|
*/
|
|
230
230
|
data: RunsAPI.Run;
|
|
231
231
|
event: 'thread.run.created';
|
|
232
232
|
}
|
|
233
233
|
/**
|
|
234
|
-
* Occurs when a [run](https://
|
|
234
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
235
235
|
* moves to a `queued` status.
|
|
236
236
|
*/
|
|
237
237
|
interface ThreadRunQueued {
|
|
238
238
|
/**
|
|
239
239
|
* Represents an execution run on a
|
|
240
|
-
* [thread](https://
|
|
240
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
241
241
|
*/
|
|
242
242
|
data: RunsAPI.Run;
|
|
243
243
|
event: 'thread.run.queued';
|
|
244
244
|
}
|
|
245
245
|
/**
|
|
246
|
-
* Occurs when a [run](https://
|
|
246
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
247
247
|
* moves to an `in_progress` status.
|
|
248
248
|
*/
|
|
249
249
|
interface ThreadRunInProgress {
|
|
250
250
|
/**
|
|
251
251
|
* Represents an execution run on a
|
|
252
|
-
* [thread](https://
|
|
252
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
253
253
|
*/
|
|
254
254
|
data: RunsAPI.Run;
|
|
255
255
|
event: 'thread.run.in_progress';
|
|
256
256
|
}
|
|
257
257
|
/**
|
|
258
|
-
* Occurs when a [run](https://
|
|
258
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
259
259
|
* moves to a `requires_action` status.
|
|
260
260
|
*/
|
|
261
261
|
interface ThreadRunRequiresAction {
|
|
262
262
|
/**
|
|
263
263
|
* Represents an execution run on a
|
|
264
|
-
* [thread](https://
|
|
264
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
265
265
|
*/
|
|
266
266
|
data: RunsAPI.Run;
|
|
267
267
|
event: 'thread.run.requires_action';
|
|
268
268
|
}
|
|
269
269
|
/**
|
|
270
|
-
* Occurs when a [run](https://
|
|
270
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
271
271
|
* is completed.
|
|
272
272
|
*/
|
|
273
273
|
interface ThreadRunCompleted {
|
|
274
274
|
/**
|
|
275
275
|
* Represents an execution run on a
|
|
276
|
-
* [thread](https://
|
|
276
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
277
277
|
*/
|
|
278
278
|
data: RunsAPI.Run;
|
|
279
279
|
event: 'thread.run.completed';
|
|
280
280
|
}
|
|
281
281
|
/**
|
|
282
|
-
* Occurs when a [run](https://
|
|
282
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
283
283
|
* ends with status `incomplete`.
|
|
284
284
|
*/
|
|
285
285
|
interface ThreadRunIncomplete {
|
|
286
286
|
/**
|
|
287
287
|
* Represents an execution run on a
|
|
288
|
-
* [thread](https://
|
|
288
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
289
289
|
*/
|
|
290
290
|
data: RunsAPI.Run;
|
|
291
291
|
event: 'thread.run.incomplete';
|
|
292
292
|
}
|
|
293
293
|
/**
|
|
294
|
-
* Occurs when a [run](https://
|
|
294
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
295
295
|
* fails.
|
|
296
296
|
*/
|
|
297
297
|
interface ThreadRunFailed {
|
|
298
298
|
/**
|
|
299
299
|
* Represents an execution run on a
|
|
300
|
-
* [thread](https://
|
|
300
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
301
301
|
*/
|
|
302
302
|
data: RunsAPI.Run;
|
|
303
303
|
event: 'thread.run.failed';
|
|
304
304
|
}
|
|
305
305
|
/**
|
|
306
|
-
* Occurs when a [run](https://
|
|
306
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
307
307
|
* moves to a `cancelling` status.
|
|
308
308
|
*/
|
|
309
309
|
interface ThreadRunCancelling {
|
|
310
310
|
/**
|
|
311
311
|
* Represents an execution run on a
|
|
312
|
-
* [thread](https://
|
|
312
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
313
313
|
*/
|
|
314
314
|
data: RunsAPI.Run;
|
|
315
315
|
event: 'thread.run.cancelling';
|
|
316
316
|
}
|
|
317
317
|
/**
|
|
318
|
-
* Occurs when a [run](https://
|
|
318
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
319
319
|
* is cancelled.
|
|
320
320
|
*/
|
|
321
321
|
interface ThreadRunCancelled {
|
|
322
322
|
/**
|
|
323
323
|
* Represents an execution run on a
|
|
324
|
-
* [thread](https://
|
|
324
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
325
325
|
*/
|
|
326
326
|
data: RunsAPI.Run;
|
|
327
327
|
event: 'thread.run.cancelled';
|
|
328
328
|
}
|
|
329
329
|
/**
|
|
330
|
-
* Occurs when a [run](https://
|
|
330
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
331
331
|
* expires.
|
|
332
332
|
*/
|
|
333
333
|
interface ThreadRunExpired {
|
|
334
334
|
/**
|
|
335
335
|
* Represents an execution run on a
|
|
336
|
-
* [thread](https://
|
|
336
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
337
337
|
*/
|
|
338
338
|
data: RunsAPI.Run;
|
|
339
339
|
event: 'thread.run.expired';
|
|
340
340
|
}
|
|
341
341
|
/**
|
|
342
342
|
* Occurs when a
|
|
343
|
-
* [run step](https://
|
|
344
|
-
*
|
|
343
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) is
|
|
344
|
+
* created.
|
|
345
345
|
*/
|
|
346
346
|
interface ThreadRunStepCreated {
|
|
347
347
|
/**
|
|
@@ -352,8 +352,8 @@ export declare namespace AssistantStreamEvent {
|
|
|
352
352
|
}
|
|
353
353
|
/**
|
|
354
354
|
* Occurs when a
|
|
355
|
-
* [run step](https://
|
|
356
|
-
*
|
|
355
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) moves to
|
|
356
|
+
* an `in_progress` state.
|
|
357
357
|
*/
|
|
358
358
|
interface ThreadRunStepInProgress {
|
|
359
359
|
/**
|
|
@@ -364,8 +364,8 @@ export declare namespace AssistantStreamEvent {
|
|
|
364
364
|
}
|
|
365
365
|
/**
|
|
366
366
|
* Occurs when parts of a
|
|
367
|
-
* [run step](https://
|
|
368
|
-
*
|
|
367
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) are
|
|
368
|
+
* being streamed.
|
|
369
369
|
*/
|
|
370
370
|
interface ThreadRunStepDelta {
|
|
371
371
|
/**
|
|
@@ -377,8 +377,8 @@ export declare namespace AssistantStreamEvent {
|
|
|
377
377
|
}
|
|
378
378
|
/**
|
|
379
379
|
* Occurs when a
|
|
380
|
-
* [run step](https://
|
|
381
|
-
*
|
|
380
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) is
|
|
381
|
+
* completed.
|
|
382
382
|
*/
|
|
383
383
|
interface ThreadRunStepCompleted {
|
|
384
384
|
/**
|
|
@@ -389,8 +389,7 @@ export declare namespace AssistantStreamEvent {
|
|
|
389
389
|
}
|
|
390
390
|
/**
|
|
391
391
|
* Occurs when a
|
|
392
|
-
* [run step](https://
|
|
393
|
-
* fails.
|
|
392
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) fails.
|
|
394
393
|
*/
|
|
395
394
|
interface ThreadRunStepFailed {
|
|
396
395
|
/**
|
|
@@ -401,8 +400,8 @@ export declare namespace AssistantStreamEvent {
|
|
|
401
400
|
}
|
|
402
401
|
/**
|
|
403
402
|
* Occurs when a
|
|
404
|
-
* [run step](https://
|
|
405
|
-
*
|
|
403
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) is
|
|
404
|
+
* cancelled.
|
|
406
405
|
*/
|
|
407
406
|
interface ThreadRunStepCancelled {
|
|
408
407
|
/**
|
|
@@ -413,8 +412,7 @@ export declare namespace AssistantStreamEvent {
|
|
|
413
412
|
}
|
|
414
413
|
/**
|
|
415
414
|
* Occurs when a
|
|
416
|
-
* [run step](https://
|
|
417
|
-
* expires.
|
|
415
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) expires.
|
|
418
416
|
*/
|
|
419
417
|
interface ThreadRunStepExpired {
|
|
420
418
|
/**
|
|
@@ -425,34 +423,34 @@ export declare namespace AssistantStreamEvent {
|
|
|
425
423
|
}
|
|
426
424
|
/**
|
|
427
425
|
* Occurs when a
|
|
428
|
-
* [message](https://
|
|
426
|
+
* [message](https://developers.openai.com/api/docs/assistants/migration) is
|
|
429
427
|
* created.
|
|
430
428
|
*/
|
|
431
429
|
interface ThreadMessageCreated {
|
|
432
430
|
/**
|
|
433
431
|
* Represents a message within a
|
|
434
|
-
* [thread](https://
|
|
432
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
435
433
|
*/
|
|
436
434
|
data: MessagesAPI.Message;
|
|
437
435
|
event: 'thread.message.created';
|
|
438
436
|
}
|
|
439
437
|
/**
|
|
440
438
|
* Occurs when a
|
|
441
|
-
* [message](https://
|
|
442
|
-
*
|
|
439
|
+
* [message](https://developers.openai.com/api/docs/assistants/migration) moves to
|
|
440
|
+
* an `in_progress` state.
|
|
443
441
|
*/
|
|
444
442
|
interface ThreadMessageInProgress {
|
|
445
443
|
/**
|
|
446
444
|
* Represents a message within a
|
|
447
|
-
* [thread](https://
|
|
445
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
448
446
|
*/
|
|
449
447
|
data: MessagesAPI.Message;
|
|
450
448
|
event: 'thread.message.in_progress';
|
|
451
449
|
}
|
|
452
450
|
/**
|
|
453
451
|
* Occurs when parts of a
|
|
454
|
-
* [Message](https://
|
|
455
|
-
*
|
|
452
|
+
* [Message](https://developers.openai.com/api/docs/assistants/migration) are being
|
|
453
|
+
* streamed.
|
|
456
454
|
*/
|
|
457
455
|
interface ThreadMessageDelta {
|
|
458
456
|
/**
|
|
@@ -464,34 +462,34 @@ export declare namespace AssistantStreamEvent {
|
|
|
464
462
|
}
|
|
465
463
|
/**
|
|
466
464
|
* Occurs when a
|
|
467
|
-
* [message](https://
|
|
465
|
+
* [message](https://developers.openai.com/api/docs/assistants/migration) is
|
|
468
466
|
* completed.
|
|
469
467
|
*/
|
|
470
468
|
interface ThreadMessageCompleted {
|
|
471
469
|
/**
|
|
472
470
|
* Represents a message within a
|
|
473
|
-
* [thread](https://
|
|
471
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
474
472
|
*/
|
|
475
473
|
data: MessagesAPI.Message;
|
|
476
474
|
event: 'thread.message.completed';
|
|
477
475
|
}
|
|
478
476
|
/**
|
|
479
477
|
* Occurs when a
|
|
480
|
-
* [message](https://
|
|
478
|
+
* [message](https://developers.openai.com/api/docs/assistants/migration) ends
|
|
481
479
|
* before it is completed.
|
|
482
480
|
*/
|
|
483
481
|
interface ThreadMessageIncomplete {
|
|
484
482
|
/**
|
|
485
483
|
* Represents a message within a
|
|
486
|
-
* [thread](https://
|
|
484
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
487
485
|
*/
|
|
488
486
|
data: MessagesAPI.Message;
|
|
489
487
|
event: 'thread.message.incomplete';
|
|
490
488
|
}
|
|
491
489
|
/**
|
|
492
490
|
* Occurs when an
|
|
493
|
-
* [error](https://
|
|
494
|
-
* This can happen due to an internal server error or a timeout.
|
|
491
|
+
* [error](https://developers.openai.com/api/docs/guides/error-codes#api-errors)
|
|
492
|
+
* occurs. This can happen due to an internal server error or a timeout.
|
|
495
493
|
*/
|
|
496
494
|
interface ErrorEvent {
|
|
497
495
|
data: Shared.ErrorObject;
|
|
@@ -527,7 +525,7 @@ export declare namespace FileSearchTool {
|
|
|
527
525
|
*
|
|
528
526
|
* Note that the file search tool may output fewer than `max_num_results` results.
|
|
529
527
|
* See the
|
|
530
|
-
* [file search tool documentation](https://
|
|
528
|
+
* [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
|
|
531
529
|
* for more information.
|
|
532
530
|
*/
|
|
533
531
|
max_num_results?: number;
|
|
@@ -536,7 +534,7 @@ export declare namespace FileSearchTool {
|
|
|
536
534
|
* will use the `auto` ranker and a score_threshold of 0.
|
|
537
535
|
*
|
|
538
536
|
* See the
|
|
539
|
-
* [file search tool documentation](https://
|
|
537
|
+
* [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
|
|
540
538
|
* for more information.
|
|
541
539
|
*/
|
|
542
540
|
ranking_options?: FileSearch.RankingOptions;
|
|
@@ -547,7 +545,7 @@ export declare namespace FileSearchTool {
|
|
|
547
545
|
* will use the `auto` ranker and a score_threshold of 0.
|
|
548
546
|
*
|
|
549
547
|
* See the
|
|
550
|
-
* [file search tool documentation](https://
|
|
548
|
+
* [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
|
|
551
549
|
* for more information.
|
|
552
550
|
*/
|
|
553
551
|
interface RankingOptions {
|
|
@@ -573,41 +571,41 @@ export interface FunctionTool {
|
|
|
573
571
|
}
|
|
574
572
|
/**
|
|
575
573
|
* Occurs when a
|
|
576
|
-
* [message](https://
|
|
574
|
+
* [message](https://developers.openai.com/api/docs/assistants/migration) is
|
|
577
575
|
* created.
|
|
578
576
|
*/
|
|
579
577
|
export type MessageStreamEvent = MessageStreamEvent.ThreadMessageCreated | MessageStreamEvent.ThreadMessageInProgress | MessageStreamEvent.ThreadMessageDelta | MessageStreamEvent.ThreadMessageCompleted | MessageStreamEvent.ThreadMessageIncomplete;
|
|
580
578
|
export declare namespace MessageStreamEvent {
|
|
581
579
|
/**
|
|
582
580
|
* Occurs when a
|
|
583
|
-
* [message](https://
|
|
581
|
+
* [message](https://developers.openai.com/api/docs/assistants/migration) is
|
|
584
582
|
* created.
|
|
585
583
|
*/
|
|
586
584
|
interface ThreadMessageCreated {
|
|
587
585
|
/**
|
|
588
586
|
* Represents a message within a
|
|
589
|
-
* [thread](https://
|
|
587
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
590
588
|
*/
|
|
591
589
|
data: MessagesAPI.Message;
|
|
592
590
|
event: 'thread.message.created';
|
|
593
591
|
}
|
|
594
592
|
/**
|
|
595
593
|
* Occurs when a
|
|
596
|
-
* [message](https://
|
|
597
|
-
*
|
|
594
|
+
* [message](https://developers.openai.com/api/docs/assistants/migration) moves to
|
|
595
|
+
* an `in_progress` state.
|
|
598
596
|
*/
|
|
599
597
|
interface ThreadMessageInProgress {
|
|
600
598
|
/**
|
|
601
599
|
* Represents a message within a
|
|
602
|
-
* [thread](https://
|
|
600
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
603
601
|
*/
|
|
604
602
|
data: MessagesAPI.Message;
|
|
605
603
|
event: 'thread.message.in_progress';
|
|
606
604
|
}
|
|
607
605
|
/**
|
|
608
606
|
* Occurs when parts of a
|
|
609
|
-
* [Message](https://
|
|
610
|
-
*
|
|
607
|
+
* [Message](https://developers.openai.com/api/docs/assistants/migration) are being
|
|
608
|
+
* streamed.
|
|
611
609
|
*/
|
|
612
610
|
interface ThreadMessageDelta {
|
|
613
611
|
/**
|
|
@@ -619,26 +617,26 @@ export declare namespace MessageStreamEvent {
|
|
|
619
617
|
}
|
|
620
618
|
/**
|
|
621
619
|
* Occurs when a
|
|
622
|
-
* [message](https://
|
|
620
|
+
* [message](https://developers.openai.com/api/docs/assistants/migration) is
|
|
623
621
|
* completed.
|
|
624
622
|
*/
|
|
625
623
|
interface ThreadMessageCompleted {
|
|
626
624
|
/**
|
|
627
625
|
* Represents a message within a
|
|
628
|
-
* [thread](https://
|
|
626
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
629
627
|
*/
|
|
630
628
|
data: MessagesAPI.Message;
|
|
631
629
|
event: 'thread.message.completed';
|
|
632
630
|
}
|
|
633
631
|
/**
|
|
634
632
|
* Occurs when a
|
|
635
|
-
* [message](https://
|
|
633
|
+
* [message](https://developers.openai.com/api/docs/assistants/migration) ends
|
|
636
634
|
* before it is completed.
|
|
637
635
|
*/
|
|
638
636
|
interface ThreadMessageIncomplete {
|
|
639
637
|
/**
|
|
640
638
|
* Represents a message within a
|
|
641
|
-
* [thread](https://
|
|
639
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
642
640
|
*/
|
|
643
641
|
data: MessagesAPI.Message;
|
|
644
642
|
event: 'thread.message.incomplete';
|
|
@@ -646,15 +644,15 @@ export declare namespace MessageStreamEvent {
|
|
|
646
644
|
}
|
|
647
645
|
/**
|
|
648
646
|
* Occurs when a
|
|
649
|
-
* [run step](https://
|
|
650
|
-
*
|
|
647
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) is
|
|
648
|
+
* created.
|
|
651
649
|
*/
|
|
652
650
|
export type RunStepStreamEvent = RunStepStreamEvent.ThreadRunStepCreated | RunStepStreamEvent.ThreadRunStepInProgress | RunStepStreamEvent.ThreadRunStepDelta | RunStepStreamEvent.ThreadRunStepCompleted | RunStepStreamEvent.ThreadRunStepFailed | RunStepStreamEvent.ThreadRunStepCancelled | RunStepStreamEvent.ThreadRunStepExpired;
|
|
653
651
|
export declare namespace RunStepStreamEvent {
|
|
654
652
|
/**
|
|
655
653
|
* Occurs when a
|
|
656
|
-
* [run step](https://
|
|
657
|
-
*
|
|
654
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) is
|
|
655
|
+
* created.
|
|
658
656
|
*/
|
|
659
657
|
interface ThreadRunStepCreated {
|
|
660
658
|
/**
|
|
@@ -665,8 +663,8 @@ export declare namespace RunStepStreamEvent {
|
|
|
665
663
|
}
|
|
666
664
|
/**
|
|
667
665
|
* Occurs when a
|
|
668
|
-
* [run step](https://
|
|
669
|
-
*
|
|
666
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) moves to
|
|
667
|
+
* an `in_progress` state.
|
|
670
668
|
*/
|
|
671
669
|
interface ThreadRunStepInProgress {
|
|
672
670
|
/**
|
|
@@ -677,8 +675,8 @@ export declare namespace RunStepStreamEvent {
|
|
|
677
675
|
}
|
|
678
676
|
/**
|
|
679
677
|
* Occurs when parts of a
|
|
680
|
-
* [run step](https://
|
|
681
|
-
*
|
|
678
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) are
|
|
679
|
+
* being streamed.
|
|
682
680
|
*/
|
|
683
681
|
interface ThreadRunStepDelta {
|
|
684
682
|
/**
|
|
@@ -690,8 +688,8 @@ export declare namespace RunStepStreamEvent {
|
|
|
690
688
|
}
|
|
691
689
|
/**
|
|
692
690
|
* Occurs when a
|
|
693
|
-
* [run step](https://
|
|
694
|
-
*
|
|
691
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) is
|
|
692
|
+
* completed.
|
|
695
693
|
*/
|
|
696
694
|
interface ThreadRunStepCompleted {
|
|
697
695
|
/**
|
|
@@ -702,8 +700,7 @@ export declare namespace RunStepStreamEvent {
|
|
|
702
700
|
}
|
|
703
701
|
/**
|
|
704
702
|
* Occurs when a
|
|
705
|
-
* [run step](https://
|
|
706
|
-
* fails.
|
|
703
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) fails.
|
|
707
704
|
*/
|
|
708
705
|
interface ThreadRunStepFailed {
|
|
709
706
|
/**
|
|
@@ -714,8 +711,8 @@ export declare namespace RunStepStreamEvent {
|
|
|
714
711
|
}
|
|
715
712
|
/**
|
|
716
713
|
* Occurs when a
|
|
717
|
-
* [run step](https://
|
|
718
|
-
*
|
|
714
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) is
|
|
715
|
+
* cancelled.
|
|
719
716
|
*/
|
|
720
717
|
interface ThreadRunStepCancelled {
|
|
721
718
|
/**
|
|
@@ -726,8 +723,7 @@ export declare namespace RunStepStreamEvent {
|
|
|
726
723
|
}
|
|
727
724
|
/**
|
|
728
725
|
* Occurs when a
|
|
729
|
-
* [run step](https://
|
|
730
|
-
* expires.
|
|
726
|
+
* [run step](https://developers.openai.com/api/docs/assistants/migration) expires.
|
|
731
727
|
*/
|
|
732
728
|
interface ThreadRunStepExpired {
|
|
733
729
|
/**
|
|
@@ -739,126 +735,126 @@ export declare namespace RunStepStreamEvent {
|
|
|
739
735
|
}
|
|
740
736
|
/**
|
|
741
737
|
* Occurs when a new
|
|
742
|
-
* [run](https://
|
|
738
|
+
* [run](https://developers.openai.com/api/docs/assistants/migration) is created.
|
|
743
739
|
*/
|
|
744
740
|
export type RunStreamEvent = RunStreamEvent.ThreadRunCreated | RunStreamEvent.ThreadRunQueued | RunStreamEvent.ThreadRunInProgress | RunStreamEvent.ThreadRunRequiresAction | RunStreamEvent.ThreadRunCompleted | RunStreamEvent.ThreadRunIncomplete | RunStreamEvent.ThreadRunFailed | RunStreamEvent.ThreadRunCancelling | RunStreamEvent.ThreadRunCancelled | RunStreamEvent.ThreadRunExpired;
|
|
745
741
|
export declare namespace RunStreamEvent {
|
|
746
742
|
/**
|
|
747
743
|
* Occurs when a new
|
|
748
|
-
* [run](https://
|
|
744
|
+
* [run](https://developers.openai.com/api/docs/assistants/migration) is created.
|
|
749
745
|
*/
|
|
750
746
|
interface ThreadRunCreated {
|
|
751
747
|
/**
|
|
752
748
|
* Represents an execution run on a
|
|
753
|
-
* [thread](https://
|
|
749
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
754
750
|
*/
|
|
755
751
|
data: RunsAPI.Run;
|
|
756
752
|
event: 'thread.run.created';
|
|
757
753
|
}
|
|
758
754
|
/**
|
|
759
|
-
* Occurs when a [run](https://
|
|
755
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
760
756
|
* moves to a `queued` status.
|
|
761
757
|
*/
|
|
762
758
|
interface ThreadRunQueued {
|
|
763
759
|
/**
|
|
764
760
|
* Represents an execution run on a
|
|
765
|
-
* [thread](https://
|
|
761
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
766
762
|
*/
|
|
767
763
|
data: RunsAPI.Run;
|
|
768
764
|
event: 'thread.run.queued';
|
|
769
765
|
}
|
|
770
766
|
/**
|
|
771
|
-
* Occurs when a [run](https://
|
|
767
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
772
768
|
* moves to an `in_progress` status.
|
|
773
769
|
*/
|
|
774
770
|
interface ThreadRunInProgress {
|
|
775
771
|
/**
|
|
776
772
|
* Represents an execution run on a
|
|
777
|
-
* [thread](https://
|
|
773
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
778
774
|
*/
|
|
779
775
|
data: RunsAPI.Run;
|
|
780
776
|
event: 'thread.run.in_progress';
|
|
781
777
|
}
|
|
782
778
|
/**
|
|
783
|
-
* Occurs when a [run](https://
|
|
779
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
784
780
|
* moves to a `requires_action` status.
|
|
785
781
|
*/
|
|
786
782
|
interface ThreadRunRequiresAction {
|
|
787
783
|
/**
|
|
788
784
|
* Represents an execution run on a
|
|
789
|
-
* [thread](https://
|
|
785
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
790
786
|
*/
|
|
791
787
|
data: RunsAPI.Run;
|
|
792
788
|
event: 'thread.run.requires_action';
|
|
793
789
|
}
|
|
794
790
|
/**
|
|
795
|
-
* Occurs when a [run](https://
|
|
791
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
796
792
|
* is completed.
|
|
797
793
|
*/
|
|
798
794
|
interface ThreadRunCompleted {
|
|
799
795
|
/**
|
|
800
796
|
* Represents an execution run on a
|
|
801
|
-
* [thread](https://
|
|
797
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
802
798
|
*/
|
|
803
799
|
data: RunsAPI.Run;
|
|
804
800
|
event: 'thread.run.completed';
|
|
805
801
|
}
|
|
806
802
|
/**
|
|
807
|
-
* Occurs when a [run](https://
|
|
803
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
808
804
|
* ends with status `incomplete`.
|
|
809
805
|
*/
|
|
810
806
|
interface ThreadRunIncomplete {
|
|
811
807
|
/**
|
|
812
808
|
* Represents an execution run on a
|
|
813
|
-
* [thread](https://
|
|
809
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
814
810
|
*/
|
|
815
811
|
data: RunsAPI.Run;
|
|
816
812
|
event: 'thread.run.incomplete';
|
|
817
813
|
}
|
|
818
814
|
/**
|
|
819
|
-
* Occurs when a [run](https://
|
|
815
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
820
816
|
* fails.
|
|
821
817
|
*/
|
|
822
818
|
interface ThreadRunFailed {
|
|
823
819
|
/**
|
|
824
820
|
* Represents an execution run on a
|
|
825
|
-
* [thread](https://
|
|
821
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
826
822
|
*/
|
|
827
823
|
data: RunsAPI.Run;
|
|
828
824
|
event: 'thread.run.failed';
|
|
829
825
|
}
|
|
830
826
|
/**
|
|
831
|
-
* Occurs when a [run](https://
|
|
827
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
832
828
|
* moves to a `cancelling` status.
|
|
833
829
|
*/
|
|
834
830
|
interface ThreadRunCancelling {
|
|
835
831
|
/**
|
|
836
832
|
* Represents an execution run on a
|
|
837
|
-
* [thread](https://
|
|
833
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
838
834
|
*/
|
|
839
835
|
data: RunsAPI.Run;
|
|
840
836
|
event: 'thread.run.cancelling';
|
|
841
837
|
}
|
|
842
838
|
/**
|
|
843
|
-
* Occurs when a [run](https://
|
|
839
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
844
840
|
* is cancelled.
|
|
845
841
|
*/
|
|
846
842
|
interface ThreadRunCancelled {
|
|
847
843
|
/**
|
|
848
844
|
* Represents an execution run on a
|
|
849
|
-
* [thread](https://
|
|
845
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
850
846
|
*/
|
|
851
847
|
data: RunsAPI.Run;
|
|
852
848
|
event: 'thread.run.cancelled';
|
|
853
849
|
}
|
|
854
850
|
/**
|
|
855
|
-
* Occurs when a [run](https://
|
|
851
|
+
* Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration)
|
|
856
852
|
* expires.
|
|
857
853
|
*/
|
|
858
854
|
interface ThreadRunExpired {
|
|
859
855
|
/**
|
|
860
856
|
* Represents an execution run on a
|
|
861
|
-
* [thread](https://
|
|
857
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration).
|
|
862
858
|
*/
|
|
863
859
|
data: RunsAPI.Run;
|
|
864
860
|
event: 'thread.run.expired';
|
|
@@ -866,13 +862,13 @@ export declare namespace RunStreamEvent {
|
|
|
866
862
|
}
|
|
867
863
|
/**
|
|
868
864
|
* Occurs when a new
|
|
869
|
-
* [thread](https://
|
|
865
|
+
* [thread](https://developers.openai.com/api/docs/assistants/migration) is
|
|
870
866
|
* created.
|
|
871
867
|
*/
|
|
872
868
|
export interface ThreadStreamEvent {
|
|
873
869
|
/**
|
|
874
870
|
* Represents a thread that contains
|
|
875
|
-
* [messages](https://
|
|
871
|
+
* [messages](https://developers.openai.com/api/docs/assistants/migration).
|
|
876
872
|
*/
|
|
877
873
|
data: ThreadsAPI.Thread;
|
|
878
874
|
event: 'thread.created';
|
|
@@ -884,10 +880,10 @@ export interface ThreadStreamEvent {
|
|
|
884
880
|
export interface AssistantCreateParams {
|
|
885
881
|
/**
|
|
886
882
|
* ID of the model to use. You can use the
|
|
887
|
-
* [List models](https://
|
|
888
|
-
* see all of your available models, or see our
|
|
889
|
-
* [Model overview](https://
|
|
890
|
-
* them.
|
|
883
|
+
* [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
|
|
884
|
+
* API to see all of your available models, or see our
|
|
885
|
+
* [Model overview](https://developers.openai.com/api/docs/models) for descriptions
|
|
886
|
+
* of them.
|
|
891
887
|
*/
|
|
892
888
|
model: (string & {}) | Shared.ChatModel;
|
|
893
889
|
/**
|
|
@@ -917,20 +913,20 @@ export interface AssistantCreateParams {
|
|
|
917
913
|
* are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
918
914
|
* reasoning effort can result in faster responses and fewer tokens used on
|
|
919
915
|
* reasoning in a response. Not all reasoning models support every value. See the
|
|
920
|
-
* [reasoning guide](https://
|
|
916
|
+
* [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
|
|
921
917
|
* model-specific support.
|
|
922
918
|
*/
|
|
923
919
|
reasoning_effort?: Shared.ReasoningEffort | null;
|
|
924
920
|
/**
|
|
925
921
|
* Specifies the format that the model must output. Compatible with
|
|
926
|
-
* [GPT-4o](https://
|
|
927
|
-
* [GPT-4 Turbo](https://
|
|
928
|
-
*
|
|
922
|
+
* [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
|
|
923
|
+
* [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
|
|
924
|
+
* all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
|
|
929
925
|
*
|
|
930
926
|
* Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
|
|
931
927
|
* Outputs which ensures the model will match your supplied JSON schema. Learn more
|
|
932
928
|
* in the
|
|
933
|
-
* [Structured Outputs guide](https://
|
|
929
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
934
930
|
*
|
|
935
931
|
* Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
|
|
936
932
|
* message the model generates is valid JSON.
|
|
@@ -986,23 +982,23 @@ export declare namespace AssistantCreateParams {
|
|
|
986
982
|
namespace ToolResources {
|
|
987
983
|
interface CodeInterpreter {
|
|
988
984
|
/**
|
|
989
|
-
* A list of [file](https://
|
|
990
|
-
* available to the `code_interpreter` tool. There can be a maximum of 20
|
|
991
|
-
* associated with the tool.
|
|
985
|
+
* A list of [file](https://developers.openai.com/api/reference/resources/files)
|
|
986
|
+
* IDs made available to the `code_interpreter` tool. There can be a maximum of 20
|
|
987
|
+
* files associated with the tool.
|
|
992
988
|
*/
|
|
993
989
|
file_ids?: Array<string>;
|
|
994
990
|
}
|
|
995
991
|
interface FileSearch {
|
|
996
992
|
/**
|
|
997
993
|
* The
|
|
998
|
-
* [vector store](https://
|
|
994
|
+
* [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
|
|
999
995
|
* attached to this assistant. There can be a maximum of 1 vector store attached to
|
|
1000
996
|
* the assistant.
|
|
1001
997
|
*/
|
|
1002
998
|
vector_store_ids?: Array<string>;
|
|
1003
999
|
/**
|
|
1004
1000
|
* A helper to create a
|
|
1005
|
-
* [vector store](https://
|
|
1001
|
+
* [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
|
|
1006
1002
|
* with file_ids and attach it to this assistant. There can be a maximum of 1
|
|
1007
1003
|
* vector store attached to the assistant.
|
|
1008
1004
|
*/
|
|
@@ -1016,10 +1012,10 @@ export declare namespace AssistantCreateParams {
|
|
|
1016
1012
|
*/
|
|
1017
1013
|
chunking_strategy?: VectorStore.Auto | VectorStore.Static;
|
|
1018
1014
|
/**
|
|
1019
|
-
* A list of [file](https://
|
|
1020
|
-
* add to the vector store. For vector stores created before Nov 2025, there
|
|
1021
|
-
* a maximum of 10,000 files in a vector store. For vector stores created
|
|
1022
|
-
* in Nov 2025, the limit is 100,000,000 files.
|
|
1015
|
+
* A list of [file](https://developers.openai.com/api/reference/resources/files)
|
|
1016
|
+
* IDs to add to the vector store. For vector stores created before Nov 2025, there
|
|
1017
|
+
* can be a maximum of 10,000 files in a vector store. For vector stores created
|
|
1018
|
+
* starting in Nov 2025, the limit is 100,000,000 files.
|
|
1023
1019
|
*/
|
|
1024
1020
|
file_ids?: Array<string>;
|
|
1025
1021
|
/**
|
|
@@ -1090,10 +1086,10 @@ export interface AssistantUpdateParams {
|
|
|
1090
1086
|
metadata?: Shared.Metadata | null;
|
|
1091
1087
|
/**
|
|
1092
1088
|
* ID of the model to use. You can use the
|
|
1093
|
-
* [List models](https://
|
|
1094
|
-
* see all of your available models, or see our
|
|
1095
|
-
* [Model overview](https://
|
|
1096
|
-
* them.
|
|
1089
|
+
* [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
|
|
1090
|
+
* API to see all of your available models, or see our
|
|
1091
|
+
* [Model overview](https://developers.openai.com/api/docs/models) for descriptions
|
|
1092
|
+
* of them.
|
|
1097
1093
|
*/
|
|
1098
1094
|
model?: (string & {}) | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5-2025-08-07' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano-2025-08-07' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano-2025-04-14' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o1' | 'o1-2024-12-17' | 'gpt-4o' | 'gpt-4o-2024-11-20' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-05-13' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4.5-preview' | 'gpt-4.5-preview-2025-02-27' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-0125-preview' | 'gpt-4-turbo-preview' | 'gpt-4-1106-preview' | 'gpt-4-vision-preview' | 'gpt-4' | 'gpt-4-0314' | 'gpt-4-0613' | 'gpt-4-32k' | 'gpt-4-32k-0314' | 'gpt-4-32k-0613' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-16k' | 'gpt-3.5-turbo-0613' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo-16k-0613';
|
|
1099
1095
|
/**
|
|
@@ -1105,20 +1101,20 @@ export interface AssistantUpdateParams {
|
|
|
1105
1101
|
* are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
1106
1102
|
* reasoning effort can result in faster responses and fewer tokens used on
|
|
1107
1103
|
* reasoning in a response. Not all reasoning models support every value. See the
|
|
1108
|
-
* [reasoning guide](https://
|
|
1104
|
+
* [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
|
|
1109
1105
|
* model-specific support.
|
|
1110
1106
|
*/
|
|
1111
1107
|
reasoning_effort?: Shared.ReasoningEffort | null;
|
|
1112
1108
|
/**
|
|
1113
1109
|
* Specifies the format that the model must output. Compatible with
|
|
1114
|
-
* [GPT-4o](https://
|
|
1115
|
-
* [GPT-4 Turbo](https://
|
|
1116
|
-
*
|
|
1110
|
+
* [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
|
|
1111
|
+
* [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
|
|
1112
|
+
* all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
|
|
1117
1113
|
*
|
|
1118
1114
|
* Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
|
|
1119
1115
|
* Outputs which ensures the model will match your supplied JSON schema. Learn more
|
|
1120
1116
|
* in the
|
|
1121
|
-
* [Structured Outputs guide](https://
|
|
1117
|
+
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
1122
1118
|
*
|
|
1123
1119
|
* Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
|
|
1124
1120
|
* message the model generates is valid JSON.
|
|
@@ -1175,16 +1171,16 @@ export declare namespace AssistantUpdateParams {
|
|
|
1175
1171
|
interface CodeInterpreter {
|
|
1176
1172
|
/**
|
|
1177
1173
|
* Overrides the list of
|
|
1178
|
-
* [file](https://
|
|
1179
|
-
* to the `code_interpreter` tool. There can be a maximum of 20 files
|
|
1180
|
-
* with the tool.
|
|
1174
|
+
* [file](https://developers.openai.com/api/reference/resources/files) IDs made
|
|
1175
|
+
* available to the `code_interpreter` tool. There can be a maximum of 20 files
|
|
1176
|
+
* associated with the tool.
|
|
1181
1177
|
*/
|
|
1182
1178
|
file_ids?: Array<string>;
|
|
1183
1179
|
}
|
|
1184
1180
|
interface FileSearch {
|
|
1185
1181
|
/**
|
|
1186
1182
|
* Overrides the
|
|
1187
|
-
* [vector store](https://
|
|
1183
|
+
* [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
|
|
1188
1184
|
* attached to this assistant. There can be a maximum of 1 vector store attached to
|
|
1189
1185
|
* the assistant.
|
|
1190
1186
|
*/
|