Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 | import type {
ComparisonFilter,
CompoundFilter,
Metadata,
Reasoning,
ResponseFormatJSONObject,
ResponseFormatText,
} from '@shared/types/shared';
export interface ParsedResponseOutputText<ParsedT> extends ResponseOutputText {
parsed: ParsedT | null;
}
export type ParsedContent<ParsedT> =
| ParsedResponseOutputText<ParsedT>
| ResponseOutputRefusal;
export interface ParsedResponseOutputMessage<ParsedT>
extends ResponseOutputMessage {
content: ParsedContent<ParsedT>[];
}
export interface ParsedResponseFunctionToolCall
extends ResponseFunctionToolCall {
parsed_arguments: unknown;
}
export type ParsedResponseOutputItem<ParsedT> =
| ParsedResponseOutputMessage<ParsedT>
| ParsedResponseFunctionToolCall
| ResponseFileSearchToolCall
| ResponseFunctionWebSearch
| ResponseComputerToolCall
| ResponseOutputItemReasoning;
export interface ParsedResponse<ParsedT> extends OpenAIResponse {
output: ParsedResponseOutputItem<ParsedT>[];
output_parsed: ParsedT | null;
}
export type ResponseParseParams = ResponseCreateParamsNonStreaming;
/**
* A tool that controls a virtual computer. Learn more about the
* [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
*/
export interface ComputerTool {
/**
* The height of the computer display.
*/
display_height: number;
/**
* The width of the computer display.
*/
display_width: number;
/**
* The type of computer environment to control.
*/
environment: 'mac' | 'windows' | 'ubuntu' | 'browser';
/**
* The type of the computer use tool. Always `computer_use_preview`.
*/
type: 'computer-preview';
}
/**
* A message input to the model with a role indicating instruction following
* hierarchy. Instructions given with the `developer` or `system` role take
* precedence over instructions given with the `user` role. Messages with the
* `assistant` role are presumed to have been generated by the model in previous
* interactions.
*/
export interface EasyInputMessage {
/**
* Text, image, or audio input to the model, used to generate a response. Can also
* contain previous assistant responses.
*/
content: string | ResponseInputMessageContentList;
/**
* The role of the message input. One of `user`, `assistant`, `system`, or
* `developer`.
*/
role: 'user' | 'assistant' | 'system' | 'developer';
/**
* The type of the message input. Always `message`.
*/
type?: 'message';
}
/**
* A tool that searches for relevant content from uploaded files. Learn more about
* the
* [file search tool](https://platform.openai.com/docs/guides/tools-file-search).
*/
export interface FileSearchTool {
/**
* The type of the file search tool. Always `file_search`.
*/
type: 'file_search';
/**
* The IDs of the vector stores to search.
*/
vector_store_ids: string[];
/**
* A filter to apply based on file attributes.
*/
filters?: ComparisonFilter | CompoundFilter;
/**
* The maximum number of results to return. This number should be between 1 and 50
* inclusive.
*/
max_num_results?: number;
/**
* Ranking options for search.
*/
ranking_options?: FileSearchToolRankingOptions;
}
export interface FileSearchToolRankingOptions {
/**
* The ranker to use for the file search.
*/
ranker?: 'auto' | 'default-2024-11-15';
/**
* The score threshold for the file search, a number between 0 and 1. Numbers
* closer to 1 will attempt to return only the most relevant results, but may
* return fewer results.
*/
score_threshold?: number;
}
/**
* Defines a function in your own code the model can choose to call. Learn more
* about
* [function calling](https://platform.openai.com/docs/guides/function-calling).
*/
export interface FunctionTool {
/**
* The name of the function to call.
*/
name: string;
/**
* A JSON schema object describing the parameters of the function.
*/
parameters: Record<string, unknown>;
/**
* Whether to enforce strict parameter validation. Default `true`.
*/
strict: boolean;
/**
* The type of the function tool. Always `function`.
*/
type: 'function';
/**
* A description of the function. Used by the model to determine whether or not to
* call the function.
*/
description?: string | null;
}
export interface OpenAIResponse {
/**
* Unique identifier for this Response.
*/
id: string;
/**
* Unix timestamp (in seconds) of when this Response was created.
*/
created_at: number;
/**
* An error object returned when the model fails to generate a Response.
*/
error: ResponseError | null;
/**
* Details about why the response is incomplete.
*/
incomplete_details: IncompleteDetails | null;
/**
* Inserts a system (or developer) message as the first item in the model's
* context.
*
* When using along with `previous_response_id`, the instructions from a previous
* response will be not be carried over to the next response. This makes it simple
* to swap out system (or developer) messages in new responses.
*/
instructions: string | null;
/**
* 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, and
* querying for objects via API or the dashboard.
*
* Keys are strings with a maximum length of 64 characters. Values are strings with
* a maximum length of 512 characters.
*/
metadata: Metadata | null;
/**
* Model ID used to generate the response, like `gpt-4o` or `o1`. OpenAI offers a
* wide range of models with different capabilities, performance characteristics,
* and price points. Refer to the
* [model guide](https://platform.openai.com/docs/models) to browse and compare
* available models.
*/
model: string;
/**
* The object type of this resource - always set to `response`.
*/
object: 'response';
/**
* An array of content items generated by the model.
*
* - The length and order of items in the `output` array is dependent on the
* model's response.
* - Rather than accessing the first item in the `output` array and assuming it's
* an `assistant` message with the content generated by the model, you might
* consider using the `output_text` property where supported in SDKs.
*/
output: ResponseOutputItem[];
/**
* Whether to allow the model to run tool calls in parallel.
*/
parallel_tool_calls: boolean;
/**
* 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. We generally recommend altering this or `top_p` but
* not both.
*/
temperature: number | null;
/**
* How the model should select which tool (or tools) to use when generating a
* response. See the `tools` parameter to see how to specify which tools the model
* can call.
*/
tool_choice: ToolChoiceOptions | ToolChoiceTypes | ToolChoiceFunction;
/**
* An array of tools the model may call while generating a response. You can
* specify which tool to use by setting the `tool_choice` parameter.
*
* The two categories of tools you can provide the model are:
*
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
* capabilities, like
* [web search](https://platform.openai.com/docs/guides/tools-web-search) or
* [file search](https://platform.openai.com/docs/guides/tools-file-search).
* Learn more about
* [built-in tools](https://platform.openai.com/docs/guides/tools).
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
* the model to call your own code. Learn more about
* [function calling](https://platform.openai.com/docs/guides/function-calling).
*/
tools: Tool[];
/**
* An alternative to sampling with temperature, called nucleus sampling, where the
* model considers the results of the tokens with top_p probability mass. So 0.1
* means only the tokens comprising the top 10% probability mass are considered.
*
* We generally recommend altering this or `temperature` but not both.
*/
top_p: number | null;
/**
* An upper bound for the number of tokens that can be generated for a response,
* including visible output tokens and
* [reasoning tokens](https://platform.openai.com/docs/guides/reasoning).
*/
max_output_tokens?: number | null;
/**
* The unique ID of the previous response to the model. Use this to create
* multi-turn conversations. Learn more about
* [conversation state](https://platform.openai.com/docs/guides/conversation-state).
*/
previous_response_id?: string | null;
/**
* **o-series models only**
*
* Configuration options for
* [reasoning models](https://platform.openai.com/docs/guides/reasoning).
*/
reasoning?: Reasoning | null;
/**
* The status of the response generation. One of `completed`, `failed`,
* `in_progress`, or `incomplete`.
*/
status?: ResponseStatus;
/**
* Configuration options for a text response from the model. Can be plain text or
* structured JSON data. Learn more:
*
* - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
* - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
*/
text?: ResponseTextConfig;
/**
* The truncation strategy to use for the model response.
*
* - `auto`: If the context of this response and previous ones exceeds the model's
* context window size, the model will truncate the response to fit the context
* window by dropping input items in the middle of the conversation.
* - `disabled` (default): If a model response will exceed the context window size
* for a model, the request will fail with a 400 error.
*/
truncation?: 'auto' | 'disabled' | null;
/**
* Represents token usage details including input tokens, output tokens, a
* breakdown of output tokens, and the total tokens used.
*/
usage?: ResponseUsage | null;
/**
* A unique identifier representing your end-user, which can help OpenAI to monitor
* and detect abuse.
* [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
*/
user?: string | null;
store?: boolean;
}
export interface IncompleteDetails {
/**
* The reason why the response is incomplete.
*/
reason?: 'max_output_tokens' | 'content_filter';
}
/**
* Emitted when there is a partial audio response.
*/
export interface ResponseAudioDeltaEvent {
/**
* A chunk of Base64 encoded response audio bytes.
*/
delta: string;
/**
* The type of the event. Always `response.audio.delta`.
*/
type: 'response.audio.delta';
}
/**
* Emitted when the audio response is complete.
*/
export interface ResponseAudioDoneEvent {
/**
* The type of the event. Always `response.audio.done`.
*/
type: 'response.audio.done';
}
/**
* Emitted when there is a partial transcript of audio.
*/
export interface ResponseAudioTranscriptDeltaEvent {
/**
* The partial transcript of the audio response.
*/
delta: string;
/**
* The type of the event. Always `response.audio.transcript.delta`.
*/
type: 'response.audio.transcript.delta';
}
/**
* Emitted when the full audio transcript is completed.
*/
export interface ResponseAudioTranscriptDoneEvent {
/**
* The type of the event. Always `response.audio.transcript.done`.
*/
type: 'response.audio.transcript.done';
}
/**
* Emitted when a partial code snippet is added by the code interpreter.
*/
export interface ResponseCodeInterpreterCallCodeDeltaEvent {
/**
* The partial code snippet added by the code interpreter.
*/
delta: string;
/**
* The index of the output item that the code interpreter call is in progress.
*/
output_index: number;
/**
* The type of the event. Always `response.code_interpreter_call.code.delta`.
*/
type: 'response.code_interpreter_call.code.delta';
}
/**
* Emitted when code snippet output is finalized by the code interpreter.
*/
export interface ResponseCodeInterpreterCallCodeDoneEvent {
/**
* The final code snippet output by the code interpreter.
*/
code: string;
/**
* The index of the output item that the code interpreter call is in progress.
*/
output_index: number;
/**
* The type of the event. Always `response.code_interpreter_call.code.done`.
*/
type: 'response.code_interpreter_call.code.done';
}
/**
* Emitted when the code interpreter call is completed.
*/
export interface ResponseCodeInterpreterCallCompletedEvent {
/**
* A tool call to run code.
*/
code_interpreter_call: ResponseCodeInterpreterToolCall;
/**
* The index of the output item that the code interpreter call is in progress.
*/
output_index: number;
/**
* The type of the event. Always `response.code_interpreter_call.completed`.
*/
type: 'response.code_interpreter_call.completed';
}
/**
* Emitted when a code interpreter call is in progress.
*/
export interface ResponseCodeInterpreterCallInProgressEvent {
/**
* A tool call to run code.
*/
code_interpreter_call: ResponseCodeInterpreterToolCall;
/**
* The index of the output item that the code interpreter call is in progress.
*/
output_index: number;
/**
* The type of the event. Always `response.code_interpreter_call.in_progress`.
*/
type: 'response.code_interpreter_call.in_progress';
}
/**
* Emitted when the code interpreter is actively interpreting the code snippet.
*/
export interface ResponseCodeInterpreterCallInterpretingEvent {
/**
* A tool call to run code.
*/
code_interpreter_call: ResponseCodeInterpreterToolCall;
/**
* The index of the output item that the code interpreter call is in progress.
*/
output_index: number;
/**
* The type of the event. Always `response.code_interpreter_call.interpreting`.
*/
type: 'response.code_interpreter_call.interpreting';
}
/**
* A tool call to run code.
*/
export interface ResponseCodeInterpreterToolCall {
/**
* The unique ID of the code interpreter tool call.
*/
id: string;
/**
* The code to run.
*/
code: string;
/**
* The results of the code interpreter tool call.
*/
results: Array<
ResponseCodeInterpreterToolCall.Logs | ResponseCodeInterpreterToolCall.Files
>;
/**
* The status of the code interpreter tool call.
*/
status: 'in_progress' | 'interpreting' | 'completed';
/**
* The type of the code interpreter tool call. Always `code_interpreter_call`.
*/
type: 'code_interpreter_call';
}
// biome-ignore lint/style/noNamespace: File will be removed in the future.
export namespace ResponseCodeInterpreterToolCall {
/**
* The output of a code interpreter tool call that is text.
*/
export interface Logs {
/**
* The logs of the code interpreter tool call.
*/
logs: string;
/**
* The type of the code interpreter text output. Always `logs`.
*/
type: 'logs';
}
/**
* The output of a code interpreter tool call that is a file.
*/
export interface Files {
files: Files.File[];
/**
* The type of the code interpreter file output. Always `files`.
*/
type: 'files';
}
// biome-ignore lint/style/noNamespace: File will be removed in the future.
export namespace Files {
export interface File {
/**
* The ID of the file.
*/
file_id: string;
/**
* The MIME type of the file.
*/
mime_type: string;
}
}
}
/**
* Emitted when the model response is complete.
*/
export interface ResponseCompletedEvent {
/**
* Properties of the completed response.
*/
response: OpenAIResponse;
/**
* The type of the event. Always `response.completed`.
*/
type: 'response.completed';
}
/**
* A tool call to a computer use tool. See the
* [computer use guide](https://platform.openai.com/docs/guides/tools-computer-use)
* for more information.
*/
export interface ResponseComputerToolCall {
/**
* The unique ID of the computer call.
*/
id: string;
/**
* A click action.
*/
action:
| ResponseComputerToolCall.Click
| ResponseComputerToolCall.DoubleClick
| ResponseComputerToolCall.Drag
| ResponseComputerToolCall.Keypress
| ResponseComputerToolCall.Move
| ResponseComputerToolCall.Screenshot
| ResponseComputerToolCall.Scroll
| ResponseComputerToolCall.Type
| ResponseComputerToolCall.Wait
| null;
/**
* An identifier used when responding to the tool call with output.
*/
call_id: string;
/**
* The pending safety checks for the computer call.
*/
pending_safety_checks: ResponseComputerToolCall.PendingSafetyCheck[];
/**
* The status of the item. One of `in_progress`, `completed`, or `incomplete`.
* Populated when items are returned via API.
*/
status: 'in_progress' | 'completed' | 'incomplete';
/**
* The type of the computer call. Always `computer_call`.
*/
type: 'computer_call';
}
// biome-ignore lint/style/noNamespace: File will be removed in the future.
export namespace ResponseComputerToolCall {
/**
* A click action.
*/
export interface Click {
/**
* Indicates which mouse button was pressed during the click. One of `left`,
* `right`, `wheel`, `back`, or `forward`.
*/
button: 'left' | 'right' | 'wheel' | 'back' | 'forward';
/**
* Specifies the event type. For a click action, this property is always set to
* `click`.
*/
type: 'click';
/**
* The x-coordinate where the click occurred.
*/
x: number;
/**
* The y-coordinate where the click occurred.
*/
y: number;
}
/**
* A double click action.
*/
export interface DoubleClick {
/**
* Specifies the event type. For a double click action, this property is always set
* to `double_click`.
*/
type: 'double_click';
/**
* The x-coordinate where the double click occurred.
*/
x: number;
/**
* The y-coordinate where the double click occurred.
*/
y: number;
}
/**
* A drag action.
*/
export interface Drag {
/**
* An array of coordinates representing the path of the drag action. Coordinates
* will appear as an array of objects, eg
*
* ```
* [
* { x: 100, y: 200 },
* { x: 200, y: 300 }
* ]
* ```
*/
path: Drag.Path[];
/**
* Specifies the event type. For a drag action, this property is always set to
* `drag`.
*/
type: 'drag';
}
// biome-ignore lint/style/noNamespace: File will be removed in the future.
export namespace Drag {
/**
* A series of x/y coordinate pairs in the drag path.
*/
export interface Path {
/**
* The x-coordinate.
*/
x: number;
/**
* The y-coordinate.
*/
y: number;
}
}
/**
* A collection of keypresses the model would like to perform.
*/
export interface Keypress {
/**
* The combination of keys the model is requesting to be pressed. This is an array
* of strings, each representing a key.
*/
keys: string[];
/**
* Specifies the event type. For a keypress action, this property is always set to
* `keypress`.
*/
type: 'keypress';
}
/**
* A mouse move action.
*/
export interface Move {
/**
* Specifies the event type. For a move action, this property is always set to
* `move`.
*/
type: 'move';
/**
* The x-coordinate to move to.
*/
x: number;
/**
* The y-coordinate to move to.
*/
y: number;
}
/**
* A screenshot action.
*/
export interface Screenshot {
/**
* Specifies the event type. For a screenshot action, this property is always set
* to `screenshot`.
*/
type: 'screenshot';
}
/**
* A scroll action.
*/
export interface Scroll {
/**
* The horizontal scroll distance.
*/
scroll_x: number;
/**
* The vertical scroll distance.
*/
scroll_y: number;
/**
* Specifies the event type. For a scroll action, this property is always set to
* `scroll`.
*/
type: 'scroll';
/**
* The x-coordinate where the scroll occurred.
*/
x: number;
/**
* The y-coordinate where the scroll occurred.
*/
y: number;
}
/**
* An action to type in text.
*/
export interface Type {
/**
* The text to type.
*/
text: string;
/**
* Specifies the event type. For a type action, this property is always set to
* `type`.
*/
type: 'type';
}
/**
* A wait action.
*/
export interface Wait {
/**
* Specifies the event type. For a wait action, this property is always set to
* `wait`.
*/
type: 'wait';
}
/**
* A pending safety check for the computer call.
*/
export interface PendingSafetyCheck {
/**
* The ID of the pending safety check.
*/
id: string;
/**
* The type of the pending safety check.
*/
code: string;
/**
* Details about the pending safety check.
*/
message: string;
}
}
/**
* Multi-modal input and output contents.
*/
export type ResponseContent =
| ResponseInputText
| ResponseInputImage
| ResponseInputFile
| ResponseOutputText
| ResponseOutputRefusal;
/**
* Emitted when a new content part is added.
*/
export interface ResponseContentPartAddedEvent {
/**
* The index of the content part that was added.
*/
content_index: number;
/**
* The ID of the output item that the content part was added to.
*/
item_id: string;
/**
* The index of the output item that the content part was added to.
*/
output_index: number;
/**
* The content part that was added.
*/
part: ResponseOutputText | ResponseOutputRefusal;
/**
* The type of the event. Always `response.content_part.added`.
*/
type: 'response.content_part.added';
}
/**
* Emitted when a content part is done.
*/
export interface ResponseContentPartDoneEvent {
/**
* The index of the content part that is done.
*/
content_index: number;
/**
* The ID of the output item that the content part was added to.
*/
item_id: string;
/**
* The index of the output item that the content part was added to.
*/
output_index: number;
/**
* The content part that is done.
*/
part: ResponseOutputText | ResponseOutputRefusal;
/**
* The type of the event. Always `response.content_part.done`.
*/
type: 'response.content_part.done';
}
/**
* An event that is emitted when a response is created.
*/
export interface ResponseCreatedEvent {
/**
* The response that was created.
*/
response: OpenAIResponse;
/**
* The type of the event. Always `response.created`.
*/
type: 'response.created';
}
/**
* An error object returned when the model fails to generate a Response.
*/
export interface ResponseError {
/**
* The error code for the response.
*/
code: string;
/**
* A human-readable description of the error.
*/
message: string;
}
/**
* Emitted when an error occurs.
*/
export interface ResponseErrorEvent {
/**
* The error code.
*/
code: string | null;
/**
* The error message.
*/
message: string;
/**
* The error parameter.
*/
param: string | null;
/**
* The type of the event. Always `error`.
*/
type: 'error';
}
/**
* An event that is emitted when a response fails.
*/
export interface ResponseFailedEvent {
/**
* The response that failed.
*/
response: OpenAIResponse;
/**
* The type of the event. Always `response.failed`.
*/
type: 'response.failed';
}
/**
* Emitted when a file search call is completed (results found).
*/
export interface ResponseFileSearchCallCompletedEvent {
/**
* The ID of the output item that the file search call is initiated.
*/
item_id: string;
/**
* The index of the output item that the file search call is initiated.
*/
output_index: number;
/**
* The type of the event. Always `response.file_search_call.completed`.
*/
type: 'response.file_search_call.completed';
}
/**
* Emitted when a file search call is initiated.
*/
export interface ResponseFileSearchCallInProgressEvent {
/**
* The ID of the output item that the file search call is initiated.
*/
item_id: string;
/**
* The index of the output item that the file search call is initiated.
*/
output_index: number;
/**
* The type of the event. Always `response.file_search_call.in_progress`.
*/
type: 'response.file_search_call.in_progress';
}
/**
* Emitted when a file search is currently searching.
*/
export interface ResponseFileSearchCallSearchingEvent {
/**
* The ID of the output item that the file search call is initiated.
*/
item_id: string;
/**
* The index of the output item that the file search call is searching.
*/
output_index: number;
/**
* The type of the event. Always `response.file_search_call.searching`.
*/
type: 'response.file_search_call.searching';
}
/**
* The results of a file search tool call. See the
* [file search guide](https://platform.openai.com/docs/guides/tools-file-search)
* for more information.
*/
export interface ResponseFileSearchToolCall {
/**
* The unique ID of the file search tool call.
*/
id: string;
/**
* The queries used to search for files.
*/
queries: string[];
/**
* The status of the file search tool call. One of `in_progress`, `searching`,
* `incomplete` or `failed`,
*/
status: 'in_progress' | 'searching' | 'completed' | 'incomplete' | 'failed';
/**
* The type of the file search tool call. Always `file_search_call`.
*/
type: 'file_search_call';
/**
* The results of the file search tool call.
*/
results?: ResponseFileSearchToolCall.Result[] | null;
}
// biome-ignore lint/style/noNamespace: File will be removed in the future.
export namespace ResponseFileSearchToolCall {
export interface Result {
/**
* 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, and
* querying for objects via API or the dashboard. Keys are strings with a maximum
* length of 64 characters. Values are strings with a maximum length of 512
* characters, booleans, or numbers.
*/
attributes?: Record<string, string | number | boolean> | null;
/**
* The unique ID of the file.
*/
file_id?: string;
/**
* The name of the file.
*/
filename?: string;
/**
* The relevance score of the file - a value between 0 and 1.
*/
score?: number;
/**
* The text that was retrieved from the file.
*/
text?: string;
}
}
/**
* An object specifying the format that the model must output.
*
* Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
* ensures the model will match your supplied JSON schema. Learn more in the
* [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
*
* The default format is `{ "type": "text" }` with no additional options.
*
* **Not recommended for gpt-4o and newer models:**
*
* Setting to `{ "type": "json_object" }` enables the older JSON mode, which
* ensures the message the model generates is valid JSON. Using `json_schema` is
* preferred for models that support it.
*/
export type ResponseFormatTextConfig =
| ResponseFormatText
| ResponseFormatTextJSONSchemaConfig
| ResponseFormatJSONObject;
/**
* JSON Schema response format. Used to generate structured JSON responses. Learn
* more about
* [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
*/
export interface ResponseFormatTextJSONSchemaConfig {
/**
* The schema for the response format, described as a JSON Schema object. Learn how
* to build JSON schemas [here](https://json-schema.org/).
*/
schema: Record<string, unknown>;
/**
* The type of response format being defined. Always `json_schema`.
*/
type: 'json_schema';
/**
* A description of what the response format is for, used by the model to determine
* how to respond in the format.
*/
description?: string;
/**
* The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores
* and dashes, with a maximum length of 64.
*/
name?: string;
/**
* Whether to enable strict schema adherence when generating the output. If set to
* true, the model will always follow the exact schema defined in the `schema`
* field. Only a subset of JSON Schema is supported when `strict` is `true`. To
* learn more, read the
* [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
*/
strict?: boolean | null;
}
/**
* Emitted when there is a partial function-call arguments delta.
*/
export interface ResponseFunctionCallArgumentsDeltaEvent {
/**
* The function-call arguments delta that is added.
*/
delta: string;
/**
* The ID of the output item that the function-call arguments delta is added to.
*/
item_id: string;
/**
* The index of the output item that the function-call arguments delta is added to.
*/
output_index: number;
/**
* The type of the event. Always `response.function_call_arguments.delta`.
*/
type: 'response.function_call_arguments.delta';
}
/**
* Emitted when function-call arguments are finalized.
*/
export interface ResponseFunctionCallArgumentsDoneEvent {
/**
* The function-call arguments.
*/
arguments: string;
/**
* The ID of the item.
*/
item_id: string;
/**
* The index of the output item.
*/
output_index: number;
type: 'response.function_call_arguments.done';
}
/**
* A tool call to run a function. See the
* [function calling guide](https://platform.openai.com/docs/guides/function-calling)
* for more information.
*/
export interface ResponseFunctionToolCall {
/**
* The unique ID of the function tool call.
*/
id: string;
/**
* A JSON string of the arguments to pass to the function.
*/
arguments: string;
/**
* The unique ID of the function tool call generated by the model.
*/
call_id: string;
/**
* The name of the function to run.
*/
name: string;
/**
* The type of the function tool call. Always `function_call`.
*/
type: 'function_call';
/**
* The status of the item. One of `in_progress`, `completed`, or `incomplete`.
* Populated when items are returned via API.
*/
status?: 'in_progress' | 'completed' | 'incomplete';
}
/**
* The results of a web search tool call. See the
* [web search guide](https://platform.openai.com/docs/guides/tools-web-search) for
* more information.
*/
export interface ResponseFunctionWebSearch {
/**
* The unique ID of the web search tool call.
*/
id: string;
/**
* The status of the web search tool call.
*/
status: 'in_progress' | 'searching' | 'completed' | 'failed';
/**
* The type of the web search tool call. Always `web_search_call`.
*/
type: 'web_search_call';
}
/**
* Emitted when the response is in progress.
*/
export interface ResponseInProgressEvent {
/**
* The response that is in progress.
*/
response: OpenAIResponse;
/**
* The type of the event. Always `response.in_progress`.
*/
type: 'response.in_progress';
}
/**
* Specify additional output data to include in the model response. Currently
* supported values are:
*
* - `file_search_call.results`: Include the search results of the file search tool
* call.
* - `message.input_image.image_url`: Include image urls from the input message.
* - `computer_call_output.output.image_url`: Include image urls from the computer
* call output.
*/
export type ResponseIncludable =
| 'file_search_call.results'
| 'message.input_image.image_url'
| 'computer_call_output.output.image_url';
/**
* An event that is emitted when a response finishes as incomplete.
*/
export interface ResponseIncompleteEvent {
/**
* The response that was incomplete.
*/
response: OpenAIResponse;
/**
* The type of the event. Always `response.incomplete`.
*/
type: 'response.incomplete';
}
/**
* A list of one or many input items to the model, containing different content
* types.
*/
export type ResponseInput = ResponseInputItem[];
/**
* An audio input to the model.
*/
export interface ResponseInputAudio {
/**
* Base64-encoded audio data.
*/
data: string;
/**
* The format of the audio data. Currently supported formats are `mp3` and `wav`.
*/
format: 'mp3' | 'wav';
/**
* The type of the input item. Always `input_audio`.
*/
type: 'input_audio';
}
/**
* A text input to the model.
*/
export type ResponseInputContent =
| ResponseInputText
| ResponseInputImage
| ResponseInputFile;
/**
* A file input to the model.
*/
export interface ResponseInputFile {
/**
* The type of the input item. Always `input_file`.
*/
type: 'input_file';
/**
* The content of the file to be sent to the model.
*/
file_data?: string;
/**
* The ID of the file to be sent to the model.
*/
file_id?: string;
/**
* The name of the file to be sent to the model.
*/
filename?: string;
}
/**
* An image input to the model. Learn about
* [image inputs](https://platform.openai.com/docs/guides/vision).
*/
export interface ResponseInputImage {
/**
* The detail level of the image to be sent to the model. One of `high`, `low`, or
* `auto`. Defaults to `auto`.
*/
detail: 'high' | 'low' | 'auto';
/**
* The type of the input item. Always `input_image`.
*/
type: 'input_image';
/**
* The ID of the file to be sent to the model.
*/
file_id?: string | null;
/**
* The URL of the image to be sent to the model. A fully qualified URL or base64
* encoded image in a data URL.
*/
image_url?: string | null;
}
/**
* A message input to the model with a role indicating instruction following
* hierarchy. Instructions given with the `developer` or `system` role take
* precedence over instructions given with the `user` role. Messages with the
* `assistant` role are presumed to have been generated by the model in previous
* interactions.
*/
export type ResponseInputItem =
| EasyInputMessage
| ResponseInputItem.Message
| ResponseOutputMessage
| ResponseFileSearchToolCall
| ResponseComputerToolCall
| ResponseInputItem.ComputerCallOutput
| ResponseFunctionWebSearch
| ResponseFunctionToolCall
| ResponseInputItem.FunctionCallOutput
| ResponseInputItem.Reasoning
| ResponseInputItem.ItemReference;
// biome-ignore lint/style/noNamespace: File will be removed in the future.
export namespace ResponseInputItem {
/**
* A message input to the model with a role indicating instruction following
* hierarchy. Instructions given with the `developer` or `system` role take
* precedence over instructions given with the `user` role.
*/
export interface Message {
/**
* A list of one or many input items to the model, containing different content
* types.
*/
content: ResponseInputMessageContentList;
/**
* The role of the message input. One of `user`, `system`, or `developer`.
*/
role: 'user' | 'system' | 'developer';
/**
* The status of item. One of `in_progress`, `completed`, or `incomplete`.
* Populated when items are returned via API.
*/
status?: 'in_progress' | 'completed' | 'incomplete';
/**
* The type of the message input. Always set to `message`.
*/
type?: 'message';
}
/**
* The output of a computer tool call.
*/
export interface ComputerCallOutput {
/**
* The ID of the computer tool call that produced the output.
*/
call_id: string;
/**
* A computer screenshot image used with the computer use tool.
*/
output: ComputerCallOutput.Output;
/**
* The type of the computer tool call output. Always `computer_call_output`.
*/
type: 'computer_call_output';
/**
* The ID of the computer tool call output.
*/
id?: string;
/**
* The safety checks reported by the API that have been acknowledged by the
* developer.
*/
acknowledged_safety_checks?: ComputerCallOutput.AcknowledgedSafetyCheck[];
/**
* The status of the message input. One of `in_progress`, `completed`, or
* `incomplete`. Populated when input items are returned via API.
*/
status?: 'in_progress' | 'completed' | 'incomplete';
}
// biome-ignore lint/style/noNamespace: File will be removed in the future.
export namespace ComputerCallOutput {
/**
* A computer screenshot image used with the computer use tool.
*/
export interface Output {
/**
* Specifies the event type. For a computer screenshot, this property is always set
* to `computer_screenshot`.
*/
type: 'computer_screenshot';
/**
* The identifier of an uploaded file that contains the screenshot.
*/
file_id?: string;
/**
* The URL of the screenshot image.
*/
image_url?: string;
}
/**
* A pending safety check for the computer call.
*/
export interface AcknowledgedSafetyCheck {
/**
* The ID of the pending safety check.
*/
id: string;
/**
* The type of the pending safety check.
*/
code: string;
/**
* Details about the pending safety check.
*/
message: string;
}
}
/**
* The output of a function tool call.
*/
export interface FunctionCallOutput {
/**
* The unique ID of the function tool call generated by the model.
*/
call_id: string;
/**
* A JSON string of the output of the function tool call.
*/
output: string;
/**
* The type of the function tool call output. Always `function_call_output`.
*/
type: 'function_call_output';
/**
* The unique ID of the function tool call output. Populated when this item is
* returned via API.
*/
id?: string;
/**
* The status of the item. One of `in_progress`, `completed`, or `incomplete`.
* Populated when items are returned via API.
*/
status?: 'in_progress' | 'completed' | 'incomplete';
}
/**
* A description of the chain of thought used by a reasoning model while generating
* a response.
*/
export interface Reasoning {
/**
* The unique identifier of the reasoning content.
*/
id: string;
/**
* Reasoning text contents.
*/
content: Reasoning.Content[];
/**
* The type of the object. Always `reasoning`.
*/
type: 'reasoning';
/**
* The status of the item. One of `in_progress`, `completed`, or `incomplete`.
* Populated when items are returned via API.
*/
status?: 'in_progress' | 'completed' | 'incomplete';
}
// biome-ignore lint/style/noNamespace: File will be removed in the future.
export namespace Reasoning {
export interface Content {
/**
* A short summary of the reasoning used by the model when generating the response.
*/
text: string;
/**
* The type of the object. Always `text`.
*/
type: 'reasoning_summary';
}
}
/**
* An internal identifier for an item to reference.
*/
export interface ItemReference {
/**
* The ID of the item to reference.
*/
id: string;
/**
* The type of item to reference. Always `item_reference`.
*/
type: 'item_reference';
}
}
/**
* A list of one or many input items to the model, containing different content
* types.
*/
export type ResponseInputMessageContentList = ResponseInputContent[];
/**
* A text input to the model.
*/
export interface ResponseInputText {
/**
* The text input to the model.
*/
text: string;
/**
* The type of the input item. Always `input_text`.
*/
type: 'input_text';
}
/**
* An audio output from the model.
*/
export interface ResponseOutputAudio {
/**
* Base64-encoded audio data from the model.
*/
data: string;
/**
* The transcript of the audio data from the model.
*/
transcript: string;
/**
* The type of the output audio. Always `output_audio`.
*/
type: 'output_audio';
}
/**
* An output message from the model.
*/
export type ResponseOutputItem =
| ResponseOutputMessage
| ResponseFileSearchToolCall
| ResponseFunctionToolCall
| ResponseFunctionWebSearch
| ResponseComputerToolCall
| ResponseOutputItemReasoning;
export interface ResponseOutputItemReasoning {
/**
* The unique identifier of the reasoning content.
*/
id: string;
/**
* Reasoning text contents.
*/
content?: {
/**
* A short summary of the reasoning used by the model when generating the response.
*/
text: string;
/**
* The type of the object. Always `text`.
*/
type: 'reasoning_summary';
};
/**
* The type of the object. Always `reasoning`.
*/
type: 'reasoning';
/**
* The status of the item. One of `in_progress`, `completed`, or `incomplete`.
* Populated when items are returned via API.
*/
status?: 'in_progress' | 'completed' | 'incomplete';
/**
* A short summary of the reasoning used by the model when generating the response.
*/
summary?: unknown;
}
/**
* Emitted when a new output item is added.
*/
export interface ResponseOutputItemAddedEvent {
/**
* The output item that was added.
*/
item: ResponseOutputItem;
/**
* The index of the output item that was added.
*/
output_index: number;
/**
* The type of the event. Always `response.output_item.added`.
*/
type: 'response.output_item.added';
}
/**
* Emitted when an output item is marked done.
*/
export interface ResponseOutputItemDoneEvent {
/**
* The output item that was marked done.
*/
item: ResponseOutputItem;
/**
* The index of the output item that was marked done.
*/
output_index: number;
/**
* The type of the event. Always `response.output_item.done`.
*/
type: 'response.output_item.done';
}
/**
* An output message from the model.
*/
export interface ResponseOutputMessage {
/**
* The unique ID of the output message.
*/
id: string;
/**
* The content of the output message.
*/
content: Array<ResponseOutputText | ResponseOutputRefusal>;
/**
* The role of the output message. Always `assistant`.
*/
role: 'assistant';
/**
* The status of the message input. One of `in_progress`, `completed`, or
* `incomplete`. Populated when input items are returned via API.
*/
status: 'in_progress' | 'completed' | 'incomplete';
/**
* The type of the output message. Always `message`.
*/
type: 'message';
}
/**
* A refusal from the model.
*/
export interface ResponseOutputRefusal {
/**
* The refusal explanationfrom the model.
*/
refusal: string;
/**
* The type of the refusal. Always `refusal`.
*/
type: 'refusal';
}
/**
* A text output from the model.
*/
export interface ResponseOutputText {
/**
* The annotations of the text output.
*/
annotations: Array<
| ResponseOutputText.FileCitation
| ResponseOutputText.URLCitation
| ResponseOutputText.FilePath
>;
/**
* The text output from the model.
*/
text: string;
/**
* The type of the output text. Always `output_text`.
*/
type: 'output_text';
}
// biome-ignore lint/style/noNamespace: File will be removed in the future.
export namespace ResponseOutputText {
/**
* A citation to a file.
*/
export interface FileCitation {
/**
* The ID of the file.
*/
file_id: string;
/**
* The index of the file in the list of files.
*/
index: number;
/**
* The type of the file citation. Always `file_citation`.
*/
type: 'file_citation';
}
/**
* A citation for a web resource used to generate a model response.
*/
export interface URLCitation {
/**
* The index of the last character of the URL citation in the message.
*/
end_index: number;
/**
* The index of the first character of the URL citation in the message.
*/
start_index: number;
/**
* The title of the web resource.
*/
title: string;
/**
* The type of the URL citation. Always `url_citation`.
*/
type: 'url_citation';
/**
* The URL of the web resource.
*/
url: string;
}
/**
* A path to a file.
*/
export interface FilePath {
/**
* The ID of the file.
*/
file_id: string;
/**
* The index of the file in the list of files.
*/
index: number;
/**
* The type of the file path. Always `file_path`.
*/
type: 'file_path';
}
}
/**
* Emitted when there is a partial refusal text.
*/
export interface ResponseRefusalDeltaEvent {
/**
* The index of the content part that the refusal text is added to.
*/
content_index: number;
/**
* The refusal text that is added.
*/
delta: string;
/**
* The ID of the output item that the refusal text is added to.
*/
item_id: string;
/**
* The index of the output item that the refusal text is added to.
*/
output_index: number;
/**
* The type of the event. Always `response.refusal.delta`.
*/
type: 'response.refusal.delta';
}
/**
* Emitted when refusal text is finalized.
*/
export interface ResponseRefusalDoneEvent {
/**
* The index of the content part that the refusal text is finalized.
*/
content_index: number;
/**
* The ID of the output item that the refusal text is finalized.
*/
item_id: string;
/**
* The index of the output item that the refusal text is finalized.
*/
output_index: number;
/**
* The refusal text that is finalized.
*/
refusal: string;
/**
* The type of the event. Always `response.refusal.done`.
*/
type: 'response.refusal.done';
}
/**
* The status of the response generation. One of `completed`, `failed`,
* `in_progress`, or `incomplete`.
*/
export type ResponseStatus =
| 'completed'
| 'failed'
| 'in_progress'
| 'incomplete';
/**
* Emitted when there is a partial audio response.
*/
export type ResponseStreamEvent =
| ResponseAudioDeltaEvent
| ResponseAudioDoneEvent
| ResponseAudioTranscriptDeltaEvent
| ResponseAudioTranscriptDoneEvent
| ResponseCodeInterpreterCallCodeDeltaEvent
| ResponseCodeInterpreterCallCodeDoneEvent
| ResponseCodeInterpreterCallCompletedEvent
| ResponseCodeInterpreterCallInProgressEvent
| ResponseCodeInterpreterCallInterpretingEvent
| ResponseCompletedEvent
| ResponseContentPartAddedEvent
| ResponseContentPartDoneEvent
| ResponseCreatedEvent
| ResponseErrorEvent
| ResponseFileSearchCallCompletedEvent
| ResponseFileSearchCallInProgressEvent
| ResponseFileSearchCallSearchingEvent
| ResponseFunctionCallArgumentsDeltaEvent
| ResponseFunctionCallArgumentsDoneEvent
| ResponseInProgressEvent
| ResponseFailedEvent
| ResponseIncompleteEvent
| ResponseOutputItemAddedEvent
| ResponseOutputItemDoneEvent
| ResponseRefusalDeltaEvent
| ResponseRefusalDoneEvent
| ResponseTextAnnotationDeltaEvent
| ResponseTextDeltaEvent
| ResponseTextDoneEvent
| ResponseWebSearchCallCompletedEvent
| ResponseWebSearchCallInProgressEvent
| ResponseWebSearchCallSearchingEvent;
/**
* Emitted when a text annotation is added.
*/
export interface ResponseTextAnnotationDeltaEvent {
/**
* A citation to a file.
*/
annotation:
| ResponseTextAnnotationDeltaEvent.FileCitation
| ResponseTextAnnotationDeltaEvent.URLCitation
| ResponseTextAnnotationDeltaEvent.FilePath;
/**
* The index of the annotation that was added.
*/
annotation_index: number;
/**
* The index of the content part that the text annotation was added to.
*/
content_index: number;
/**
* The ID of the output item that the text annotation was added to.
*/
item_id: string;
/**
* The index of the output item that the text annotation was added to.
*/
output_index: number;
/**
* The type of the event. Always `response.output_text.annotation.added`.
*/
type: 'response.output_text.annotation.added';
}
// biome-ignore lint/style/noNamespace: File will be removed in the future.
export namespace ResponseTextAnnotationDeltaEvent {
/**
* A citation to a file.
*/
export interface FileCitation {
/**
* The ID of the file.
*/
file_id: string;
/**
* The index of the file in the list of files.
*/
index: number;
/**
* The type of the file citation. Always `file_citation`.
*/
type: 'file_citation';
}
/**
* A citation for a web resource used to generate a model response.
*/
export interface URLCitation {
/**
* The index of the last character of the URL citation in the message.
*/
end_index: number;
/**
* The index of the first character of the URL citation in the message.
*/
start_index: number;
/**
* The title of the web resource.
*/
title: string;
/**
* The type of the URL citation. Always `url_citation`.
*/
type: 'url_citation';
/**
* The URL of the web resource.
*/
url: string;
}
/**
* A path to a file.
*/
export interface FilePath {
/**
* The ID of the file.
*/
file_id: string;
/**
* The index of the file in the list of files.
*/
index: number;
/**
* The type of the file path. Always `file_path`.
*/
type: 'file_path';
}
}
/**
* Configuration options for a text response from the model. Can be plain text or
* structured JSON data. Learn more:
*
* - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
* - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
*/
export interface ResponseTextConfig {
/**
* An object specifying the format that the model must output.
*
* Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
* ensures the model will match your supplied JSON schema. Learn more in the
* [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
*
* The default format is `{ "type": "text" }` with no additional options.
*
* **Not recommended for gpt-4o and newer models:**
*
* Setting to `{ "type": "json_object" }` enables the older JSON mode, which
* ensures the message the model generates is valid JSON. Using `json_schema` is
* preferred for models that support it.
*/
format?: ResponseFormatTextConfig;
}
/**
* Emitted when there is an additional text delta.
*/
export interface ResponseTextDeltaEvent {
/**
* The index of the content part that the text delta was added to.
*/
content_index: number;
/**
* The text delta that was added.
*/
delta: string;
/**
* The ID of the output item that the text delta was added to.
*/
item_id: string;
/**
* The index of the output item that the text delta was added to.
*/
output_index: number;
/**
* The type of the event. Always `response.output_text.delta`.
*/
type: 'response.output_text.delta';
}
/**
* Emitted when text content is finalized.
*/
export interface ResponseTextDoneEvent {
/**
* The index of the content part that the text content is finalized.
*/
content_index: number;
/**
* The ID of the output item that the text content is finalized.
*/
item_id: string;
/**
* The index of the output item that the text content is finalized.
*/
output_index: number;
/**
* The text content that is finalized.
*/
text: string;
/**
* The type of the event. Always `response.output_text.done`.
*/
type: 'response.output_text.done';
}
/**
* Represents token usage details including input tokens, output tokens, a
* breakdown of output tokens, and the total tokens used.
*/
export interface ResponseUsage {
/**
* The number of input tokens.
*/
input_tokens: number;
/**
* The number of output tokens.
*/
output_tokens: number;
/**
* A detailed breakdown of the output tokens.
*/
output_tokens_details: ResponseUsage.OutputTokensDetails;
/**
* The total number of tokens used.
*/
total_tokens: number;
}
// biome-ignore lint/style/noNamespace: Will be removed in the future.
export namespace ResponseUsage {
/**
* A detailed breakdown of the output tokens.
*/
export interface OutputTokensDetails {
/**
* The number of reasoning tokens.
*/
reasoning_tokens: number;
}
}
/**
* Emitted when a web search call is completed.
*/
export interface ResponseWebSearchCallCompletedEvent {
/**
* Unique ID for the output item associated with the web search call.
*/
item_id: string;
/**
* The index of the output item that the web search call is associated with.
*/
output_index: number;
/**
* The type of the event. Always `response.web_search_call.completed`.
*/
type: 'response.web_search_call.completed';
}
/**
* Emitted when a web search call is initiated.
*/
export interface ResponseWebSearchCallInProgressEvent {
/**
* Unique ID for the output item associated with the web search call.
*/
item_id: string;
/**
* The index of the output item that the web search call is associated with.
*/
output_index: number;
/**
* The type of the event. Always `response.web_search_call.in_progress`.
*/
type: 'response.web_search_call.in_progress';
}
/**
* Emitted when a web search call is executing.
*/
export interface ResponseWebSearchCallSearchingEvent {
/**
* Unique ID for the output item associated with the web search call.
*/
item_id: string;
/**
* The index of the output item that the web search call is associated with.
*/
output_index: number;
/**
* The type of the event. Always `response.web_search_call.searching`.
*/
type: 'response.web_search_call.searching';
}
/**
* A tool that searches for relevant content from uploaded files. Learn more about
* the
* [file search tool](https://platform.openai.com/docs/guides/tools-file-search).
*/
export type Tool = FileSearchTool | FunctionTool | ComputerTool | WebSearchTool;
/**
* Use this option to force the model to call a specific function.
*/
export interface ToolChoiceFunction {
/**
* The name of the function to call.
*/
name: string;
/**
* For function calling, the type is always `function`.
*/
type: 'function';
}
/**
* Controls which (if any) tool is called by the model.
*
* `none` means the model will not call any tool and instead generates a message.
*
* `auto` means the model can pick between generating a message or calling one or
* more tools.
*
* `required` means the model must call one or more tools.
*/
export type ToolChoiceOptions = 'none' | 'auto' | 'required';
/**
* Indicates that the model should use a built-in tool to generate a response.
* [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools).
*/
export interface ToolChoiceTypes {
/**
* The type of hosted tool the model should to use. Learn more about
* [built-in tools](https://platform.openai.com/docs/guides/tools).
*
* Allowed values are:
*
* - `file_search`
* - `web_search_preview`
* - `computer_use_preview`
*/
type:
| 'file_search'
| 'web_search_preview'
| 'computer_use_preview'
| 'web_search_preview_2025_03_11';
}
/**
* This tool searches the web for relevant results to use in a response. Learn more
* about the
* [web search tool](https://platform.openai.com/docs/guides/tools-web-search).
*/
export interface WebSearchTool {
/**
* The type of the web search tool. One of:
*
* - `web_search_preview`
* - `web_search_preview_2025_03_11`
*/
type: 'web_search_preview' | 'web_search_preview_2025_03_11';
/**
* High level guidance for the amount of context window space to use for the
* search. One of `low`, `medium`, or `high`. `medium` is the default.
*/
search_context_size?: 'low' | 'medium' | 'high';
user_location?: WebSearchToolUserLocation | null;
}
interface WebSearchToolUserLocation {
/**
* The type of location approximation. Always `approximate`.
*/
type: 'approximate';
/**
* Free text input for the city of the user, e.g. `San Francisco`.
*/
city?: string;
/**
* The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of
* the user, e.g. `US`.
*/
country?: string;
/**
* Free text input for the region of the user, e.g. `California`.
*/
region?: string;
/**
* The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the
* user, e.g. `America/Los_Angeles`.
*/
timezone?: string;
}
export type ResponseCreateParams =
| ResponseCreateParamsNonStreaming
| ResponseCreateParamsStreaming;
export interface ResponseCreateParamsBase {
/**
* Text, image, or file inputs to the model, used to generate a response.
*
* Learn more:
*
* - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
* - [Image inputs](https://platform.openai.com/docs/guides/images)
* - [File inputs](https://platform.openai.com/docs/guides/pdf-files)
* - [Conversation state](https://platform.openai.com/docs/guides/conversation-state)
* - [Function calling](https://platform.openai.com/docs/guides/function-calling)
*/
input: string | ResponseInput;
/**
* Model ID used to generate the response, like `gpt-4o` or `o1`. OpenAI offers a
* wide range of models with different capabilities, performance characteristics,
* and price points. Refer to the
* [model guide](https://platform.openai.com/docs/models) to browse and compare
* available models.
*/
model: string;
/**
* Specify additional output data to include in the model response. Currently
* supported values are:
*
* - `file_search_call.results`: Include the search results of the file search tool
* call.
* - `message.input_image.image_url`: Include image urls from the input message.
* - `computer_call_output.output.image_url`: Include image urls from the computer
* call output.
*/
include?: ResponseIncludable[] | null;
/**
* Inserts a system (or developer) message as the first item in the model's
* context.
*
* When using along with `previous_response_id`, the instructions from a previous
* response will be not be carried over to the next response. This makes it simple
* to swap out system (or developer) messages in new responses.
*/
instructions?: string | null;
/**
* An upper bound for the number of tokens that can be generated for a response,
* including visible output tokens and
* [reasoning tokens](https://platform.openai.com/docs/guides/reasoning).
*/
max_output_tokens?: number | null;
/**
* 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, and
* querying for objects via API or the dashboard.
*
* Keys are strings with a maximum length of 64 characters. Values are strings with
* a maximum length of 512 characters.
*/
metadata?: Metadata | null;
/**
* Whether to allow the model to run tool calls in parallel.
*/
parallel_tool_calls?: boolean | null;
/**
* The unique ID of the previous response to the model. Use this to create
* multi-turn conversations. Learn more about
* [conversation state](https://platform.openai.com/docs/guides/conversation-state).
*/
previous_response_id?: string | null;
/**
* **o-series models only**
*
* Configuration options for
* [reasoning models](https://platform.openai.com/docs/guides/reasoning).
*/
reasoning?: Reasoning | null;
/**
* Whether to store the generated model response for later retrieval via API.
*/
store?: boolean | null;
/**
* If set to true, the model response data will be streamed to the client as it is
* generated using
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
* See the
* [Streaming section below](https://platform.openai.com/docs/api-reference/responses-streaming)
* for more information.
*/
stream?: boolean | null;
/**
* 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. We generally recommend altering this or `top_p` but
* not both.
*/
temperature?: number | null;
/**
* Configuration options for a text response from the model. Can be plain text or
* structured JSON data. Learn more:
*
* - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
* - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
*/
text?: ResponseTextConfig;
/**
* How the model should select which tool (or tools) to use when generating a
* response. See the `tools` parameter to see how to specify which tools the model
* can call.
*/
tool_choice?: ToolChoiceOptions | ToolChoiceTypes | ToolChoiceFunction;
/**
* An array of tools the model may call while generating a response. You can
* specify which tool to use by setting the `tool_choice` parameter.
*
* The two categories of tools you can provide the model are:
*
* - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
* capabilities, like
* [web search](https://platform.openai.com/docs/guides/tools-web-search) or
* [file search](https://platform.openai.com/docs/guides/tools-file-search).
* Learn more about
* [built-in tools](https://platform.openai.com/docs/guides/tools).
* - **Function calls (custom tools)**: Functions that are defined by you, enabling
* the model to call your own code. Learn more about
* [function calling](https://platform.openai.com/docs/guides/function-calling).
*/
tools?: Tool[];
/**
* An alternative to sampling with temperature, called nucleus sampling, where the
* model considers the results of the tokens with top_p probability mass. So 0.1
* means only the tokens comprising the top 10% probability mass are considered.
*
* We generally recommend altering this or `temperature` but not both.
*/
top_p?: number | null;
/**
* The truncation strategy to use for the model response.
*
* - `auto`: If the context of this response and previous ones exceeds the model's
* context window size, the model will truncate the response to fit the context
* window by dropping input items in the middle of the conversation.
* - `disabled` (default): If a model response will exceed the context window size
* for a model, the request will fail with a 400 error.
*/
truncation?: 'auto' | 'disabled' | null;
/**
* A unique identifier representing your end-user, which can help OpenAI to monitor
* and detect abuse.
* [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
*/
user?: string;
}
export interface ResponseCreateParamsNonStreaming
extends ResponseCreateParamsBase {
/**
* If set to true, the model response data will be streamed to the client as it is
* generated using
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
* See the
* [Streaming section below](https://platform.openai.com/docs/api-reference/responses-streaming)
* for more information.
*/
stream?: false | null;
}
export interface ResponseCreateParamsStreaming
extends ResponseCreateParamsBase {
/**
* If set to true, the model response data will be streamed to the client as it is
* generated using
* [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
* See the
* [Streaming section below](https://platform.openai.com/docs/api-reference/responses-streaming)
* for more information.
*/
stream: true;
}
export interface ResponseRetrieveParams {
/**
* Additional fields to include in the response. See the `include` parameter for
* Response creation above for more information.
*/
include?: ResponseIncludable[];
}
export interface ModelResponseDeleteResponse {
id: string;
object: 'response';
deleted: boolean;
}
|