@ai-sdk/openai 3.0.36 → 3.0.37

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @ai-sdk/openai
 
+## 3.0.37
+
+### Patch Changes
+
+- 58bc42d: feat(provider/openai): support custom tools with alias mapping
+- Updated dependencies [58bc42d]
+  - @ai-sdk/provider-utils@4.0.16
+
 ## 3.0.36
 
 ### Patch Changes

package/dist/index.d.mts

@@ -286,6 +286,12 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
             path: string;
             diff: string;
         };
+    } | {
+        type: "custom_tool_call";
+        id: string;
+        call_id: string;
+        name: string;
+        input: string;
     } | {
         type: "shell_call";
         id: string;
@@ -328,6 +334,13 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         name: string;
         arguments: string;
         status: "completed";
+    } | {
+        type: "custom_tool_call";
+        id: string;
+        call_id: string;
+        name: string;
+        input: string;
+        status: "completed";
     } | {
         type: "code_interpreter_call";
         id: string;
@@ -477,6 +490,11 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
     item_id: string;
     output_index: number;
     delta: string;
+} | {
+    type: "response.custom_tool_call_input.delta";
+    item_id: string;
+    output_index: number;
+    delta: string;
 } | {
     type: "response.image_generation_call.partial_image";
     item_id: string;
@@ -556,6 +574,28 @@ type OpenAIResponsesLogprobs = NonNullable<(OpenAIResponsesChunk & {
     type: 'response.output_text.delta';
 })['logprobs']> | null;
 
+declare const customToolFactory: _ai_sdk_provider_utils.ProviderToolFactory<string, {
+    /**
+     * The name of the custom tool, used to identify it in the API.
+     */
+    name: string;
+    /**
+     * An optional description of what the tool does.
+     */
+    description?: string;
+    /**
+     * The output format specification for the tool.
+     * Omit for unconstrained text output.
+     */
+    format?: {
+        type: "grammar";
+        syntax: "regex" | "lark";
+        definition: string;
+    } | {
+        type: "text";
+    };
+}>;
+
 /**
  * Type definitions for the apply_patch operations.
  */
@@ -602,6 +642,16 @@ declare const openaiTools: {
         status: "completed" | "failed";
         output?: string;
     }, {}>;
+    /**
+     * Custom tools let callers constrain model output to a grammar (regex or
+     * Lark syntax). The model returns a `custom_tool_call` output item whose
+     * `input` field is a string matching the specified grammar.
+     *
+     * @param name - The name of the custom tool.
+     * @param description - An optional description of the tool.
+     * @param format - The output format constraint (grammar type, syntax, and definition).
+     */
+    customTool: (args: Parameters<typeof customToolFactory>[0]) => _ai_sdk_provider_utils.Tool<string, unknown>;
     /**
      * The Code Interpreter tool allows models to write and run Python code in a
      * sandboxed environment to solve complex problems in domains like data analysis,

package/dist/index.d.ts

@@ -286,6 +286,12 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
             path: string;
             diff: string;
         };
+    } | {
+        type: "custom_tool_call";
+        id: string;
+        call_id: string;
+        name: string;
+        input: string;
     } | {
         type: "shell_call";
         id: string;
@@ -328,6 +334,13 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         name: string;
         arguments: string;
         status: "completed";
+    } | {
+        type: "custom_tool_call";
+        id: string;
+        call_id: string;
+        name: string;
+        input: string;
+        status: "completed";
     } | {
         type: "code_interpreter_call";
         id: string;
@@ -477,6 +490,11 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
     item_id: string;
     output_index: number;
     delta: string;
+} | {
+    type: "response.custom_tool_call_input.delta";
+    item_id: string;
+    output_index: number;
+    delta: string;
 } | {
     type: "response.image_generation_call.partial_image";
     item_id: string;
@@ -556,6 +574,28 @@ type OpenAIResponsesLogprobs = NonNullable<(OpenAIResponsesChunk & {
     type: 'response.output_text.delta';
 })['logprobs']> | null;
 
+declare const customToolFactory: _ai_sdk_provider_utils.ProviderToolFactory<string, {
+    /**
+     * The name of the custom tool, used to identify it in the API.
+     */
+    name: string;
+    /**
+     * An optional description of what the tool does.
+     */
+    description?: string;
+    /**
+     * The output format specification for the tool.
+     * Omit for unconstrained text output.
+     */
+    format?: {
+        type: "grammar";
+        syntax: "regex" | "lark";
+        definition: string;
+    } | {
+        type: "text";
+    };
+}>;
+
 /**
  * Type definitions for the apply_patch operations.
  */
@@ -602,6 +642,16 @@ declare const openaiTools: {
         status: "completed" | "failed";
         output?: string;
     }, {}>;
+    /**
+     * Custom tools let callers constrain model output to a grammar (regex or
+     * Lark syntax). The model returns a `custom_tool_call` output item whose
+     * `input` field is a string matching the specified grammar.
+     *
+     * @param name - The name of the custom tool.
+     * @param description - An optional description of the tool.
+     * @param format - The output format constraint (grammar type, syntax, and definition).
+     */
+    customTool: (args: Parameters<typeof customToolFactory>[0]) => _ai_sdk_provider_utils.Tool<string, unknown>;
     /**
      * The Code Interpreter tool allows models to write and run Python code in a
      * sandboxed environment to solve complex problems in domains like data analysis,