@inductiv/node-red-openai-api 0.8.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/node.html CHANGED
@@ -132,6 +132,27 @@
132
132
  data-i18n="OpenaiApi.parameters.createTranslation"
133
133
  ></option>
134
134
  </optgroup>
135
+
136
+ <!-- Batch Endpoint-->
137
+ <optgroup style="font-style: normal;" label="📦 Batch">
138
+ <option
139
+ value="createBatch"
140
+ data-i18n="OpenaiApi.parameters.createBatch"
141
+ ></option>
142
+ <option
143
+ value="retrieveBatch"
144
+ data-i18n="OpenaiApi.parameters.retrieveBatch"
145
+ ></option>
146
+ <option
147
+ value="cancelBatch"
148
+ data-i18n="OpenaiApi.parameters.cancelBatch"
149
+ ></option>
150
+ <option
151
+ value="listBatch"
152
+ data-i18n="OpenaiApi.parameters.listBatch"
153
+ ></option>
154
+ </optgroup>
155
+
135
156
  <optgroup style="font-style: normal;" label="🗨️ Chat">
136
157
  <option
137
158
  value="createChatCompletion"
@@ -219,14 +240,6 @@
219
240
  value="modifyMessage"
220
241
  data-i18n="OpenaiApi.parameters.modifyMessage"
221
242
  ></option>
222
- <option
223
- value="listMessageFiles"
224
- data-i18n="OpenaiApi.parameters.listMessageFiles"
225
- ></option>
226
- <option
227
- value="getMessageFile"
228
- data-i18n="OpenaiApi.parameters.getMessageFile"
229
- ></option>
230
243
  </optgroup>
231
244
  <optgroup style="font-style: normal;" label="🧠 Models">
232
245
  <option
@@ -267,8 +280,8 @@
267
280
  data-i18n="OpenaiApi.parameters.modifyRun"
268
281
  ></option>
269
282
  <option
270
- value="submitToolOuputsToRun"
271
- data-i18n="OpenaiApi.parameters.submitToolOuputsToRun"
283
+ value="submitToolOutputsToRun"
284
+ data-i18n="OpenaiApi.parameters.submitToolOutputsToRun"
272
285
  ></option>
273
286
  <option
274
287
  value="cancelRun"
@@ -301,6 +314,67 @@
301
314
  data-i18n="OpenaiApi.parameters.deleteThread"
302
315
  ></option>
303
316
  </optgroup>
317
+
318
+ <optgroup style="font-style: normal;" label="🔢 Vector Stores (Beta)">
319
+ <option
320
+ value="createVectorStore"
321
+ data-i18n="OpenaiApi.parameters.createVectorStore"
322
+ ></option>
323
+ <option
324
+ value="listVectorStores"
325
+ data-i18n="OpenaiApi.parameters.listVectorStores"
326
+ ></option>
327
+ <option
328
+ value="retrieveVectorStore"
329
+ data-i18n="OpenaiApi.parameters.retrieveVectorStore"
330
+ ></option>
331
+ <option
332
+ value="modifyVectorStore"
333
+ data-i18n="OpenaiApi.parameters.modifyVectorStore"
334
+ ></option>
335
+ <option
336
+ value="deleteVectorStore"
337
+ data-i18n="OpenaiApi.parameters.deleteVectorStore"
338
+ ></option>
339
+ </optgroup>
340
+
341
+ <optgroup style="font-style: normal;" label="🗃️ Vector Store Files (Beta)">
342
+ <option
343
+ value="createVectorStoreFile"
344
+ data-i18n="OpenaiApi.parameters.createVectorStoreFile"
345
+ ></option>
346
+ <option
347
+ value="listVectorStoreFiles"
348
+ data-i18n="OpenaiApi.parameters.listVectorStoreFiles"
349
+ ></option>
350
+ <option
351
+ value="retrieveVectorStoreFile"
352
+ data-i18n="OpenaiApi.parameters.retrieveVectorStoreFile"
353
+ ></option>
354
+ <option
355
+ value="deleteVectorStoreFile"
356
+ data-i18n="OpenaiApi.parameters.deleteVectorStoreFile"
357
+ ></option>
358
+ </optgroup>
359
+
360
+ <optgroup style="font-style: normal;" label="🗄️ Vector Store File Batches (Beta)">
361
+ <option
362
+ value="createVectorStoreFileBatch"
363
+ data-i18n="OpenaiApi.parameters.createVectorStoreFileBatch"
364
+ ></option>
365
+ <option
366
+ value="retrieveVectorStoreFileBatch"
367
+ data-i18n="OpenaiApi.parameters.retrieveVectorStoreFileBatch"
368
+ ></option>
369
+ <option
370
+ value="cancelVectorStoreFileBatch"
371
+ data-i18n="OpenaiApi.parameters.cancelVectorStoreFileBatch"
372
+ ></option>
373
+ <option
374
+ value="listVectorStoreBatchFiles"
375
+ data-i18n="OpenaiApi.parameters.listVectorStoreBatchFiles"
376
+ ></option>
377
+ </optgroup>
304
378
  </select>
305
379
  </div>
306
380
  </script>
@@ -378,16 +452,18 @@
378
452
  <span class="property-type">array</span>
379
453
  </dt>
380
454
  <dd>A list of tool enabled on the assistant.</dd>
455
+
381
456
  <dt class="optional">
382
- file_ids
457
+ tool_resources
383
458
  <a
384
- href="https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-file_ids"
459
+ href="https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-tool_resources"
385
460
  target="_blank"
386
461
  ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
387
462
  ></a>
388
- <span class="property-type">array</span>
463
+ <span class="property-type">object</span>
389
464
  </dt>
390
- <dd>A list of file IDs attached to this assistant.</dd>
465
+ <dd>A set of resources that are used by the assistant's tools. </dd>
466
+
391
467
  <dt class="optional">
392
468
  metadata
393
469
  <a
@@ -398,6 +474,40 @@
398
474
  <span class="property-type">object</span>
399
475
  </dt>
400
476
  <dd>Set of 16 key-value pairs that can be attached to an object.</dd>
477
+
478
+ <dt class="optional">
479
+ temperature
480
+ <a
481
+ href="https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-temperature"
482
+ target="_blank"
483
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
484
+ ></a>
485
+ <span class="property-type">number</span>
486
+ </dt>
487
+ <dd>What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.</dd>
488
+
489
+ <dt class="optional">
490
+ top_p
491
+ <a
492
+ href="https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-top_p"
493
+ target="_blank"
494
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
495
+ ></a>
496
+ <span class="property-type">number</span>
497
+ </dt>
498
+ <dd>An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.</dd>
499
+
500
+ <dt class="optional">
501
+ response_format
502
+ <a
503
+ href="https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-response_format"
504
+ target="_blank"
505
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
506
+ ></a>
507
+ <span class="property-type">string</span>
508
+ </dt>
509
+ <dd>Specifies the format that the model must output.</dd>
510
+
401
511
  </dl>
402
512
 
403
513
  <h2>Retrieve Assistant</h2>
@@ -431,7 +541,8 @@
431
541
  ></a>
432
542
  <span class="property-type">string</span>
433
543
  </dt>
434
- <dd>The ID of the assistant to modify.</dd>
544
+ <dd>The ID of the assistant to retrieve.</dd>
545
+
435
546
  <dt class="optional">
436
547
  model
437
548
  <a
@@ -482,16 +593,18 @@
482
593
  <span class="property-type">array</span>
483
594
  </dt>
484
595
  <dd>A list of tool enabled on the assistant.</dd>
596
+
485
597
  <dt class="optional">
486
- file_ids
598
+ tool_resources
487
599
  <a
488
- href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-file_ids"
600
+ href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-tool_resources"
489
601
  target="_blank"
490
602
  ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
491
603
  ></a>
492
- <span class="property-type">array</span>
604
+ <span class="property-type">object</span>
493
605
  </dt>
494
- <dd>A list of File IDs attached to this assistant.</dd>
606
+ <dd>A set of resources that are used by the assistant's tools. </dd>
607
+
495
608
  <dt class="optional">
496
609
  metadata
497
610
  <a
@@ -502,6 +615,40 @@
502
615
  <span class="property-type">object</span>
503
616
  </dt>
504
617
  <dd>Set of 16 key-value pairs that can be attached to an object.</dd>
618
+
619
+ <dt class="optional">
620
+ temperature
621
+ <a
622
+ href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-temperature"
623
+ target="_blank"
624
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
625
+ ></a>
626
+ <span class="property-type">number</span>
627
+ </dt>
628
+ <dd>What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.</dd>
629
+
630
+ <dt class="optional">
631
+ top_p
632
+ <a
633
+ href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-top_p"
634
+ target="_blank"
635
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
636
+ ></a>
637
+ <span class="property-type">number</span>
638
+ </dt>
639
+ <dd>An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.</dd>
640
+
641
+ <dt class="optional">
642
+ response_format
643
+ <a
644
+ href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-response_format"
645
+ target="_blank"
646
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
647
+ ></a>
648
+ <span class="property-type">string</span>
649
+ </dt>
650
+ <dd>Specifies the format that the model must output.</dd>
651
+
505
652
  </dl>
506
653
 
507
654
  <h2>Delete Assistant</h2>
@@ -764,7 +911,7 @@
764
911
  <span class="property-type">string</span>
765
912
  </dt>
766
913
  <dd>
767
- The format to audio in. Supported formats are mp3, opus, aac, and flac.
914
+ The format to audio in. Supported formats are mp3, opus, aac, flac, wav, and pcm.
768
915
  </dd>
769
916
  <dt class="optional">
770
917
  speed
@@ -933,6 +1080,129 @@
933
1080
  </dl>
934
1081
  </section>
935
1082
 
1083
+ <!-- Begin Batch Endpoint Documentation-->
1084
+ <section>
1085
+ <h1 style="font-weight: bold;">📦 Batch</h1>
1086
+ <a
1087
+ href="https://platform.openai.com/docs/api-reference/batch"
1088
+ target="_blank"
1089
+ >Official Documentation
1090
+ <i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1091
+ ></a>
1092
+ <h2>Create Batch</h2>
1093
+ <p>Creates and executes a batch from an uploaded file of requests.</p>
1094
+ <dl class="message-properties">
1095
+ <h2>msg.payload Properties</h2>
1096
+
1097
+ <dt>
1098
+ input_file_id
1099
+ <a
1100
+ href="https://platform.openai.com/docs/api-reference/batch/create#batch-create-input_file_id"
1101
+ target="_blank"
1102
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1103
+ ></a>
1104
+ <span class="property-type">string</span>
1105
+ </dt>
1106
+ <dd>The ID of an uploaded file that contains requests for the new batch.</dd>
1107
+ <dt>
1108
+ endpoint
1109
+ <a
1110
+ href="https://platform.openai.com/docs/api-reference/batch/create#batch-create-endpoint"
1111
+ target="_blank"
1112
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1113
+ ></a>
1114
+ <span class="property-type">string</span>
1115
+ </dt>
1116
+ <dd>The endpoint to be used for all requests in the batch. Currently only /v1/chat/completions is supported.</dd>
1117
+ <dt>
1118
+ completion_window
1119
+ <a
1120
+ href="https://platform.openai.com/docs/api-reference/batch/create#batch-create-completion_window"
1121
+ target="_blank"
1122
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1123
+ ></a>
1124
+ <span class="property-type">string</span>
1125
+ </dt>
1126
+ <dd>
1127
+ The time frame within which the batch should be processed. Currently only 24h is supported.
1128
+ </dd>
1129
+ <dt class="optional">
1130
+ metadata
1131
+ <a
1132
+ href="https://platform.openai.com/docs/api-reference/batch/create#batch-create-metadata"
1133
+ target="_blank"
1134
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1135
+ ></a>
1136
+ <span class="property-type">string</span>
1137
+ </dt>
1138
+ <dd>
1139
+ Optional custom metadata for the batch.
1140
+ </dd>
1141
+ </dl>
1142
+
1143
+ <h2>Retrieve Batch</h2>
1144
+ <p>Retrieves a batch.</p>
1145
+ <dl class="message-properties">
1146
+ <h2>msg.payload Properties</h2>
1147
+
1148
+ <dt>
1149
+ batch_id
1150
+ <a
1151
+ href="https://platform.openai.com/docs/api-reference/batch/retrieve#batch-retrieve-batch_id"
1152
+ target="_blank"
1153
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1154
+ ></a>
1155
+ <span class="property-type">string</span>
1156
+ </dt>
1157
+ <dd>The ID of the batch to retrieve.</dd>
1158
+ </dl>
1159
+
1160
+ <h2>Cancel Batch</h2>
1161
+ <p>Cancels an in-progress batch.</p>
1162
+ <dl class="message-properties">
1163
+ <h2>msg.payload Properties</h2>
1164
+ <dt>
1165
+ batch_id
1166
+ <a
1167
+ href="https://platform.openai.com/docs/api-reference/batch/cancel#batch-cancel-batch_id"
1168
+ target="_blank"
1169
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1170
+ ></a>
1171
+ <span class="property-type">string</span>
1172
+ </dt>
1173
+ <dd>The ID of the batch to cancel.</dd>
1174
+ </dl>
1175
+
1176
+ <h2>List Batch</h2>
1177
+ <p>List your organization's batches.</p>
1178
+ <dl class="message-properties">
1179
+ <h2>msg.payload Properties</h2>
1180
+ <dt class="optional">
1181
+ after
1182
+ <a
1183
+ href="https://platform.openai.com/docs/api-reference/batch/list#batch-list-after"
1184
+ target="_blank"
1185
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1186
+ ></a>
1187
+ <span class="property-type">string</span>
1188
+ </dt>
1189
+ <dd>A cursor for use in pagination. after is an object ID that defines your place in the list.</dd>
1190
+
1191
+ <dt class="optional">
1192
+ limit
1193
+ <a
1194
+ href="https://platform.openai.com/docs/api-reference/batch/list#batch-list-limit"
1195
+ target="_blank"
1196
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1197
+ ></a>
1198
+ <span class="property-type">integer</span>
1199
+ </dt>
1200
+ <dd>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</dd>
1201
+ </dl>
1202
+
1203
+ </section>
1204
+ <!-- End Batch Endpoitn Documentation -->
1205
+
936
1206
  <section>
937
1207
  <h1 style="font-weight: bold;">🗨️ Chat</h1>
938
1208
  <a
@@ -1399,6 +1669,29 @@
1399
1669
  <span class="property-type">string</span>
1400
1670
  </dt>
1401
1671
  <dd>The ID of an uploaded file that contains validation data.</dd>
1672
+
1673
+ <dt class="optional">
1674
+ integrations
1675
+ <a
1676
+ href="https://platform.openai.com/docs/api-reference/fine-tuning/create#fine-tuning-create-integrations"
1677
+ target="_blank"
1678
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1679
+ ></a>
1680
+ <span class="property-type">array</span>
1681
+ </dt>
1682
+ <dd>A list of integrations to enable for your fine-tuning job.</dd>
1683
+
1684
+ <dt class="optional">
1685
+ seed
1686
+ <a
1687
+ href="https://platform.openai.com/docs/api-reference/fine-tuning/create#fine-tuning-create-seed"
1688
+ target="_blank"
1689
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1690
+ ></a>
1691
+ <span class="property-type">array</span>
1692
+ </dt>
1693
+ <dd>The seed controls the reproducibility of the job.</dd>
1694
+
1402
1695
  </dl>
1403
1696
 
1404
1697
  <h2>List Fine-tuning Jobs</h2>
@@ -1979,138 +2272,35 @@
1979
2272
  <dd>Set of 16 key-value pairs that can be attached to an object.</dd>
1980
2273
  </dl>
1981
2274
 
1982
- <h3>List Message Files</h3>
1983
- <p>Returns a list of message files.</p>
2275
+ </section>
2276
+
2277
+ <section>
2278
+ <h1 style="font-weight: bold;">🧠 Models</h1>
2279
+ <a
2280
+ href="https://platform.openai.com/docs/api-reference/models"
2281
+ target="_blank"
2282
+ >Official Documentation
2283
+ <i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2284
+ ></a>
2285
+ <h2>List Models</h2>
2286
+ <p>
2287
+ Lists the currently available models, and provides basic information about
2288
+ each one such as the owner and availability.
2289
+ </p>
2290
+ <dl class="message-properties"></dl>
2291
+
2292
+ <h2>Retrieve Model</h2>
2293
+ <p>
2294
+ Retrieves a model instance, providing basic information about the model
2295
+ such as the owner and permissioning.
2296
+ </p>
1984
2297
  <dl class="message-properties">
1985
2298
  <h2>msg.payload Properties</h2>
1986
2299
 
1987
2300
  <dt>
1988
- thread_id
1989
- <a
1990
- href="https://platform.openai.com/docs/api-reference/messages/listMessageFiles#messages-listmessagefiles-thread_id"
1991
- target="_blank"
1992
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1993
- ></a>
1994
- <span class="property-type">string</span>
1995
- </dt>
1996
- <dd>The ID of the thread that the message and files belong to.</dd>
1997
- <dt>
1998
- message_id
2301
+ model
1999
2302
  <a
2000
- href="https://platform.openai.com/docs/api-reference/messages/listMessageFiles#messages-listmessagefiles-message_id"
2001
- target="_blank"
2002
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2003
- ></a>
2004
- <span class="property-type">string</span>
2005
- </dt>
2006
- <dd>The ID of the message that the files belongs to.</dd>
2007
- <dt class="optional">
2008
- limit
2009
- <a
2010
- href="https://platform.openai.com/docs/api-reference/messages/listMessageFiles#messages-listmessagefiles-limit"
2011
- target="_blank"
2012
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2013
- ></a>
2014
- <span class="property-type">integer</span>
2015
- </dt>
2016
- <dd>A limit on the number of objects to be returned.</dd>
2017
- <dt class="optional">
2018
- order
2019
- <a
2020
- href="https://platform.openai.com/docs/api-reference/messages/listMessageFiles#messages-listmessagefiles-order"
2021
- target="_blank"
2022
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2023
- ></a>
2024
- <span class="property-type">string</span>
2025
- </dt>
2026
- <dd>Sort order by the created_at timestamp of the objects.</dd>
2027
- <dt class="optional">
2028
- after
2029
- <a
2030
- href="https://platform.openai.com/docs/api-reference/messages/listMessageFiles#messages-listmessagefiles-after"
2031
- target="_blank"
2032
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2033
- ></a>
2034
- <span class="property-type">string</span>
2035
- </dt>
2036
- <dd>A cursor for use in pagination.</dd>
2037
- <dt class="optional">
2038
- before
2039
- <a
2040
- href="https://platform.openai.com/docs/api-reference/messages/listMessageFiles#messages-listmessagefiles-before"
2041
- target="_blank"
2042
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2043
- ></a>
2044
- <span class="property-type">string</span>
2045
- </dt>
2046
- <dd>A cursor for use in pagination.</dd>
2047
- </dl>
2048
-
2049
- <h3>Retrieve Message File</h3>
2050
- <p>Retrieves a message file.</p>
2051
- <dl class="message-properties">
2052
- <h2>msg.payload Properties</h2>
2053
-
2054
- <dt>
2055
- thread_id
2056
- <a
2057
- href="https://platform.openai.com/docs/api-reference/messages/getMessageFile#messages-getmessagefile-thread_id"
2058
- target="_blank"
2059
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2060
- ></a>
2061
- <span class="property-type">string</span>
2062
- </dt>
2063
- <dd>The ID of the thread to which the message and File belong.</dd>
2064
- <dt>
2065
- message_id
2066
- <a
2067
- href="https://platform.openai.com/docs/api-reference/messages/getMessageFile#messages-getmessagefile-message_id"
2068
- target="_blank"
2069
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2070
- ></a>
2071
- <span class="property-type">string</span>
2072
- </dt>
2073
- <dd>The ID of the message the file belongs to.</dd>
2074
- <dt>
2075
- file_id
2076
- <a
2077
- href="https://platform.openai.com/docs/api-reference/messages/getMessageFile#messages-getmessagefile-file_id"
2078
- target="_blank"
2079
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2080
- ></a>
2081
- <span class="property-type">string</span>
2082
- </dt>
2083
- <dd>The ID of the file being retrieved.</dd>
2084
- </dl>
2085
- </section>
2086
-
2087
- <section>
2088
- <h1 style="font-weight: bold;">🧠 Models</h1>
2089
- <a
2090
- href="https://platform.openai.com/docs/api-reference/models"
2091
- target="_blank"
2092
- >Official Documentation
2093
- <i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2094
- ></a>
2095
- <h2>List Models</h2>
2096
- <p>
2097
- Lists the currently available models, and provides basic information about
2098
- each one such as the owner and availability.
2099
- </p>
2100
- <dl class="message-properties"></dl>
2101
-
2102
- <h2>Retrieve Model</h2>
2103
- <p>
2104
- Retrieves a model instance, providing basic information about the model
2105
- such as the owner and permissioning.
2106
- </p>
2107
- <dl class="message-properties">
2108
- <h2>msg.payload Properties</h2>
2109
-
2110
- <dt>
2111
- model
2112
- <a
2113
- href="https://platform.openai.com/docs/api-reference/models/retrieve#models-retrieve-model"
2303
+ href="https://platform.openai.com/docs/api-reference/models/retrieve#models-retrieve-model"
2114
2304
  target="_blank"
2115
2305
  ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2116
2306
  ></a>
@@ -2473,7 +2663,7 @@
2473
2663
  target="_blank"
2474
2664
  ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2475
2665
  ></a>
2476
- <span class="property-type"></span>array
2666
+ <span class="property-type">array</span>
2477
2667
  </dt>
2478
2668
  <dd>Override the tools the assistant can use for this run.</dd>
2479
2669
  <dt class="optional">
@@ -2486,6 +2676,95 @@
2486
2676
  <span class="property-type">object</span>
2487
2677
  </dt>
2488
2678
  <dd>Set of 16 key-value pairs that can be attached to an object.</dd>
2679
+
2680
+ <dt class="optional">
2681
+ temperature
2682
+ <a
2683
+ href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-temperature"
2684
+ target="_blank"
2685
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2686
+ ></a>
2687
+ <span class="property-type">number</span>
2688
+ </dt>
2689
+ <dd>What sampling temperature to use, between 0 and 2.</dd>
2690
+
2691
+ <dt class="optional">
2692
+ top_p
2693
+ <a
2694
+ href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-top_p"
2695
+ target="_blank"
2696
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2697
+ ></a>
2698
+ <span class="property-type">number</span>
2699
+ </dt>
2700
+ <dd>An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.</dd>
2701
+
2702
+ <dt class="optional">
2703
+ stream
2704
+ <a
2705
+ href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-stream"
2706
+ target="_blank"
2707
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2708
+ ></a>
2709
+ <span class="property-type">boolean</span>
2710
+ </dt>
2711
+ <dd>If true, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a data: [DONE] message.</dd>
2712
+
2713
+ <dt class="optional">
2714
+ max_prompt_tokens
2715
+ <a
2716
+ href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-max_prompt_tokens"
2717
+ target="_blank"
2718
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2719
+ ></a>
2720
+ <span class="property-type">integer</span>
2721
+ </dt>
2722
+ <dd>The maximum number of prompt tokens that may be used over the course of the run.</dd>
2723
+
2724
+ <dt class="optional">
2725
+ max_completion_tokens
2726
+ <a
2727
+ href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-max_completion_tokens"
2728
+ target="_blank"
2729
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2730
+ ></a>
2731
+ <span class="property-type">integer</span>
2732
+ </dt>
2733
+ <dd>The maximum number of completion tokens that may be used over the course of the run.</dd>
2734
+
2735
+ <dt class="optional">
2736
+ truncation_strategy
2737
+ <a
2738
+ href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-truncation_strategy"
2739
+ target="_blank"
2740
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2741
+ ></a>
2742
+ <span class="property-type">object</span>
2743
+ </dt>
2744
+ <dd>Controls for how a thread will be truncated prior to the run.</dd>
2745
+
2746
+ <dt class="optional">
2747
+ tool_choice
2748
+ <a
2749
+ href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-tool_choice"
2750
+ target="_blank"
2751
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2752
+ ></a>
2753
+ <span class="property-type">string or object</span>
2754
+ </dt>
2755
+ <dd>Controls for how a thread will be truncated prior to the run.</dd>
2756
+
2757
+ <dt class="optional">
2758
+ response_format
2759
+ <a
2760
+ href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-response_format"
2761
+ target="_blank"
2762
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2763
+ ></a>
2764
+ <span class="property-type">string or object</span>
2765
+ </dt>
2766
+ <dd>Specifies the format that the model must output.</dd>
2767
+
2489
2768
  </dl>
2490
2769
 
2491
2770
  <h2>Retrieve Run</h2>
@@ -2566,6 +2845,7 @@
2566
2845
  <span class="property-type">string</span>
2567
2846
  </dt>
2568
2847
  <dd>The ID of the run that requires the tool output submission.</dd>
2848
+
2569
2849
  <dt>
2570
2850
  tool_outputs
2571
2851
  <a
@@ -2576,6 +2856,18 @@
2576
2856
  <span class="property-type">array</span>
2577
2857
  </dt>
2578
2858
  <dd>A list of tools for which the outputs are being submitted.</dd>
2859
+
2860
+ <dt class="optional">
2861
+ stream
2862
+ <a
2863
+ href="https://platform.openai.com/docs/api-reference/runs/submitToolOutputs#runs-submittooloutputs-stream"
2864
+ target="_blank"
2865
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2866
+ ></a>
2867
+ <span class="property-type">boolean</span>
2868
+ </dt>
2869
+ <dd>If true, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a data: [DONE] message.</dd>
2870
+
2579
2871
  </dl>
2580
2872
 
2581
2873
  <h2>Cancel Run</h2>
@@ -2808,6 +3100,549 @@
2808
3100
  <dd>The ID of the thread to delete.</dd>
2809
3101
  </dl>
2810
3102
  </section>
3103
+
3104
+ <!-- Begin Vector Stores Documentation-->
3105
+ <section>
3106
+ <h1 style="font-weight: bold;">🔢 Vector Stores</h1>
3107
+ <a
3108
+ href="https://platform.openai.com/docs/api-reference/vector-stores"
3109
+ target="_blank"
3110
+ >Official Documentation
3111
+ <i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3112
+ ></a>
3113
+ <h2>Create Vector Store</h2>
3114
+ <p>Create a vector store.</p>
3115
+ <dl class="message-properties">
3116
+ <h2>msg.payload Properties</h2>
3117
+ <dt class="optional">
3118
+ file_ids
3119
+ <a
3120
+ href="https://platform.openai.com/docs/api-reference/vector-stores/create"
3121
+ target="_blank"
3122
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3123
+ ></a>
3124
+ <span class="property-type">array</span>
3125
+ </dt>
3126
+ <dd>A list of File IDs that the vector store should use. Useful for tools like file_search that can access files.</dd>
3127
+
3128
+ <dt class="optional">
3129
+ name
3130
+ <a
3131
+ href="https://platform.openai.com/docs/api-reference/vector-stores/create#vector-stores-create-name"
3132
+ target="_blank"
3133
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3134
+ ></a>
3135
+ <span class="property-type">string</span>
3136
+ </dt>
3137
+ <dd>The name of the vector store.</dd>
3138
+
3139
+ <dt class="optional">
3140
+ expires_after
3141
+ <a
3142
+ href="https://platform.openai.com/docs/api-reference/vector-stores/create#vector-stores-create-expires_after"
3143
+ target="_blank"
3144
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3145
+ ></a>
3146
+ <span class="property-type">object</span>
3147
+ </dt>
3148
+ <dd>The expiration policy for a vector store.</dd>
3149
+
3150
+ <dt class="optional">
3151
+ metadata
3152
+ <a
3153
+ href="https://platform.openai.com/docs/api-reference/vector-stores/create#vector-stores-create-metadata"
3154
+ target="_blank"
3155
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3156
+ ></a>
3157
+ <span class="property-type">object</span>
3158
+ </dt>
3159
+ <dd>Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.</dd>
3160
+ </dl>
3161
+
3162
+ <h2>List Vector Stores</h2>
3163
+ <p>Returns a list of vector stores.</p>
3164
+ <dl class="message-properties">
3165
+ <h2>msg.payload Properties</h2>
3166
+
3167
+ <dt class="optional">
3168
+ limit
3169
+ <a
3170
+ href="https://platform.openai.com/docs/api-reference/vector-stores/list#vector-stores-list-limit"
3171
+ target="_blank"
3172
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3173
+ ></a>
3174
+ <span class="property-type">integer</span>
3175
+ </dt>
3176
+ <dd>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</dd>
3177
+
3178
+ <dt class="optional">
3179
+ order
3180
+ <a
3181
+ href="https://platform.openai.com/docs/api-reference/vector-stores/list#vector-stores-list-order"
3182
+ target="_blank"
3183
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3184
+ ></a>
3185
+ <span class="property-type">string</span>
3186
+ </dt>
3187
+ <dd>Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.</dd>
3188
+
3189
+ <dt class="optional">
3190
+ after
3191
+ <a
3192
+ href="https://platform.openai.com/docs/api-reference/vector-stores/list#vector-stores-list-after"
3193
+ target="_blank"
3194
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3195
+ ></a>
3196
+ <span class="property-type">string</span>
3197
+ </dt>
3198
+ <dd>A cursor for use in pagination. after is an object ID that defines your place in the list.</dd>
3199
+
3200
+ <dt class="optional">
3201
+ before
3202
+ <a
3203
+ href="https://platform.openai.com/docs/api-reference/vector-stores/list#vector-stores-list-before"
3204
+ target="_blank"
3205
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3206
+ ></a>
3207
+ <span class="property-type">string</span>
3208
+ </dt>
3209
+ <dd>A cursor for use in pagination. before is an object ID that defines your place in the list.</dd>
3210
+ </dl>
3211
+
3212
+ <h2>Retrieve Vector Store</h2>
3213
+ <p>Retrieves a vector store.</p>
3214
+ <dl class="message-properties">
3215
+ <h2>msg.payload Properties</h2>
3216
+
3217
+ <dt>
3218
+ vector_store_id
3219
+ <a
3220
+ href="https://platform.openai.com/docs/api-reference/vector-stores/retrieve#vector-stores-retrieve-vector_store_id"
3221
+ target="_blank"
3222
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3223
+ ></a>
3224
+ <span class="property-type">string</span>
3225
+ </dt>
3226
+ <dd>The ID of the vector store to retrieve.</dd>
3227
+ </dl>
3228
+
3229
+ <h2>Modify Vector Store</h2>
3230
+ <p>Modifies a vector store.</p>
3231
+ <dl class="message-properties">
3232
+ <h2>msg.payload Properties</h2>
3233
+
3234
+ <dt>
3235
+ vector_store_id
3236
+ <a
3237
+ href="https://platform.openai.com/docs/api-reference/vector-stores/modify#vector-stores-modify-vector_store_id"
3238
+ target="_blank"
3239
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3240
+ ></a>
3241
+ <span class="property-type">string</span>
3242
+ </dt>
3243
+ <dd>The ID of the vector store to modify.</dd>
3244
+
3245
+ <dt class="optional">
3246
+ name
3247
+ <a
3248
+ href="https://platform.openai.com/docs/api-reference/vector-stores/modify#vector-stores-modify-name"
3249
+ target="_blank"
3250
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3251
+ ></a>
3252
+ <span class="property-type">string</span>
3253
+ </dt>
3254
+ <dd>The name of the vector store.</dd>
3255
+
3256
+ <dt class="optional">
3257
+ expires_after
3258
+ <a
3259
+ href="https://platform.openai.com/docs/api-reference/vector-stores/modify#vector-stores-modify-expires_after"
3260
+ target="_blank"
3261
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3262
+ ></a>
3263
+ <span class="property-type">object</span>
3264
+ </dt>
3265
+ <dd>The expiration policy for a vector store.</dd>
3266
+
3267
+ <dt class="optional">
3268
+ metadata
3269
+ <a
3270
+ href="https://platform.openai.com/docs/api-reference/vector-stores/modify#vector-stores-modify-metadata"
3271
+ target="_blank"
3272
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3273
+ ></a>
3274
+ <span class="property-type">object</span>
3275
+ </dt>
3276
+ <dd>Set of 16 key-value pairs that can be attached to an object.</dd>
3277
+ </dl>
3278
+ <dl>
3279
+ <h2>Delete Vector Store</h2>
3280
+ <p>Delete a vector store.</p>
3281
+ <dl class="message-properties">
3282
+ <h2>msg.payload Properties</h2>
3283
+
3284
+ <dt>
3285
+ vector_store_id
3286
+ <a
3287
+ href="https://platform.openai.com/docs/api-reference/vector-stores/delete#vector-stores-delete-vector_store_id"
3288
+ target="_blank"
3289
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3290
+ ></a>
3291
+ <span class="property-type">string</span>
3292
+ </dt>
3293
+ <dd>The ID of the vector store to delete.</dd>
3294
+ </dl>
3295
+
3296
+ </section>
3297
+ <!-- End Vector Stores Documentation -->
3298
+
3299
+ <!-- Begin Vector Store Files Documentation -->
3300
+
3301
+ <section>
3302
+ <h1 style="font-weight: bold;">🔢 Vector Store Files</h1>
3303
+ <a
3304
+ href="https://platform.openai.com/docs/api-reference/vector-stores-files"
3305
+ target="_blank"
3306
+ >Official Documentation
3307
+ <i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3308
+ ></a>
3309
+
3310
+ <h2>Create Vector Store File</h2>
3311
+ <p>Create a vector store file by attaching a File to a vector store.</p>
3312
+ <dl class="message-properties">
3313
+ <h2>msg.payload Properties</h2>
3314
+ <dt>
3315
+ vector_store_id
3316
+ <a
3317
+ href="https://platform.openai.com/docs/api-reference/vector-stores-files/createFile#vector-stores-files-createfile-vector_store_id"
3318
+ target="_blank"
3319
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3320
+ ></a>
3321
+ <span class="property-type">string</span>
3322
+ </dt>
3323
+ <dd>The ID of the vector store for which to create a File.</dd>
3324
+
3325
+ <dt>
3326
+ file_id
3327
+ <a
3328
+ href="https://platform.openai.com/docs/api-reference/vector-stores-files/createFile#vector-stores-files-createfile-file_id"
3329
+ target="_blank"
3330
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3331
+ ></a>
3332
+ <span class="property-type">string</span>
3333
+ </dt>
3334
+ <dd>A File ID that the vector store should use. Useful for tools like file_search that can access files.</dd>
3335
+ </dl>
3336
+
3337
+
3338
+ <h2>List Vector Store Files</h2>
3339
+ <p>Returns a list of vector store files.</p>
3340
+ <dl class="message-properties">
3341
+ <h2>msg.payload Properties</h2>
3342
+ <dt>
3343
+ vector_store_id
3344
+ <a
3345
+ href="https://platform.openai.com/docs/api-reference/vector-stores-files/listFiles#vector-stores-files-listfiles-vector_store_id"
3346
+ target="_blank"
3347
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3348
+ ></a>
3349
+ <span class="property-type">string</span>
3350
+ </dt>
3351
+ <dd>The ID of the vector store that the files belong to.</dd>
3352
+
3353
+ <dt class="optional">
3354
+ limit
3355
+ <a
3356
+ href="https://platform.openai.com/docs/api-reference/vector-stores-files/listFiles#vector-stores-files-listfiles-limit"
3357
+ target="_blank"
3358
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3359
+ ></a>
3360
+ <span class="property-type">integer</span>
3361
+ </dt>
3362
+ <dd>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</dd>
3363
+
3364
+ <dt class="optional">
3365
+ order
3366
+ <a
3367
+ href="https://platform.openai.com/docs/api-reference/vector-stores-files/listFiles#vector-stores-files-listfiles-order"
3368
+ target="_blank"
3369
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3370
+ ></a>
3371
+ <span class="property-type">string</span>
3372
+ </dt>
3373
+ <dd>Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.</dd>
3374
+
3375
+ <dt class="optional">
3376
+ before
3377
+ <a
3378
+ href="https://platform.openai.com/docs/api-reference/vector-stores-files/listFiles#vector-stores-files-listfiles-before"
3379
+ target="_blank"
3380
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3381
+ ></a>
3382
+ <span class="property-type">string</span>
3383
+ </dt>
3384
+ <dd>A cursor for use in pagination. before is an object ID that defines your place in the list.</dd>
3385
+
3386
+ <dt class="optional">
3387
+ after
3388
+ <a
3389
+ href="https://platform.openai.com/docs/api-reference/vector-stores-files/listFiles#vector-stores-files-listfiles-after"
3390
+ target="_blank"
3391
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3392
+ ></a>
3393
+ <span class="property-type">string</span>
3394
+ </dt>
3395
+ <dd>A cursor for use in pagination. after is an object ID that defines your place in the list.</dd>
3396
+
3397
+ <dt class="optional">
3398
+ filter
3399
+ <a
3400
+ href="https://platform.openai.com/docs/api-reference/vector-stores-files/listFiles#vector-stores-files-listfiles-filter"
3401
+ target="_blank"
3402
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3403
+ ></a>
3404
+ <span class="property-type">string</span>
3405
+ </dt>
3406
+ <dd>Filter by file status. One of in_progress, completed, failed, cancelled.</dd>
3407
+
3408
+ </dl>
3409
+
3410
+ <h2>Retrieve Vector Store File</h2>
3411
+ <p>Retrieves a vector store file.</p>
3412
+ <dl class="message-properties">
3413
+ <h2>msg.payload Properties</h2>
3414
+ <dt>
3415
+ vector_store_id
3416
+ <a
3417
+ href="https://platform.openai.com/docs/api-reference/vector-stores-files/getFile#vector-stores-files-getfile-vector_store_id"
3418
+ target="_blank"
3419
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3420
+ ></a>
3421
+ <span class="property-type">string</span>
3422
+ </dt>
3423
+ <dd>The ID of the vector store that the file belongs to.</dd>
3424
+
3425
+ <dt>
3426
+ file_id
3427
+ <a
3428
+ href="https://platform.openai.com/docs/api-reference/vector-stores-files/getFile#vector-stores-files-getfile-file_id"
3429
+ target="_blank"
3430
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3431
+ ></a>
3432
+ <span class="property-type">string</span>
3433
+ </dt>
3434
+ <dd>The ID of the file being retrieved.</dd>
3435
+
3436
+ </dl>
3437
+
3438
+ <h2>Delete Vector Store File</h2>
3439
+ <p>Remove a file from a vector store.</p>
3440
+ <dl class="message-properties">
3441
+ <h2>msg.payload Properties</h2>
3442
+ <dt>
3443
+ vector_store_id
3444
+ <a
3445
+ href="https://platform.openai.com/docs/api-reference/vector-stores-files/deleteFile#vector-stores-files-deletefile-vector_store_id"
3446
+ target="_blank"
3447
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3448
+ ></a>
3449
+ <span class="property-type">string</span>
3450
+ </dt>
3451
+ <dd>The ID of the vector store that the file belongs to.</dd>
3452
+
3453
+ <dt>
3454
+ file_id
3455
+ <a
3456
+ href="https://platform.openai.com/docs/api-reference/vector-stores-files/deleteFile#vector-stores-files-deletefile-file_id"
3457
+ target="_blank"
3458
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3459
+ ></a>
3460
+ <span class="property-type">string</span>
3461
+ </dt>
3462
+ <dd>The ID of the file to remove from the vector store.</dd>
3463
+
3464
+ </dl>
3465
+
3466
+ </section>
3467
+
3468
+ <!-- End Vector Store Files Documentation -->
3469
+
3470
+ <!-- Begin Vector Store File Batch Documentation -->
3471
+ <section>
3472
+ <h1 style="font-weight: bold;">🔢 Vector Store File Batches</h1>
3473
+ <a
3474
+ href="https://platform.openai.com/docs/api-reference/vector-stores-file-batches"
3475
+ target="_blank"
3476
+ >Official Documentation
3477
+ <i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3478
+ ></a>
3479
+ <h2>Create Vector Store File Batch</h2>
3480
+ <p>Create a vector store file batch.</p>
3481
+ <dl class="message-properties">
3482
+ <h2>msg.payload Properties</h2>
3483
+ <dt>
3484
+ vector_store_id
3485
+ <a
3486
+ href="https://platform.openai.com/docs/api-reference/vector-stores-file-batches/createBatch#vector-stores-file-batches-createbatch-vector_store_id"
3487
+ target="_blank"
3488
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3489
+ ></a>
3490
+ <span class="property-type">string</span>
3491
+ </dt>
3492
+ <dd>The ID of the vector store for which to create a File Batch.</dd>
3493
+
3494
+ <dt>
3495
+ file_ids
3496
+ <a
3497
+ href="https://platform.openai.com/docs/api-reference/vector-stores-file-batches/createBatch#vector-stores-file-batches-createbatch-file_ids"
3498
+ target="_blank"
3499
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3500
+ ></a>
3501
+ <span class="property-type">array</span>
3502
+ </dt>
3503
+ <dd>A list of File IDs that the vector store should use. Useful for tools like file_search that can access files.</dd>
3504
+ </dl>
3505
+
3506
+
3507
+ <h2>Retrieve Vector Store File Batch</h2>
3508
+ <p>Retrieves a vector store file batch.</p>
3509
+ <dl class="message-properties">
3510
+ <h2>msg.payload Properties</h2>
3511
+ <dt>
3512
+ vector_store_id
3513
+ <a
3514
+ href="https://platform.openai.com/docs/api-reference/vector-stores-file-batches/getBatch#vector-stores-file-batches-getbatch-vector_store_id"
3515
+ target="_blank"
3516
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3517
+ ></a>
3518
+ <span class="property-type">string</span>
3519
+ </dt>
3520
+ <dd>The ID of the vector store that the file batch belongs to.</dd>
3521
+
3522
+ <dt>
3523
+ batch_id
3524
+ <a
3525
+ href="https://platform.openai.com/docs/api-reference/vector-stores-file-batches/getBatch#vector-stores-file-batches-getbatch-batch_id"
3526
+ target="_blank"
3527
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3528
+ ></a>
3529
+ <span class="property-type">string</span>
3530
+ </dt>
3531
+ <dd>The ID of the file batch being retrieved.</dd>
3532
+ </dl>
3533
+
3534
+ <h2>Cancel Vector Store File Batch</h2>
3535
+ <p>Cancel a vector store file batch.</p>
3536
+ <dl class="message-properties">
3537
+ <h2>msg.payload Properties</h2>
3538
+ <dt>
3539
+ vector_store_id
3540
+ <a
3541
+ href="https://platform.openai.com/docs/api-reference/vector-stores-file-batches/cancelBatch#vector-stores-file-batches-cancelbatch-vector_store_id"
3542
+ target="_blank"
3543
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3544
+ ></a>
3545
+ <span class="property-type">string</span>
3546
+ </dt>
3547
+ <dd>The ID of the vector store that the file batch belongs to.</dd>
3548
+
3549
+ <dt>
3550
+ batch_id
3551
+ <a
3552
+ href="https://platform.openai.com/docs/api-reference/vector-stores-file-batches/cancelBatch#vector-stores-file-batches-cancelbatch-batch_id"
3553
+ target="_blank"
3554
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3555
+ ></a>
3556
+ <span class="property-type">string</span>
3557
+ </dt>
3558
+ <dd>The ID of the file batch to cancel.</dd>
3559
+ </dl>
3560
+
3561
+ <h2>List Vector Store Batch Files</h2>
3562
+ <p>Returns a list of vector store files in a batch.</p>
3563
+ <dl class="message-properties">
3564
+ <h2>msg.payload Properties</h2>
3565
+ <dt>
3566
+ vector_store_id
3567
+ <a
3568
+ href="https://platform.openai.com/docs/api-reference/vector-stores-file-batches/listBatchFiles#vector-stores-file-batches-listbatchfiles-vector_store_id"
3569
+ target="_blank"
3570
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3571
+ ></a>
3572
+ <span class="property-type">string</span>
3573
+ </dt>
3574
+ <dd>The ID of the vector store that the files belong to.</dd>
3575
+
3576
+ <dt>
3577
+ batch_id
3578
+ <a
3579
+ href="https://platform.openai.com/docs/api-reference/vector-stores-file-batches/listBatchFiles#vector-stores-file-batches-listbatchfiles-batch_id"
3580
+ target="_blank"
3581
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3582
+ ></a>
3583
+ <span class="property-type">string</span>
3584
+ </dt>
3585
+ <dd>The ID of the file batch that the files belong to.</dd>
3586
+
3587
+ <dt class="optional">
3588
+ limit
3589
+ <a
3590
+ href="https://platform.openai.com/docs/api-reference/vector-stores-file-batches/listBatchFiles#vector-stores-file-batches-listbatchfiles-limit"
3591
+ target="_blank"
3592
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3593
+ ></a>
3594
+ <span class="property-type">integer</span>
3595
+ </dt>
3596
+ <dd>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.</dd>
3597
+
3598
+ <dt class="optional">
3599
+ order
3600
+ <a
3601
+ href="https://platform.openai.com/docs/api-reference/vector-stores-file-batches/listBatchFiles#vector-stores-file-batches-listbatchfiles-order"
3602
+ target="_blank"
3603
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3604
+ ></a>
3605
+ <span class="property-type">string</span>
3606
+ </dt>
3607
+ <dd>Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.</dd>
3608
+
3609
+ <dt class="optional">
3610
+ after
3611
+ <a
3612
+ href="https://platform.openai.com/docs/api-reference/vector-stores-file-batches/listBatchFiles#vector-stores-file-batches-listbatchfiles-after"
3613
+ target="_blank"
3614
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3615
+ ></a>
3616
+ <span class="property-type">string</span>
3617
+ </dt>
3618
+ <dd>A cursor for use in pagination. after is an object ID that defines your place in the list.</dd>
3619
+
3620
+ <dt class="optional">
3621
+ before
3622
+ <a
3623
+ href="https://platform.openai.com/docs/api-reference/vector-stores-file-batches/listBatchFiles#vector-stores-file-batches-listbatchfiles-before"
3624
+ target="_blank"
3625
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3626
+ ></a>
3627
+ <span class="property-type">string</span>
3628
+ </dt>
3629
+ <dd>A cursor for use in pagination. before is an object ID that defines your place in the list.</dd>
3630
+
3631
+ <dt class="optional">
3632
+ filter
3633
+ <a
3634
+ href="https://platform.openai.com/docs/api-reference/vector-stores-file-batches/listBatchFiles#vector-stores-file-batches-listbatchfiles-filter"
3635
+ target="_blank"
3636
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3637
+ ></a>
3638
+ <span class="property-type">string</span>
3639
+ </dt>
3640
+ <dd>Filter by file status. One of in_progress, completed, failed, cancelled.</dd>
3641
+
3642
+ </dl>
3643
+ </section>
3644
+ <!-- End Vector Store File Batch Documentation -->
3645
+
2811
3646
  </section>
2812
3647
  </script>
2813
3648