@inductiv/node-red-openai-api 1.103.0 → 6.27.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.
Files changed (69) hide show
  1. package/README.md +213 -86
  2. package/examples/realtime/client-secrets.json +182 -0
  3. package/examples/responses/computer-use.json +142 -0
  4. package/examples/responses/mcp.json +1 -1
  5. package/examples/responses/phase.json +102 -0
  6. package/examples/responses/tool-search.json +107 -0
  7. package/examples/responses/websocket.json +172 -0
  8. package/internals/openai-api-features-v6.23.0-v6.27.0.md +96 -0
  9. package/lib.js +12696 -15003
  10. package/locales/en-US/node.json +50 -1
  11. package/node.html +1723 -1012
  12. package/node.js +204 -54
  13. package/package.json +9 -7
  14. package/src/assistants/help.html +1 -77
  15. package/src/audio/help.html +1 -37
  16. package/src/batch/help.html +3 -17
  17. package/src/chat/help.html +11 -89
  18. package/src/container-files/help.html +1 -27
  19. package/src/containers/help.html +8 -18
  20. package/src/conversations/help.html +135 -0
  21. package/src/conversations/methods.js +73 -0
  22. package/src/conversations/template.html +10 -0
  23. package/src/embeddings/help.html +1 -11
  24. package/src/evals/help.html +249 -0
  25. package/src/evals/methods.js +114 -0
  26. package/src/evals/template.html +14 -0
  27. package/src/files/help.html +4 -17
  28. package/src/fine-tuning/help.html +1 -35
  29. package/src/images/help.html +1 -45
  30. package/src/lib.js +53 -1
  31. package/src/messages/help.html +19 -39
  32. package/src/messages/methods.js +13 -0
  33. package/src/messages/template.html +7 -18
  34. package/src/models/help.html +1 -5
  35. package/src/moderations/help.html +1 -5
  36. package/src/node.html +126 -37
  37. package/src/realtime/help.html +209 -0
  38. package/src/realtime/methods.js +45 -0
  39. package/src/realtime/template.html +7 -0
  40. package/src/responses/help.html +286 -63
  41. package/src/responses/methods.js +234 -16
  42. package/src/responses/template.html +21 -1
  43. package/src/responses/websocket.js +150 -0
  44. package/src/runs/help.html +1 -123
  45. package/src/skills/help.html +183 -0
  46. package/src/skills/methods.js +99 -0
  47. package/src/skills/template.html +13 -0
  48. package/src/threads/help.html +1 -15
  49. package/src/uploads/help.html +1 -21
  50. package/src/vector-store-file-batches/help.html +1 -27
  51. package/src/vector-store-file-batches/methods.js +5 -5
  52. package/src/vector-store-files/help.html +1 -25
  53. package/src/vector-store-files/methods.js +4 -7
  54. package/src/vector-stores/help.html +2 -31
  55. package/src/vector-stores/methods.js +5 -11
  56. package/src/vector-stores/template.html +7 -22
  57. package/src/videos/help.html +113 -0
  58. package/src/videos/methods.js +50 -0
  59. package/src/videos/template.html +8 -0
  60. package/src/webhooks/help.html +61 -0
  61. package/src/webhooks/methods.js +40 -0
  62. package/src/webhooks/template.html +4 -0
  63. package/test/openai-methods-mapping.test.js +1559 -0
  64. package/test/openai-node-auth-routing.test.js +206 -0
  65. package/test/openai-responses-websocket.test.js +472 -0
  66. package/test/service-host-editor-template.test.js +56 -0
  67. package/test/service-host-node.test.js +185 -0
  68. package/test/services.test.js +150 -0
  69. package/test/utils.test.js +78 -0
package/src/runs/help.html CHANGED
@@ -1,7 +1,7 @@
1
1
  <section>
2
2
  <details>
3
3
  <summary style="font-weight: bold;">🔄 Runs</summary>
4
- <a href="https://platform.openai.com/docs/api-reference/runs" target="_blank">Official Documentation</a>
4
+ <a href="https://developers.openai.com/api/reference/typescript/resources/beta/threads/runs/" target="_blank">Official Documentation</a>
5
5
  <h4 style="font-weight: bolder;"> ⋙ Create Thread and Run</h4>
6
6
  <p>Create a thread and run it in one request.</p>
7
7
  <dl class="message-properties">
@@ -9,46 +9,34 @@
9
9
 
10
10
  <dt>
11
11
  assistant_id
12
- <a href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-assistant_id"
13
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
14
12
  <span class="property-type">string</span>
15
13
  </dt>
16
14
  <dd>The ID of the assistant to use to execute this run.</dd>
17
15
  <dt class="optional">
18
16
  thread
19
- <a href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-thread"
20
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
21
17
  <span class="property-type">object</span>
22
18
  </dt>
23
19
  <dd>A thread object to create with the run.</dd>
24
20
 
25
21
  <dt class="optional">
26
22
  model
27
- <a href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-model"
28
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
29
23
  <span class="property-type">string</span>
30
24
  </dt>
31
25
  <dd>The ID of the Model to be used to execute this run.</dd>
32
26
  <dt class="optional">
33
27
  instructions
34
- <a href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-instructions"
35
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
36
28
  <span class="property-type">string</span>
37
29
  </dt>
38
30
  <dd>Override the default system message of the assistant.</dd>
39
31
 
40
32
  <dt class="optional">
41
33
  tools
42
- <a href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-tools"
43
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
44
34
  <span class="property-type">array</span>
45
35
  </dt>
46
36
  <dd>Override the tools the assistant can use for this run.</dd>
47
37
 
48
38
  <dt class="optional">
49
39
  tool_resources
50
- <a href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-tool_resources"
51
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
52
40
  <span class="property-type">object or null</span>
53
41
  </dt>
54
42
  <dd>A set of resources that are used by the assistant's tools.</dd>
@@ -56,24 +44,18 @@
56
44
 
57
45
  <dt class="optional">
58
46
  metadata
59
- <a href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-metadata"
60
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
61
47
  <span class="property-type">object</span>
62
48
  </dt>
63
49
  <dd>Set of 16 key-value pairs that can be attached to an object.</dd>
64
50
 
65
51
  <dt class="optional">
66
52
  temperature
67
- <a href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-temperature"
68
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
69
53
  <span class="property-type">number</span>
70
54
  </dt>
71
55
  <dd>What sampling temperature to use, between 0 and 2.</dd>
72
56
 
73
57
  <dt class="optional">
74
58
  top_p
75
- <a href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-top_p"
76
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
77
59
  <span class="property-type">number or null</span>
78
60
  </dt>
79
61
  <dd>An alternative to sampling with temperature.</dd>
@@ -81,8 +63,6 @@
81
63
 
82
64
  <dt class="optional">
83
65
  stream
84
- <a href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-stream"
85
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
86
66
  <span class="property-type">boolean</span>
87
67
  </dt>
88
68
  <dd>If <code>true</code>, returns a stream of events that happen during the Run as server-sent events,
@@ -90,24 +70,18 @@
90
70
 
91
71
  <dt class="optional">
92
72
  max_prompt_tokens
93
- <a href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-max_prompt_tokens"
94
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
95
73
  <span class="property-type">integer</span>
96
74
  </dt>
97
75
  <dd>The maximum number of prompt tokens that may be used over the course of the run.</dd>
98
76
 
99
77
  <dt class="optional">
100
78
  max_completion_tokens
101
- <a href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-max_completion_tokens"
102
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
103
79
  <span class="property-type">integer</span>
104
80
  </dt>
105
81
  <dd>The maximum number of completion tokens that may be used over the course of the run.</dd>
106
82
 
107
83
  <dt class="optional">
108
84
  truncation_strategy
109
- <a href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-truncation_strategy"
110
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
111
85
  <span class="property-type">object</span>
112
86
  <dd>
113
87
  <strong><code>@property {string} type</code></strong> - The truncation strategy to use for the thread.
@@ -123,8 +97,6 @@
123
97
 
124
98
  <dt class="optional">
125
99
  tool_choice
126
- <a href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-tool_choice"
127
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
128
100
  <span class="property-type">string | object</span>
129
101
  </dt>
130
102
  <dd>Controls which (if any) tool is called by the model. <code>none</code> means the model will not call any
@@ -134,16 +106,12 @@
134
106
 
135
107
  <dt class="optional">
136
108
  parallel_tool_calls
137
- <a href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-parallel_tool_calls"
138
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
139
109
  <span class="property-type">boolean</span>
140
110
  </dt>
141
111
  <dd>Whether to enable parallel function calling during tool use.</dd>
142
112
 
143
113
  <dt class="optional">
144
114
  response_format
145
- <a href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-response_format"
146
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
147
115
  <span class="property-type">string | object</span>
148
116
  </dt>
149
117
  <dd>Specifies the format that the model must output.</dd>
@@ -157,36 +125,26 @@
157
125
 
158
126
  <dt>
159
127
  thread_id
160
- <a href="https://platform.openai.com/docs/api-reference/runs/listRuns#runs-listruns-thread_id"
161
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
162
128
  <span class="property-type">string</span>
163
129
  </dt>
164
130
  <dd>The ID of the thread the run belongs to.</dd>
165
131
  <dt class="optional">
166
132
  limit
167
- <a href="https://platform.openai.com/docs/api-reference/runs/listRuns#runs-listruns-limit"
168
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
169
133
  <span class="property-type">integer</span>
170
134
  </dt>
171
135
  <dd>A limit on the number of objects to be returned.</dd>
172
136
  <dt class="optional">
173
137
  order
174
- <a href="https://platform.openai.com/docs/api-reference/runs/listRuns#runs-listruns-order"
175
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
176
138
  <span class="property-type">string</span>
177
139
  </dt>
178
140
  <dd>Sort order by the created_at timestamp of the objects.</dd>
179
141
  <dt class="optional">
180
142
  after
181
- <a href="https://platform.openai.com/docs/api-reference/runs/listRuns#runs-listruns-after"
182
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
183
143
  <span class="property-type">string</span>
184
144
  </dt>
185
145
  <dd>A cursor for use in pagination.</dd>
186
146
  <dt class="optional">
187
147
  before
188
- <a href="https://platform.openai.com/docs/api-reference/runs/listRuns#runs-listruns-before"
189
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
190
148
  <span class="property-type">string</span>
191
149
  </dt>
192
150
  <dd>A cursor for use in pagination.</dd>
@@ -199,38 +157,28 @@
199
157
 
200
158
  <dt>
201
159
  thread_id
202
- <a href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-thread_id"
203
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
204
160
  <span class="property-type">string</span>
205
161
  </dt>
206
162
  <dd>The ID of the thread to run.</dd>
207
163
 
208
164
  <dt>
209
165
  include
210
- <a href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-include"
211
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
212
166
  <span class="property-type">array</span>
213
167
  </dt>
214
168
  <dd>A list of additional fields to include in the response.</dd>
215
169
 
216
170
  <dt>
217
171
  assistant_id
218
- <a href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-assistant_id"
219
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
220
172
  <span class="property-type">string</span>
221
173
  </dt>
222
174
  <dd>The ID of the assistant to use to execute this run.</dd>
223
175
  <dt class="optional">
224
176
  model
225
- <a href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-model"
226
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
227
177
  <span class="property-type">string</span>
228
178
  </dt>
229
179
  <dd>The ID of the Model to be used to execute this run.</dd>
230
180
  <dt class="optional">
231
181
  instructions
232
- <a href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-instructions"
233
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
234
182
  <span class="property-type">string</span>
235
183
  </dt>
236
184
  <dd>
@@ -240,8 +188,6 @@
240
188
 
241
189
  <dt class="optional">
242
190
  additional_instructions
243
- <a href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-additional_instructions"
244
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
245
191
  <span class="property-type">string</span>
246
192
  </dt>
247
193
  <dd>
@@ -251,8 +197,6 @@
251
197
 
252
198
  <dt class="optional">
253
199
  additional_messages
254
- <a href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-additional_messages"
255
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
256
200
  <span class="property-type">array</span>
257
201
  </dt>
258
202
  <dd>
@@ -261,31 +205,23 @@
261
205
 
262
206
  <dt class="optional">
263
207
  tools
264
- <a href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-tools"
265
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
266
208
  <span class="property-type">array</span>
267
209
  </dt>
268
210
  <dd>Override the tools the assistant can use for this run.</dd>
269
211
  <dt class="optional">
270
212
  metadata
271
- <a href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-metadata"
272
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
273
213
  <span class="property-type">object</span>
274
214
  </dt>
275
215
  <dd>Set of 16 key-value pairs that can be attached to an object.</dd>
276
216
 
277
217
  <dt class="optional">
278
218
  temperature
279
- <a href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-temperature"
280
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
281
219
  <span class="property-type">number</span>
282
220
  </dt>
283
221
  <dd>What sampling temperature to use, between 0 and 2.</dd>
284
222
 
285
223
  <dt class="optional">
286
224
  top_p
287
- <a href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-top_p"
288
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
289
225
  <span class="property-type">number</span>
290
226
  </dt>
291
227
  <dd>An alternative to sampling with temperature, called nucleus sampling, where the model considers the
@@ -293,8 +229,6 @@
293
229
 
294
230
  <dt class="optional">
295
231
  stream
296
- <a href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-stream"
297
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
298
232
  <span class="property-type">boolean</span>
299
233
  </dt>
300
234
  <dd>If true, returns a stream of events that happen during the Run as server-sent events, terminating when
@@ -302,48 +236,36 @@
302
236
 
303
237
  <dt class="optional">
304
238
  max_prompt_tokens
305
- <a href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-max_prompt_tokens"
306
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
307
239
  <span class="property-type">integer</span>
308
240
  </dt>
309
241
  <dd>The maximum number of prompt tokens that may be used over the course of the run.</dd>
310
242
 
311
243
  <dt class="optional">
312
244
  max_completion_tokens
313
- <a href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-max_completion_tokens"
314
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
315
245
  <span class="property-type">integer</span>
316
246
  </dt>
317
247
  <dd>The maximum number of completion tokens that may be used over the course of the run.</dd>
318
248
 
319
249
  <dt class="optional">
320
250
  truncation_strategy
321
- <a href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-truncation_strategy"
322
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
323
251
  <span class="property-type">object</span>
324
252
  </dt>
325
253
  <dd>Controls for how a thread will be truncated prior to the run.</dd>
326
254
 
327
255
  <dt class="optional">
328
256
  tool_choice
329
- <a href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-tool_choice"
330
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
331
257
  <span class="property-type">string or object</span>
332
258
  </dt>
333
259
  <dd>Controls for how a thread will be truncated prior to the run.</dd>
334
260
 
335
261
  <dt class="optional">
336
262
  parallel_tool_calls
337
- <a href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-parallel_tool_calls"
338
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
339
263
  <span class="property-type">boolean</span>
340
264
  </dt>
341
265
  <dd>Whether to enable parallel function calling during tool use.</dd>
342
266
 
343
267
  <dt class="optional">
344
268
  response_format
345
- <a href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-response_format"
346
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
347
269
  <span class="property-type">string or object</span>
348
270
  </dt>
349
271
  <dd>Specifies the format that the model must output.</dd>
@@ -356,15 +278,11 @@
356
278
  <h4>msg.payload Properties</h4>
357
279
 
358
280
  <dt>thread_id
359
- <a href="https://platform.openai.com/docs/api-reference/runs/getRun#runs-getrun-thread_id"
360
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
361
281
  <span class="property-type">string</span>
362
282
  </dt>
363
283
  <dd>The ID of the thread that was run.</dd>
364
284
 
365
285
  <dt>run_id
366
- <a href="https://platform.openai.com/docs/api-reference/runs/getRun#runs-getrun-run_id"
367
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
368
286
  <span class="property-type">string</span>
369
287
  </dt>
370
288
  <dd>The ID of the run to retrieve.</dd>
@@ -377,22 +295,16 @@
377
295
 
378
296
  <dt>
379
297
  thread_id
380
- <a href="https://platform.openai.com/docs/api-reference/runs/getRun#runs-getrun-thread_id"
381
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
382
298
  <span class="property-type">string</span>
383
299
  </dt>
384
300
  <dd>The ID of the thread that was run.</dd>
385
301
  <dt>
386
302
  run_id
387
- <a href="https://platform.openai.com/docs/api-reference/runs/getRun#runs-getrun-run_id"
388
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
389
303
  <span class="property-type">string</span>
390
304
  </dt>
391
305
  <dd>The ID of the run to modify.</dd>
392
306
  <dt class="optional">
393
307
  metadata
394
- <a href="https://platform.openai.com/docs/api-reference/runs/modifyRun#runs-modifyrun-metadata"
395
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
396
308
  <span class="property-type">object</span>
397
309
  </dt>
398
310
  <dd>Set of 16 key-value pairs that can be attached to an object.</dd>
@@ -410,31 +322,23 @@
410
322
 
411
323
  <dt>
412
324
  thread_id
413
- <a href="https://platform.openai.com/docs/api-reference/runs/submitToolOutputs#runs-submittooloutputs-thread_id"
414
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
415
325
  <span class="property-type">string</span>
416
326
  </dt>
417
327
  <dd>The ID of the thread to which this run belongs.</dd>
418
328
  <dt>
419
329
  run_id
420
- <a href="https://platform.openai.com/docs/api-reference/runs/submitToolOutputs#runs-submittooloutputs-run_id"
421
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
422
330
  <span class="property-type">string</span>
423
331
  </dt>
424
332
  <dd>The ID of the run that requires the tool output submission.</dd>
425
333
 
426
334
  <dt>
427
335
  tool_outputs
428
- <a href="https://platform.openai.com/docs/api-reference/runs/submitToolOutputs#runs-submittooloutputs-tool_outputs"
429
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
430
336
  <span class="property-type">array</span>
431
337
  </dt>
432
338
  <dd>A list of tools for which the outputs are being submitted.</dd>
433
339
 
434
340
  <dt class="optional">
435
341
  stream
436
- <a href="https://platform.openai.com/docs/api-reference/runs/submitToolOutputs#runs-submittooloutputs-stream"
437
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
438
342
  <span class="property-type">boolean</span>
439
343
  </dt>
440
344
  <dd>If true, returns a stream of events that happen during the Run as server-sent events, terminating when
@@ -449,15 +353,11 @@
449
353
 
450
354
  <dt>
451
355
  thread_id
452
- <a href="https://platform.openai.com/docs/api-reference/runs/cancelRun#runs-cancelrun-thread_id"
453
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
454
356
  <span class="property-type">string</span>
455
357
  </dt>
456
358
  <dd>The ID of the thread to which this run belongs.</dd>
457
359
  <dt>
458
360
  run_id
459
- <a href="https://platform.openai.com/docs/api-reference/runs/cancelRun#runs-cancelrun-run_id"
460
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
461
361
  <span class="property-type">string</span>
462
362
  </dt>
463
363
  <dd>The ID of the run to cancel.</dd>
@@ -470,52 +370,38 @@
470
370
 
471
371
  <dt>
472
372
  thread_id
473
- <a href="https://platform.openai.com/docs/api-reference/runs/listRunSteps#runs-listrunsteps-thread_id"
474
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
475
373
  <span class="property-type">string</span>
476
374
  </dt>
477
375
  <dd>The ID of the thread the run and run steps belong to.</dd>
478
376
  <dt>
479
377
  run_id
480
- <a href="https://platform.openai.com/docs/api-reference/runs/listRunSteps#runs-listrunsteps-run_id"
481
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
482
378
  <span class="property-type">string</span>
483
379
  </dt>
484
380
  <dd>The ID of the run the run steps belong to.</dd>
485
381
  <dt class="optional">
486
382
  limit
487
- <a href="https://platform.openai.com/docs/api-reference/runs/listRunSteps#runs-listrunsteps-limit"
488
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
489
383
  <span class="property-type">integer</span>
490
384
  </dt>
491
385
  <dd>A limit on the number of objects to be returned.</dd>
492
386
  <dt class="optional">
493
387
  order
494
- <a href="https://platform.openai.com/docs/api-reference/runs/listRunSteps#runs-listrunsteps-order"
495
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
496
388
  <span class="property-type">string</span>
497
389
  </dt>
498
390
  <dd>Sort order by the created_at timestamp of the objects.</dd>
499
391
  <dt class="optional">
500
392
  after
501
- <a href="https://platform.openai.com/docs/api-reference/runs/listRunSteps#runs-listrunsteps-after"
502
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
503
393
  <span class="property-type">string</span>
504
394
  </dt>
505
395
  <dd>A cursor for use in pagination.</dd>
506
396
 
507
397
  <dt class="optional">
508
398
  before
509
- <a href="https://platform.openai.com/docs/api-reference/runs/listRunSteps#runs-listrunsteps-before"
510
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
511
399
  <span class="property-type">string</span>
512
400
  </dt>
513
401
  <dd>A cursor for use in pagination.</dd>
514
402
 
515
403
  <dt class="optional">
516
404
  include
517
- <a href="https://platform.openai.com/docs/api-reference/run-steps/listRunSteps#run-steps-listrunsteps-include"
518
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
519
405
  <span class="property-type">array</span>
520
406
  </dt>
521
407
  <dd>A list of additional fields to include in the response.</dd>
@@ -528,31 +414,23 @@
528
414
 
529
415
  <dt>
530
416
  thread_id
531
- <a href="https://platform.openai.com/docs/api-reference/runs/getRunStep#runs-getrunstep-thread_id"
532
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
533
417
  <span class="property-type">string</span>
534
418
  </dt>
535
419
  <dd>The ID of the thread to which the run and run step belongs.</dd>
536
420
  <dt>
537
421
  run_id
538
- <a href="https://platform.openai.com/docs/api-reference/runs/getRunStep#runs-getrunstep-run_id"
539
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
540
422
  <span class="property-type">string</span>
541
423
  </dt>
542
424
  <dd>The ID of the run to which the run step belongs.</dd>
543
425
 
544
426
  <dt>
545
427
  step_id
546
- <a href="https://platform.openai.com/docs/api-reference/runs/getRunStep#runs-getrunstep-step_id"
547
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
548
428
  <span class="property-type">string</span>
549
429
  </dt>
550
430
  <dd>The ID of the run step to retrieve.</dd>
551
431
 
552
432
  <dt>
553
433
  include
554
- <a href="https://platform.openai.com/docs/api-reference/run-steps/getRunStep#run-steps-getrunstep-include"
555
- target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
556
434
  <span class="property-type">array</span>
557
435
  </dt>
558
436
  <dd>A list of additional fields to include in the response.</dd>