ogx-client 1.0.2 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/ci.yml +7 -7
- package/.github/workflows/release-doctor.yml +1 -1
- package/.release-please-manifest.json +1 -1
- package/.stats.yml +2 -2
- package/CHANGELOG.md +20 -0
- package/dist/CHANGELOG.md +20 -0
- package/dist/package.json +1 -1
- package/dist/resources/conversations/conversations.d.ts +41 -2
- package/dist/resources/conversations/conversations.d.ts.map +1 -1
- package/dist/resources/conversations/conversations.js.map +1 -1
- package/dist/resources/conversations/conversations.mjs.map +1 -1
- package/dist/resources/conversations/items.d.ts +164 -8
- package/dist/resources/conversations/items.d.ts.map +1 -1
- package/dist/resources/conversations/items.js.map +1 -1
- package/dist/resources/conversations/items.mjs.map +1 -1
- package/dist/resources/responses/input-items.d.ts +41 -2
- package/dist/resources/responses/input-items.d.ts.map +1 -1
- package/dist/resources/responses/responses.d.ts +547 -24
- package/dist/resources/responses/responses.d.ts.map +1 -1
- package/dist/resources/responses/responses.js.map +1 -1
- package/dist/resources/responses/responses.mjs.map +1 -1
- package/dist/src/resources/conversations/conversations.ts +57 -2
- package/dist/src/resources/conversations/items.ts +228 -8
- package/dist/src/resources/responses/input-items.ts +57 -2
- package/dist/src/resources/responses/responses.ts +746 -22
- package/dist/src/version.ts +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/version.mjs +1 -1
- package/package.json +1 -1
- package/src/resources/conversations/conversations.ts +57 -2
- package/src/resources/conversations/items.ts +228 -8
- package/src/resources/responses/input-items.ts +57 -2
- package/src/resources/responses/responses.ts +746 -22
- package/src/version.ts +1 -1
- package/tests/api-resources/responses/responses.test.ts +39 -4
|
@@ -101,7 +101,7 @@ export interface CompactedResponse {
|
|
|
101
101
|
|
|
102
102
|
output: Array<
|
|
103
103
|
| CompactedResponse.OpenAIResponseMessageOutput
|
|
104
|
-
| CompactedResponse.
|
|
104
|
+
| CompactedResponse.OpenAIResponseOutputMessageWebSearchToolCallOutput
|
|
105
105
|
| CompactedResponse.OpenAIResponseOutputMessageFileSearchToolCall
|
|
106
106
|
| CompactedResponse.OpenAIResponseOutputMessageFunctionToolCall
|
|
107
107
|
| CompactedResponse.OpenAIResponseOutputMessageMcpCall
|
|
@@ -325,14 +325,69 @@ export namespace CompactedResponse {
|
|
|
325
325
|
/**
|
|
326
326
|
* Web search tool call output message for OpenAI responses.
|
|
327
327
|
*/
|
|
328
|
-
export interface
|
|
328
|
+
export interface OpenAIResponseOutputMessageWebSearchToolCallOutput {
|
|
329
329
|
id: string;
|
|
330
330
|
|
|
331
331
|
status: string;
|
|
332
332
|
|
|
333
|
+
/**
|
|
334
|
+
* Web search action: performs a search query.
|
|
335
|
+
*/
|
|
336
|
+
action?:
|
|
337
|
+
| OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionSearch
|
|
338
|
+
| OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionOpenPage
|
|
339
|
+
| OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionFind
|
|
340
|
+
| null;
|
|
341
|
+
|
|
333
342
|
type?: 'web_search_call';
|
|
334
343
|
}
|
|
335
344
|
|
|
345
|
+
export namespace OpenAIResponseOutputMessageWebSearchToolCallOutput {
|
|
346
|
+
/**
|
|
347
|
+
* Web search action: performs a search query.
|
|
348
|
+
*/
|
|
349
|
+
export interface WebSearchActionSearch {
|
|
350
|
+
query: string;
|
|
351
|
+
|
|
352
|
+
queries?: Array<string> | null;
|
|
353
|
+
|
|
354
|
+
sources?: Array<WebSearchActionSearch.Source> | null;
|
|
355
|
+
|
|
356
|
+
type?: 'search';
|
|
357
|
+
}
|
|
358
|
+
|
|
359
|
+
export namespace WebSearchActionSearch {
|
|
360
|
+
/**
|
|
361
|
+
* A source URL returned by a web search action.
|
|
362
|
+
*/
|
|
363
|
+
export interface Source {
|
|
364
|
+
url: string;
|
|
365
|
+
|
|
366
|
+
type?: 'url';
|
|
367
|
+
}
|
|
368
|
+
}
|
|
369
|
+
|
|
370
|
+
/**
|
|
371
|
+
* Web search action: opens a specific URL from search results.
|
|
372
|
+
*/
|
|
373
|
+
export interface WebSearchActionOpenPage {
|
|
374
|
+
type?: 'open_page';
|
|
375
|
+
|
|
376
|
+
url?: string | null;
|
|
377
|
+
}
|
|
378
|
+
|
|
379
|
+
/**
|
|
380
|
+
* Web search action: searches for a pattern within a loaded page.
|
|
381
|
+
*/
|
|
382
|
+
export interface WebSearchActionFind {
|
|
383
|
+
pattern: string;
|
|
384
|
+
|
|
385
|
+
url: string;
|
|
386
|
+
|
|
387
|
+
type?: 'find_in_page';
|
|
388
|
+
}
|
|
389
|
+
}
|
|
390
|
+
|
|
336
391
|
/**
|
|
337
392
|
* File search tool call output message for OpenAI responses.
|
|
338
393
|
*/
|
|
@@ -657,9 +712,64 @@ export namespace ResponseInput {
|
|
|
657
712
|
|
|
658
713
|
status: string;
|
|
659
714
|
|
|
715
|
+
/**
|
|
716
|
+
* Web search action: performs a search query.
|
|
717
|
+
*/
|
|
718
|
+
action?:
|
|
719
|
+
| OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionSearch
|
|
720
|
+
| OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionOpenPage
|
|
721
|
+
| OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionFind
|
|
722
|
+
| null;
|
|
723
|
+
|
|
660
724
|
type?: 'web_search_call';
|
|
661
725
|
}
|
|
662
726
|
|
|
727
|
+
export namespace OpenAIResponseOutputMessageWebSearchToolCall {
|
|
728
|
+
/**
|
|
729
|
+
* Web search action: performs a search query.
|
|
730
|
+
*/
|
|
731
|
+
export interface WebSearchActionSearch {
|
|
732
|
+
query: string;
|
|
733
|
+
|
|
734
|
+
queries?: Array<string> | null;
|
|
735
|
+
|
|
736
|
+
sources?: Array<WebSearchActionSearch.Source> | null;
|
|
737
|
+
|
|
738
|
+
type?: 'search';
|
|
739
|
+
}
|
|
740
|
+
|
|
741
|
+
export namespace WebSearchActionSearch {
|
|
742
|
+
/**
|
|
743
|
+
* A source URL returned by a web search action.
|
|
744
|
+
*/
|
|
745
|
+
export interface Source {
|
|
746
|
+
url: string;
|
|
747
|
+
|
|
748
|
+
type?: 'url';
|
|
749
|
+
}
|
|
750
|
+
}
|
|
751
|
+
|
|
752
|
+
/**
|
|
753
|
+
* Web search action: opens a specific URL from search results.
|
|
754
|
+
*/
|
|
755
|
+
export interface WebSearchActionOpenPage {
|
|
756
|
+
type?: 'open_page';
|
|
757
|
+
|
|
758
|
+
url?: string | null;
|
|
759
|
+
}
|
|
760
|
+
|
|
761
|
+
/**
|
|
762
|
+
* Web search action: searches for a pattern within a loaded page.
|
|
763
|
+
*/
|
|
764
|
+
export interface WebSearchActionFind {
|
|
765
|
+
pattern: string;
|
|
766
|
+
|
|
767
|
+
url: string;
|
|
768
|
+
|
|
769
|
+
type?: 'find_in_page';
|
|
770
|
+
}
|
|
771
|
+
}
|
|
772
|
+
|
|
663
773
|
/**
|
|
664
774
|
* File search tool call output message for OpenAI responses.
|
|
665
775
|
*/
|
|
@@ -1131,7 +1241,7 @@ export interface ResponseObject {
|
|
|
1131
1241
|
|
|
1132
1242
|
output: Array<
|
|
1133
1243
|
| ResponseObject.OpenAIResponseMessageOutput
|
|
1134
|
-
| ResponseObject.
|
|
1244
|
+
| ResponseObject.OpenAIResponseOutputMessageWebSearchToolCallOutput
|
|
1135
1245
|
| ResponseObject.OpenAIResponseOutputMessageFileSearchToolCall
|
|
1136
1246
|
| ResponseObject.OpenAIResponseOutputMessageFunctionToolCall
|
|
1137
1247
|
| ResponseObject.OpenAIResponseOutputMessageMcpCall
|
|
@@ -1166,7 +1276,7 @@ export interface ResponseObject {
|
|
|
1166
1276
|
|
|
1167
1277
|
max_tool_calls?: number | null;
|
|
1168
1278
|
|
|
1169
|
-
metadata?:
|
|
1279
|
+
metadata?: unknown;
|
|
1170
1280
|
|
|
1171
1281
|
object?: 'response';
|
|
1172
1282
|
|
|
@@ -1190,6 +1300,8 @@ export interface ResponseObject {
|
|
|
1190
1300
|
*/
|
|
1191
1301
|
reasoning?: ResponseObject.Reasoning | null;
|
|
1192
1302
|
|
|
1303
|
+
safety_identifier?: string | null;
|
|
1304
|
+
|
|
1193
1305
|
service_tier?: string;
|
|
1194
1306
|
|
|
1195
1307
|
temperature?: number;
|
|
@@ -1225,7 +1337,11 @@ export interface ResponseObject {
|
|
|
1225
1337
|
|
|
1226
1338
|
top_p?: number;
|
|
1227
1339
|
|
|
1228
|
-
|
|
1340
|
+
/**
|
|
1341
|
+
* Controls how the service truncates input when it exceeds the model context
|
|
1342
|
+
* window.
|
|
1343
|
+
*/
|
|
1344
|
+
truncation?: 'auto' | 'disabled';
|
|
1229
1345
|
|
|
1230
1346
|
/**
|
|
1231
1347
|
* Usage information for OpenAI response.
|
|
@@ -1437,14 +1553,69 @@ export namespace ResponseObject {
|
|
|
1437
1553
|
/**
|
|
1438
1554
|
* Web search tool call output message for OpenAI responses.
|
|
1439
1555
|
*/
|
|
1440
|
-
export interface
|
|
1556
|
+
export interface OpenAIResponseOutputMessageWebSearchToolCallOutput {
|
|
1441
1557
|
id: string;
|
|
1442
1558
|
|
|
1443
1559
|
status: string;
|
|
1444
1560
|
|
|
1561
|
+
/**
|
|
1562
|
+
* Web search action: performs a search query.
|
|
1563
|
+
*/
|
|
1564
|
+
action?:
|
|
1565
|
+
| OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionSearch
|
|
1566
|
+
| OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionOpenPage
|
|
1567
|
+
| OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionFind
|
|
1568
|
+
| null;
|
|
1569
|
+
|
|
1445
1570
|
type?: 'web_search_call';
|
|
1446
1571
|
}
|
|
1447
1572
|
|
|
1573
|
+
export namespace OpenAIResponseOutputMessageWebSearchToolCallOutput {
|
|
1574
|
+
/**
|
|
1575
|
+
* Web search action: performs a search query.
|
|
1576
|
+
*/
|
|
1577
|
+
export interface WebSearchActionSearch {
|
|
1578
|
+
query: string;
|
|
1579
|
+
|
|
1580
|
+
queries?: Array<string> | null;
|
|
1581
|
+
|
|
1582
|
+
sources?: Array<WebSearchActionSearch.Source> | null;
|
|
1583
|
+
|
|
1584
|
+
type?: 'search';
|
|
1585
|
+
}
|
|
1586
|
+
|
|
1587
|
+
export namespace WebSearchActionSearch {
|
|
1588
|
+
/**
|
|
1589
|
+
* A source URL returned by a web search action.
|
|
1590
|
+
*/
|
|
1591
|
+
export interface Source {
|
|
1592
|
+
url: string;
|
|
1593
|
+
|
|
1594
|
+
type?: 'url';
|
|
1595
|
+
}
|
|
1596
|
+
}
|
|
1597
|
+
|
|
1598
|
+
/**
|
|
1599
|
+
* Web search action: opens a specific URL from search results.
|
|
1600
|
+
*/
|
|
1601
|
+
export interface WebSearchActionOpenPage {
|
|
1602
|
+
type?: 'open_page';
|
|
1603
|
+
|
|
1604
|
+
url?: string | null;
|
|
1605
|
+
}
|
|
1606
|
+
|
|
1607
|
+
/**
|
|
1608
|
+
* Web search action: searches for a pattern within a loaded page.
|
|
1609
|
+
*/
|
|
1610
|
+
export interface WebSearchActionFind {
|
|
1611
|
+
pattern: string;
|
|
1612
|
+
|
|
1613
|
+
url: string;
|
|
1614
|
+
|
|
1615
|
+
type?: 'find_in_page';
|
|
1616
|
+
}
|
|
1617
|
+
}
|
|
1618
|
+
|
|
1448
1619
|
/**
|
|
1449
1620
|
* File search tool call output message for OpenAI responses.
|
|
1450
1621
|
*/
|
|
@@ -1695,6 +1866,11 @@ export namespace ResponseObject {
|
|
|
1695
1866
|
export interface Reasoning {
|
|
1696
1867
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | null;
|
|
1697
1868
|
|
|
1869
|
+
/**
|
|
1870
|
+
* @deprecated Deprecated: use 'summary' instead.
|
|
1871
|
+
*/
|
|
1872
|
+
generate_summary?: 'auto' | 'concise' | 'detailed' | null;
|
|
1873
|
+
|
|
1698
1874
|
/**
|
|
1699
1875
|
* Summary mode for reasoning output. One of 'auto', 'concise', or 'detailed'.
|
|
1700
1876
|
*/
|
|
@@ -1788,9 +1964,43 @@ export namespace ResponseObject {
|
|
|
1788
1964
|
* Web search tool configuration for OpenAI response inputs.
|
|
1789
1965
|
*/
|
|
1790
1966
|
export interface OpenAIResponseInputToolWebSearch {
|
|
1791
|
-
|
|
1967
|
+
/**
|
|
1968
|
+
* Domain filters for web search results.
|
|
1969
|
+
*/
|
|
1970
|
+
filters?: OpenAIResponseInputToolWebSearch.Filters | null;
|
|
1971
|
+
|
|
1972
|
+
search_context_size?: 'low' | 'medium' | 'high' | null;
|
|
1792
1973
|
|
|
1793
1974
|
type?: 'web_search' | 'web_search_preview' | 'web_search_preview_2025_03_11' | 'web_search_2025_08_26';
|
|
1975
|
+
|
|
1976
|
+
/**
|
|
1977
|
+
* Approximate user location to refine web search results.
|
|
1978
|
+
*/
|
|
1979
|
+
user_location?: OpenAIResponseInputToolWebSearch.UserLocation | null;
|
|
1980
|
+
}
|
|
1981
|
+
|
|
1982
|
+
export namespace OpenAIResponseInputToolWebSearch {
|
|
1983
|
+
/**
|
|
1984
|
+
* Domain filters for web search results.
|
|
1985
|
+
*/
|
|
1986
|
+
export interface Filters {
|
|
1987
|
+
allowed_domains?: Array<string> | null;
|
|
1988
|
+
}
|
|
1989
|
+
|
|
1990
|
+
/**
|
|
1991
|
+
* Approximate user location to refine web search results.
|
|
1992
|
+
*/
|
|
1993
|
+
export interface UserLocation {
|
|
1994
|
+
city?: string | null;
|
|
1995
|
+
|
|
1996
|
+
country?: string | null;
|
|
1997
|
+
|
|
1998
|
+
region?: string | null;
|
|
1999
|
+
|
|
2000
|
+
timezone?: string | null;
|
|
2001
|
+
|
|
2002
|
+
type?: 'approximate';
|
|
2003
|
+
}
|
|
1794
2004
|
}
|
|
1795
2005
|
|
|
1796
2006
|
/**
|
|
@@ -2059,9 +2269,64 @@ export namespace ResponseObjectStream {
|
|
|
2059
2269
|
|
|
2060
2270
|
status: string;
|
|
2061
2271
|
|
|
2272
|
+
/**
|
|
2273
|
+
* Web search action: performs a search query.
|
|
2274
|
+
*/
|
|
2275
|
+
action?:
|
|
2276
|
+
| OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionSearch
|
|
2277
|
+
| OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionOpenPage
|
|
2278
|
+
| OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionFind
|
|
2279
|
+
| null;
|
|
2280
|
+
|
|
2062
2281
|
type?: 'web_search_call';
|
|
2063
2282
|
}
|
|
2064
2283
|
|
|
2284
|
+
export namespace OpenAIResponseOutputMessageWebSearchToolCall {
|
|
2285
|
+
/**
|
|
2286
|
+
* Web search action: performs a search query.
|
|
2287
|
+
*/
|
|
2288
|
+
export interface WebSearchActionSearch {
|
|
2289
|
+
query: string;
|
|
2290
|
+
|
|
2291
|
+
queries?: Array<string> | null;
|
|
2292
|
+
|
|
2293
|
+
sources?: Array<WebSearchActionSearch.Source> | null;
|
|
2294
|
+
|
|
2295
|
+
type?: 'search';
|
|
2296
|
+
}
|
|
2297
|
+
|
|
2298
|
+
export namespace WebSearchActionSearch {
|
|
2299
|
+
/**
|
|
2300
|
+
* A source URL returned by a web search action.
|
|
2301
|
+
*/
|
|
2302
|
+
export interface Source {
|
|
2303
|
+
url: string;
|
|
2304
|
+
|
|
2305
|
+
type?: 'url';
|
|
2306
|
+
}
|
|
2307
|
+
}
|
|
2308
|
+
|
|
2309
|
+
/**
|
|
2310
|
+
* Web search action: opens a specific URL from search results.
|
|
2311
|
+
*/
|
|
2312
|
+
export interface WebSearchActionOpenPage {
|
|
2313
|
+
type?: 'open_page';
|
|
2314
|
+
|
|
2315
|
+
url?: string | null;
|
|
2316
|
+
}
|
|
2317
|
+
|
|
2318
|
+
/**
|
|
2319
|
+
* Web search action: searches for a pattern within a loaded page.
|
|
2320
|
+
*/
|
|
2321
|
+
export interface WebSearchActionFind {
|
|
2322
|
+
pattern: string;
|
|
2323
|
+
|
|
2324
|
+
url: string;
|
|
2325
|
+
|
|
2326
|
+
type?: 'find_in_page';
|
|
2327
|
+
}
|
|
2328
|
+
}
|
|
2329
|
+
|
|
2065
2330
|
/**
|
|
2066
2331
|
* File search tool call output message for OpenAI responses.
|
|
2067
2332
|
*/
|
|
@@ -2271,9 +2536,64 @@ export namespace ResponseObjectStream {
|
|
|
2271
2536
|
|
|
2272
2537
|
status: string;
|
|
2273
2538
|
|
|
2539
|
+
/**
|
|
2540
|
+
* Web search action: performs a search query.
|
|
2541
|
+
*/
|
|
2542
|
+
action?:
|
|
2543
|
+
| OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionSearch
|
|
2544
|
+
| OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionOpenPage
|
|
2545
|
+
| OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionFind
|
|
2546
|
+
| null;
|
|
2547
|
+
|
|
2274
2548
|
type?: 'web_search_call';
|
|
2275
2549
|
}
|
|
2276
2550
|
|
|
2551
|
+
export namespace OpenAIResponseOutputMessageWebSearchToolCall {
|
|
2552
|
+
/**
|
|
2553
|
+
* Web search action: performs a search query.
|
|
2554
|
+
*/
|
|
2555
|
+
export interface WebSearchActionSearch {
|
|
2556
|
+
query: string;
|
|
2557
|
+
|
|
2558
|
+
queries?: Array<string> | null;
|
|
2559
|
+
|
|
2560
|
+
sources?: Array<WebSearchActionSearch.Source> | null;
|
|
2561
|
+
|
|
2562
|
+
type?: 'search';
|
|
2563
|
+
}
|
|
2564
|
+
|
|
2565
|
+
export namespace WebSearchActionSearch {
|
|
2566
|
+
/**
|
|
2567
|
+
* A source URL returned by a web search action.
|
|
2568
|
+
*/
|
|
2569
|
+
export interface Source {
|
|
2570
|
+
url: string;
|
|
2571
|
+
|
|
2572
|
+
type?: 'url';
|
|
2573
|
+
}
|
|
2574
|
+
}
|
|
2575
|
+
|
|
2576
|
+
/**
|
|
2577
|
+
* Web search action: opens a specific URL from search results.
|
|
2578
|
+
*/
|
|
2579
|
+
export interface WebSearchActionOpenPage {
|
|
2580
|
+
type?: 'open_page';
|
|
2581
|
+
|
|
2582
|
+
url?: string | null;
|
|
2583
|
+
}
|
|
2584
|
+
|
|
2585
|
+
/**
|
|
2586
|
+
* Web search action: searches for a pattern within a loaded page.
|
|
2587
|
+
*/
|
|
2588
|
+
export interface WebSearchActionFind {
|
|
2589
|
+
pattern: string;
|
|
2590
|
+
|
|
2591
|
+
url: string;
|
|
2592
|
+
|
|
2593
|
+
type?: 'find_in_page';
|
|
2594
|
+
}
|
|
2595
|
+
}
|
|
2596
|
+
|
|
2277
2597
|
/**
|
|
2278
2598
|
* File search tool call output message for OpenAI responses.
|
|
2279
2599
|
*/
|
|
@@ -3402,9 +3722,64 @@ export namespace ResponseOutput {
|
|
|
3402
3722
|
|
|
3403
3723
|
status: string;
|
|
3404
3724
|
|
|
3725
|
+
/**
|
|
3726
|
+
* Web search action: performs a search query.
|
|
3727
|
+
*/
|
|
3728
|
+
action?:
|
|
3729
|
+
| OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionSearch
|
|
3730
|
+
| OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionOpenPage
|
|
3731
|
+
| OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionFind
|
|
3732
|
+
| null;
|
|
3733
|
+
|
|
3405
3734
|
type?: 'web_search_call';
|
|
3406
3735
|
}
|
|
3407
3736
|
|
|
3737
|
+
export namespace OpenAIResponseOutputMessageWebSearchToolCall {
|
|
3738
|
+
/**
|
|
3739
|
+
* Web search action: performs a search query.
|
|
3740
|
+
*/
|
|
3741
|
+
export interface WebSearchActionSearch {
|
|
3742
|
+
query: string;
|
|
3743
|
+
|
|
3744
|
+
queries?: Array<string> | null;
|
|
3745
|
+
|
|
3746
|
+
sources?: Array<WebSearchActionSearch.Source> | null;
|
|
3747
|
+
|
|
3748
|
+
type?: 'search';
|
|
3749
|
+
}
|
|
3750
|
+
|
|
3751
|
+
export namespace WebSearchActionSearch {
|
|
3752
|
+
/**
|
|
3753
|
+
* A source URL returned by a web search action.
|
|
3754
|
+
*/
|
|
3755
|
+
export interface Source {
|
|
3756
|
+
url: string;
|
|
3757
|
+
|
|
3758
|
+
type?: 'url';
|
|
3759
|
+
}
|
|
3760
|
+
}
|
|
3761
|
+
|
|
3762
|
+
/**
|
|
3763
|
+
* Web search action: opens a specific URL from search results.
|
|
3764
|
+
*/
|
|
3765
|
+
export interface WebSearchActionOpenPage {
|
|
3766
|
+
type?: 'open_page';
|
|
3767
|
+
|
|
3768
|
+
url?: string | null;
|
|
3769
|
+
}
|
|
3770
|
+
|
|
3771
|
+
/**
|
|
3772
|
+
* Web search action: searches for a pattern within a loaded page.
|
|
3773
|
+
*/
|
|
3774
|
+
export interface WebSearchActionFind {
|
|
3775
|
+
pattern: string;
|
|
3776
|
+
|
|
3777
|
+
url: string;
|
|
3778
|
+
|
|
3779
|
+
type?: 'find_in_page';
|
|
3780
|
+
}
|
|
3781
|
+
}
|
|
3782
|
+
|
|
3408
3783
|
/**
|
|
3409
3784
|
* File search tool call output message for OpenAI responses.
|
|
3410
3785
|
*/
|
|
@@ -3587,7 +3962,7 @@ export interface ResponseListResponse {
|
|
|
3587
3962
|
|
|
3588
3963
|
input: Array<
|
|
3589
3964
|
| ResponseListResponse.OpenAIResponseMessageOutput
|
|
3590
|
-
| ResponseListResponse.
|
|
3965
|
+
| ResponseListResponse.OpenAIResponseOutputMessageWebSearchToolCallOutput
|
|
3591
3966
|
| ResponseListResponse.OpenAIResponseOutputMessageFileSearchToolCall
|
|
3592
3967
|
| ResponseListResponse.OpenAIResponseOutputMessageFunctionToolCall
|
|
3593
3968
|
| ResponseListResponse.OpenAIResponseOutputMessageMcpCall
|
|
@@ -3603,7 +3978,7 @@ export interface ResponseListResponse {
|
|
|
3603
3978
|
|
|
3604
3979
|
output: Array<
|
|
3605
3980
|
| ResponseListResponse.OpenAIResponseMessageOutput
|
|
3606
|
-
| ResponseListResponse.
|
|
3981
|
+
| ResponseListResponse.OpenAIResponseOutputMessageWebSearchToolCallOutput
|
|
3607
3982
|
| ResponseListResponse.OpenAIResponseOutputMessageFileSearchToolCall
|
|
3608
3983
|
| ResponseListResponse.OpenAIResponseOutputMessageFunctionToolCall
|
|
3609
3984
|
| ResponseListResponse.OpenAIResponseOutputMessageMcpCall
|
|
@@ -3662,6 +4037,8 @@ export interface ResponseListResponse {
|
|
|
3662
4037
|
*/
|
|
3663
4038
|
reasoning?: ResponseListResponse.Reasoning | null;
|
|
3664
4039
|
|
|
4040
|
+
safety_identifier?: string | null;
|
|
4041
|
+
|
|
3665
4042
|
service_tier?: string;
|
|
3666
4043
|
|
|
3667
4044
|
temperature?: number;
|
|
@@ -3697,7 +4074,11 @@ export interface ResponseListResponse {
|
|
|
3697
4074
|
|
|
3698
4075
|
top_p?: number;
|
|
3699
4076
|
|
|
3700
|
-
|
|
4077
|
+
/**
|
|
4078
|
+
* Controls how the service truncates input when it exceeds the model context
|
|
4079
|
+
* window.
|
|
4080
|
+
*/
|
|
4081
|
+
truncation?: 'auto' | 'disabled' | null;
|
|
3701
4082
|
|
|
3702
4083
|
/**
|
|
3703
4084
|
* Usage information for OpenAI response.
|
|
@@ -3909,14 +4290,69 @@ export namespace ResponseListResponse {
|
|
|
3909
4290
|
/**
|
|
3910
4291
|
* Web search tool call output message for OpenAI responses.
|
|
3911
4292
|
*/
|
|
3912
|
-
export interface
|
|
4293
|
+
export interface OpenAIResponseOutputMessageWebSearchToolCallOutput {
|
|
3913
4294
|
id: string;
|
|
3914
4295
|
|
|
3915
4296
|
status: string;
|
|
3916
4297
|
|
|
4298
|
+
/**
|
|
4299
|
+
* Web search action: performs a search query.
|
|
4300
|
+
*/
|
|
4301
|
+
action?:
|
|
4302
|
+
| OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionSearch
|
|
4303
|
+
| OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionOpenPage
|
|
4304
|
+
| OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionFind
|
|
4305
|
+
| null;
|
|
4306
|
+
|
|
3917
4307
|
type?: 'web_search_call';
|
|
3918
4308
|
}
|
|
3919
4309
|
|
|
4310
|
+
export namespace OpenAIResponseOutputMessageWebSearchToolCallOutput {
|
|
4311
|
+
/**
|
|
4312
|
+
* Web search action: performs a search query.
|
|
4313
|
+
*/
|
|
4314
|
+
export interface WebSearchActionSearch {
|
|
4315
|
+
query: string;
|
|
4316
|
+
|
|
4317
|
+
queries?: Array<string> | null;
|
|
4318
|
+
|
|
4319
|
+
sources?: Array<WebSearchActionSearch.Source> | null;
|
|
4320
|
+
|
|
4321
|
+
type?: 'search';
|
|
4322
|
+
}
|
|
4323
|
+
|
|
4324
|
+
export namespace WebSearchActionSearch {
|
|
4325
|
+
/**
|
|
4326
|
+
* A source URL returned by a web search action.
|
|
4327
|
+
*/
|
|
4328
|
+
export interface Source {
|
|
4329
|
+
url: string;
|
|
4330
|
+
|
|
4331
|
+
type?: 'url';
|
|
4332
|
+
}
|
|
4333
|
+
}
|
|
4334
|
+
|
|
4335
|
+
/**
|
|
4336
|
+
* Web search action: opens a specific URL from search results.
|
|
4337
|
+
*/
|
|
4338
|
+
export interface WebSearchActionOpenPage {
|
|
4339
|
+
type?: 'open_page';
|
|
4340
|
+
|
|
4341
|
+
url?: string | null;
|
|
4342
|
+
}
|
|
4343
|
+
|
|
4344
|
+
/**
|
|
4345
|
+
* Web search action: searches for a pattern within a loaded page.
|
|
4346
|
+
*/
|
|
4347
|
+
export interface WebSearchActionFind {
|
|
4348
|
+
pattern: string;
|
|
4349
|
+
|
|
4350
|
+
url: string;
|
|
4351
|
+
|
|
4352
|
+
type?: 'find_in_page';
|
|
4353
|
+
}
|
|
4354
|
+
}
|
|
4355
|
+
|
|
3920
4356
|
/**
|
|
3921
4357
|
* File search tool call output message for OpenAI responses.
|
|
3922
4358
|
*/
|
|
@@ -4378,14 +4814,69 @@ export namespace ResponseListResponse {
|
|
|
4378
4814
|
/**
|
|
4379
4815
|
* Web search tool call output message for OpenAI responses.
|
|
4380
4816
|
*/
|
|
4381
|
-
export interface
|
|
4817
|
+
export interface OpenAIResponseOutputMessageWebSearchToolCallOutput {
|
|
4382
4818
|
id: string;
|
|
4383
4819
|
|
|
4384
4820
|
status: string;
|
|
4385
4821
|
|
|
4822
|
+
/**
|
|
4823
|
+
* Web search action: performs a search query.
|
|
4824
|
+
*/
|
|
4825
|
+
action?:
|
|
4826
|
+
| OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionSearch
|
|
4827
|
+
| OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionOpenPage
|
|
4828
|
+
| OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionFind
|
|
4829
|
+
| null;
|
|
4830
|
+
|
|
4386
4831
|
type?: 'web_search_call';
|
|
4387
4832
|
}
|
|
4388
4833
|
|
|
4834
|
+
export namespace OpenAIResponseOutputMessageWebSearchToolCallOutput {
|
|
4835
|
+
/**
|
|
4836
|
+
* Web search action: performs a search query.
|
|
4837
|
+
*/
|
|
4838
|
+
export interface WebSearchActionSearch {
|
|
4839
|
+
query: string;
|
|
4840
|
+
|
|
4841
|
+
queries?: Array<string> | null;
|
|
4842
|
+
|
|
4843
|
+
sources?: Array<WebSearchActionSearch.Source> | null;
|
|
4844
|
+
|
|
4845
|
+
type?: 'search';
|
|
4846
|
+
}
|
|
4847
|
+
|
|
4848
|
+
export namespace WebSearchActionSearch {
|
|
4849
|
+
/**
|
|
4850
|
+
* A source URL returned by a web search action.
|
|
4851
|
+
*/
|
|
4852
|
+
export interface Source {
|
|
4853
|
+
url: string;
|
|
4854
|
+
|
|
4855
|
+
type?: 'url';
|
|
4856
|
+
}
|
|
4857
|
+
}
|
|
4858
|
+
|
|
4859
|
+
/**
|
|
4860
|
+
* Web search action: opens a specific URL from search results.
|
|
4861
|
+
*/
|
|
4862
|
+
export interface WebSearchActionOpenPage {
|
|
4863
|
+
type?: 'open_page';
|
|
4864
|
+
|
|
4865
|
+
url?: string | null;
|
|
4866
|
+
}
|
|
4867
|
+
|
|
4868
|
+
/**
|
|
4869
|
+
* Web search action: searches for a pattern within a loaded page.
|
|
4870
|
+
*/
|
|
4871
|
+
export interface WebSearchActionFind {
|
|
4872
|
+
pattern: string;
|
|
4873
|
+
|
|
4874
|
+
url: string;
|
|
4875
|
+
|
|
4876
|
+
type?: 'find_in_page';
|
|
4877
|
+
}
|
|
4878
|
+
}
|
|
4879
|
+
|
|
4389
4880
|
/**
|
|
4390
4881
|
* File search tool call output message for OpenAI responses.
|
|
4391
4882
|
*/
|
|
@@ -4636,6 +5127,11 @@ export namespace ResponseListResponse {
|
|
|
4636
5127
|
export interface Reasoning {
|
|
4637
5128
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | null;
|
|
4638
5129
|
|
|
5130
|
+
/**
|
|
5131
|
+
* @deprecated Deprecated: use 'summary' instead.
|
|
5132
|
+
*/
|
|
5133
|
+
generate_summary?: 'auto' | 'concise' | 'detailed' | null;
|
|
5134
|
+
|
|
4639
5135
|
/**
|
|
4640
5136
|
* Summary mode for reasoning output. One of 'auto', 'concise', or 'detailed'.
|
|
4641
5137
|
*/
|
|
@@ -4729,9 +5225,43 @@ export namespace ResponseListResponse {
|
|
|
4729
5225
|
* Web search tool configuration for OpenAI response inputs.
|
|
4730
5226
|
*/
|
|
4731
5227
|
export interface OpenAIResponseInputToolWebSearch {
|
|
4732
|
-
|
|
5228
|
+
/**
|
|
5229
|
+
* Domain filters for web search results.
|
|
5230
|
+
*/
|
|
5231
|
+
filters?: OpenAIResponseInputToolWebSearch.Filters | null;
|
|
5232
|
+
|
|
5233
|
+
search_context_size?: 'low' | 'medium' | 'high' | null;
|
|
4733
5234
|
|
|
4734
5235
|
type?: 'web_search' | 'web_search_preview' | 'web_search_preview_2025_03_11' | 'web_search_2025_08_26';
|
|
5236
|
+
|
|
5237
|
+
/**
|
|
5238
|
+
* Approximate user location to refine web search results.
|
|
5239
|
+
*/
|
|
5240
|
+
user_location?: OpenAIResponseInputToolWebSearch.UserLocation | null;
|
|
5241
|
+
}
|
|
5242
|
+
|
|
5243
|
+
export namespace OpenAIResponseInputToolWebSearch {
|
|
5244
|
+
/**
|
|
5245
|
+
* Domain filters for web search results.
|
|
5246
|
+
*/
|
|
5247
|
+
export interface Filters {
|
|
5248
|
+
allowed_domains?: Array<string> | null;
|
|
5249
|
+
}
|
|
5250
|
+
|
|
5251
|
+
/**
|
|
5252
|
+
* Approximate user location to refine web search results.
|
|
5253
|
+
*/
|
|
5254
|
+
export interface UserLocation {
|
|
5255
|
+
city?: string | null;
|
|
5256
|
+
|
|
5257
|
+
country?: string | null;
|
|
5258
|
+
|
|
5259
|
+
region?: string | null;
|
|
5260
|
+
|
|
5261
|
+
timezone?: string | null;
|
|
5262
|
+
|
|
5263
|
+
type?: 'approximate';
|
|
5264
|
+
}
|
|
4735
5265
|
}
|
|
4736
5266
|
|
|
4737
5267
|
/**
|
|
@@ -4913,7 +5443,7 @@ export interface ResponseCreateParamsBase {
|
|
|
4913
5443
|
| string
|
|
4914
5444
|
| Array<
|
|
4915
5445
|
| ResponseCreateParams.OpenAIResponseMessageInput
|
|
4916
|
-
| ResponseCreateParams.
|
|
5446
|
+
| ResponseCreateParams.OpenAIResponseOutputMessageWebSearchToolCallInput
|
|
4917
5447
|
| ResponseCreateParams.OpenAIResponseOutputMessageFileSearchToolCall
|
|
4918
5448
|
| ResponseCreateParams.OpenAIResponseOutputMessageFunctionToolCall
|
|
4919
5449
|
| ResponseCreateParams.OpenAIResponseOutputMessageMcpCall
|
|
@@ -5022,6 +5552,12 @@ export interface ResponseCreateParamsBase {
|
|
|
5022
5552
|
*/
|
|
5023
5553
|
reasoning?: ResponseCreateParams.Reasoning | null;
|
|
5024
5554
|
|
|
5555
|
+
/**
|
|
5556
|
+
* A stable identifier used to associate the request with an end user, for safety
|
|
5557
|
+
* monitoring. Echoed back on the response.
|
|
5558
|
+
*/
|
|
5559
|
+
safety_identifier?: string | null;
|
|
5560
|
+
|
|
5025
5561
|
/**
|
|
5026
5562
|
* The service tier for the request.
|
|
5027
5563
|
*/
|
|
@@ -5093,7 +5629,7 @@ export interface ResponseCreateParamsBase {
|
|
|
5093
5629
|
* Controls how the service truncates input when it exceeds the model context
|
|
5094
5630
|
* window.
|
|
5095
5631
|
*/
|
|
5096
|
-
truncation?: 'auto' | 'disabled'
|
|
5632
|
+
truncation?: 'auto' | 'disabled';
|
|
5097
5633
|
|
|
5098
5634
|
[k: string]: unknown;
|
|
5099
5635
|
}
|
|
@@ -5302,14 +5838,69 @@ export namespace ResponseCreateParams {
|
|
|
5302
5838
|
/**
|
|
5303
5839
|
* Web search tool call output message for OpenAI responses.
|
|
5304
5840
|
*/
|
|
5305
|
-
export interface
|
|
5841
|
+
export interface OpenAIResponseOutputMessageWebSearchToolCallInput {
|
|
5306
5842
|
id: string;
|
|
5307
5843
|
|
|
5308
5844
|
status: string;
|
|
5309
5845
|
|
|
5846
|
+
/**
|
|
5847
|
+
* Web search action: performs a search query.
|
|
5848
|
+
*/
|
|
5849
|
+
action?:
|
|
5850
|
+
| OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionSearch
|
|
5851
|
+
| OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionOpenPage
|
|
5852
|
+
| OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionFind
|
|
5853
|
+
| null;
|
|
5854
|
+
|
|
5310
5855
|
type?: 'web_search_call';
|
|
5311
5856
|
}
|
|
5312
5857
|
|
|
5858
|
+
export namespace OpenAIResponseOutputMessageWebSearchToolCallInput {
|
|
5859
|
+
/**
|
|
5860
|
+
* Web search action: performs a search query.
|
|
5861
|
+
*/
|
|
5862
|
+
export interface WebSearchActionSearch {
|
|
5863
|
+
query: string;
|
|
5864
|
+
|
|
5865
|
+
queries?: Array<string> | null;
|
|
5866
|
+
|
|
5867
|
+
sources?: Array<WebSearchActionSearch.Source> | null;
|
|
5868
|
+
|
|
5869
|
+
type?: 'search';
|
|
5870
|
+
}
|
|
5871
|
+
|
|
5872
|
+
export namespace WebSearchActionSearch {
|
|
5873
|
+
/**
|
|
5874
|
+
* A source URL returned by a web search action.
|
|
5875
|
+
*/
|
|
5876
|
+
export interface Source {
|
|
5877
|
+
url: string;
|
|
5878
|
+
|
|
5879
|
+
type?: 'url';
|
|
5880
|
+
}
|
|
5881
|
+
}
|
|
5882
|
+
|
|
5883
|
+
/**
|
|
5884
|
+
* Web search action: opens a specific URL from search results.
|
|
5885
|
+
*/
|
|
5886
|
+
export interface WebSearchActionOpenPage {
|
|
5887
|
+
type?: 'open_page';
|
|
5888
|
+
|
|
5889
|
+
url?: string | null;
|
|
5890
|
+
}
|
|
5891
|
+
|
|
5892
|
+
/**
|
|
5893
|
+
* Web search action: searches for a pattern within a loaded page.
|
|
5894
|
+
*/
|
|
5895
|
+
export interface WebSearchActionFind {
|
|
5896
|
+
pattern: string;
|
|
5897
|
+
|
|
5898
|
+
url: string;
|
|
5899
|
+
|
|
5900
|
+
type?: 'find_in_page';
|
|
5901
|
+
}
|
|
5902
|
+
}
|
|
5903
|
+
|
|
5313
5904
|
/**
|
|
5314
5905
|
* File search tool call output message for OpenAI responses.
|
|
5315
5906
|
*/
|
|
@@ -5646,6 +6237,11 @@ export namespace ResponseCreateParams {
|
|
|
5646
6237
|
export interface Reasoning {
|
|
5647
6238
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | null;
|
|
5648
6239
|
|
|
6240
|
+
/**
|
|
6241
|
+
* @deprecated Deprecated: use 'summary' instead.
|
|
6242
|
+
*/
|
|
6243
|
+
generate_summary?: 'auto' | 'concise' | 'detailed' | null;
|
|
6244
|
+
|
|
5649
6245
|
/**
|
|
5650
6246
|
* Summary mode for reasoning output. One of 'auto', 'concise', or 'detailed'.
|
|
5651
6247
|
*/
|
|
@@ -5749,9 +6345,43 @@ export namespace ResponseCreateParams {
|
|
|
5749
6345
|
* Web search tool configuration for OpenAI response inputs.
|
|
5750
6346
|
*/
|
|
5751
6347
|
export interface OpenAIResponseInputToolWebSearch {
|
|
5752
|
-
|
|
6348
|
+
/**
|
|
6349
|
+
* Domain filters for web search results.
|
|
6350
|
+
*/
|
|
6351
|
+
filters?: OpenAIResponseInputToolWebSearch.Filters | null;
|
|
6352
|
+
|
|
6353
|
+
search_context_size?: 'low' | 'medium' | 'high' | null;
|
|
5753
6354
|
|
|
5754
6355
|
type?: 'web_search' | 'web_search_preview' | 'web_search_preview_2025_03_11' | 'web_search_2025_08_26';
|
|
6356
|
+
|
|
6357
|
+
/**
|
|
6358
|
+
* Approximate user location to refine web search results.
|
|
6359
|
+
*/
|
|
6360
|
+
user_location?: OpenAIResponseInputToolWebSearch.UserLocation | null;
|
|
6361
|
+
}
|
|
6362
|
+
|
|
6363
|
+
export namespace OpenAIResponseInputToolWebSearch {
|
|
6364
|
+
/**
|
|
6365
|
+
* Domain filters for web search results.
|
|
6366
|
+
*/
|
|
6367
|
+
export interface Filters {
|
|
6368
|
+
allowed_domains?: Array<string> | null;
|
|
6369
|
+
}
|
|
6370
|
+
|
|
6371
|
+
/**
|
|
6372
|
+
* Approximate user location to refine web search results.
|
|
6373
|
+
*/
|
|
6374
|
+
export interface UserLocation {
|
|
6375
|
+
city?: string | null;
|
|
6376
|
+
|
|
6377
|
+
country?: string | null;
|
|
6378
|
+
|
|
6379
|
+
region?: string | null;
|
|
6380
|
+
|
|
6381
|
+
timezone?: string | null;
|
|
6382
|
+
|
|
6383
|
+
type?: 'approximate';
|
|
6384
|
+
}
|
|
5755
6385
|
}
|
|
5756
6386
|
|
|
5757
6387
|
/**
|
|
@@ -5932,9 +6562,9 @@ export interface ResponseListParams extends OpenAICursorPageParams {
|
|
|
5932
6562
|
|
|
5933
6563
|
export interface ResponseCompactParams {
|
|
5934
6564
|
/**
|
|
5935
|
-
*
|
|
6565
|
+
* Model identifier.
|
|
5936
6566
|
*/
|
|
5937
|
-
model: string;
|
|
6567
|
+
model: string | null;
|
|
5938
6568
|
|
|
5939
6569
|
/**
|
|
5940
6570
|
* Input message(s) to compact.
|
|
@@ -5943,7 +6573,7 @@ export interface ResponseCompactParams {
|
|
|
5943
6573
|
| string
|
|
5944
6574
|
| Array<
|
|
5945
6575
|
| ResponseCompactParams.OpenAIResponseMessageInput
|
|
5946
|
-
| ResponseCompactParams.
|
|
6576
|
+
| ResponseCompactParams.OpenAIResponseOutputMessageWebSearchToolCallInput
|
|
5947
6577
|
| ResponseCompactParams.OpenAIResponseOutputMessageFileSearchToolCall
|
|
5948
6578
|
| ResponseCompactParams.OpenAIResponseOutputMessageFunctionToolCall
|
|
5949
6579
|
| ResponseCompactParams.OpenAIResponseOutputMessageMcpCall
|
|
@@ -6207,14 +6837,69 @@ export namespace ResponseCompactParams {
|
|
|
6207
6837
|
/**
|
|
6208
6838
|
* Web search tool call output message for OpenAI responses.
|
|
6209
6839
|
*/
|
|
6210
|
-
export interface
|
|
6840
|
+
export interface OpenAIResponseOutputMessageWebSearchToolCallInput {
|
|
6211
6841
|
id: string;
|
|
6212
6842
|
|
|
6213
6843
|
status: string;
|
|
6214
6844
|
|
|
6845
|
+
/**
|
|
6846
|
+
* Web search action: performs a search query.
|
|
6847
|
+
*/
|
|
6848
|
+
action?:
|
|
6849
|
+
| OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionSearch
|
|
6850
|
+
| OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionOpenPage
|
|
6851
|
+
| OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionFind
|
|
6852
|
+
| null;
|
|
6853
|
+
|
|
6215
6854
|
type?: 'web_search_call';
|
|
6216
6855
|
}
|
|
6217
6856
|
|
|
6857
|
+
export namespace OpenAIResponseOutputMessageWebSearchToolCallInput {
|
|
6858
|
+
/**
|
|
6859
|
+
* Web search action: performs a search query.
|
|
6860
|
+
*/
|
|
6861
|
+
export interface WebSearchActionSearch {
|
|
6862
|
+
query: string;
|
|
6863
|
+
|
|
6864
|
+
queries?: Array<string> | null;
|
|
6865
|
+
|
|
6866
|
+
sources?: Array<WebSearchActionSearch.Source> | null;
|
|
6867
|
+
|
|
6868
|
+
type?: 'search';
|
|
6869
|
+
}
|
|
6870
|
+
|
|
6871
|
+
export namespace WebSearchActionSearch {
|
|
6872
|
+
/**
|
|
6873
|
+
* A source URL returned by a web search action.
|
|
6874
|
+
*/
|
|
6875
|
+
export interface Source {
|
|
6876
|
+
url: string;
|
|
6877
|
+
|
|
6878
|
+
type?: 'url';
|
|
6879
|
+
}
|
|
6880
|
+
}
|
|
6881
|
+
|
|
6882
|
+
/**
|
|
6883
|
+
* Web search action: opens a specific URL from search results.
|
|
6884
|
+
*/
|
|
6885
|
+
export interface WebSearchActionOpenPage {
|
|
6886
|
+
type?: 'open_page';
|
|
6887
|
+
|
|
6888
|
+
url?: string | null;
|
|
6889
|
+
}
|
|
6890
|
+
|
|
6891
|
+
/**
|
|
6892
|
+
* Web search action: searches for a pattern within a loaded page.
|
|
6893
|
+
*/
|
|
6894
|
+
export interface WebSearchActionFind {
|
|
6895
|
+
pattern: string;
|
|
6896
|
+
|
|
6897
|
+
url: string;
|
|
6898
|
+
|
|
6899
|
+
type?: 'find_in_page';
|
|
6900
|
+
}
|
|
6901
|
+
}
|
|
6902
|
+
|
|
6218
6903
|
/**
|
|
6219
6904
|
* File search tool call output message for OpenAI responses.
|
|
6220
6905
|
*/
|
|
@@ -6481,6 +7166,11 @@ export namespace ResponseCompactParams {
|
|
|
6481
7166
|
export interface Reasoning {
|
|
6482
7167
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | null;
|
|
6483
7168
|
|
|
7169
|
+
/**
|
|
7170
|
+
* @deprecated Deprecated: use 'summary' instead.
|
|
7171
|
+
*/
|
|
7172
|
+
generate_summary?: 'auto' | 'concise' | 'detailed' | null;
|
|
7173
|
+
|
|
6484
7174
|
/**
|
|
6485
7175
|
* Summary mode for reasoning output. One of 'auto', 'concise', or 'detailed'.
|
|
6486
7176
|
*/
|
|
@@ -6520,9 +7210,43 @@ export namespace ResponseCompactParams {
|
|
|
6520
7210
|
* Web search tool configuration for OpenAI response inputs.
|
|
6521
7211
|
*/
|
|
6522
7212
|
export interface OpenAIResponseInputToolWebSearch {
|
|
6523
|
-
|
|
7213
|
+
/**
|
|
7214
|
+
* Domain filters for web search results.
|
|
7215
|
+
*/
|
|
7216
|
+
filters?: OpenAIResponseInputToolWebSearch.Filters | null;
|
|
7217
|
+
|
|
7218
|
+
search_context_size?: 'low' | 'medium' | 'high' | null;
|
|
6524
7219
|
|
|
6525
7220
|
type?: 'web_search' | 'web_search_preview' | 'web_search_preview_2025_03_11' | 'web_search_2025_08_26';
|
|
7221
|
+
|
|
7222
|
+
/**
|
|
7223
|
+
* Approximate user location to refine web search results.
|
|
7224
|
+
*/
|
|
7225
|
+
user_location?: OpenAIResponseInputToolWebSearch.UserLocation | null;
|
|
7226
|
+
}
|
|
7227
|
+
|
|
7228
|
+
export namespace OpenAIResponseInputToolWebSearch {
|
|
7229
|
+
/**
|
|
7230
|
+
* Domain filters for web search results.
|
|
7231
|
+
*/
|
|
7232
|
+
export interface Filters {
|
|
7233
|
+
allowed_domains?: Array<string> | null;
|
|
7234
|
+
}
|
|
7235
|
+
|
|
7236
|
+
/**
|
|
7237
|
+
* Approximate user location to refine web search results.
|
|
7238
|
+
*/
|
|
7239
|
+
export interface UserLocation {
|
|
7240
|
+
city?: string | null;
|
|
7241
|
+
|
|
7242
|
+
country?: string | null;
|
|
7243
|
+
|
|
7244
|
+
region?: string | null;
|
|
7245
|
+
|
|
7246
|
+
timezone?: string | null;
|
|
7247
|
+
|
|
7248
|
+
type?: 'approximate';
|
|
7249
|
+
}
|
|
6526
7250
|
}
|
|
6527
7251
|
|
|
6528
7252
|
/**
|