@inductiv/node-red-openai-api 1.85.1 → 1.87.3

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
@@ -153,11 +153,35 @@
153
153
  ></option>
154
154
  </optgroup>
155
155
 
156
- <optgroup style="font-style: normal;" label="🗨️ Chat">
156
+ <optgroup style="font-style: normal;" label="💬 Chat">
157
157
  <option
158
158
  value="createChatCompletion"
159
159
  data-i18n="OpenaiApi.parameters.createChatCompletion"
160
160
  ></option>
161
+ <option
162
+ value="getChatCompletion"
163
+ data-i18n="OpenaiApi.parameters.getChatCompletion"
164
+ ></option>
165
+ <option
166
+ value="getChatMessages"
167
+ data-i18n="OpenaiApi.parameters.getChatMessages"
168
+ ></option>
169
+
170
+ <option
171
+ value="listChatCompletions"
172
+ data-i18n="OpenaiApi.parameters.listChatCompletions"
173
+ ></option>
174
+
175
+ <option
176
+ value="updateChatCompletion"
177
+ data-i18n="OpenaiApi.parameters.updateChatCompletion"
178
+ ></option>
179
+
180
+ <option
181
+ value="deleteChatCompletion"
182
+ data-i18n="OpenaiApi.parameters.deleteChatCompletion"
183
+ ></option>
184
+
161
185
  </optgroup>
162
186
  <optgroup style="font-style: normal;" label="🔗 Embeddings">
163
187
  <option
@@ -265,7 +289,28 @@
265
289
  data-i18n="OpenaiApi.parameters.createModeration"
266
290
  ></option>
267
291
  </optgroup>
292
+ <optgroup style="font-style: normal;" label="🗨️ Responses">
293
+ <option
294
+ value="createModelResponse"
295
+ data-i18n="OpenaiApi.parameters.createModelResponse"
296
+ ></option>
268
297
 
298
+ <option
299
+ value="getModelResponse"
300
+ data-i18n="OpenaiApi.parameters.getModelResponse"
301
+ ></option>
302
+
303
+ <option
304
+ value="deleteModelResponse"
305
+ data-i18n="OpenaiApi.parameters.deleteModelResponse"
306
+ ></option>
307
+
308
+ <option
309
+ value="listInputItems"
310
+ data-i18n="OpenaiApi.parameters.listInputItems"
311
+ ></option>
312
+
313
+ </optgroup>
269
314
  <optgroup style="font-style: normal;" label="🔄 Runs (Beta)">
270
315
  <option
271
316
  value="createThreadAndRun"
@@ -1245,344 +1290,585 @@
1245
1290
 
1246
1291
  <section>
1247
1292
  <details>
1248
- <summary style="font-weight: bold;">🗨️ Chat</summary>
1293
+ <summary style="font-weight: bold;">💬 Chat</summary>
1294
+ <a
1295
+ href="https://platform.openai.com/docs/api-reference/chat"
1296
+ target="_blank"
1297
+ >Official Documentation
1298
+ <i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1299
+ ></a>
1300
+ <h4 style="font-weight: bolder;"> ⋙ Create Chat Completion</h4>
1301
+ <p>
1302
+ Creates a model response for the given chat conversation.
1249
1303
  <a
1250
- href="https://platform.openai.com/docs/api-reference/chat"
1304
+ href="https://platform.openai.com/docs/api-reference/chat/create"
1251
1305
  target="_blank"
1252
- >Official Documentation
1253
- <i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1254
- ></a>
1255
- <h4 style="font-weight: bolder;"> ⋙ Create Chat Completion</h4>
1256
- <p>
1257
- Creates a model response for the given chat conversation.
1306
+ >Full documentation.</a
1307
+ >
1308
+ </p>
1309
+ <dl class="message-properties">
1310
+ <h4>msg.payload Properties</h4>
1311
+
1312
+ <dt>
1313
+ messages
1258
1314
  <a
1259
- href="https://platform.openai.com/docs/api-reference/chat/create"
1315
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-messages"
1260
1316
  target="_blank"
1261
- >Full documentation.</a
1262
- >
1263
- </p>
1264
- <dl class="message-properties">
1265
- <h4>msg.payload Properties</h4>
1266
-
1267
- <dt>
1268
- messages
1269
- <a
1270
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-messages"
1271
- target="_blank"
1272
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1273
- ></a>
1274
- <span class="property-type">array</span>
1275
- </dt>
1276
- <dd>A list of messages comprising the conversation so far.</dd>
1277
- <dt>
1278
- model
1279
- <a
1280
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-model"
1281
- target="_blank"
1282
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1283
- ></a>
1284
- <span class="property-type">string</span>
1285
- </dt>
1286
- <dd>ID of the model to use.</dd>
1317
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1318
+ ></a>
1319
+ <span class="property-type">array</span>
1320
+ </dt>
1321
+ <dd>A list of messages comprising the conversation so far.</dd>
1322
+ <dt>
1323
+ model
1324
+ <a
1325
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-model"
1326
+ target="_blank"
1327
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1328
+ ></a>
1329
+ <span class="property-type">string</span>
1330
+ </dt>
1331
+ <dd>ID of the model to use.</dd>
1287
1332
 
1288
- <dt class="optional">
1289
- store
1290
- <a
1291
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-store"
1292
- target="_blank"
1293
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1294
- ></a>
1295
- <span class="property-type">boolean | null</span>
1296
- </dt>
1297
- <dd>Whether to store the output of this chat completion request.</dd>
1333
+ <dt class="optional">
1334
+ store
1335
+ <a
1336
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-store"
1337
+ target="_blank"
1338
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1339
+ ></a>
1340
+ <span class="property-type">boolean | null</span>
1341
+ </dt>
1342
+ <dd>Whether to store the output of this chat completion request.</dd>
1298
1343
 
1299
- <dt class="optional">
1300
- reasoning_effort
1301
- <a
1302
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-reasoning_effort"
1303
- target="_blank"
1304
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1305
- ></a>
1306
- <span class="property-type">string</span>
1307
- </dt>
1308
- <dd>Constrains effort on reasoning for reasoning models.</dd>
1344
+ <dt class="optional">
1345
+ reasoning_effort
1346
+ <a
1347
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-reasoning_effort"
1348
+ target="_blank"
1349
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1350
+ ></a>
1351
+ <span class="property-type">string</span>
1352
+ </dt>
1353
+ <dd>Constrains effort on reasoning for reasoning models.</dd>
1309
1354
 
1310
- <dt class="optional">
1311
- metadata
1312
- <a
1313
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-metadata"
1314
- target="_blank"
1315
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1316
- ></a>
1317
- <span class="property-type">object or null</span>
1318
- </dt>
1319
- <dd>Developer-defined tags and values used for filtering completions in the dashboard.</dd>
1355
+ <dt class="optional">
1356
+ metadata
1357
+ <a
1358
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-metadata"
1359
+ target="_blank"
1360
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1361
+ ></a>
1362
+ <span class="property-type">object or null</span>
1363
+ </dt>
1364
+ <dd>Developer-defined tags and values used for filtering completions in the dashboard.</dd>
1320
1365
 
1321
- <dt class="optional">
1322
- frequency_penalty
1323
- <a
1324
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-frequency_penalty"
1325
- target="_blank"
1326
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1327
- ></a>
1328
- <span class="property-type">number</span>
1329
- </dt>
1330
- <dd>Number between -2.0 and 2.0.</dd>
1331
- <dt class="optional">
1332
- logit_bias
1333
- <a
1334
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-logit_bias"
1335
- target="_blank"
1336
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1337
- ></a>
1338
- <span class="property-type">object</span>
1339
- </dt>
1340
- <dd>
1341
- Modify the likelihood of specified tokens appearing in the completion.
1342
- </dd>
1343
- <dt class="optional">
1344
- logprobs
1345
- <a
1346
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-logprobs"
1347
- target="_blank"
1348
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1349
- ></a>
1350
- <span class="property-type">boolean</span>
1351
- </dt>
1352
- <dd>Whether to return log probabilities of the output tokens or not.</dd>
1353
- <dt class="optional">
1354
- top_logprobs
1355
- <a
1356
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-top_logprobs"
1357
- target="_blank"
1358
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1359
- ></a>
1360
- <span class="property-type">integer</span>
1361
- </dt>
1362
- <dd>
1363
- An integer between 0 and 5 specifying the number of most likely tokens
1364
- to return at each token position, each with an associated log
1365
- probability.
1366
- </dd>
1367
- <dt class="optional">
1368
- max_tokens
1369
- <a
1370
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-max_tokens"
1371
- target="_blank"
1372
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1373
- ></a>
1374
- <span class="property-type">integer</span>
1375
- </dt>
1376
- <dd>
1377
- The maximum number of tokens that can be generated in the chat
1378
- completion.
1379
- </dd>
1380
- <dt class="optional">
1381
- n
1382
- <a
1383
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-n"
1384
- target="_blank"
1385
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1386
- ></a>
1387
- <span class="property-type">integer</span>
1388
- </dt>
1389
- <dd>
1390
- How many chat completion choices to generate for each input message.
1391
- </dd>
1366
+ <dt class="optional">
1367
+ frequency_penalty
1368
+ <a
1369
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-frequency_penalty"
1370
+ target="_blank"
1371
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1372
+ ></a>
1373
+ <span class="property-type">number</span>
1374
+ </dt>
1375
+ <dd>Number between -2.0 and 2.0.</dd>
1376
+ <dt class="optional">
1377
+ logit_bias
1378
+ <a
1379
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-logit_bias"
1380
+ target="_blank"
1381
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1382
+ ></a>
1383
+ <span class="property-type">object</span>
1384
+ </dt>
1385
+ <dd>
1386
+ Modify the likelihood of specified tokens appearing in the completion.
1387
+ </dd>
1388
+ <dt class="optional">
1389
+ logprobs
1390
+ <a
1391
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-logprobs"
1392
+ target="_blank"
1393
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1394
+ ></a>
1395
+ <span class="property-type">boolean</span>
1396
+ </dt>
1397
+ <dd>Whether to return log probabilities of the output tokens or not.</dd>
1398
+ <dt class="optional">
1399
+ top_logprobs
1400
+ <a
1401
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-top_logprobs"
1402
+ target="_blank"
1403
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1404
+ ></a>
1405
+ <span class="property-type">integer</span>
1406
+ </dt>
1407
+ <dd>
1408
+ An integer between 0 and 5 specifying the number of most likely tokens
1409
+ to return at each token position, each with an associated log
1410
+ probability.
1411
+ </dd>
1412
+ <dt class="optional">
1413
+ max_tokens [Deprecated]
1414
+ <a
1415
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-max_tokens"
1416
+ target="_blank"
1417
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1418
+ ></a>
1419
+ <span class="property-type">integer</span>
1420
+ </dt>
1421
+ <dd>
1422
+ The maximum number of tokens that can be generated in the chat
1423
+ completion. This value is now deprecated in favor of max_completion_tokens,
1424
+ and is not compatible with o1 series models.
1425
+ </dd>
1426
+
1427
+ <dt class="optional">
1428
+ max_completion_tokens
1429
+ <a
1430
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-max_completion_tokens"
1431
+ target="_blank"
1432
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1433
+ ></a>
1434
+ <span class="property-type">integer</span>
1435
+ </dt>
1436
+ <dd>
1437
+ An upper bound for the number of tokens that can be generated for a completion,
1438
+ including visible output tokens and reasoning tokens.
1439
+ </dd>
1440
+
1441
+ <dt class="optional">
1442
+ n
1443
+ <a
1444
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-n"
1445
+ target="_blank"
1446
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1447
+ ></a>
1448
+ <span class="property-type">integer</span>
1449
+ </dt>
1450
+ <dd>
1451
+ How many chat completion choices to generate for each input message.
1452
+ </dd>
1392
1453
 
1393
- <dt class="optional">
1394
- modalities
1395
- <a
1396
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-modalities"
1397
- target="_blank"
1398
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1399
- ></a>
1400
- <span class="property-type">array or null</span>
1401
- </dt>
1402
- <dd>
1403
- Output types that you would like the model to generate for this request.
1404
- </dd>
1454
+ <dt class="optional">
1455
+ modalities
1456
+ <a
1457
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-modalities"
1458
+ target="_blank"
1459
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1460
+ ></a>
1461
+ <span class="property-type">array or null</span>
1462
+ </dt>
1463
+ <dd>
1464
+ Output types that you would like the model to generate for this request.
1465
+ </dd>
1405
1466
 
1406
- <dt class="optional">
1407
- prediction
1408
- <a
1409
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-prediction"
1410
- target="_blank"
1411
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1412
- ></a>
1413
- <span class="property-type">object</span>
1414
- </dt>
1415
- <dd>
1416
- Configuration for a Predicted Output.
1417
- </dd>
1467
+ <dt class="optional">
1468
+ prediction
1469
+ <a
1470
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-prediction"
1471
+ target="_blank"
1472
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1473
+ ></a>
1474
+ <span class="property-type">object</span>
1475
+ </dt>
1476
+ <dd>
1477
+ Configuration for a Predicted Output.
1478
+ </dd>
1418
1479
 
1419
- <dt class="optional">
1420
- audio
1421
- <a
1422
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-audio"
1423
- target="_blank"
1424
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1425
- ></a>
1426
- <span class="property-type">object or null</span>
1427
- </dt>
1428
- <dd>
1429
- Parameters for audio output.
1430
- </dd>
1480
+ <dt class="optional">
1481
+ audio
1482
+ <a
1483
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-audio"
1484
+ target="_blank"
1485
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1486
+ ></a>
1487
+ <span class="property-type">object or null</span>
1488
+ </dt>
1489
+ <dd>
1490
+ Parameters for audio output.
1491
+ </dd>
1431
1492
 
1432
- <dt class="optional">
1433
- presence_penalty
1434
- <a
1435
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-presence_penalty"
1436
- target="_blank"
1437
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1438
- ></a>
1439
- <span class="property-type">number</span>
1440
- </dt>
1441
- <dd>Number between -2.0 and 2.0.</dd>
1442
- <dt class="optional">
1443
- response_format
1444
- <a
1445
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-response_format"
1446
- target="_blank"
1447
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1448
- ></a>
1449
- <span class="property-type">object</span>
1450
- </dt>
1451
- <dd>An object specifying the format that the model must output.</dd>
1452
- <dt class="optional">
1453
- seed
1454
- <a
1455
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-seed"
1456
- target="_blank"
1457
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1458
- ></a>
1459
- <span class="property-type">integer</span>
1460
- </dt>
1461
- <dd>
1462
- This feature is in Beta. If specified, the system will make a best
1463
- effort to sample deterministically, such that repeated requests with the
1464
- same seed and parameters should return the same result.
1465
- </dd>
1493
+ <dt class="optional">
1494
+ presence_penalty
1495
+ <a
1496
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-presence_penalty"
1497
+ target="_blank"
1498
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1499
+ ></a>
1500
+ <span class="property-type">number</span>
1501
+ </dt>
1502
+ <dd>Number between -2.0 and 2.0.</dd>
1466
1503
 
1467
- <dt class="optional">
1468
- service_tier
1469
- <a
1470
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-service_tier"
1471
- target="_blank"
1472
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1473
- ></a>
1474
- <span class="property-type">string or null</span>
1475
- </dt>
1476
- <dd>
1477
- Specifies the latency tier to use for processing the request.
1478
- </dd>
1504
+ <dt class="optional">
1505
+ response_format
1506
+ <a
1507
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-response_format"
1508
+ target="_blank"
1509
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1510
+ ></a>
1511
+ <span class="property-type">object</span>
1512
+ </dt>
1513
+ <dd>An object specifying the format that the model must output.</dd>
1479
1514
 
1480
- <dt class="optional">
1481
- stop
1482
- <a
1483
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-stop"
1484
- target="_blank"
1485
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1486
- ></a>
1487
- <span class="property-type">string | array</span>
1488
- </dt>
1489
- <dd>
1490
- Up to 4 sequences where the API will stop generating further tokens.
1491
- </dd>
1492
- <dt class="optional">
1493
- stream
1494
- <a
1495
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-stream"
1496
- target="_blank"
1497
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1498
- ></a>
1499
- <span class="property-type">boolean</span>
1500
- </dt>
1501
- <dd>If set, partial message deltas will be sent, like in ChatGPT.</dd>
1515
+ <dt class="optional">
1516
+ seed
1517
+ <a
1518
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-seed"
1519
+ target="_blank"
1520
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1521
+ ></a>
1522
+ <span class="property-type">integer</span>
1523
+ </dt>
1524
+ <dd>
1525
+ This feature is in Beta. If specified, the system will make a best
1526
+ effort to sample deterministically, such that repeated requests with the
1527
+ same seed and parameters should return the same result.
1528
+ </dd>
1502
1529
 
1503
- <dt class="optional">
1504
- stream_options
1505
- <a
1506
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-stream_options"
1507
- target="_blank"
1508
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1509
- ></a>
1510
- <span class="property-type">object</span>
1511
- </dt>
1512
- <dd>Options for streaming response. Only set this when you set ```stream: true```.</dd>
1530
+ <dt class="optional">
1531
+ service_tier
1532
+ <a
1533
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-service_tier"
1534
+ target="_blank"
1535
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1536
+ ></a>
1537
+ <span class="property-type">string or null</span>
1538
+ </dt>
1539
+ <dd>
1540
+ Specifies the latency tier to use for processing the request.
1541
+ </dd>
1513
1542
 
1514
- <dt class="optional">
1515
- temperature
1516
- <a
1517
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-temperature"
1518
- target="_blank"
1519
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1520
- ></a>
1521
- <span class="property-type">number</span>
1522
- </dt>
1523
- <dd>What sampling temperature to use, between 0 and 2.</dd>
1524
- <dt class="optional">
1525
- top_p
1526
- <a
1527
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-top_p"
1528
- target="_blank"
1529
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1530
- ></a>
1531
- <span class="property-type">number</span>
1532
- </dt>
1533
- <dd>
1534
- An alternative to sampling with temperature, called nucleus sampling,
1535
- where the model considers the results of the tokens with top_p
1536
- probability mass.
1537
- </dd>
1538
- <dt class="optional">
1539
- tools
1540
- <a
1541
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-tools"
1542
- target="_blank"
1543
- ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1544
- ></a>
1545
- <span class="property-type">array</span>
1546
- </dt>
1547
- <dd>A list of tools the model may call.</dd>
1548
- <dt class="optional">
1549
- tool_choice
1543
+ <dt class="optional">
1544
+ stop
1545
+ <a
1546
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-stop"
1547
+ target="_blank"
1548
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1549
+ ></a>
1550
+ <span class="property-type">string | array</span>
1551
+ </dt>
1552
+ <dd>
1553
+ Up to 4 sequences where the API will stop generating further tokens.
1554
+ </dd>
1555
+
1556
+ <dt class="optional">
1557
+ stream
1558
+ <a
1559
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-stream"
1560
+ target="_blank"
1561
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1562
+ ></a>
1563
+ <span class="property-type">boolean</span>
1564
+ </dt>
1565
+ <dd>If set, partial message deltas will be sent, like in ChatGPT.</dd>
1566
+
1567
+ <dt class="optional">
1568
+ stream_options
1569
+ <a
1570
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-stream_options"
1571
+ target="_blank"
1572
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1573
+ ></a>
1574
+ <span class="property-type">object</span>
1575
+ </dt>
1576
+ <dd>Options for streaming response. Only set this when you set ```stream: true```.</dd>
1577
+
1578
+ <dt class="optional">
1579
+ temperature
1580
+ <a
1581
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-temperature"
1582
+ target="_blank"
1583
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1584
+ ></a>
1585
+ <span class="property-type">number</span>
1586
+ </dt>
1587
+ <dd>What sampling temperature to use, between 0 and 2.</dd>
1588
+
1589
+ <dt class="optional">
1590
+ top_p
1591
+ <a
1592
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-top_p"
1593
+ target="_blank"
1594
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1595
+ ></a>
1596
+ <span class="property-type">number</span>
1597
+ </dt>
1598
+ <dd>
1599
+ An alternative to sampling with temperature, called nucleus sampling,
1600
+ where the model considers the results of the tokens with top_p
1601
+ probability mass.
1602
+ </dd>
1603
+
1604
+ <dt class="optional">
1605
+ tools
1606
+ <a
1607
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-tools"
1608
+ target="_blank"
1609
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1610
+ ></a>
1611
+ <span class="property-type">array</span>
1612
+ </dt>
1613
+ <dd>A list of tools the model may call.</dd>
1614
+
1615
+ <dt class="optional">
1616
+ tool_choice
1617
+ <a
1618
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-tool_choice"
1619
+ target="_blank"
1620
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1621
+ ></a>
1622
+ <span class="property-type">string | object</span>
1623
+ </dt>
1624
+ <dd>Whether to enable parallel function calling during tool use.</dd>
1625
+
1626
+ <dt class="optional">
1627
+ parallel_tool_calls
1628
+ <a
1629
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-parallel_tool_calls"
1630
+ target="_blank"
1631
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1632
+ ></a>
1633
+ <span class="property-type">string | object</span>
1634
+ </dt>
1635
+ <dd>Whether to enable parallel function calling during tool use.</dd>
1636
+
1637
+ <dt class="optional">
1638
+ user
1639
+ <a
1640
+ href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-user"
1641
+ target="_blank"
1642
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1643
+ ></a>
1644
+ <span class="property-type">string</span>
1645
+ </dt>
1646
+ <dd>
1647
+ A unique identifier representing your end-user, which can help OpenAI to
1648
+ monitor and detect abuse.
1649
+ </dd>
1650
+
1651
+ </dl>
1652
+
1653
+
1654
+ <h4 style="font-weight: bolder;"> ⋙ Get Chat Completion</h4>
1655
+ <p>
1656
+ Get a stored chat completion.
1657
+ <a
1658
+ href="https://platform.openai.com/docs/api-reference/chat/get"
1659
+ target="_blank"
1660
+ >Full documentation.</a
1661
+ >
1662
+ </p>
1663
+ <dl class="message-properties">
1664
+ <h4>msg.payload Properties</h4>
1665
+
1666
+ <dt>
1667
+ completion_id
1668
+ <a
1669
+ href="https://platform.openai.com/docs/api-reference/chat/get#chat-get-completion_id"
1670
+ target="_blank"
1671
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1672
+ ></a>
1673
+ <span class="property-type">string</span>
1674
+ </dt>
1675
+ <dd>The ID of the chat completion to retrieve.</dd>
1676
+ </dl>
1677
+
1678
+ <!-- Begin Get Chat Messages -->
1679
+ <h4 style="font-weight: bolder;"> ⋙ Get Chat Messages</h4>
1680
+ <p>
1681
+ Get the messages in a stored chat completion.
1682
+ <a
1683
+ href="https://platform.openai.com/docs/api-reference/chat/getMessages"
1684
+ target="_blank"
1685
+ >Full documentation.</a
1686
+ >
1687
+ </p>
1688
+ <dl class="message-properties">
1689
+ <h4>msg.payload Properties</h4>
1690
+
1691
+ <dt>
1692
+ completion_id
1693
+ <a
1694
+ href="https://platform.openai.com/docs/api-reference/chat/getMessages#chat-getmessages-completion_id"
1695
+ target="_blank"
1696
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1697
+ ></a>
1698
+ <span class="property-type">string</span>
1699
+ </dt>
1700
+ <dd>The ID of the chat completion to retrieve messages from.</dd>
1701
+
1702
+ <dt class="optional">
1703
+ after
1704
+ <a
1705
+ href="https://platform.openai.com/docs/api-reference/chat/getMessages#chat-getmessages-afterf"
1706
+ target="_blank"
1707
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1708
+ ></a>
1709
+ <span class="property-type">string</span>
1710
+ </dt>
1711
+ <dd>Identifier for the last message from the previous pagination request.</dd>
1712
+
1713
+ <dt class="optional">
1714
+ limit
1715
+ <a
1716
+ href="https://platform.openai.com/docs/api-reference/chat/getMessages#chat-getmessages-limit"
1717
+ target="_blank"
1718
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1719
+ ></a>
1720
+ <span class="property-type">integer</span>
1721
+ </dt>
1722
+ <dd>Number of messages to retrieve.</dd>
1723
+
1724
+ <dt class="optional">
1725
+ order
1726
+ <a
1727
+ href="https://platform.openai.com/docs/api-reference/chat/getMessages#chat-getmessages-order"
1728
+ target="_blank"
1729
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1730
+ ></a>
1731
+ <span class="property-type">string</span>
1732
+ </dt>
1733
+ <dd>Sort order for messages by timestamp.</dd>
1734
+ </dl>
1735
+ <!-- END Get Chat Messages -->
1736
+
1737
+ <!-- Begin List Chat Completions -->
1738
+ <dl>
1739
+ <h4 style="font-weight: bolder;"> ⋙ List Chat Completions</h4>
1740
+ <p>
1741
+ List stored chat completions.
1742
+ <a
1743
+ href="https://platform.openai.com/docs/api-reference/chat/list"
1744
+ target="_blank"
1745
+ >Full documentation.</a
1746
+ >
1747
+ </p>
1748
+ <dl class="message-properties">
1749
+ <h4>msg.payload Properties</h4>
1750
+
1751
+ <dt class="optional">
1752
+ model
1753
+ <a
1754
+ href="https://platform.openai.com/docs/api-reference/chat/list#chat-list-model"
1755
+ target="_blank"
1756
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1757
+ ></a>
1758
+ <span class="property-type">string</span>
1759
+ </dt>
1760
+ <dd>The model used to generate the chat completions.</dd>
1761
+
1762
+ <dt class="optional">
1763
+ metadata
1764
+ <a
1765
+ href="https://platform.openai.com/docs/api-reference/chat/list#chat-list-metadata"
1766
+ target="_blank"
1767
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1768
+ ></a>
1769
+ <span class="property-type">object</span>
1770
+ </dt>
1771
+ <dd>A list of metadata keys to filter the chat completions by.</dd>
1772
+
1773
+ <dt class="optional">
1774
+ after
1775
+ <a
1776
+ href="https://platform.openai.com/docs/api-reference/chat/getMessages#chat-getmessages-limit"
1777
+ target="_blank"
1778
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1779
+ ></a>
1780
+ <span class="property-type">string</span>
1781
+ </dt>
1782
+ <dd>Identifier for the last chat completion from the previous pagination request.</dd>
1783
+
1784
+ <dt class="optional">
1785
+ limit
1786
+ <a
1787
+ href="https://platform.openai.com/docs/api-reference/chat/list#chat-list-limit"
1788
+ target="_blank"
1789
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1790
+ ></a>
1791
+ <span class="property-type">integer</span>
1792
+ </dt>
1793
+ <dd>Number of chat completions to retrieve.</dd>
1794
+
1795
+ <dt class="optional">
1796
+ order
1797
+ <a
1798
+ href="https://platform.openai.com/docs/api-reference/chat/list#chat-list-order"
1799
+ target="_blank"
1800
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1801
+ ></a>
1802
+ <span class="property-type">string</span>
1803
+ </dt>
1804
+ <dd>Sort order for chat completions by timestamp.</dd>
1805
+ </dl>
1806
+ <!-- END List Chat Completions -->
1807
+
1808
+ <!-- Begin Update Chat Completions -->
1809
+ <dl>
1810
+ <h4 style="font-weight: bolder;"> ⋙ Update Chat Completion</h4>
1811
+ <p>
1812
+ Modify a stored chat completion.
1813
+ <a
1814
+ href="https://platform.openai.com/docs/api-reference/chat/update"
1815
+ target="_blank"
1816
+ >Full documentation.</a
1817
+ >
1818
+ </p>
1819
+ <dl class="message-properties">
1820
+ <h4>msg.payload Properties</h4>
1821
+
1822
+ <dt>
1823
+ completion_id
1550
1824
  <a
1551
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-tool_choice"
1825
+ href="https://platform.openai.com/docs/api-reference/chat/update#chat-update-completion_id"
1552
1826
  target="_blank"
1553
1827
  ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1554
1828
  ></a>
1555
- <span class="property-type">string | object</span>
1829
+ <span class="property-type">string</span>
1556
1830
  </dt>
1557
- <dd>Whether to enable parallel function calling during tool use.</dd>
1831
+ <dd>The ID of the chat completion to update.</dd>
1558
1832
 
1559
- <dt class="optional">
1560
- parallel_tool_calls
1833
+ <dt>
1834
+ metadata
1561
1835
  <a
1562
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-parallel_tool_calls"
1836
+ href="https://platform.openai.com/docs/api-reference/chat/getMessages#chat-getmessages-limit"
1563
1837
  target="_blank"
1564
1838
  ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1565
1839
  ></a>
1566
- <span class="property-type">string | object</span>
1840
+ <span class="property-type">object</span>
1567
1841
  </dt>
1568
- <dd>Whether to enable parallel function calling during tool use.</dd>
1842
+ <dd>Set of 16 key-value pairs that can be attached to an object.</dd>
1843
+ </dl>
1844
+ <!-- END Update Chat Completion -->
1569
1845
 
1570
- <dt class="optional">
1571
- user
1846
+ <!-- Begin Delete Chat Completion -->
1847
+ <dl>
1848
+ <h4 style="font-weight: bolder;"> ⋙ Delete Chat Completion</h4>
1849
+ <p>
1850
+ Delete a stored chat completion.
1851
+ <a
1852
+ href="https://platform.openai.com/docs/api-reference/chat/delete"
1853
+ target="_blank"
1854
+ >Full documentation.</a
1855
+ >
1856
+ </p>
1857
+ <dl class="message-properties">
1858
+ <h4>msg.payload Properties</h4>
1859
+
1860
+ <dt>
1861
+ completion_id
1572
1862
  <a
1573
- href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-user"
1863
+ href="https://platform.openai.com/docs/api-reference/chat/delete#chat-delete-completion_id"
1574
1864
  target="_blank"
1575
1865
  ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
1576
1866
  ></a>
1577
1867
  <span class="property-type">string</span>
1578
1868
  </dt>
1579
- <dd>
1580
- A unique identifier representing your end-user, which can help OpenAI to
1581
- monitor and detect abuse.
1582
- </dd>
1583
-
1869
+ <dd>The ID of the chat completion to delete.</dd>
1584
1870
  </dl>
1585
-
1871
+ <!-- END Delete Chat Completion -->
1586
1872
  </details>
1587
1873
  </section>
1588
1874
 
@@ -2649,6 +2935,333 @@
2649
2935
 
2650
2936
  </details>
2651
2937
  </section>
2938
+ <!-- End Moderations docs -->
2939
+
2940
+ <!-- Begin Responses docs -->
2941
+ <section>
2942
+ <details>
2943
+ <summary style="font-weight: bold;">🗨️ Responses</summary>
2944
+ <a
2945
+ href="https://platform.openai.com/docs/api-reference/responses"
2946
+ target="_blank"
2947
+ >Official Documentation
2948
+ <i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2949
+ ></a>
2950
+ <h4 style="font-weight: bolder;"> ⋙ Create Model Response</h4>
2951
+ <p>Creates a model response.</p>
2952
+ <dl class="message-properties">
2953
+ <h4>msg.payload Properties</h4>
2954
+
2955
+ <dt>
2956
+ input
2957
+ <a
2958
+ href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-input"
2959
+ target="_blank"
2960
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2961
+ ></a>
2962
+ <span class="property-type">string | array</span>
2963
+ </dt>
2964
+ <dd>Text, image, or file inputs to the model, used to generate a response.</dd>
2965
+
2966
+ <dt>
2967
+ model
2968
+ <a
2969
+ href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-model"
2970
+ target="_blank"
2971
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2972
+ ></a>
2973
+ <span class="property-type">string</span>
2974
+ </dt>
2975
+ <dd>Model ID used to generate the response.</dd>
2976
+
2977
+ <dt class="optional">
2978
+ include
2979
+ <a
2980
+ href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-include"
2981
+ target="_blank"
2982
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2983
+ ></a>
2984
+ <span class="property-type">array</span>
2985
+ </dt>
2986
+ <dd>Specify additional output data to include in the model response.</dd>
2987
+
2988
+ <dt class="optional">
2989
+ instructions
2990
+ <a
2991
+ href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-instructions"
2992
+ target="_blank"
2993
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
2994
+ ></a>
2995
+ <span class="property-type">string</span>
2996
+ </dt>
2997
+ <dd>Inserts a system (or developer) message as the first item in the model's context.</dd>
2998
+
2999
+ <dt class="optional">
3000
+ max_output_tokens
3001
+ <a
3002
+ href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-max_output_tokens"
3003
+ target="_blank"
3004
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3005
+ ></a>
3006
+ <span class="property-type">integer</span>
3007
+ </dt>
3008
+ <dd>An upper bound for the number of tokens that can be generated for a response.</dd>
3009
+
3010
+ <dt class="optional">
3011
+ metadata
3012
+ <a
3013
+ href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-metadata"
3014
+ target="_blank"
3015
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3016
+ ></a>
3017
+ <span class="property-type">object</span>
3018
+ </dt>
3019
+ <dd>Set of 16 key-value pairs that can be attached to an object.</dd>
3020
+
3021
+ <dt class="optional">
3022
+ parallel_tool_calls
3023
+ <a
3024
+ href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-parallel_tool_calls"
3025
+ target="_blank"
3026
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3027
+ ></a>
3028
+ <span class="property-type">boolean</span>
3029
+ </dt>
3030
+ <dd>Whether to allow the model to run tool calls in parallel.</dd>
3031
+
3032
+ <dt class="optional">
3033
+ parallel_tool_calls
3034
+ <a
3035
+ href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-parallel_tool_calls"
3036
+ target="_blank"
3037
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3038
+ ></a>
3039
+ <span class="property-type">boolean</span>
3040
+ </dt>
3041
+ <dd>Whether to allow the model to run tool calls in parallel.</dd>
3042
+
3043
+ <dt class="optional">
3044
+ previous_response_id
3045
+ <a
3046
+ href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-previous_response_id"
3047
+ target="_blank"
3048
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3049
+ ></a>
3050
+ <span class="property-type">string</span>
3051
+ </dt>
3052
+ <dd>The unique ID of the previous response to the model.</dd>
3053
+
3054
+ <dt class="optional">
3055
+ reasoning
3056
+ <a
3057
+ href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-reasoning"
3058
+ target="_blank"
3059
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3060
+ ></a>
3061
+ <span class="property-type">object</span>
3062
+ </dt>
3063
+ <dd>o-series models only. See official docs for option properties.</dd>
3064
+
3065
+ <dt class="optional">
3066
+ store
3067
+ <a
3068
+ href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-store"
3069
+ target="_blank"
3070
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3071
+ ></a>
3072
+ <span class="property-type">boolean</span>
3073
+ </dt>
3074
+ <dd>Whether to store the generated model response for later retrieval via API.</dd>
3075
+
3076
+ <dt class="optional">
3077
+ stream
3078
+ <a
3079
+ href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-stream"
3080
+ target="_blank"
3081
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3082
+ ></a>
3083
+ <span class="property-type">boolean</span>
3084
+ </dt>
3085
+ <dd>If set to true, the model response data will be streamed to the client as it is generated using server-sent events.</dd>
3086
+
3087
+ <dt class="optional">
3088
+ temperature
3089
+ <a
3090
+ href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-temperature"
3091
+ target="_blank"
3092
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3093
+ ></a>
3094
+ <span class="property-type">number</span>
3095
+ </dt>
3096
+ <dd>What sampling temperature to use, between 0 and 2.</dd>
3097
+
3098
+ <dt class="optional">
3099
+ text
3100
+ <a
3101
+ href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-text"
3102
+ target="_blank"
3103
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3104
+ ></a>
3105
+ <span class="property-type">object</span>
3106
+ </dt>
3107
+ <dd>Configuration options for a text response from the model.</dd>
3108
+
3109
+ <dt class="optional">
3110
+ tool_choice
3111
+ <a
3112
+ href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-tool_choice"
3113
+ target="_blank"
3114
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3115
+ ></a>
3116
+ <span class="property-type">string or object</span>
3117
+ </dt>
3118
+ <dd>How the model should select which tool (or tools) to use when generating a response.</dd>
3119
+
3120
+ <dt class="optional">
3121
+ tools
3122
+ <a
3123
+ href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-tools"
3124
+ target="_blank"
3125
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3126
+ ></a>
3127
+ <span class="property-type">array</span>
3128
+ </dt>
3129
+ <dd>An array of tools the model may call while generating a response.</dd>
3130
+
3131
+ <dt class="optional">
3132
+ top_p
3133
+ <a
3134
+ href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-top_p"
3135
+ target="_blank"
3136
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3137
+ ></a>
3138
+ <span class="property-type">number</span>
3139
+ </dt>
3140
+ <dd>An alternative to sampling with temperature, called nucleus sampling.</dd>
3141
+
3142
+ <dt class="optional">
3143
+ truncation
3144
+ <a
3145
+ href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-truncation"
3146
+ target="_blank"
3147
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3148
+ ></a>
3149
+ <span class="property-type">string</span>
3150
+ </dt>
3151
+ <dd>The truncation strategy to use for the model response.</dd>
3152
+
3153
+ <dt class="optional">
3154
+ user
3155
+ <a
3156
+ href="https://platform.openai.com/docs/api-reference/responses/create#responses-create-user"
3157
+ target="_blank"
3158
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3159
+ ></a>
3160
+ <span class="property-type">string</span>
3161
+ </dt>
3162
+ <dd>A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.</dd>
3163
+
3164
+ </dl>
3165
+
3166
+ <h4 style="font-weight: bolder;"> ⋙ Get Model Response</h4>
3167
+ <p>Retrieves a model response with the given ID.</p>
3168
+ <dl class="message-properties">
3169
+ <h4>msg.payload Properties</h4>
3170
+
3171
+ <dt>
3172
+ response_id
3173
+ <a
3174
+ href="https://platform.openai.com/docs/api-reference/responses/get#responses-get-response_id"
3175
+ target="_blank"
3176
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3177
+ ></a>
3178
+ <span class="property-type">string</span>
3179
+ </dt>
3180
+ <dd>The ID of the response to retrieve.</dd>
3181
+ </dl>
3182
+
3183
+ <h4 style="font-weight: bolder;"> ⋙ Delete Model Response</h4>
3184
+ <p>Deletes a model response with the given ID.</p>
3185
+ <dl class="message-properties">
3186
+ <h4>msg.payload Properties</h4>
3187
+
3188
+ <dt>
3189
+ response_id
3190
+ <a
3191
+ href="https://platform.openai.com/docs/api-reference/responses/delete#responses-delete-response_id"
3192
+ target="_blank"
3193
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3194
+ ></a>
3195
+ <span class="property-type">string</span>
3196
+ </dt>
3197
+ <dd>The ID of the response to delete.</dd>
3198
+ </dl>
3199
+
3200
+ <h4 style="font-weight: bolder;"> ⋙ List Input Items</h4>
3201
+ <p>Returns a list of input items for a given response.</p>
3202
+ <dl class="message-properties">
3203
+ <h4>msg.payload Properties</h4>
3204
+
3205
+ <dt>
3206
+ response_id
3207
+ <a
3208
+ href="https://platform.openai.com/docs/api-reference/responses/input-items#responses-input-items-response_id"
3209
+ target="_blank"
3210
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3211
+ ></a>
3212
+ <span class="property-type">string</span>
3213
+ </dt>
3214
+ <dd>The ID of the response to retrieve input items for.</dd>
3215
+
3216
+ <dt class="optional">
3217
+ after
3218
+ <a
3219
+ href="https://platform.openai.com/docs/api-reference/responses/input-items#responses-input-items-after"
3220
+ target="_blank"
3221
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3222
+ ></a>
3223
+ <span class="property-type">string</span>
3224
+ </dt>
3225
+ <dd>An item ID to list items after, used in pagination.</dd>
3226
+
3227
+ <dt class="optional">
3228
+ before
3229
+ <a
3230
+ href="https://platform.openai.com/docs/api-reference/responses/input-items#responses-input-items-before"
3231
+ target="_blank"
3232
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3233
+ ></a>
3234
+ <span class="property-type">string</span>
3235
+ </dt>
3236
+ <dd>An item ID to list items before, used in pagination.</dd>
3237
+
3238
+ <dt class="optional">
3239
+ limit
3240
+ <a
3241
+ href="https://platform.openai.com/docs/api-reference/responses/input-items#responses-input-items-limit"
3242
+ target="_blank"
3243
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3244
+ ></a>
3245
+ <span class="property-type">integer</span>
3246
+ </dt>
3247
+ <dd>A limit on the number of objects to be returned.</dd>
3248
+
3249
+ <dt class="optional">
3250
+ order
3251
+ <a
3252
+ href="https://platform.openai.com/docs/api-reference/responses/input-items#responses-input-items-order"
3253
+ target="_blank"
3254
+ ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
3255
+ ></a>
3256
+ <span class="property-type">string</span>
3257
+ </dt>
3258
+ <dd>The order to return the input items in. Default is <code>asc</code>.</dd>
3259
+
3260
+ </dl>
3261
+
3262
+ </details>
3263
+ </section>
3264
+ <!-- End Responses docs -->
2652
3265
 
2653
3266
  <!-- Begin Runs docs -->
2654
3267
  <section>