ogx-client 1.0.1 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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
|
@@ -44,7 +44,7 @@ export declare class ResponseListResponsesOpenAICursorPage extends OpenAICursorP
|
|
|
44
44
|
export interface CompactedResponse {
|
|
45
45
|
id: string;
|
|
46
46
|
created_at: number;
|
|
47
|
-
output: Array<CompactedResponse.OpenAIResponseMessageOutput | CompactedResponse.
|
|
47
|
+
output: Array<CompactedResponse.OpenAIResponseMessageOutput | CompactedResponse.OpenAIResponseOutputMessageWebSearchToolCallOutput | CompactedResponse.OpenAIResponseOutputMessageFileSearchToolCall | CompactedResponse.OpenAIResponseOutputMessageFunctionToolCall | CompactedResponse.OpenAIResponseOutputMessageMcpCall | CompactedResponse.OpenAIResponseOutputMessageMcpListTools | CompactedResponse.OpenAIResponseMcpApprovalRequest | CompactedResponse.OpenAIResponseOutputMessageReasoningItem | CompactedResponse.OpenAIResponseInputFunctionToolCallOutput | CompactedResponse.OpenAIResponseMcpApprovalResponse | CompactedResponse.OpenAIResponseCompaction>;
|
|
48
48
|
/**
|
|
49
49
|
* Usage information for OpenAI response.
|
|
50
50
|
*/
|
|
@@ -193,11 +193,50 @@ export declare namespace CompactedResponse {
|
|
|
193
193
|
/**
|
|
194
194
|
* Web search tool call output message for OpenAI responses.
|
|
195
195
|
*/
|
|
196
|
-
interface
|
|
196
|
+
interface OpenAIResponseOutputMessageWebSearchToolCallOutput {
|
|
197
197
|
id: string;
|
|
198
198
|
status: string;
|
|
199
|
+
/**
|
|
200
|
+
* Web search action: performs a search query.
|
|
201
|
+
*/
|
|
202
|
+
action?: OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionSearch | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionOpenPage | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionFind | null;
|
|
199
203
|
type?: 'web_search_call';
|
|
200
204
|
}
|
|
205
|
+
namespace OpenAIResponseOutputMessageWebSearchToolCallOutput {
|
|
206
|
+
/**
|
|
207
|
+
* Web search action: performs a search query.
|
|
208
|
+
*/
|
|
209
|
+
interface WebSearchActionSearch {
|
|
210
|
+
query: string;
|
|
211
|
+
queries?: Array<string> | null;
|
|
212
|
+
sources?: Array<WebSearchActionSearch.Source> | null;
|
|
213
|
+
type?: 'search';
|
|
214
|
+
}
|
|
215
|
+
namespace WebSearchActionSearch {
|
|
216
|
+
/**
|
|
217
|
+
* A source URL returned by a web search action.
|
|
218
|
+
*/
|
|
219
|
+
interface Source {
|
|
220
|
+
url: string;
|
|
221
|
+
type?: 'url';
|
|
222
|
+
}
|
|
223
|
+
}
|
|
224
|
+
/**
|
|
225
|
+
* Web search action: opens a specific URL from search results.
|
|
226
|
+
*/
|
|
227
|
+
interface WebSearchActionOpenPage {
|
|
228
|
+
type?: 'open_page';
|
|
229
|
+
url?: string | null;
|
|
230
|
+
}
|
|
231
|
+
/**
|
|
232
|
+
* Web search action: searches for a pattern within a loaded page.
|
|
233
|
+
*/
|
|
234
|
+
interface WebSearchActionFind {
|
|
235
|
+
pattern: string;
|
|
236
|
+
url: string;
|
|
237
|
+
type?: 'find_in_page';
|
|
238
|
+
}
|
|
239
|
+
}
|
|
201
240
|
/**
|
|
202
241
|
* File search tool call output message for OpenAI responses.
|
|
203
242
|
*/
|
|
@@ -430,8 +469,47 @@ export declare namespace ResponseInput {
|
|
|
430
469
|
interface OpenAIResponseOutputMessageWebSearchToolCall {
|
|
431
470
|
id: string;
|
|
432
471
|
status: string;
|
|
472
|
+
/**
|
|
473
|
+
* Web search action: performs a search query.
|
|
474
|
+
*/
|
|
475
|
+
action?: OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionSearch | OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionOpenPage | OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionFind | null;
|
|
433
476
|
type?: 'web_search_call';
|
|
434
477
|
}
|
|
478
|
+
namespace OpenAIResponseOutputMessageWebSearchToolCall {
|
|
479
|
+
/**
|
|
480
|
+
* Web search action: performs a search query.
|
|
481
|
+
*/
|
|
482
|
+
interface WebSearchActionSearch {
|
|
483
|
+
query: string;
|
|
484
|
+
queries?: Array<string> | null;
|
|
485
|
+
sources?: Array<WebSearchActionSearch.Source> | null;
|
|
486
|
+
type?: 'search';
|
|
487
|
+
}
|
|
488
|
+
namespace WebSearchActionSearch {
|
|
489
|
+
/**
|
|
490
|
+
* A source URL returned by a web search action.
|
|
491
|
+
*/
|
|
492
|
+
interface Source {
|
|
493
|
+
url: string;
|
|
494
|
+
type?: 'url';
|
|
495
|
+
}
|
|
496
|
+
}
|
|
497
|
+
/**
|
|
498
|
+
* Web search action: opens a specific URL from search results.
|
|
499
|
+
*/
|
|
500
|
+
interface WebSearchActionOpenPage {
|
|
501
|
+
type?: 'open_page';
|
|
502
|
+
url?: string | null;
|
|
503
|
+
}
|
|
504
|
+
/**
|
|
505
|
+
* Web search action: searches for a pattern within a loaded page.
|
|
506
|
+
*/
|
|
507
|
+
interface WebSearchActionFind {
|
|
508
|
+
pattern: string;
|
|
509
|
+
url: string;
|
|
510
|
+
type?: 'find_in_page';
|
|
511
|
+
}
|
|
512
|
+
}
|
|
435
513
|
/**
|
|
436
514
|
* File search tool call output message for OpenAI responses.
|
|
437
515
|
*/
|
|
@@ -766,7 +844,7 @@ export interface ResponseObject {
|
|
|
766
844
|
id: string;
|
|
767
845
|
created_at: number;
|
|
768
846
|
model: string;
|
|
769
|
-
output: Array<ResponseObject.OpenAIResponseMessageOutput | ResponseObject.
|
|
847
|
+
output: Array<ResponseObject.OpenAIResponseMessageOutput | ResponseObject.OpenAIResponseOutputMessageWebSearchToolCallOutput | ResponseObject.OpenAIResponseOutputMessageFileSearchToolCall | ResponseObject.OpenAIResponseOutputMessageFunctionToolCall | ResponseObject.OpenAIResponseOutputMessageMcpCall | ResponseObject.OpenAIResponseOutputMessageMcpListTools | ResponseObject.OpenAIResponseMcpApprovalRequest | ResponseObject.OpenAIResponseOutputMessageReasoningItem>;
|
|
770
848
|
status: string;
|
|
771
849
|
store: boolean;
|
|
772
850
|
background?: boolean;
|
|
@@ -783,9 +861,7 @@ export interface ResponseObject {
|
|
|
783
861
|
instructions?: string | null;
|
|
784
862
|
max_output_tokens?: number | null;
|
|
785
863
|
max_tool_calls?: number | null;
|
|
786
|
-
metadata?:
|
|
787
|
-
[key: string]: string;
|
|
788
|
-
} | null;
|
|
864
|
+
metadata?: unknown;
|
|
789
865
|
object?: 'response';
|
|
790
866
|
parallel_tool_calls?: boolean;
|
|
791
867
|
presence_penalty?: number;
|
|
@@ -801,6 +877,7 @@ export interface ResponseObject {
|
|
|
801
877
|
* Controls how much reasoning the model performs before generating a response.
|
|
802
878
|
*/
|
|
803
879
|
reasoning?: ResponseObject.Reasoning | null;
|
|
880
|
+
safety_identifier?: string | null;
|
|
804
881
|
service_tier?: string;
|
|
805
882
|
temperature?: number;
|
|
806
883
|
/**
|
|
@@ -814,7 +891,11 @@ export interface ResponseObject {
|
|
|
814
891
|
tools?: Array<ResponseObject.OpenAIResponseInputToolWebSearch | ResponseObject.OpenAIResponseInputToolFileSearch | ResponseObject.OpenAIResponseInputToolFunction | ResponseObject.OpenAIResponseToolMcp>;
|
|
815
892
|
top_logprobs?: number;
|
|
816
893
|
top_p?: number;
|
|
817
|
-
|
|
894
|
+
/**
|
|
895
|
+
* Controls how the service truncates input when it exceeds the model context
|
|
896
|
+
* window.
|
|
897
|
+
*/
|
|
898
|
+
truncation?: 'auto' | 'disabled';
|
|
818
899
|
/**
|
|
819
900
|
* Usage information for OpenAI response.
|
|
820
901
|
*/
|
|
@@ -962,11 +1043,50 @@ export declare namespace ResponseObject {
|
|
|
962
1043
|
/**
|
|
963
1044
|
* Web search tool call output message for OpenAI responses.
|
|
964
1045
|
*/
|
|
965
|
-
interface
|
|
1046
|
+
interface OpenAIResponseOutputMessageWebSearchToolCallOutput {
|
|
966
1047
|
id: string;
|
|
967
1048
|
status: string;
|
|
1049
|
+
/**
|
|
1050
|
+
* Web search action: performs a search query.
|
|
1051
|
+
*/
|
|
1052
|
+
action?: OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionSearch | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionOpenPage | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionFind | null;
|
|
968
1053
|
type?: 'web_search_call';
|
|
969
1054
|
}
|
|
1055
|
+
namespace OpenAIResponseOutputMessageWebSearchToolCallOutput {
|
|
1056
|
+
/**
|
|
1057
|
+
* Web search action: performs a search query.
|
|
1058
|
+
*/
|
|
1059
|
+
interface WebSearchActionSearch {
|
|
1060
|
+
query: string;
|
|
1061
|
+
queries?: Array<string> | null;
|
|
1062
|
+
sources?: Array<WebSearchActionSearch.Source> | null;
|
|
1063
|
+
type?: 'search';
|
|
1064
|
+
}
|
|
1065
|
+
namespace WebSearchActionSearch {
|
|
1066
|
+
/**
|
|
1067
|
+
* A source URL returned by a web search action.
|
|
1068
|
+
*/
|
|
1069
|
+
interface Source {
|
|
1070
|
+
url: string;
|
|
1071
|
+
type?: 'url';
|
|
1072
|
+
}
|
|
1073
|
+
}
|
|
1074
|
+
/**
|
|
1075
|
+
* Web search action: opens a specific URL from search results.
|
|
1076
|
+
*/
|
|
1077
|
+
interface WebSearchActionOpenPage {
|
|
1078
|
+
type?: 'open_page';
|
|
1079
|
+
url?: string | null;
|
|
1080
|
+
}
|
|
1081
|
+
/**
|
|
1082
|
+
* Web search action: searches for a pattern within a loaded page.
|
|
1083
|
+
*/
|
|
1084
|
+
interface WebSearchActionFind {
|
|
1085
|
+
pattern: string;
|
|
1086
|
+
url: string;
|
|
1087
|
+
type?: 'find_in_page';
|
|
1088
|
+
}
|
|
1089
|
+
}
|
|
970
1090
|
/**
|
|
971
1091
|
* File search tool call output message for OpenAI responses.
|
|
972
1092
|
*/
|
|
@@ -1156,6 +1276,10 @@ export declare namespace ResponseObject {
|
|
|
1156
1276
|
*/
|
|
1157
1277
|
interface Reasoning {
|
|
1158
1278
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | null;
|
|
1279
|
+
/**
|
|
1280
|
+
* @deprecated Deprecated: use 'summary' instead.
|
|
1281
|
+
*/
|
|
1282
|
+
generate_summary?: 'auto' | 'concise' | 'detailed' | null;
|
|
1159
1283
|
/**
|
|
1160
1284
|
* Summary mode for reasoning output. One of 'auto', 'concise', or 'detailed'.
|
|
1161
1285
|
*/
|
|
@@ -1233,8 +1357,34 @@ export declare namespace ResponseObject {
|
|
|
1233
1357
|
* Web search tool configuration for OpenAI response inputs.
|
|
1234
1358
|
*/
|
|
1235
1359
|
interface OpenAIResponseInputToolWebSearch {
|
|
1236
|
-
|
|
1360
|
+
/**
|
|
1361
|
+
* Domain filters for web search results.
|
|
1362
|
+
*/
|
|
1363
|
+
filters?: OpenAIResponseInputToolWebSearch.Filters | null;
|
|
1364
|
+
search_context_size?: 'low' | 'medium' | 'high' | null;
|
|
1237
1365
|
type?: 'web_search' | 'web_search_preview' | 'web_search_preview_2025_03_11' | 'web_search_2025_08_26';
|
|
1366
|
+
/**
|
|
1367
|
+
* Approximate user location to refine web search results.
|
|
1368
|
+
*/
|
|
1369
|
+
user_location?: OpenAIResponseInputToolWebSearch.UserLocation | null;
|
|
1370
|
+
}
|
|
1371
|
+
namespace OpenAIResponseInputToolWebSearch {
|
|
1372
|
+
/**
|
|
1373
|
+
* Domain filters for web search results.
|
|
1374
|
+
*/
|
|
1375
|
+
interface Filters {
|
|
1376
|
+
allowed_domains?: Array<string> | null;
|
|
1377
|
+
}
|
|
1378
|
+
/**
|
|
1379
|
+
* Approximate user location to refine web search results.
|
|
1380
|
+
*/
|
|
1381
|
+
interface UserLocation {
|
|
1382
|
+
city?: string | null;
|
|
1383
|
+
country?: string | null;
|
|
1384
|
+
region?: string | null;
|
|
1385
|
+
timezone?: string | null;
|
|
1386
|
+
type?: 'approximate';
|
|
1387
|
+
}
|
|
1238
1388
|
}
|
|
1239
1389
|
/**
|
|
1240
1390
|
* File search tool configuration for OpenAI response inputs.
|
|
@@ -1422,8 +1572,47 @@ export declare namespace ResponseObjectStream {
|
|
|
1422
1572
|
interface OpenAIResponseOutputMessageWebSearchToolCall {
|
|
1423
1573
|
id: string;
|
|
1424
1574
|
status: string;
|
|
1575
|
+
/**
|
|
1576
|
+
* Web search action: performs a search query.
|
|
1577
|
+
*/
|
|
1578
|
+
action?: OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionSearch | OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionOpenPage | OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionFind | null;
|
|
1425
1579
|
type?: 'web_search_call';
|
|
1426
1580
|
}
|
|
1581
|
+
namespace OpenAIResponseOutputMessageWebSearchToolCall {
|
|
1582
|
+
/**
|
|
1583
|
+
* Web search action: performs a search query.
|
|
1584
|
+
*/
|
|
1585
|
+
interface WebSearchActionSearch {
|
|
1586
|
+
query: string;
|
|
1587
|
+
queries?: Array<string> | null;
|
|
1588
|
+
sources?: Array<WebSearchActionSearch.Source> | null;
|
|
1589
|
+
type?: 'search';
|
|
1590
|
+
}
|
|
1591
|
+
namespace WebSearchActionSearch {
|
|
1592
|
+
/**
|
|
1593
|
+
* A source URL returned by a web search action.
|
|
1594
|
+
*/
|
|
1595
|
+
interface Source {
|
|
1596
|
+
url: string;
|
|
1597
|
+
type?: 'url';
|
|
1598
|
+
}
|
|
1599
|
+
}
|
|
1600
|
+
/**
|
|
1601
|
+
* Web search action: opens a specific URL from search results.
|
|
1602
|
+
*/
|
|
1603
|
+
interface WebSearchActionOpenPage {
|
|
1604
|
+
type?: 'open_page';
|
|
1605
|
+
url?: string | null;
|
|
1606
|
+
}
|
|
1607
|
+
/**
|
|
1608
|
+
* Web search action: searches for a pattern within a loaded page.
|
|
1609
|
+
*/
|
|
1610
|
+
interface WebSearchActionFind {
|
|
1611
|
+
pattern: string;
|
|
1612
|
+
url: string;
|
|
1613
|
+
type?: 'find_in_page';
|
|
1614
|
+
}
|
|
1615
|
+
}
|
|
1427
1616
|
/**
|
|
1428
1617
|
* File search tool call output message for OpenAI responses.
|
|
1429
1618
|
*/
|
|
@@ -1578,8 +1767,47 @@ export declare namespace ResponseObjectStream {
|
|
|
1578
1767
|
interface OpenAIResponseOutputMessageWebSearchToolCall {
|
|
1579
1768
|
id: string;
|
|
1580
1769
|
status: string;
|
|
1770
|
+
/**
|
|
1771
|
+
* Web search action: performs a search query.
|
|
1772
|
+
*/
|
|
1773
|
+
action?: OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionSearch | OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionOpenPage | OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionFind | null;
|
|
1581
1774
|
type?: 'web_search_call';
|
|
1582
1775
|
}
|
|
1776
|
+
namespace OpenAIResponseOutputMessageWebSearchToolCall {
|
|
1777
|
+
/**
|
|
1778
|
+
* Web search action: performs a search query.
|
|
1779
|
+
*/
|
|
1780
|
+
interface WebSearchActionSearch {
|
|
1781
|
+
query: string;
|
|
1782
|
+
queries?: Array<string> | null;
|
|
1783
|
+
sources?: Array<WebSearchActionSearch.Source> | null;
|
|
1784
|
+
type?: 'search';
|
|
1785
|
+
}
|
|
1786
|
+
namespace WebSearchActionSearch {
|
|
1787
|
+
/**
|
|
1788
|
+
* A source URL returned by a web search action.
|
|
1789
|
+
*/
|
|
1790
|
+
interface Source {
|
|
1791
|
+
url: string;
|
|
1792
|
+
type?: 'url';
|
|
1793
|
+
}
|
|
1794
|
+
}
|
|
1795
|
+
/**
|
|
1796
|
+
* Web search action: opens a specific URL from search results.
|
|
1797
|
+
*/
|
|
1798
|
+
interface WebSearchActionOpenPage {
|
|
1799
|
+
type?: 'open_page';
|
|
1800
|
+
url?: string | null;
|
|
1801
|
+
}
|
|
1802
|
+
/**
|
|
1803
|
+
* Web search action: searches for a pattern within a loaded page.
|
|
1804
|
+
*/
|
|
1805
|
+
interface WebSearchActionFind {
|
|
1806
|
+
pattern: string;
|
|
1807
|
+
url: string;
|
|
1808
|
+
type?: 'find_in_page';
|
|
1809
|
+
}
|
|
1810
|
+
}
|
|
1583
1811
|
/**
|
|
1584
1812
|
* File search tool call output message for OpenAI responses.
|
|
1585
1813
|
*/
|
|
@@ -2388,8 +2616,47 @@ export declare namespace ResponseOutput {
|
|
|
2388
2616
|
interface OpenAIResponseOutputMessageWebSearchToolCall {
|
|
2389
2617
|
id: string;
|
|
2390
2618
|
status: string;
|
|
2619
|
+
/**
|
|
2620
|
+
* Web search action: performs a search query.
|
|
2621
|
+
*/
|
|
2622
|
+
action?: OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionSearch | OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionOpenPage | OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionFind | null;
|
|
2391
2623
|
type?: 'web_search_call';
|
|
2392
2624
|
}
|
|
2625
|
+
namespace OpenAIResponseOutputMessageWebSearchToolCall {
|
|
2626
|
+
/**
|
|
2627
|
+
* Web search action: performs a search query.
|
|
2628
|
+
*/
|
|
2629
|
+
interface WebSearchActionSearch {
|
|
2630
|
+
query: string;
|
|
2631
|
+
queries?: Array<string> | null;
|
|
2632
|
+
sources?: Array<WebSearchActionSearch.Source> | null;
|
|
2633
|
+
type?: 'search';
|
|
2634
|
+
}
|
|
2635
|
+
namespace WebSearchActionSearch {
|
|
2636
|
+
/**
|
|
2637
|
+
* A source URL returned by a web search action.
|
|
2638
|
+
*/
|
|
2639
|
+
interface Source {
|
|
2640
|
+
url: string;
|
|
2641
|
+
type?: 'url';
|
|
2642
|
+
}
|
|
2643
|
+
}
|
|
2644
|
+
/**
|
|
2645
|
+
* Web search action: opens a specific URL from search results.
|
|
2646
|
+
*/
|
|
2647
|
+
interface WebSearchActionOpenPage {
|
|
2648
|
+
type?: 'open_page';
|
|
2649
|
+
url?: string | null;
|
|
2650
|
+
}
|
|
2651
|
+
/**
|
|
2652
|
+
* Web search action: searches for a pattern within a loaded page.
|
|
2653
|
+
*/
|
|
2654
|
+
interface WebSearchActionFind {
|
|
2655
|
+
pattern: string;
|
|
2656
|
+
url: string;
|
|
2657
|
+
type?: 'find_in_page';
|
|
2658
|
+
}
|
|
2659
|
+
}
|
|
2393
2660
|
/**
|
|
2394
2661
|
* File search tool call output message for OpenAI responses.
|
|
2395
2662
|
*/
|
|
@@ -2528,9 +2795,9 @@ export declare namespace ResponseOutput {
|
|
|
2528
2795
|
export interface ResponseListResponse {
|
|
2529
2796
|
id: string;
|
|
2530
2797
|
created_at: number;
|
|
2531
|
-
input: Array<ResponseListResponse.OpenAIResponseMessageOutput | ResponseListResponse.
|
|
2798
|
+
input: Array<ResponseListResponse.OpenAIResponseMessageOutput | ResponseListResponse.OpenAIResponseOutputMessageWebSearchToolCallOutput | ResponseListResponse.OpenAIResponseOutputMessageFileSearchToolCall | ResponseListResponse.OpenAIResponseOutputMessageFunctionToolCall | ResponseListResponse.OpenAIResponseOutputMessageMcpCall | ResponseListResponse.OpenAIResponseOutputMessageMcpListTools | ResponseListResponse.OpenAIResponseMcpApprovalRequest | ResponseListResponse.OpenAIResponseOutputMessageReasoningItem | ResponseListResponse.OpenAIResponseInputFunctionToolCallOutput | ResponseListResponse.OpenAIResponseMcpApprovalResponse | ResponseListResponse.OpenAIResponseCompaction>;
|
|
2532
2799
|
model: string;
|
|
2533
|
-
output: Array<ResponseListResponse.OpenAIResponseMessageOutput | ResponseListResponse.
|
|
2800
|
+
output: Array<ResponseListResponse.OpenAIResponseMessageOutput | ResponseListResponse.OpenAIResponseOutputMessageWebSearchToolCallOutput | ResponseListResponse.OpenAIResponseOutputMessageFileSearchToolCall | ResponseListResponse.OpenAIResponseOutputMessageFunctionToolCall | ResponseListResponse.OpenAIResponseOutputMessageMcpCall | ResponseListResponse.OpenAIResponseOutputMessageMcpListTools | ResponseListResponse.OpenAIResponseMcpApprovalRequest | ResponseListResponse.OpenAIResponseOutputMessageReasoningItem>;
|
|
2534
2801
|
status: string;
|
|
2535
2802
|
store: boolean;
|
|
2536
2803
|
background?: boolean;
|
|
@@ -2565,6 +2832,7 @@ export interface ResponseListResponse {
|
|
|
2565
2832
|
* Controls how much reasoning the model performs before generating a response.
|
|
2566
2833
|
*/
|
|
2567
2834
|
reasoning?: ResponseListResponse.Reasoning | null;
|
|
2835
|
+
safety_identifier?: string | null;
|
|
2568
2836
|
service_tier?: string;
|
|
2569
2837
|
temperature?: number;
|
|
2570
2838
|
/**
|
|
@@ -2578,7 +2846,11 @@ export interface ResponseListResponse {
|
|
|
2578
2846
|
tools?: Array<ResponseListResponse.OpenAIResponseInputToolWebSearch | ResponseListResponse.OpenAIResponseInputToolFileSearch | ResponseListResponse.OpenAIResponseInputToolFunction | ResponseListResponse.OpenAIResponseToolMcp>;
|
|
2579
2847
|
top_logprobs?: number;
|
|
2580
2848
|
top_p?: number;
|
|
2581
|
-
|
|
2849
|
+
/**
|
|
2850
|
+
* Controls how the service truncates input when it exceeds the model context
|
|
2851
|
+
* window.
|
|
2852
|
+
*/
|
|
2853
|
+
truncation?: 'auto' | 'disabled' | null;
|
|
2582
2854
|
/**
|
|
2583
2855
|
* Usage information for OpenAI response.
|
|
2584
2856
|
*/
|
|
@@ -2726,11 +2998,50 @@ export declare namespace ResponseListResponse {
|
|
|
2726
2998
|
/**
|
|
2727
2999
|
* Web search tool call output message for OpenAI responses.
|
|
2728
3000
|
*/
|
|
2729
|
-
interface
|
|
3001
|
+
interface OpenAIResponseOutputMessageWebSearchToolCallOutput {
|
|
2730
3002
|
id: string;
|
|
2731
3003
|
status: string;
|
|
3004
|
+
/**
|
|
3005
|
+
* Web search action: performs a search query.
|
|
3006
|
+
*/
|
|
3007
|
+
action?: OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionSearch | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionOpenPage | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionFind | null;
|
|
2732
3008
|
type?: 'web_search_call';
|
|
2733
3009
|
}
|
|
3010
|
+
namespace OpenAIResponseOutputMessageWebSearchToolCallOutput {
|
|
3011
|
+
/**
|
|
3012
|
+
* Web search action: performs a search query.
|
|
3013
|
+
*/
|
|
3014
|
+
interface WebSearchActionSearch {
|
|
3015
|
+
query: string;
|
|
3016
|
+
queries?: Array<string> | null;
|
|
3017
|
+
sources?: Array<WebSearchActionSearch.Source> | null;
|
|
3018
|
+
type?: 'search';
|
|
3019
|
+
}
|
|
3020
|
+
namespace WebSearchActionSearch {
|
|
3021
|
+
/**
|
|
3022
|
+
* A source URL returned by a web search action.
|
|
3023
|
+
*/
|
|
3024
|
+
interface Source {
|
|
3025
|
+
url: string;
|
|
3026
|
+
type?: 'url';
|
|
3027
|
+
}
|
|
3028
|
+
}
|
|
3029
|
+
/**
|
|
3030
|
+
* Web search action: opens a specific URL from search results.
|
|
3031
|
+
*/
|
|
3032
|
+
interface WebSearchActionOpenPage {
|
|
3033
|
+
type?: 'open_page';
|
|
3034
|
+
url?: string | null;
|
|
3035
|
+
}
|
|
3036
|
+
/**
|
|
3037
|
+
* Web search action: searches for a pattern within a loaded page.
|
|
3038
|
+
*/
|
|
3039
|
+
interface WebSearchActionFind {
|
|
3040
|
+
pattern: string;
|
|
3041
|
+
url: string;
|
|
3042
|
+
type?: 'find_in_page';
|
|
3043
|
+
}
|
|
3044
|
+
}
|
|
2734
3045
|
/**
|
|
2735
3046
|
* File search tool call output message for OpenAI responses.
|
|
2736
3047
|
*/
|
|
@@ -3060,11 +3371,50 @@ export declare namespace ResponseListResponse {
|
|
|
3060
3371
|
/**
|
|
3061
3372
|
* Web search tool call output message for OpenAI responses.
|
|
3062
3373
|
*/
|
|
3063
|
-
interface
|
|
3374
|
+
interface OpenAIResponseOutputMessageWebSearchToolCallOutput {
|
|
3064
3375
|
id: string;
|
|
3065
3376
|
status: string;
|
|
3377
|
+
/**
|
|
3378
|
+
* Web search action: performs a search query.
|
|
3379
|
+
*/
|
|
3380
|
+
action?: OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionSearch | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionOpenPage | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionFind | null;
|
|
3066
3381
|
type?: 'web_search_call';
|
|
3067
3382
|
}
|
|
3383
|
+
namespace OpenAIResponseOutputMessageWebSearchToolCallOutput {
|
|
3384
|
+
/**
|
|
3385
|
+
* Web search action: performs a search query.
|
|
3386
|
+
*/
|
|
3387
|
+
interface WebSearchActionSearch {
|
|
3388
|
+
query: string;
|
|
3389
|
+
queries?: Array<string> | null;
|
|
3390
|
+
sources?: Array<WebSearchActionSearch.Source> | null;
|
|
3391
|
+
type?: 'search';
|
|
3392
|
+
}
|
|
3393
|
+
namespace WebSearchActionSearch {
|
|
3394
|
+
/**
|
|
3395
|
+
* A source URL returned by a web search action.
|
|
3396
|
+
*/
|
|
3397
|
+
interface Source {
|
|
3398
|
+
url: string;
|
|
3399
|
+
type?: 'url';
|
|
3400
|
+
}
|
|
3401
|
+
}
|
|
3402
|
+
/**
|
|
3403
|
+
* Web search action: opens a specific URL from search results.
|
|
3404
|
+
*/
|
|
3405
|
+
interface WebSearchActionOpenPage {
|
|
3406
|
+
type?: 'open_page';
|
|
3407
|
+
url?: string | null;
|
|
3408
|
+
}
|
|
3409
|
+
/**
|
|
3410
|
+
* Web search action: searches for a pattern within a loaded page.
|
|
3411
|
+
*/
|
|
3412
|
+
interface WebSearchActionFind {
|
|
3413
|
+
pattern: string;
|
|
3414
|
+
url: string;
|
|
3415
|
+
type?: 'find_in_page';
|
|
3416
|
+
}
|
|
3417
|
+
}
|
|
3068
3418
|
/**
|
|
3069
3419
|
* File search tool call output message for OpenAI responses.
|
|
3070
3420
|
*/
|
|
@@ -3254,6 +3604,10 @@ export declare namespace ResponseListResponse {
|
|
|
3254
3604
|
*/
|
|
3255
3605
|
interface Reasoning {
|
|
3256
3606
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | null;
|
|
3607
|
+
/**
|
|
3608
|
+
* @deprecated Deprecated: use 'summary' instead.
|
|
3609
|
+
*/
|
|
3610
|
+
generate_summary?: 'auto' | 'concise' | 'detailed' | null;
|
|
3257
3611
|
/**
|
|
3258
3612
|
* Summary mode for reasoning output. One of 'auto', 'concise', or 'detailed'.
|
|
3259
3613
|
*/
|
|
@@ -3331,8 +3685,34 @@ export declare namespace ResponseListResponse {
|
|
|
3331
3685
|
* Web search tool configuration for OpenAI response inputs.
|
|
3332
3686
|
*/
|
|
3333
3687
|
interface OpenAIResponseInputToolWebSearch {
|
|
3334
|
-
|
|
3688
|
+
/**
|
|
3689
|
+
* Domain filters for web search results.
|
|
3690
|
+
*/
|
|
3691
|
+
filters?: OpenAIResponseInputToolWebSearch.Filters | null;
|
|
3692
|
+
search_context_size?: 'low' | 'medium' | 'high' | null;
|
|
3335
3693
|
type?: 'web_search' | 'web_search_preview' | 'web_search_preview_2025_03_11' | 'web_search_2025_08_26';
|
|
3694
|
+
/**
|
|
3695
|
+
* Approximate user location to refine web search results.
|
|
3696
|
+
*/
|
|
3697
|
+
user_location?: OpenAIResponseInputToolWebSearch.UserLocation | null;
|
|
3698
|
+
}
|
|
3699
|
+
namespace OpenAIResponseInputToolWebSearch {
|
|
3700
|
+
/**
|
|
3701
|
+
* Domain filters for web search results.
|
|
3702
|
+
*/
|
|
3703
|
+
interface Filters {
|
|
3704
|
+
allowed_domains?: Array<string> | null;
|
|
3705
|
+
}
|
|
3706
|
+
/**
|
|
3707
|
+
* Approximate user location to refine web search results.
|
|
3708
|
+
*/
|
|
3709
|
+
interface UserLocation {
|
|
3710
|
+
city?: string | null;
|
|
3711
|
+
country?: string | null;
|
|
3712
|
+
region?: string | null;
|
|
3713
|
+
timezone?: string | null;
|
|
3714
|
+
type?: 'approximate';
|
|
3715
|
+
}
|
|
3336
3716
|
}
|
|
3337
3717
|
/**
|
|
3338
3718
|
* File search tool configuration for OpenAI response inputs.
|
|
@@ -3484,7 +3864,7 @@ export interface ResponseCreateParamsBase {
|
|
|
3484
3864
|
/**
|
|
3485
3865
|
* Input message(s) to create the response.
|
|
3486
3866
|
*/
|
|
3487
|
-
input: string | Array<ResponseCreateParams.OpenAIResponseMessageInput | ResponseCreateParams.
|
|
3867
|
+
input: string | Array<ResponseCreateParams.OpenAIResponseMessageInput | ResponseCreateParams.OpenAIResponseOutputMessageWebSearchToolCallInput | ResponseCreateParams.OpenAIResponseOutputMessageFileSearchToolCall | ResponseCreateParams.OpenAIResponseOutputMessageFunctionToolCall | ResponseCreateParams.OpenAIResponseOutputMessageMcpCall | ResponseCreateParams.OpenAIResponseOutputMessageMcpListTools | ResponseCreateParams.OpenAIResponseMcpApprovalRequest | ResponseCreateParams.OpenAIResponseOutputMessageReasoningItem | ResponseCreateParams.OpenAIResponseInputFunctionToolCallOutput | ResponseCreateParams.OpenAIResponseMcpApprovalResponse | ResponseCreateParams.OpenAIResponseCompaction>;
|
|
3488
3868
|
/**
|
|
3489
3869
|
* The underlying LLM used for completions.
|
|
3490
3870
|
*/
|
|
@@ -3559,6 +3939,11 @@ export interface ResponseCreateParamsBase {
|
|
|
3559
3939
|
* Controls how much reasoning the model performs before generating a response.
|
|
3560
3940
|
*/
|
|
3561
3941
|
reasoning?: ResponseCreateParams.Reasoning | null;
|
|
3942
|
+
/**
|
|
3943
|
+
* A stable identifier used to associate the request with an end user, for safety
|
|
3944
|
+
* monitoring. Echoed back on the response.
|
|
3945
|
+
*/
|
|
3946
|
+
safety_identifier?: string | null;
|
|
3562
3947
|
/**
|
|
3563
3948
|
* The service tier for the request.
|
|
3564
3949
|
*/
|
|
@@ -3605,7 +3990,7 @@ export interface ResponseCreateParamsBase {
|
|
|
3605
3990
|
* Controls how the service truncates input when it exceeds the model context
|
|
3606
3991
|
* window.
|
|
3607
3992
|
*/
|
|
3608
|
-
truncation?: 'auto' | 'disabled'
|
|
3993
|
+
truncation?: 'auto' | 'disabled';
|
|
3609
3994
|
[k: string]: unknown;
|
|
3610
3995
|
}
|
|
3611
3996
|
export declare namespace ResponseCreateParams {
|
|
@@ -3750,11 +4135,50 @@ export declare namespace ResponseCreateParams {
|
|
|
3750
4135
|
/**
|
|
3751
4136
|
* Web search tool call output message for OpenAI responses.
|
|
3752
4137
|
*/
|
|
3753
|
-
interface
|
|
4138
|
+
interface OpenAIResponseOutputMessageWebSearchToolCallInput {
|
|
3754
4139
|
id: string;
|
|
3755
4140
|
status: string;
|
|
4141
|
+
/**
|
|
4142
|
+
* Web search action: performs a search query.
|
|
4143
|
+
*/
|
|
4144
|
+
action?: OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionSearch | OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionOpenPage | OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionFind | null;
|
|
3756
4145
|
type?: 'web_search_call';
|
|
3757
4146
|
}
|
|
4147
|
+
namespace OpenAIResponseOutputMessageWebSearchToolCallInput {
|
|
4148
|
+
/**
|
|
4149
|
+
* Web search action: performs a search query.
|
|
4150
|
+
*/
|
|
4151
|
+
interface WebSearchActionSearch {
|
|
4152
|
+
query: string;
|
|
4153
|
+
queries?: Array<string> | null;
|
|
4154
|
+
sources?: Array<WebSearchActionSearch.Source> | null;
|
|
4155
|
+
type?: 'search';
|
|
4156
|
+
}
|
|
4157
|
+
namespace WebSearchActionSearch {
|
|
4158
|
+
/**
|
|
4159
|
+
* A source URL returned by a web search action.
|
|
4160
|
+
*/
|
|
4161
|
+
interface Source {
|
|
4162
|
+
url: string;
|
|
4163
|
+
type?: 'url';
|
|
4164
|
+
}
|
|
4165
|
+
}
|
|
4166
|
+
/**
|
|
4167
|
+
* Web search action: opens a specific URL from search results.
|
|
4168
|
+
*/
|
|
4169
|
+
interface WebSearchActionOpenPage {
|
|
4170
|
+
type?: 'open_page';
|
|
4171
|
+
url?: string | null;
|
|
4172
|
+
}
|
|
4173
|
+
/**
|
|
4174
|
+
* Web search action: searches for a pattern within a loaded page.
|
|
4175
|
+
*/
|
|
4176
|
+
interface WebSearchActionFind {
|
|
4177
|
+
pattern: string;
|
|
4178
|
+
url: string;
|
|
4179
|
+
type?: 'find_in_page';
|
|
4180
|
+
}
|
|
4181
|
+
}
|
|
3758
4182
|
/**
|
|
3759
4183
|
* File search tool call output message for OpenAI responses.
|
|
3760
4184
|
*/
|
|
@@ -4001,6 +4425,10 @@ export declare namespace ResponseCreateParams {
|
|
|
4001
4425
|
*/
|
|
4002
4426
|
interface Reasoning {
|
|
4003
4427
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | null;
|
|
4428
|
+
/**
|
|
4429
|
+
* @deprecated Deprecated: use 'summary' instead.
|
|
4430
|
+
*/
|
|
4431
|
+
generate_summary?: 'auto' | 'concise' | 'detailed' | null;
|
|
4004
4432
|
/**
|
|
4005
4433
|
* Summary mode for reasoning output. One of 'auto', 'concise', or 'detailed'.
|
|
4006
4434
|
*/
|
|
@@ -4087,8 +4515,34 @@ export declare namespace ResponseCreateParams {
|
|
|
4087
4515
|
* Web search tool configuration for OpenAI response inputs.
|
|
4088
4516
|
*/
|
|
4089
4517
|
interface OpenAIResponseInputToolWebSearch {
|
|
4090
|
-
|
|
4518
|
+
/**
|
|
4519
|
+
* Domain filters for web search results.
|
|
4520
|
+
*/
|
|
4521
|
+
filters?: OpenAIResponseInputToolWebSearch.Filters | null;
|
|
4522
|
+
search_context_size?: 'low' | 'medium' | 'high' | null;
|
|
4091
4523
|
type?: 'web_search' | 'web_search_preview' | 'web_search_preview_2025_03_11' | 'web_search_2025_08_26';
|
|
4524
|
+
/**
|
|
4525
|
+
* Approximate user location to refine web search results.
|
|
4526
|
+
*/
|
|
4527
|
+
user_location?: OpenAIResponseInputToolWebSearch.UserLocation | null;
|
|
4528
|
+
}
|
|
4529
|
+
namespace OpenAIResponseInputToolWebSearch {
|
|
4530
|
+
/**
|
|
4531
|
+
* Domain filters for web search results.
|
|
4532
|
+
*/
|
|
4533
|
+
interface Filters {
|
|
4534
|
+
allowed_domains?: Array<string> | null;
|
|
4535
|
+
}
|
|
4536
|
+
/**
|
|
4537
|
+
* Approximate user location to refine web search results.
|
|
4538
|
+
*/
|
|
4539
|
+
interface UserLocation {
|
|
4540
|
+
city?: string | null;
|
|
4541
|
+
country?: string | null;
|
|
4542
|
+
region?: string | null;
|
|
4543
|
+
timezone?: string | null;
|
|
4544
|
+
type?: 'approximate';
|
|
4545
|
+
}
|
|
4092
4546
|
}
|
|
4093
4547
|
/**
|
|
4094
4548
|
* File search tool configuration for OpenAI response inputs.
|
|
@@ -4242,13 +4696,13 @@ export interface ResponseListParams extends OpenAICursorPageParams {
|
|
|
4242
4696
|
}
|
|
4243
4697
|
export interface ResponseCompactParams {
|
|
4244
4698
|
/**
|
|
4245
|
-
*
|
|
4699
|
+
* Model identifier.
|
|
4246
4700
|
*/
|
|
4247
|
-
model: string;
|
|
4701
|
+
model: string | null;
|
|
4248
4702
|
/**
|
|
4249
4703
|
* Input message(s) to compact.
|
|
4250
4704
|
*/
|
|
4251
|
-
input?: string | Array<ResponseCompactParams.OpenAIResponseMessageInput | ResponseCompactParams.
|
|
4705
|
+
input?: string | Array<ResponseCompactParams.OpenAIResponseMessageInput | ResponseCompactParams.OpenAIResponseOutputMessageWebSearchToolCallInput | ResponseCompactParams.OpenAIResponseOutputMessageFileSearchToolCall | ResponseCompactParams.OpenAIResponseOutputMessageFunctionToolCall | ResponseCompactParams.OpenAIResponseOutputMessageMcpCall | ResponseCompactParams.OpenAIResponseOutputMessageMcpListTools | ResponseCompactParams.OpenAIResponseMcpApprovalRequest | ResponseCompactParams.OpenAIResponseOutputMessageReasoningItem | ResponseCompactParams.OpenAIResponseInputFunctionToolCallOutput | ResponseCompactParams.OpenAIResponseMcpApprovalResponse | ResponseCompactParams.OpenAIResponseCompaction> | null;
|
|
4252
4706
|
/**
|
|
4253
4707
|
* Instructions to guide the compaction.
|
|
4254
4708
|
*/
|
|
@@ -4425,11 +4879,50 @@ export declare namespace ResponseCompactParams {
|
|
|
4425
4879
|
/**
|
|
4426
4880
|
* Web search tool call output message for OpenAI responses.
|
|
4427
4881
|
*/
|
|
4428
|
-
interface
|
|
4882
|
+
interface OpenAIResponseOutputMessageWebSearchToolCallInput {
|
|
4429
4883
|
id: string;
|
|
4430
4884
|
status: string;
|
|
4885
|
+
/**
|
|
4886
|
+
* Web search action: performs a search query.
|
|
4887
|
+
*/
|
|
4888
|
+
action?: OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionSearch | OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionOpenPage | OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionFind | null;
|
|
4431
4889
|
type?: 'web_search_call';
|
|
4432
4890
|
}
|
|
4891
|
+
namespace OpenAIResponseOutputMessageWebSearchToolCallInput {
|
|
4892
|
+
/**
|
|
4893
|
+
* Web search action: performs a search query.
|
|
4894
|
+
*/
|
|
4895
|
+
interface WebSearchActionSearch {
|
|
4896
|
+
query: string;
|
|
4897
|
+
queries?: Array<string> | null;
|
|
4898
|
+
sources?: Array<WebSearchActionSearch.Source> | null;
|
|
4899
|
+
type?: 'search';
|
|
4900
|
+
}
|
|
4901
|
+
namespace WebSearchActionSearch {
|
|
4902
|
+
/**
|
|
4903
|
+
* A source URL returned by a web search action.
|
|
4904
|
+
*/
|
|
4905
|
+
interface Source {
|
|
4906
|
+
url: string;
|
|
4907
|
+
type?: 'url';
|
|
4908
|
+
}
|
|
4909
|
+
}
|
|
4910
|
+
/**
|
|
4911
|
+
* Web search action: opens a specific URL from search results.
|
|
4912
|
+
*/
|
|
4913
|
+
interface WebSearchActionOpenPage {
|
|
4914
|
+
type?: 'open_page';
|
|
4915
|
+
url?: string | null;
|
|
4916
|
+
}
|
|
4917
|
+
/**
|
|
4918
|
+
* Web search action: searches for a pattern within a loaded page.
|
|
4919
|
+
*/
|
|
4920
|
+
interface WebSearchActionFind {
|
|
4921
|
+
pattern: string;
|
|
4922
|
+
url: string;
|
|
4923
|
+
type?: 'find_in_page';
|
|
4924
|
+
}
|
|
4925
|
+
}
|
|
4433
4926
|
/**
|
|
4434
4927
|
* File search tool call output message for OpenAI responses.
|
|
4435
4928
|
*/
|
|
@@ -4625,6 +5118,10 @@ export declare namespace ResponseCompactParams {
|
|
|
4625
5118
|
*/
|
|
4626
5119
|
interface Reasoning {
|
|
4627
5120
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | null;
|
|
5121
|
+
/**
|
|
5122
|
+
* @deprecated Deprecated: use 'summary' instead.
|
|
5123
|
+
*/
|
|
5124
|
+
generate_summary?: 'auto' | 'concise' | 'detailed' | null;
|
|
4628
5125
|
/**
|
|
4629
5126
|
* Summary mode for reasoning output. One of 'auto', 'concise', or 'detailed'.
|
|
4630
5127
|
*/
|
|
@@ -4658,8 +5155,34 @@ export declare namespace ResponseCompactParams {
|
|
|
4658
5155
|
* Web search tool configuration for OpenAI response inputs.
|
|
4659
5156
|
*/
|
|
4660
5157
|
interface OpenAIResponseInputToolWebSearch {
|
|
4661
|
-
|
|
5158
|
+
/**
|
|
5159
|
+
* Domain filters for web search results.
|
|
5160
|
+
*/
|
|
5161
|
+
filters?: OpenAIResponseInputToolWebSearch.Filters | null;
|
|
5162
|
+
search_context_size?: 'low' | 'medium' | 'high' | null;
|
|
4662
5163
|
type?: 'web_search' | 'web_search_preview' | 'web_search_preview_2025_03_11' | 'web_search_2025_08_26';
|
|
5164
|
+
/**
|
|
5165
|
+
* Approximate user location to refine web search results.
|
|
5166
|
+
*/
|
|
5167
|
+
user_location?: OpenAIResponseInputToolWebSearch.UserLocation | null;
|
|
5168
|
+
}
|
|
5169
|
+
namespace OpenAIResponseInputToolWebSearch {
|
|
5170
|
+
/**
|
|
5171
|
+
* Domain filters for web search results.
|
|
5172
|
+
*/
|
|
5173
|
+
interface Filters {
|
|
5174
|
+
allowed_domains?: Array<string> | null;
|
|
5175
|
+
}
|
|
5176
|
+
/**
|
|
5177
|
+
* Approximate user location to refine web search results.
|
|
5178
|
+
*/
|
|
5179
|
+
interface UserLocation {
|
|
5180
|
+
city?: string | null;
|
|
5181
|
+
country?: string | null;
|
|
5182
|
+
region?: string | null;
|
|
5183
|
+
timezone?: string | null;
|
|
5184
|
+
type?: 'approximate';
|
|
5185
|
+
}
|
|
4663
5186
|
}
|
|
4664
5187
|
/**
|
|
4665
5188
|
* File search tool configuration for OpenAI response inputs.
|