@effect/ai-openai 4.0.0-beta.10 → 4.0.0-beta.101
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/dist/Generated.d.ts +66675 -37672
- package/dist/Generated.d.ts.map +1 -1
- package/dist/Generated.js +1 -1
- package/dist/Generated.js.map +1 -1
- package/dist/OpenAiClient.d.ts +170 -29
- package/dist/OpenAiClient.d.ts.map +1 -1
- package/dist/OpenAiClient.js +321 -46
- package/dist/OpenAiClient.js.map +1 -1
- package/dist/OpenAiClientGenerated.d.ts +91 -0
- package/dist/OpenAiClientGenerated.d.ts.map +1 -0
- package/dist/OpenAiClientGenerated.js +84 -0
- package/dist/OpenAiClientGenerated.js.map +1 -0
- package/dist/OpenAiConfig.d.ts +88 -10
- package/dist/OpenAiConfig.d.ts.map +1 -1
- package/dist/OpenAiConfig.js +42 -7
- package/dist/OpenAiConfig.js.map +1 -1
- package/dist/OpenAiEmbeddingModel.d.ts +188 -0
- package/dist/OpenAiEmbeddingModel.d.ts.map +1 -0
- package/dist/OpenAiEmbeddingModel.js +194 -0
- package/dist/OpenAiEmbeddingModel.js.map +1 -0
- package/dist/OpenAiError.d.ts +168 -35
- package/dist/OpenAiError.d.ts.map +1 -1
- package/dist/OpenAiError.js +1 -1
- package/dist/OpenAiLanguageModel.d.ts +360 -72
- package/dist/OpenAiLanguageModel.d.ts.map +1 -1
- package/dist/OpenAiLanguageModel.js +392 -169
- package/dist/OpenAiLanguageModel.js.map +1 -1
- package/dist/OpenAiSchema.d.ts +2325 -0
- package/dist/OpenAiSchema.d.ts.map +1 -0
- package/dist/OpenAiSchema.js +811 -0
- package/dist/OpenAiSchema.js.map +1 -0
- package/dist/OpenAiTelemetry.d.ts +63 -22
- package/dist/OpenAiTelemetry.d.ts.map +1 -1
- package/dist/OpenAiTelemetry.js +20 -10
- package/dist/OpenAiTelemetry.js.map +1 -1
- package/dist/OpenAiTool.d.ts +155 -69
- package/dist/OpenAiTool.d.ts.map +1 -1
- package/dist/OpenAiTool.js +125 -39
- package/dist/OpenAiTool.js.map +1 -1
- package/dist/index.d.ts +19 -33
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +19 -33
- package/dist/index.js.map +1 -1
- package/dist/internal/errors.js +4 -4
- package/dist/internal/errors.js.map +1 -1
- package/dist/internal/utilities.js +0 -4
- package/dist/internal/utilities.js.map +1 -1
- package/package.json +5 -6
- package/src/Generated.ts +9720 -4890
- package/src/OpenAiClient.ts +499 -98
- package/src/OpenAiClientGenerated.ts +202 -0
- package/src/OpenAiConfig.ts +89 -11
- package/src/OpenAiEmbeddingModel.ts +332 -0
- package/src/OpenAiError.ts +170 -35
- package/src/OpenAiLanguageModel.ts +778 -170
- package/src/OpenAiSchema.ts +1286 -0
- package/src/OpenAiTelemetry.ts +69 -28
- package/src/OpenAiTool.ts +126 -40
- package/src/index.ts +22 -33
- package/src/internal/errors.ts +6 -4
- package/src/internal/utilities.ts +0 -6
package/dist/OpenAiTool.d.ts
CHANGED
|
@@ -1,29 +1,34 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* OpenAI provider
|
|
2
|
+
* The `OpenAiTool` module defines OpenAI provider tools for Effect AI language
|
|
3
|
+
* model requests. It exposes typed descriptors for tools such as Apply Patch,
|
|
4
|
+
* Code Interpreter, File Search, Image Generation, MCP, Web Search, and
|
|
5
|
+
* shell-like local tools, including their provider names, configuration
|
|
6
|
+
* arguments, call parameters, success schemas, and handler requirements.
|
|
3
7
|
*
|
|
4
|
-
*
|
|
5
|
-
* code interpreter, file search, and web search functionality.
|
|
6
|
-
*
|
|
7
|
-
* @since 1.0.0
|
|
8
|
+
* @since 4.0.0
|
|
8
9
|
*/
|
|
9
10
|
import * as Schema from "effect/Schema";
|
|
10
11
|
import * as Tool from "effect/unstable/ai/Tool";
|
|
11
12
|
/**
|
|
12
13
|
* Union of all OpenAI provider-defined tools.
|
|
13
14
|
*
|
|
14
|
-
* @since 1.0.0
|
|
15
15
|
* @category models
|
|
16
|
+
* @since 4.0.0
|
|
16
17
|
*/
|
|
17
18
|
export type OpenAiTool = ReturnType<typeof ApplyPatch> | ReturnType<typeof CodeInterpreter> | ReturnType<typeof FileSearch> | ReturnType<typeof Shell> | ReturnType<typeof ImageGeneration> | ReturnType<typeof LocalShell> | ReturnType<typeof Mcp> | ReturnType<typeof WebSearch> | ReturnType<typeof WebSearchPreview>;
|
|
18
19
|
/**
|
|
19
|
-
* OpenAI Apply Patch tool
|
|
20
|
+
* Defines the OpenAI Apply Patch tool that allows the model to apply diffs by creating,
|
|
21
|
+
* deleting, or updating files. This local tool runs in your environment and
|
|
22
|
+
* requires a handler to execute file operations.
|
|
23
|
+
*
|
|
24
|
+
* **When to use**
|
|
20
25
|
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
26
|
+
* Use when you want an OpenAI model to request structured file edits as create,
|
|
27
|
+
* delete, or update operations that your application executes through a local
|
|
28
|
+
* handler.
|
|
24
29
|
*
|
|
25
|
-
* @since 1.0.0
|
|
26
30
|
* @category tools
|
|
31
|
+
* @since 4.0.0
|
|
27
32
|
*/
|
|
28
33
|
export declare const ApplyPatch: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
|
|
29
34
|
readonly failureMode?: Mode | undefined;
|
|
@@ -52,29 +57,38 @@ export declare const ApplyPatch: <Mode extends Tool.FailureMode | undefined = un
|
|
|
52
57
|
readonly failureMode: Mode extends undefined ? "error" : Mode;
|
|
53
58
|
}, true>;
|
|
54
59
|
/**
|
|
55
|
-
* OpenAI Code Interpreter tool
|
|
60
|
+
* Defines the OpenAI Code Interpreter tool that allows the model to execute Python code in
|
|
61
|
+
* a sandboxed environment.
|
|
62
|
+
*
|
|
63
|
+
* **When to use**
|
|
64
|
+
*
|
|
65
|
+
* Use to enable OpenAI-hosted Python execution for a model response.
|
|
66
|
+
*
|
|
67
|
+
* **Details**
|
|
56
68
|
*
|
|
57
|
-
*
|
|
69
|
+
* The tool is configured with a `container` argument. Successful tool calls
|
|
70
|
+
* expose `outputs`, which may contain logs or generated images, or `null` when
|
|
71
|
+
* no outputs are available.
|
|
58
72
|
*
|
|
59
|
-
* @since 1.0.0
|
|
60
73
|
* @category tools
|
|
74
|
+
* @since 4.0.0
|
|
61
75
|
*/
|
|
62
76
|
export declare const CodeInterpreter: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
|
|
63
77
|
readonly container: string | {
|
|
64
78
|
readonly type: "auto";
|
|
65
|
-
readonly
|
|
79
|
+
readonly file_ids?: readonly string[];
|
|
80
|
+
readonly memory_limit?: "16g" | "1g" | "4g" | "64g" | null;
|
|
66
81
|
readonly network_policy?: {
|
|
67
82
|
readonly type: "disabled";
|
|
68
83
|
} | {
|
|
69
84
|
readonly type: "allowlist";
|
|
70
85
|
readonly allowed_domains: readonly string[];
|
|
71
86
|
readonly domain_secrets?: readonly {
|
|
72
|
-
readonly value: string;
|
|
73
|
-
readonly name: string;
|
|
74
87
|
readonly domain: string;
|
|
88
|
+
readonly name: string;
|
|
89
|
+
readonly value: string;
|
|
75
90
|
}[];
|
|
76
91
|
};
|
|
77
|
-
readonly file_ids?: readonly string[];
|
|
78
92
|
};
|
|
79
93
|
}) => Tool.ProviderDefined<"openai.code_interpreter", "OpenAiCodeInterpreter", {
|
|
80
94
|
readonly args: Schema.Struct<{
|
|
@@ -112,19 +126,28 @@ export declare const CodeInterpreter: <Mode extends Tool.FailureMode | undefined
|
|
|
112
126
|
readonly failureMode: Mode extends undefined ? "error" : Mode;
|
|
113
127
|
}, false>;
|
|
114
128
|
/**
|
|
115
|
-
* OpenAI File Search tool
|
|
129
|
+
* Defines the OpenAI File Search tool that enables the model to search through uploaded
|
|
130
|
+
* files and vector stores.
|
|
131
|
+
*
|
|
132
|
+
* **When to use**
|
|
133
|
+
*
|
|
134
|
+
* Use to let an OpenAI model search uploaded files through one or more vector
|
|
135
|
+
* stores.
|
|
116
136
|
*
|
|
117
|
-
*
|
|
137
|
+
* **Details**
|
|
138
|
+
*
|
|
139
|
+
* The tool requires `vector_store_ids` and accepts optional `filters`,
|
|
140
|
+
* `max_num_results`, and `ranking_options`. Successful tool calls expose the
|
|
141
|
+
* search `status`, generated `queries`, and optional `results`.
|
|
118
142
|
*
|
|
119
|
-
* @since 1.0.0
|
|
120
143
|
* @category tools
|
|
144
|
+
* @since 4.0.0
|
|
121
145
|
*/
|
|
122
146
|
export declare const FileSearch: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
|
|
123
|
-
readonly vector_store_ids: readonly string[];
|
|
124
147
|
readonly filters?: {
|
|
125
|
-
readonly
|
|
126
|
-
readonly type: "eq" | "ne" | "gt" | "gte" | "lt" | "lte";
|
|
148
|
+
readonly type: "eq" | "gt" | "gte" | "in" | "lt" | "lte" | "ne" | "nin";
|
|
127
149
|
readonly key: string;
|
|
150
|
+
readonly value: string | number | boolean | readonly (string | number)[];
|
|
128
151
|
} | {
|
|
129
152
|
readonly type: "and" | "or";
|
|
130
153
|
readonly filters: readonly unknown[];
|
|
@@ -138,16 +161,17 @@ export declare const FileSearch: <Mode extends Tool.FailureMode | undefined = un
|
|
|
138
161
|
readonly text_weight: number;
|
|
139
162
|
};
|
|
140
163
|
};
|
|
164
|
+
readonly vector_store_ids: readonly string[];
|
|
141
165
|
}) => Tool.ProviderDefined<"openai.file_search", "OpenAiFileSearch", {
|
|
142
166
|
readonly args: Schema.Struct<{
|
|
143
167
|
readonly filters: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Struct<{
|
|
144
|
-
readonly type: Schema.Literals<readonly ["eq", "ne", "gt", "gte", "lt", "lte"]>;
|
|
168
|
+
readonly type: Schema.Literals<readonly ["eq", "ne", "gt", "gte", "lt", "lte", "in", "nin"]>;
|
|
145
169
|
readonly key: Schema.String;
|
|
146
170
|
readonly value: Schema.Union<readonly [Schema.String, Schema.Number, Schema.Boolean, Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Number]>>]>;
|
|
147
171
|
}>, Schema.Struct<{
|
|
148
172
|
readonly type: Schema.Literals<readonly ["and", "or"]>;
|
|
149
173
|
readonly filters: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
150
|
-
readonly type: Schema.Literals<readonly ["eq", "ne", "gt", "gte", "lt", "lte"]>;
|
|
174
|
+
readonly type: Schema.Literals<readonly ["eq", "ne", "gt", "gte", "lt", "lte", "in", "nin"]>;
|
|
151
175
|
readonly key: Schema.String;
|
|
152
176
|
readonly value: Schema.Union<readonly [Schema.String, Schema.Number, Schema.Boolean, Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Number]>>]>;
|
|
153
177
|
}>, Schema.Unknown]>>;
|
|
@@ -179,27 +203,38 @@ export declare const FileSearch: <Mode extends Tool.FailureMode | undefined = un
|
|
|
179
203
|
readonly failureMode: Mode extends undefined ? "error" : Mode;
|
|
180
204
|
}, false>;
|
|
181
205
|
/**
|
|
182
|
-
* OpenAI Image Generation tool
|
|
206
|
+
* Defines the OpenAI Image Generation tool that enables the model to generate images using
|
|
207
|
+
* the GPT image models.
|
|
208
|
+
*
|
|
209
|
+
* **When to use**
|
|
210
|
+
*
|
|
211
|
+
* Use to enable OpenAI provider-defined image generation through a language
|
|
212
|
+
* model response.
|
|
213
|
+
*
|
|
214
|
+
* **Details**
|
|
183
215
|
*
|
|
184
|
-
*
|
|
216
|
+
* The tool configures the `image_generation` provider tool, including model,
|
|
217
|
+
* size, quality, output format, moderation, background, input-image options,
|
|
218
|
+
* and partial image settings. Successful tool calls expose `result` as base64
|
|
219
|
+
* image data or `null`.
|
|
185
220
|
*
|
|
186
|
-
* @since 1.0.0
|
|
187
221
|
* @category tools
|
|
222
|
+
* @since 4.0.0
|
|
188
223
|
*/
|
|
189
224
|
export declare const ImageGeneration: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
|
|
190
|
-
readonly
|
|
191
|
-
readonly
|
|
192
|
-
readonly quality?: "auto" | "low" | "high" | "medium";
|
|
193
|
-
readonly background?: "auto" | "transparent" | "opaque";
|
|
194
|
-
readonly output_format?: "png" | "webp" | "jpeg";
|
|
195
|
-
readonly output_compression?: number;
|
|
196
|
-
readonly partial_images?: number;
|
|
197
|
-
readonly moderation?: "auto" | "low";
|
|
198
|
-
readonly input_fidelity?: "low" | "high" | null;
|
|
225
|
+
readonly background?: "auto" | "opaque" | "transparent";
|
|
226
|
+
readonly input_fidelity?: "high" | "low" | null;
|
|
199
227
|
readonly input_image_mask?: {
|
|
200
|
-
readonly file_id?: string;
|
|
201
228
|
readonly image_url?: string;
|
|
229
|
+
readonly file_id?: string;
|
|
202
230
|
};
|
|
231
|
+
readonly model?: string;
|
|
232
|
+
readonly moderation?: "auto" | "low";
|
|
233
|
+
readonly output_compression?: number;
|
|
234
|
+
readonly output_format?: "jpeg" | "png" | "webp";
|
|
235
|
+
readonly partial_images?: number;
|
|
236
|
+
readonly quality?: "auto" | "high" | "low" | "medium";
|
|
237
|
+
readonly size?: string;
|
|
203
238
|
}) => Tool.ProviderDefined<"openai.image_generation", "OpenAiImageGeneration", {
|
|
204
239
|
readonly args: Schema.Struct<{
|
|
205
240
|
readonly background: Schema.optionalKey<Schema.Literals<readonly ["transparent", "opaque", "auto"]>>;
|
|
@@ -214,7 +249,7 @@ export declare const ImageGeneration: <Mode extends Tool.FailureMode | undefined
|
|
|
214
249
|
readonly output_format: Schema.optionalKey<Schema.Literals<readonly ["png", "webp", "jpeg"]>>;
|
|
215
250
|
readonly partial_images: Schema.optionalKey<Schema.Number>;
|
|
216
251
|
readonly quality: Schema.optionalKey<Schema.Literals<readonly ["low", "medium", "high", "auto"]>>;
|
|
217
|
-
readonly size: Schema.optionalKey<Schema.Literals<readonly ["1024x1024", "1024x1536", "1536x1024", "auto"]>>;
|
|
252
|
+
readonly size: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Literals<readonly ["1024x1024", "1024x1536", "1536x1024", "auto"]>]>>;
|
|
218
253
|
}>;
|
|
219
254
|
readonly parameters: Schema.Void;
|
|
220
255
|
readonly success: Schema.Struct<{
|
|
@@ -224,13 +259,23 @@ export declare const ImageGeneration: <Mode extends Tool.FailureMode | undefined
|
|
|
224
259
|
readonly failureMode: Mode extends undefined ? "error" : Mode;
|
|
225
260
|
}, false>;
|
|
226
261
|
/**
|
|
227
|
-
* OpenAI Local Shell tool
|
|
262
|
+
* Defines the OpenAI Local Shell tool that enables the model to run a command with a local
|
|
263
|
+
* shell. This local tool runs in your environment and requires a handler to
|
|
264
|
+
* execute commands.
|
|
265
|
+
*
|
|
266
|
+
* **When to use**
|
|
267
|
+
*
|
|
268
|
+
* Use to let an OpenAI model request local shell commands that your application
|
|
269
|
+
* executes through a handler.
|
|
228
270
|
*
|
|
229
|
-
*
|
|
230
|
-
*
|
|
271
|
+
* **Details**
|
|
272
|
+
*
|
|
273
|
+
* The tool exposes a provider-defined `local_shell` call. It is marked as
|
|
274
|
+
* handler-required, so applications must provide the command execution policy
|
|
275
|
+
* and implementation.
|
|
231
276
|
*
|
|
232
|
-
* @since 1.0.0
|
|
233
277
|
* @category tools
|
|
278
|
+
* @since 4.0.0
|
|
234
279
|
*/
|
|
235
280
|
export declare const LocalShell: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
|
|
236
281
|
readonly failureMode?: Mode | undefined;
|
|
@@ -253,24 +298,35 @@ export declare const LocalShell: <Mode extends Tool.FailureMode | undefined = un
|
|
|
253
298
|
readonly failureMode: Mode extends undefined ? "error" : Mode;
|
|
254
299
|
}, true>;
|
|
255
300
|
/**
|
|
256
|
-
* OpenAI MCP tool
|
|
301
|
+
* Defines the OpenAI MCP tool that gives the model access to additional tools via remote
|
|
302
|
+
* Model Context Protocol (MCP) servers.
|
|
303
|
+
*
|
|
304
|
+
* **When to use**
|
|
305
|
+
*
|
|
306
|
+
* Use to let an OpenAI model call tools exposed by a remote MCP server.
|
|
307
|
+
*
|
|
308
|
+
* **Details**
|
|
257
309
|
*
|
|
258
|
-
*
|
|
259
|
-
*
|
|
310
|
+
* The tool accepts MCP server configuration such as allowed tools,
|
|
311
|
+
* authorization, connector id, approval requirements, server metadata, and
|
|
312
|
+
* server URL. Tool call results include the called tool name, arguments, output,
|
|
313
|
+
* error, and server label.
|
|
314
|
+
*
|
|
315
|
+
* **Gotchas**
|
|
316
|
+
*
|
|
317
|
+
* This schema leaves both `server_url` and `connector_id` optional, but OpenAI
|
|
318
|
+
* may require a server URL or connector id for a usable MCP tool configuration.
|
|
260
319
|
*
|
|
261
|
-
* @since 1.0.0
|
|
262
320
|
* @category tools
|
|
321
|
+
* @since 4.0.0
|
|
263
322
|
*/
|
|
264
323
|
export declare const Mcp: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
|
|
265
|
-
readonly server_label: string;
|
|
266
324
|
readonly allowed_tools?: readonly string[] | {
|
|
267
325
|
readonly tool_names?: readonly string[];
|
|
268
326
|
readonly read_only?: boolean;
|
|
269
327
|
} | null;
|
|
270
|
-
readonly server_url?: string;
|
|
271
|
-
readonly connector_id?: "connector_dropbox" | "connector_gmail" | "connector_googlecalendar" | "connector_googledrive" | "connector_microsoftteams" | "connector_outlookcalendar" | "connector_outlookemail" | "connector_sharepoint";
|
|
272
328
|
readonly authorization?: string;
|
|
273
|
-
readonly
|
|
329
|
+
readonly connector_id?: "connector_dropbox" | "connector_gmail" | "connector_googlecalendar" | "connector_googledrive" | "connector_microsoftteams" | "connector_outlookcalendar" | "connector_outlookemail" | "connector_sharepoint";
|
|
274
330
|
readonly require_approval?: "always" | "never" | {
|
|
275
331
|
readonly always?: {
|
|
276
332
|
readonly tool_names?: readonly string[];
|
|
@@ -281,6 +337,9 @@ export declare const Mcp: <Mode extends Tool.FailureMode | undefined = undefined
|
|
|
281
337
|
readonly read_only?: boolean;
|
|
282
338
|
};
|
|
283
339
|
} | null;
|
|
340
|
+
readonly server_description?: string;
|
|
341
|
+
readonly server_label: string;
|
|
342
|
+
readonly server_url?: string;
|
|
284
343
|
}) => Tool.ProviderDefined<"openai.mcp", "OpenAiMcp", {
|
|
285
344
|
readonly args: Schema.Struct<{
|
|
286
345
|
readonly allowed_tools: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Struct<{
|
|
@@ -303,7 +362,7 @@ export declare const Mcp: <Mode extends Tool.FailureMode | undefined = undefined
|
|
|
303
362
|
readonly server_label: Schema.String;
|
|
304
363
|
readonly server_url: Schema.optionalKey<Schema.String>;
|
|
305
364
|
}>;
|
|
306
|
-
readonly parameters: Schema.
|
|
365
|
+
readonly parameters: Schema.Unknown;
|
|
307
366
|
readonly success: Schema.Struct<{
|
|
308
367
|
readonly type: Schema.Literal<"mcp_call">;
|
|
309
368
|
readonly name: Schema.String;
|
|
@@ -316,14 +375,21 @@ export declare const Mcp: <Mode extends Tool.FailureMode | undefined = undefined
|
|
|
316
375
|
readonly failureMode: Mode extends undefined ? "error" : Mode;
|
|
317
376
|
}, false>;
|
|
318
377
|
/**
|
|
319
|
-
* OpenAI
|
|
378
|
+
* Defines the OpenAI shell tool for model-requested command execution.
|
|
379
|
+
*
|
|
380
|
+
* **When to use**
|
|
320
381
|
*
|
|
321
|
-
*
|
|
322
|
-
*
|
|
323
|
-
*
|
|
382
|
+
* Use to let an OpenAI model request shell commands that your application
|
|
383
|
+
* executes through a handler.
|
|
384
|
+
*
|
|
385
|
+
* **Details**
|
|
386
|
+
*
|
|
387
|
+
* The tool exposes a provider-defined `shell` call. It is marked as
|
|
388
|
+
* handler-required, so applications must provide the command execution policy
|
|
389
|
+
* and implementation.
|
|
324
390
|
*
|
|
325
|
-
* @since 1.0.0
|
|
326
391
|
* @category tools
|
|
392
|
+
* @since 4.0.0
|
|
327
393
|
*/
|
|
328
394
|
export declare const Shell: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
|
|
329
395
|
readonly failureMode?: Mode | undefined;
|
|
@@ -346,20 +412,34 @@ export declare const Shell: <Mode extends Tool.FailureMode | undefined = undefin
|
|
|
346
412
|
readonly type: Schema.Literal<"exit">;
|
|
347
413
|
readonly exit_code: Schema.Number;
|
|
348
414
|
}>]>;
|
|
415
|
+
readonly created_by: Schema.optionalKey<Schema.String>;
|
|
349
416
|
}>>;
|
|
350
417
|
}>;
|
|
351
418
|
readonly failure: Schema.Never;
|
|
352
419
|
readonly failureMode: Mode extends undefined ? "error" : Mode;
|
|
353
420
|
}, true>;
|
|
354
421
|
/**
|
|
355
|
-
* OpenAI Web Search tool
|
|
422
|
+
* Defines the OpenAI Web Search tool that enables the model to search the web for
|
|
423
|
+
* information.
|
|
424
|
+
*
|
|
425
|
+
* **When to use**
|
|
426
|
+
*
|
|
427
|
+
* Use to enable OpenAI provider-defined web search for a model response.
|
|
356
428
|
*
|
|
357
|
-
*
|
|
429
|
+
* **Details**
|
|
430
|
+
*
|
|
431
|
+
* The tool accepts optional filters, user location, and search context size.
|
|
432
|
+
* Successful calls expose the performed search action and status.
|
|
433
|
+
*
|
|
434
|
+
* @see {@link WebSearchPreview} for the preview web search provider tool
|
|
358
435
|
*
|
|
359
|
-
* @since 1.0.0
|
|
360
436
|
* @category tools
|
|
437
|
+
* @since 4.0.0
|
|
361
438
|
*/
|
|
362
439
|
export declare const WebSearch: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
|
|
440
|
+
readonly filters?: {
|
|
441
|
+
readonly allowed_domains?: readonly string[] | null;
|
|
442
|
+
} | null;
|
|
363
443
|
readonly user_location?: {
|
|
364
444
|
readonly type?: "approximate";
|
|
365
445
|
readonly country?: string | null;
|
|
@@ -367,10 +447,7 @@ export declare const WebSearch: <Mode extends Tool.FailureMode | undefined = und
|
|
|
367
447
|
readonly city?: string | null;
|
|
368
448
|
readonly timezone?: string | null;
|
|
369
449
|
} | null;
|
|
370
|
-
readonly search_context_size?: "
|
|
371
|
-
readonly filters?: {
|
|
372
|
-
readonly allowed_domains?: readonly string[] | null;
|
|
373
|
-
} | null;
|
|
450
|
+
readonly search_context_size?: "high" | "low" | "medium";
|
|
374
451
|
}) => Tool.ProviderDefined<"openai.web_search", "OpenAiWebSearch", {
|
|
375
452
|
readonly args: Schema.Struct<{
|
|
376
453
|
readonly filters: Schema.optionalKey<Schema.Union<readonly [Schema.Struct<{
|
|
@@ -426,12 +503,21 @@ export declare const WebSearch: <Mode extends Tool.FailureMode | undefined = und
|
|
|
426
503
|
readonly failureMode: Mode extends undefined ? "error" : Mode;
|
|
427
504
|
}, false>;
|
|
428
505
|
/**
|
|
429
|
-
* OpenAI Web Search
|
|
506
|
+
* Defines the OpenAI preview Web Search tool for model responses.
|
|
507
|
+
*
|
|
508
|
+
* **When to use**
|
|
509
|
+
*
|
|
510
|
+
* Use to enable the preview OpenAI web search provider tool.
|
|
511
|
+
*
|
|
512
|
+
* **Details**
|
|
513
|
+
*
|
|
514
|
+
* The preview tool accepts optional user location and search context size, then
|
|
515
|
+
* exposes the performed search action and status in successful calls.
|
|
430
516
|
*
|
|
431
|
-
*
|
|
517
|
+
* @see {@link WebSearch} for the stable web search provider tool
|
|
432
518
|
*
|
|
433
|
-
* @since 1.0.0
|
|
434
519
|
* @category tools
|
|
520
|
+
* @since 4.0.0
|
|
435
521
|
*/
|
|
436
522
|
export declare const WebSearchPreview: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
|
|
437
523
|
readonly user_location?: {
|
|
@@ -441,7 +527,7 @@ export declare const WebSearchPreview: <Mode extends Tool.FailureMode | undefine
|
|
|
441
527
|
readonly city?: string | null;
|
|
442
528
|
readonly timezone?: string | null;
|
|
443
529
|
} | null;
|
|
444
|
-
readonly search_context_size?: "
|
|
530
|
+
readonly search_context_size?: "high" | "low" | "medium";
|
|
445
531
|
}) => Tool.ProviderDefined<"openai.web_search_preview", "OpenAiWebSearchPreview", {
|
|
446
532
|
readonly args: Schema.Struct<{
|
|
447
533
|
readonly user_location: Schema.optionalKey<Schema.Union<readonly [Schema.Struct<{
|
package/dist/OpenAiTool.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OpenAiTool.d.ts","sourceRoot":"","sources":["../src/OpenAiTool.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"OpenAiTool.d.ts","sourceRoot":"","sources":["../src/OpenAiTool.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,IAAI,MAAM,yBAAyB,CAAA;AAG/C;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAClB,UAAU,CAAC,OAAO,UAAU,CAAC,GAC7B,UAAU,CAAC,OAAO,eAAe,CAAC,GAClC,UAAU,CAAC,OAAO,UAAU,CAAC,GAC7B,UAAU,CAAC,OAAO,KAAK,CAAC,GACxB,UAAU,CAAC,OAAO,eAAe,CAAC,GAClC,UAAU,CAAC,OAAO,UAAU,CAAC,GAC7B,UAAU,CAAC,OAAO,GAAG,CAAC,GACtB,UAAU,CAAC,OAAO,SAAS,CAAC,GAC5B,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAEvC;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;QAarB,CAAA;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAc1B,CAAA;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAerB,CAAA;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAmB1B,CAAA;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;QAWrB,CAAA;AAEF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAsBd,CAAA;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;QAWhB,CAAA;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAgBpB,CAAA;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAY3B,CAAA"}
|