@ai-sdk/openai 3.0.130 → 3.0.132
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/CHANGELOG.md +16 -0
- package/dist/index.d.mts +10 -1
- package/dist/index.d.ts +10 -1
- package/dist/index.js +77 -54
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +221 -192
- package/dist/index.mjs.map +1 -1
- package/dist/internal/index.d.mts +96 -3
- package/dist/internal/index.d.ts +96 -3
- package/dist/internal/index.js +85 -53
- package/dist/internal/index.js.map +1 -1
- package/dist/internal/index.mjs +225 -191
- package/dist/internal/index.mjs.map +1 -1
- package/docs/03-openai.mdx +3 -3
- package/package.json +5 -5
- package/src/chat/openai-chat-api.ts +1 -1
- package/src/completion/openai-completion-api.ts +1 -1
- package/src/image/openai-image-model-options.ts +40 -39
- package/src/internal/index.ts +1 -0
- package/src/openai-error.ts +22 -14
- package/src/responses/convert-openai-responses-usage.ts +6 -0
- package/src/responses/convert-to-openai-responses-input.ts +17 -11
- package/src/responses/openai-responses-api.ts +117 -94
- package/src/responses/openai-responses-language-model.ts +1 -0
- package/src/responses/openai-responses-options.ts +4 -2
- package/src/responses/openai-responses-prepare-tools.ts +4 -3
- package/src/tool/file-search.ts +15 -12
- package/src/tool/mcp.ts +13 -11
- package/src/tool/shell.ts +22 -21
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { LanguageModelV3, LanguageModelV3CallOptions, LanguageModelV3GenerateResult, LanguageModelV3StreamResult, EmbeddingModelV3, ImageModelV3, TranscriptionModelV3CallOptions, TranscriptionModelV3, SpeechModelV3, JSONValue } from '@ai-sdk/provider';
|
|
1
|
+
import { LanguageModelV3, LanguageModelV3CallOptions, LanguageModelV3GenerateResult, LanguageModelV3StreamResult, EmbeddingModelV3, ImageModelV3, TranscriptionModelV3CallOptions, TranscriptionModelV3, SpeechModelV3, JSONValue, JSONObject } from '@ai-sdk/provider';
|
|
2
2
|
import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
|
|
3
|
-
import { InferSchema, FetchFunction, EXPERIMENTAL_EMBEDDING_MODEL_MAX_INPUT_BYTES_PER_CALL } from '@ai-sdk/provider-utils';
|
|
3
|
+
import { InferSchema, FetchFunction, EXPERIMENTAL_EMBEDDING_MODEL_MAX_INPUT_BYTES_PER_CALL, FlexibleSchema } from '@ai-sdk/provider-utils';
|
|
4
4
|
|
|
5
5
|
type OpenAIChatModelId = 'o1' | 'o1-2024-12-17' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o3' | 'o3-2025-04-16' | 'o4-mini' | 'o4-mini-2025-04-16' | 'gpt-4.1' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano' | 'gpt-4.1-nano-2025-04-14' | 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-audio-preview-2025-06-03' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4o-mini-audio-preview' | 'gpt-4o-mini-audio-preview-2024-12-17' | 'gpt-4o-search-preview' | 'gpt-4o-search-preview-2025-03-11' | 'gpt-4o-mini-search-preview' | 'gpt-4o-mini-search-preview-2025-03-11' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-16k' | 'gpt-5' | 'gpt-5-2025-08-07' | 'gpt-5-mini' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano' | 'gpt-5-nano-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-5.1' | 'gpt-5.1-2025-11-13' | 'gpt-5.1-chat-latest' | 'gpt-5.2' | 'gpt-5.2-2025-12-11' | 'gpt-5.2-chat-latest' | 'gpt-5.2-pro' | 'gpt-5.2-pro-2025-12-11' | 'gpt-5.3-chat-latest' | 'gpt-5.4' | 'gpt-5.4-2026-03-05' | 'gpt-5.4-mini' | 'gpt-5.4-mini-2026-03-17' | 'gpt-5.4-nano' | 'gpt-5.4-nano-2026-03-17' | 'gpt-5.4-pro' | 'gpt-5.4-pro-2026-03-05' | 'gpt-5.5' | 'gpt-5.5-2026-04-23' | 'gpt-5.6' | 'gpt-5.6-luna' | 'gpt-5.6-sol' | 'gpt-5.6-terra' | 'gpt-6-astra' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'gpt-6-sol' | (string & {});
|
|
6
6
|
declare const openaiLanguageModelChatOptions: _ai_sdk_provider_utils.LazySchema<{
|
|
@@ -297,6 +297,10 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
|
|
|
297
297
|
input_tokens_details?: (Record<string, JSONValue | undefined> & {
|
|
298
298
|
cached_tokens?: number | null | undefined;
|
|
299
299
|
cache_write_tokens?: number | null | undefined;
|
|
300
|
+
cache_write_tokens_details?: (Record<string, JSONValue | undefined> & {
|
|
301
|
+
ttl_30m_tokens?: number | null | undefined;
|
|
302
|
+
ttl_12h_tokens?: number | null | undefined;
|
|
303
|
+
}) | null | undefined;
|
|
300
304
|
orchestration_input_tokens?: number | null | undefined;
|
|
301
305
|
orchestration_input_cached_tokens?: number | null | undefined;
|
|
302
306
|
}) | null | undefined;
|
|
@@ -328,6 +332,10 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
|
|
|
328
332
|
input_tokens_details?: (Record<string, JSONValue | undefined> & {
|
|
329
333
|
cached_tokens?: number | null | undefined;
|
|
330
334
|
cache_write_tokens?: number | null | undefined;
|
|
335
|
+
cache_write_tokens_details?: (Record<string, JSONValue | undefined> & {
|
|
336
|
+
ttl_30m_tokens?: number | null | undefined;
|
|
337
|
+
ttl_12h_tokens?: number | null | undefined;
|
|
338
|
+
}) | null | undefined;
|
|
331
339
|
orchestration_input_tokens?: number | null | undefined;
|
|
332
340
|
orchestration_input_cached_tokens?: number | null | undefined;
|
|
333
341
|
}) | null | undefined;
|
|
@@ -1198,6 +1206,91 @@ declare const imageGeneration: (args?: ImageGenerationArgs) => _ai_sdk_provider_
|
|
|
1198
1206
|
result: string;
|
|
1199
1207
|
}>;
|
|
1200
1208
|
|
|
1209
|
+
declare const toolSearchArgsSchema: _ai_sdk_provider_utils.LazySchema<{
|
|
1210
|
+
execution?: "server" | "client" | undefined;
|
|
1211
|
+
description?: string | undefined;
|
|
1212
|
+
parameters?: Record<string, unknown> | undefined;
|
|
1213
|
+
}>;
|
|
1214
|
+
declare const toolSearchInputSchema: _ai_sdk_provider_utils.LazySchema<{
|
|
1215
|
+
arguments?: unknown;
|
|
1216
|
+
call_id?: string | null | undefined;
|
|
1217
|
+
}>;
|
|
1218
|
+
declare const toolSearchOutputSchema: FlexibleSchema<{
|
|
1219
|
+
tools: Array<JSONObject>;
|
|
1220
|
+
}>;
|
|
1221
|
+
declare const toolSearchToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{
|
|
1222
|
+
/**
|
|
1223
|
+
* The arguments from the tool_search_call.
|
|
1224
|
+
* This is preserved for multi-turn conversation reconstruction.
|
|
1225
|
+
*/
|
|
1226
|
+
arguments?: unknown;
|
|
1227
|
+
/**
|
|
1228
|
+
* The call ID from the tool_search_call.
|
|
1229
|
+
* Present for client-executed tool search; null for hosted.
|
|
1230
|
+
*/
|
|
1231
|
+
call_id?: string | null;
|
|
1232
|
+
}, {
|
|
1233
|
+
/**
|
|
1234
|
+
* The tools that were loaded by the tool search.
|
|
1235
|
+
* These are the deferred tools that the model requested to load.
|
|
1236
|
+
* Each tool is represented as a JSON object with properties depending on its type.
|
|
1237
|
+
*
|
|
1238
|
+
* Common properties include:
|
|
1239
|
+
* - `type`: The type of the tool (e.g., 'function', 'web_search', etc.)
|
|
1240
|
+
* - `name`: The name of the tool (for function tools)
|
|
1241
|
+
* - `description`: A description of the tool
|
|
1242
|
+
* - `deferLoading`: Whether this tool was deferred (had defer_loading: true)
|
|
1243
|
+
* - `parameters`: The JSON Schema for the function parameters (for function tools)
|
|
1244
|
+
* - `strict`: Whether to enable strict schema adherence (for function tools)
|
|
1245
|
+
*/
|
|
1246
|
+
tools: Array<JSONObject>;
|
|
1247
|
+
}, {
|
|
1248
|
+
/**
|
|
1249
|
+
* Whether the tool search is executed by the server (hosted) or client.
|
|
1250
|
+
* - `'server'` (default): OpenAI performs the search across deferred tools.
|
|
1251
|
+
* - `'client'`: The model emits a `tool_search_call` and your `execute`
|
|
1252
|
+
* function performs the lookup, returning the tools to load.
|
|
1253
|
+
*/
|
|
1254
|
+
execution?: "server" | "client";
|
|
1255
|
+
/**
|
|
1256
|
+
* A description of the tool search capability.
|
|
1257
|
+
* Only used for client-executed tool search.
|
|
1258
|
+
*/
|
|
1259
|
+
description?: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* JSON Schema for the search arguments your application expects.
|
|
1262
|
+
* Only used for client-executed tool search.
|
|
1263
|
+
*/
|
|
1264
|
+
parameters?: Record<string, unknown>;
|
|
1265
|
+
}>;
|
|
1266
|
+
declare const toolSearch: (args?: Parameters<typeof toolSearchToolFactory>[0]) => _ai_sdk_provider_utils.Tool<{
|
|
1267
|
+
/**
|
|
1268
|
+
* The arguments from the tool_search_call.
|
|
1269
|
+
* This is preserved for multi-turn conversation reconstruction.
|
|
1270
|
+
*/
|
|
1271
|
+
arguments?: unknown;
|
|
1272
|
+
/**
|
|
1273
|
+
* The call ID from the tool_search_call.
|
|
1274
|
+
* Present for client-executed tool search; null for hosted.
|
|
1275
|
+
*/
|
|
1276
|
+
call_id?: string | null;
|
|
1277
|
+
}, {
|
|
1278
|
+
/**
|
|
1279
|
+
* The tools that were loaded by the tool search.
|
|
1280
|
+
* These are the deferred tools that the model requested to load.
|
|
1281
|
+
* Each tool is represented as a JSON object with properties depending on its type.
|
|
1282
|
+
*
|
|
1283
|
+
* Common properties include:
|
|
1284
|
+
* - `type`: The type of the tool (e.g., 'function', 'web_search', etc.)
|
|
1285
|
+
* - `name`: The name of the tool (for function tools)
|
|
1286
|
+
* - `description`: A description of the tool
|
|
1287
|
+
* - `deferLoading`: Whether this tool was deferred (had defer_loading: true)
|
|
1288
|
+
* - `parameters`: The JSON Schema for the function parameters (for function tools)
|
|
1289
|
+
* - `strict`: Whether to enable strict schema adherence (for function tools)
|
|
1290
|
+
*/
|
|
1291
|
+
tools: Array<JSONObject>;
|
|
1292
|
+
}>;
|
|
1293
|
+
|
|
1201
1294
|
declare const webSearchArgsSchema: _ai_sdk_provider_utils.LazySchema<{
|
|
1202
1295
|
externalWebAccess?: boolean | undefined;
|
|
1203
1296
|
filters?: {
|
|
@@ -1483,4 +1576,4 @@ declare const webSearchPreview: _ai_sdk_provider_utils.ProviderToolFactoryWithOu
|
|
|
1483
1576
|
};
|
|
1484
1577
|
}>;
|
|
1485
1578
|
|
|
1486
|
-
export { type ApplyPatchOperation, OpenAIChatLanguageModel, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingModelOptions, OpenAIImageModel, type OpenAIImageModelEditOptions, type OpenAIImageModelGenerationOptions, type OpenAIImageModelId, type OpenAIImageModelOptions, type OpenAILanguageModelChatOptions, type OpenAILanguageModelCompletionOptions, OpenAIResponsesLanguageModel, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAISpeechModelOptions, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionModelOptions, type OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, type OpenaiResponsesToolCallProviderMetadata, type ResponsesProviderMetadata, type ResponsesReasoningProviderMetadata, type ResponsesSourceDocumentProviderMetadata, type ResponsesTextProviderMetadata, type ResponsesToolCallProviderMetadata, applyPatch, applyPatchArgsSchema, applyPatchInputSchema, applyPatchOutputSchema, applyPatchToolFactory, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, getMaxImagesPerCall, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionModelOptions, openaiEmbeddingModelOptions, openaiImageModelEditOptions, openaiImageModelGenerationOptions, openaiImageModelOptions, openaiLanguageModelChatOptions, openaiLanguageModelCompletionOptions, openaiSpeechModelOptionsSchema, webSearch, webSearchArgsSchema, webSearchOutputSchema, webSearchPreview, webSearchPreviewArgsSchema, webSearchPreviewInputSchema, webSearchToolFactory };
|
|
1579
|
+
export { type ApplyPatchOperation, OpenAIChatLanguageModel, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingModelOptions, OpenAIImageModel, type OpenAIImageModelEditOptions, type OpenAIImageModelGenerationOptions, type OpenAIImageModelId, type OpenAIImageModelOptions, type OpenAILanguageModelChatOptions, type OpenAILanguageModelCompletionOptions, OpenAIResponsesLanguageModel, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAISpeechModelOptions, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionModelOptions, type OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, type OpenaiResponsesToolCallProviderMetadata, type ResponsesProviderMetadata, type ResponsesReasoningProviderMetadata, type ResponsesSourceDocumentProviderMetadata, type ResponsesTextProviderMetadata, type ResponsesToolCallProviderMetadata, applyPatch, applyPatchArgsSchema, applyPatchInputSchema, applyPatchOutputSchema, applyPatchToolFactory, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, getMaxImagesPerCall, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionModelOptions, openaiEmbeddingModelOptions, openaiImageModelEditOptions, openaiImageModelGenerationOptions, openaiImageModelOptions, openaiLanguageModelChatOptions, openaiLanguageModelCompletionOptions, openaiSpeechModelOptionsSchema, toolSearch, toolSearchArgsSchema, toolSearchInputSchema, toolSearchOutputSchema, webSearch, webSearchArgsSchema, webSearchOutputSchema, webSearchPreview, webSearchPreviewArgsSchema, webSearchPreviewInputSchema, webSearchToolFactory };
|
package/dist/internal/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { LanguageModelV3, LanguageModelV3CallOptions, LanguageModelV3GenerateResult, LanguageModelV3StreamResult, EmbeddingModelV3, ImageModelV3, TranscriptionModelV3CallOptions, TranscriptionModelV3, SpeechModelV3, JSONValue } from '@ai-sdk/provider';
|
|
1
|
+
import { LanguageModelV3, LanguageModelV3CallOptions, LanguageModelV3GenerateResult, LanguageModelV3StreamResult, EmbeddingModelV3, ImageModelV3, TranscriptionModelV3CallOptions, TranscriptionModelV3, SpeechModelV3, JSONValue, JSONObject } from '@ai-sdk/provider';
|
|
2
2
|
import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
|
|
3
|
-
import { InferSchema, FetchFunction, EXPERIMENTAL_EMBEDDING_MODEL_MAX_INPUT_BYTES_PER_CALL } from '@ai-sdk/provider-utils';
|
|
3
|
+
import { InferSchema, FetchFunction, EXPERIMENTAL_EMBEDDING_MODEL_MAX_INPUT_BYTES_PER_CALL, FlexibleSchema } from '@ai-sdk/provider-utils';
|
|
4
4
|
|
|
5
5
|
type OpenAIChatModelId = 'o1' | 'o1-2024-12-17' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o3' | 'o3-2025-04-16' | 'o4-mini' | 'o4-mini-2025-04-16' | 'gpt-4.1' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano' | 'gpt-4.1-nano-2025-04-14' | 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-audio-preview-2025-06-03' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4o-mini-audio-preview' | 'gpt-4o-mini-audio-preview-2024-12-17' | 'gpt-4o-search-preview' | 'gpt-4o-search-preview-2025-03-11' | 'gpt-4o-mini-search-preview' | 'gpt-4o-mini-search-preview-2025-03-11' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-16k' | 'gpt-5' | 'gpt-5-2025-08-07' | 'gpt-5-mini' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano' | 'gpt-5-nano-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-5.1' | 'gpt-5.1-2025-11-13' | 'gpt-5.1-chat-latest' | 'gpt-5.2' | 'gpt-5.2-2025-12-11' | 'gpt-5.2-chat-latest' | 'gpt-5.2-pro' | 'gpt-5.2-pro-2025-12-11' | 'gpt-5.3-chat-latest' | 'gpt-5.4' | 'gpt-5.4-2026-03-05' | 'gpt-5.4-mini' | 'gpt-5.4-mini-2026-03-17' | 'gpt-5.4-nano' | 'gpt-5.4-nano-2026-03-17' | 'gpt-5.4-pro' | 'gpt-5.4-pro-2026-03-05' | 'gpt-5.5' | 'gpt-5.5-2026-04-23' | 'gpt-5.6' | 'gpt-5.6-luna' | 'gpt-5.6-sol' | 'gpt-5.6-terra' | 'gpt-6-astra' | 'gpt-6.1-sol' | 'gpt-6-luna' | 'gpt-6-sol' | (string & {});
|
|
6
6
|
declare const openaiLanguageModelChatOptions: _ai_sdk_provider_utils.LazySchema<{
|
|
@@ -297,6 +297,10 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
|
|
|
297
297
|
input_tokens_details?: (Record<string, JSONValue | undefined> & {
|
|
298
298
|
cached_tokens?: number | null | undefined;
|
|
299
299
|
cache_write_tokens?: number | null | undefined;
|
|
300
|
+
cache_write_tokens_details?: (Record<string, JSONValue | undefined> & {
|
|
301
|
+
ttl_30m_tokens?: number | null | undefined;
|
|
302
|
+
ttl_12h_tokens?: number | null | undefined;
|
|
303
|
+
}) | null | undefined;
|
|
300
304
|
orchestration_input_tokens?: number | null | undefined;
|
|
301
305
|
orchestration_input_cached_tokens?: number | null | undefined;
|
|
302
306
|
}) | null | undefined;
|
|
@@ -328,6 +332,10 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
|
|
|
328
332
|
input_tokens_details?: (Record<string, JSONValue | undefined> & {
|
|
329
333
|
cached_tokens?: number | null | undefined;
|
|
330
334
|
cache_write_tokens?: number | null | undefined;
|
|
335
|
+
cache_write_tokens_details?: (Record<string, JSONValue | undefined> & {
|
|
336
|
+
ttl_30m_tokens?: number | null | undefined;
|
|
337
|
+
ttl_12h_tokens?: number | null | undefined;
|
|
338
|
+
}) | null | undefined;
|
|
331
339
|
orchestration_input_tokens?: number | null | undefined;
|
|
332
340
|
orchestration_input_cached_tokens?: number | null | undefined;
|
|
333
341
|
}) | null | undefined;
|
|
@@ -1198,6 +1206,91 @@ declare const imageGeneration: (args?: ImageGenerationArgs) => _ai_sdk_provider_
|
|
|
1198
1206
|
result: string;
|
|
1199
1207
|
}>;
|
|
1200
1208
|
|
|
1209
|
+
declare const toolSearchArgsSchema: _ai_sdk_provider_utils.LazySchema<{
|
|
1210
|
+
execution?: "server" | "client" | undefined;
|
|
1211
|
+
description?: string | undefined;
|
|
1212
|
+
parameters?: Record<string, unknown> | undefined;
|
|
1213
|
+
}>;
|
|
1214
|
+
declare const toolSearchInputSchema: _ai_sdk_provider_utils.LazySchema<{
|
|
1215
|
+
arguments?: unknown;
|
|
1216
|
+
call_id?: string | null | undefined;
|
|
1217
|
+
}>;
|
|
1218
|
+
declare const toolSearchOutputSchema: FlexibleSchema<{
|
|
1219
|
+
tools: Array<JSONObject>;
|
|
1220
|
+
}>;
|
|
1221
|
+
declare const toolSearchToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{
|
|
1222
|
+
/**
|
|
1223
|
+
* The arguments from the tool_search_call.
|
|
1224
|
+
* This is preserved for multi-turn conversation reconstruction.
|
|
1225
|
+
*/
|
|
1226
|
+
arguments?: unknown;
|
|
1227
|
+
/**
|
|
1228
|
+
* The call ID from the tool_search_call.
|
|
1229
|
+
* Present for client-executed tool search; null for hosted.
|
|
1230
|
+
*/
|
|
1231
|
+
call_id?: string | null;
|
|
1232
|
+
}, {
|
|
1233
|
+
/**
|
|
1234
|
+
* The tools that were loaded by the tool search.
|
|
1235
|
+
* These are the deferred tools that the model requested to load.
|
|
1236
|
+
* Each tool is represented as a JSON object with properties depending on its type.
|
|
1237
|
+
*
|
|
1238
|
+
* Common properties include:
|
|
1239
|
+
* - `type`: The type of the tool (e.g., 'function', 'web_search', etc.)
|
|
1240
|
+
* - `name`: The name of the tool (for function tools)
|
|
1241
|
+
* - `description`: A description of the tool
|
|
1242
|
+
* - `deferLoading`: Whether this tool was deferred (had defer_loading: true)
|
|
1243
|
+
* - `parameters`: The JSON Schema for the function parameters (for function tools)
|
|
1244
|
+
* - `strict`: Whether to enable strict schema adherence (for function tools)
|
|
1245
|
+
*/
|
|
1246
|
+
tools: Array<JSONObject>;
|
|
1247
|
+
}, {
|
|
1248
|
+
/**
|
|
1249
|
+
* Whether the tool search is executed by the server (hosted) or client.
|
|
1250
|
+
* - `'server'` (default): OpenAI performs the search across deferred tools.
|
|
1251
|
+
* - `'client'`: The model emits a `tool_search_call` and your `execute`
|
|
1252
|
+
* function performs the lookup, returning the tools to load.
|
|
1253
|
+
*/
|
|
1254
|
+
execution?: "server" | "client";
|
|
1255
|
+
/**
|
|
1256
|
+
* A description of the tool search capability.
|
|
1257
|
+
* Only used for client-executed tool search.
|
|
1258
|
+
*/
|
|
1259
|
+
description?: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* JSON Schema for the search arguments your application expects.
|
|
1262
|
+
* Only used for client-executed tool search.
|
|
1263
|
+
*/
|
|
1264
|
+
parameters?: Record<string, unknown>;
|
|
1265
|
+
}>;
|
|
1266
|
+
declare const toolSearch: (args?: Parameters<typeof toolSearchToolFactory>[0]) => _ai_sdk_provider_utils.Tool<{
|
|
1267
|
+
/**
|
|
1268
|
+
* The arguments from the tool_search_call.
|
|
1269
|
+
* This is preserved for multi-turn conversation reconstruction.
|
|
1270
|
+
*/
|
|
1271
|
+
arguments?: unknown;
|
|
1272
|
+
/**
|
|
1273
|
+
* The call ID from the tool_search_call.
|
|
1274
|
+
* Present for client-executed tool search; null for hosted.
|
|
1275
|
+
*/
|
|
1276
|
+
call_id?: string | null;
|
|
1277
|
+
}, {
|
|
1278
|
+
/**
|
|
1279
|
+
* The tools that were loaded by the tool search.
|
|
1280
|
+
* These are the deferred tools that the model requested to load.
|
|
1281
|
+
* Each tool is represented as a JSON object with properties depending on its type.
|
|
1282
|
+
*
|
|
1283
|
+
* Common properties include:
|
|
1284
|
+
* - `type`: The type of the tool (e.g., 'function', 'web_search', etc.)
|
|
1285
|
+
* - `name`: The name of the tool (for function tools)
|
|
1286
|
+
* - `description`: A description of the tool
|
|
1287
|
+
* - `deferLoading`: Whether this tool was deferred (had defer_loading: true)
|
|
1288
|
+
* - `parameters`: The JSON Schema for the function parameters (for function tools)
|
|
1289
|
+
* - `strict`: Whether to enable strict schema adherence (for function tools)
|
|
1290
|
+
*/
|
|
1291
|
+
tools: Array<JSONObject>;
|
|
1292
|
+
}>;
|
|
1293
|
+
|
|
1201
1294
|
declare const webSearchArgsSchema: _ai_sdk_provider_utils.LazySchema<{
|
|
1202
1295
|
externalWebAccess?: boolean | undefined;
|
|
1203
1296
|
filters?: {
|
|
@@ -1483,4 +1576,4 @@ declare const webSearchPreview: _ai_sdk_provider_utils.ProviderToolFactoryWithOu
|
|
|
1483
1576
|
};
|
|
1484
1577
|
}>;
|
|
1485
1578
|
|
|
1486
|
-
export { type ApplyPatchOperation, OpenAIChatLanguageModel, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingModelOptions, OpenAIImageModel, type OpenAIImageModelEditOptions, type OpenAIImageModelGenerationOptions, type OpenAIImageModelId, type OpenAIImageModelOptions, type OpenAILanguageModelChatOptions, type OpenAILanguageModelCompletionOptions, OpenAIResponsesLanguageModel, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAISpeechModelOptions, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionModelOptions, type OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, type OpenaiResponsesToolCallProviderMetadata, type ResponsesProviderMetadata, type ResponsesReasoningProviderMetadata, type ResponsesSourceDocumentProviderMetadata, type ResponsesTextProviderMetadata, type ResponsesToolCallProviderMetadata, applyPatch, applyPatchArgsSchema, applyPatchInputSchema, applyPatchOutputSchema, applyPatchToolFactory, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, getMaxImagesPerCall, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionModelOptions, openaiEmbeddingModelOptions, openaiImageModelEditOptions, openaiImageModelGenerationOptions, openaiImageModelOptions, openaiLanguageModelChatOptions, openaiLanguageModelCompletionOptions, openaiSpeechModelOptionsSchema, webSearch, webSearchArgsSchema, webSearchOutputSchema, webSearchPreview, webSearchPreviewArgsSchema, webSearchPreviewInputSchema, webSearchToolFactory };
|
|
1579
|
+
export { type ApplyPatchOperation, OpenAIChatLanguageModel, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingModelOptions, OpenAIImageModel, type OpenAIImageModelEditOptions, type OpenAIImageModelGenerationOptions, type OpenAIImageModelId, type OpenAIImageModelOptions, type OpenAILanguageModelChatOptions, type OpenAILanguageModelCompletionOptions, OpenAIResponsesLanguageModel, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAISpeechModelOptions, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionModelOptions, type OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, type OpenaiResponsesToolCallProviderMetadata, type ResponsesProviderMetadata, type ResponsesReasoningProviderMetadata, type ResponsesSourceDocumentProviderMetadata, type ResponsesTextProviderMetadata, type ResponsesToolCallProviderMetadata, applyPatch, applyPatchArgsSchema, applyPatchInputSchema, applyPatchOutputSchema, applyPatchToolFactory, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, getMaxImagesPerCall, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionModelOptions, openaiEmbeddingModelOptions, openaiImageModelEditOptions, openaiImageModelGenerationOptions, openaiImageModelOptions, openaiLanguageModelChatOptions, openaiLanguageModelCompletionOptions, openaiSpeechModelOptionsSchema, toolSearch, toolSearchArgsSchema, toolSearchInputSchema, toolSearchOutputSchema, webSearch, webSearchArgsSchema, webSearchOutputSchema, webSearchPreview, webSearchPreviewArgsSchema, webSearchPreviewInputSchema, webSearchToolFactory };
|