@effect/ai-openai 4.0.0-beta.70 → 4.0.0-beta.71

package/dist/OpenAiTool.d.ts

@@ -1,8 +1,27 @@
 /**
- * OpenAI provider-defined tools for use with the LanguageModel.
+ * OpenAI provider-defined tools for Effect AI language model requests.
  *
- * Provides tools that are natively supported by OpenAI's API, including
- * code interpreter, file search, and web search functionality.
+ * This module exposes typed descriptors for OpenAI tools such as code
+ * interpreter, file search, image generation, MCP, web search, and shell-like
+ * local tools. Each descriptor captures the OpenAI provider name, user-facing
+ * configuration arguments, provider call parameters, success output schema, and
+ * whether the tool call needs an application-provided handler.
+ *
+ * **Mental model**
+ *
+ * Provider-defined tools are not implementations of the capability themselves.
+ * They are schemas and metadata that tell the language model provider which
+ * tool to make available and tell Effect AI how to decode any tool calls or
+ * tool results that come back.
+ *
+ * **Common tasks**
+ *
+ * Use hosted or provider-routed tools such as {@link CodeInterpreter},
+ * {@link FileSearch}, {@link ImageGeneration}, {@link Mcp}, {@link WebSearch},
+ * and {@link WebSearchPreview} to opt into OpenAI-managed capabilities. Use
+ * handler-required tools such as {@link ApplyPatch}, {@link Shell}, and
+ * {@link LocalShell} only when your application is prepared to execute the
+ * requested local operation and enforce its own safety policy.
  *
  * @since 4.0.0
  */
@@ -20,6 +39,12 @@ export type OpenAiTool = ReturnType<typeof ApplyPatch> | ReturnType<typeof CodeI
  * deleting, or updating files. This local tool runs in your environment and
  * requires a handler to execute file operations.
  *
+ * **When to use**
+ *
+ * Use when you want an OpenAI model to request structured file edits as create,
+ * delete, or update operations that your application executes through a local
+ * handler.
+ *
  * @category tools
  * @since 4.0.0
  */
@@ -53,6 +78,16 @@ export declare const ApplyPatch: <Mode extends Tool.FailureMode | undefined = un
  * OpenAI Code Interpreter tool that allows the model to execute Python code in
  * a sandboxed environment.
  *
+ * **When to use**
+ *
+ * Use to enable OpenAI-hosted Python execution for a model response.
+ *
+ * **Details**
+ *
+ * The tool is configured with a `container` argument. Successful tool calls
+ * expose `outputs`, which may contain logs or generated images, or `null` when
+ * no outputs are available.
+ *
  * @category tools
  * @since 4.0.0
  */
@@ -112,6 +147,17 @@ export declare const CodeInterpreter: <Mode extends Tool.FailureMode | undefined
  * OpenAI File Search tool that enables the model to search through uploaded
  * files and vector stores.
  *
+ * **When to use**
+ *
+ * Use to let an OpenAI model search uploaded files through one or more vector
+ * stores.
+ *
+ * **Details**
+ *
+ * The tool requires `vector_store_ids` and accepts optional `filters`,
+ * `max_num_results`, and `ranking_options`. Successful tool calls expose the
+ * search `status`, generated `queries`, and optional `results`.
+ *
  * @category tools
  * @since 4.0.0
  */
@@ -178,6 +224,18 @@ export declare const FileSearch: <Mode extends Tool.FailureMode | undefined = un
  * OpenAI Image Generation tool that enables the model to generate images using
  * the GPT image models.
  *
+ * **When to use**
+ *
+ * Use to enable OpenAI provider-defined image generation through a language
+ * model response.
+ *
+ * **Details**
+ *
+ * The tool configures the `image_generation` provider tool, including model,
+ * size, quality, output format, moderation, background, input-image options,
+ * and partial image settings. Successful tool calls expose `result` as base64
+ * image data or `null`.
+ *
  * @category tools
  * @since 4.0.0
  */
@@ -223,6 +281,17 @@ export declare const ImageGeneration: <Mode extends Tool.FailureMode | undefined
  * shell. This local tool runs in your environment and requires a handler to
  * execute commands.
  *
+ * **When to use**
+ *
+ * Use to let an OpenAI model request local shell commands that your application
+ * executes through a handler.
+ *
+ * **Details**
+ *
+ * The tool exposes a provider-defined `local_shell` call. It is marked as
+ * handler-required, so applications must provide the command execution policy
+ * and implementation.
+ *
  * @category tools
  * @since 4.0.0
  */
@@ -250,6 +319,22 @@ export declare const LocalShell: <Mode extends Tool.FailureMode | undefined = un
  * OpenAI MCP tool that gives the model access to additional tools via remote
  * Model Context Protocol (MCP) servers.
  *
+ * **When to use**
+ *
+ * Use to let an OpenAI model call tools exposed by a remote MCP server.
+ *
+ * **Details**
+ *
+ * The tool accepts MCP server configuration such as allowed tools,
+ * authorization, connector id, approval requirements, server metadata, and
+ * server URL. Tool call results include the called tool name, arguments, output,
+ * error, and server label.
+ *
+ * **Gotchas**
+ *
+ * This schema leaves both `server_url` and `connector_id` optional, but OpenAI
+ * may require a server URL or connector id for a usable MCP tool configuration.
+ *
  * @category tools
  * @since 4.0.0
  */
@@ -346,6 +431,17 @@ export declare const Shell: <Mode extends Tool.FailureMode | undefined = undefin
  * OpenAI Web Search tool that enables the model to search the web for
  * information.
  *
+ * **When to use**
+ *
+ * Use to enable OpenAI provider-defined web search for a model response.
+ *
+ * **Details**
+ *
+ * The tool accepts optional filters, user location, and search context size.
+ * Successful calls expose the performed search action and status.
+ *
+ * @see {@link WebSearchPreview} for the preview web search provider tool
+ *
  * @category tools
  * @since 4.0.0
  */
@@ -416,8 +512,18 @@ export declare const WebSearch: <Mode extends Tool.FailureMode | undefined = und
     readonly failureMode: Mode extends undefined ? "error" : Mode;
 }, false>;
 /**
- * OpenAI Web Search Preview tool, a preview version of the web search tool with
- * additional features.
+ * OpenAI preview Web Search tool for model responses.
+ *
+ * **When to use**
+ *
+ * Use to enable the preview OpenAI web search provider tool.
+ *
+ * **Details**
+ *
+ * The preview tool accepts optional user location and search context size, then
+ * exposes the performed search action and status in successful calls.
+ *
+ * @see {@link WebSearch} for the stable web search provider tool
  *
  * @category tools
  * @since 4.0.0

package/dist/OpenAiTool.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"OpenAiTool.d.ts","sourceRoot":"","sources":["../src/OpenAiTool.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;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;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;QAarB,CAAA;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAc1B,CAAA;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAerB,CAAA;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAmB1B,CAAA;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;QAWrB,CAAA;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAsBd,CAAA;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;QAWhB,CAAA;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAgBpB,CAAA;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAY3B,CAAA"}
+{"version":3,"file":"OpenAiTool.d.ts","sourceRoot":"","sources":["../src/OpenAiTool.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;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;;;;;;;GAOG;AACH,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;QAWhB,CAAA;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAgBpB,CAAA;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAY3B,CAAA"}

package/dist/OpenAiTool.js

@@ -1,8 +1,27 @@
 /**
- * OpenAI provider-defined tools for use with the LanguageModel.
+ * OpenAI provider-defined tools for Effect AI language model requests.
  *
- * Provides tools that are natively supported by OpenAI's API, including
- * code interpreter, file search, and web search functionality.
+ * This module exposes typed descriptors for OpenAI tools such as code
+ * interpreter, file search, image generation, MCP, web search, and shell-like
+ * local tools. Each descriptor captures the OpenAI provider name, user-facing
+ * configuration arguments, provider call parameters, success output schema, and
+ * whether the tool call needs an application-provided handler.
+ *
+ * **Mental model**
+ *
+ * Provider-defined tools are not implementations of the capability themselves.
+ * They are schemas and metadata that tell the language model provider which
+ * tool to make available and tell Effect AI how to decode any tool calls or
+ * tool results that come back.
+ *
+ * **Common tasks**
+ *
+ * Use hosted or provider-routed tools such as {@link CodeInterpreter},
+ * {@link FileSearch}, {@link ImageGeneration}, {@link Mcp}, {@link WebSearch},
+ * and {@link WebSearchPreview} to opt into OpenAI-managed capabilities. Use
+ * handler-required tools such as {@link ApplyPatch}, {@link Shell}, and
+ * {@link LocalShell} only when your application is prepared to execute the
+ * requested local operation and enforce its own safety policy.
  *
  * @since 4.0.0
  */
@@ -14,6 +33,12 @@ import * as Generated from "./Generated.js";
  * deleting, or updating files. This local tool runs in your environment and
  * requires a handler to execute file operations.
  *
+ * **When to use**
+ *
+ * Use when you want an OpenAI model to request structured file edits as create,
+ * delete, or update operations that your application executes through a local
+ * handler.
+ *
  * @category tools
  * @since 4.0.0
  */
@@ -35,6 +60,16 @@ export const ApplyPatch = /*#__PURE__*/Tool.providerDefined({
  * OpenAI Code Interpreter tool that allows the model to execute Python code in
  * a sandboxed environment.
  *
+ * **When to use**
+ *
+ * Use to enable OpenAI-hosted Python execution for a model response.
+ *
+ * **Details**
+ *
+ * The tool is configured with a `container` argument. Successful tool calls
+ * expose `outputs`, which may contain logs or generated images, or `null` when
+ * no outputs are available.
+ *
  * @category tools
  * @since 4.0.0
  */
@@ -57,6 +92,17 @@ export const CodeInterpreter = /*#__PURE__*/Tool.providerDefined({
  * OpenAI File Search tool that enables the model to search through uploaded
  * files and vector stores.
  *
+ * **When to use**
+ *
+ * Use to let an OpenAI model search uploaded files through one or more vector
+ * stores.
+ *
+ * **Details**
+ *
+ * The tool requires `vector_store_ids` and accepts optional `filters`,
+ * `max_num_results`, and `ranking_options`. Successful tool calls expose the
+ * search `status`, generated `queries`, and optional `results`.
+ *
  * @category tools
  * @since 4.0.0
  */
@@ -80,6 +126,18 @@ export const FileSearch = /*#__PURE__*/Tool.providerDefined({
  * OpenAI Image Generation tool that enables the model to generate images using
  * the GPT image models.
  *
+ * **When to use**
+ *
+ * Use to enable OpenAI provider-defined image generation through a language
+ * model response.
+ *
+ * **Details**
+ *
+ * The tool configures the `image_generation` provider tool, including model,
+ * size, quality, output format, moderation, background, input-image options,
+ * and partial image settings. Successful tool calls expose `result` as base64
+ * image data or `null`.
+ *
  * @category tools
  * @since 4.0.0
  */
@@ -108,6 +166,17 @@ export const ImageGeneration = /*#__PURE__*/Tool.providerDefined({
  * shell. This local tool runs in your environment and requires a handler to
  * execute commands.
  *
+ * **When to use**
+ *
+ * Use to let an OpenAI model request local shell commands that your application
+ * executes through a handler.
+ *
+ * **Details**
+ *
+ * The tool exposes a provider-defined `local_shell` call. It is marked as
+ * handler-required, so applications must provide the command execution policy
+ * and implementation.
+ *
  * @category tools
  * @since 4.0.0
  */
@@ -127,6 +196,22 @@ export const LocalShell = /*#__PURE__*/Tool.providerDefined({
  * OpenAI MCP tool that gives the model access to additional tools via remote
  * Model Context Protocol (MCP) servers.
  *
+ * **When to use**
+ *
+ * Use to let an OpenAI model call tools exposed by a remote MCP server.
+ *
+ * **Details**
+ *
+ * The tool accepts MCP server configuration such as allowed tools,
+ * authorization, connector id, approval requirements, server metadata, and
+ * server URL. Tool call results include the called tool name, arguments, output,
+ * error, and server label.
+ *
+ * **Gotchas**
+ *
+ * This schema leaves both `server_url` and `connector_id` optional, but OpenAI
+ * may require a server URL or connector id for a usable MCP tool configuration.
+ *
  * @category tools
  * @since 4.0.0
  */
@@ -177,6 +262,17 @@ export const Shell = /*#__PURE__*/Tool.providerDefined({
  * OpenAI Web Search tool that enables the model to search the web for
  * information.
  *
+ * **When to use**
+ *
+ * Use to enable OpenAI provider-defined web search for a model response.
+ *
+ * **Details**
+ *
+ * The tool accepts optional filters, user location, and search context size.
+ * Successful calls expose the performed search action and status.
+ *
+ * @see {@link WebSearchPreview} for the preview web search provider tool
+ *
  * @category tools
  * @since 4.0.0
  */
@@ -198,8 +294,18 @@ export const WebSearch = /*#__PURE__*/Tool.providerDefined({
   })
 });
 /**
- * OpenAI Web Search Preview tool, a preview version of the web search tool with
- * additional features.
+ * OpenAI preview Web Search tool for model responses.
+ *
+ * **When to use**
+ *
+ * Use to enable the preview OpenAI web search provider tool.
+ *
+ * **Details**
+ *
+ * The preview tool accepts optional user location and search context size, then
+ * exposes the performed search action and status in successful calls.
+ *
+ * @see {@link WebSearch} for the stable web search provider tool
  *
  * @category tools
  * @since 4.0.0

package/dist/OpenAiTool.js.map

@@ -1 +1 @@
-{"version":3,"file":"OpenAiTool.js","names":["Schema","Tool","Generated","ApplyPatch","providerDefined","id","customName","providerName","requiresHandler","parameters","Struct","call_id","ApplyPatchToolCall","fields","operation","success","status","ApplyPatchToolCallOutput","output","CodeInterpreter","args","container","CodeInterpreterTool","code","CodeInterpreterToolCall","container_id","outputs","FileSearch","filters","FileSearchTool","max_num_results","ranking_options","vector_store_ids","FileSearchToolCall","queries","results","ImageGeneration","background","ImageGenTool","input_fidelity","input_image_mask","model","moderation","output_compression","output_format","partial_images","quality","size","result","ImageGenToolCall","LocalShell","action","LocalShellToolCall","LocalShellToolCallOutput","Mcp","allowed_tools","MCPTool","authorization","connector_id","require_approval","server_description","server_label","server_url","Unknown","type","MCPToolCall","name","arguments","error","Shell","FunctionShellCall","FunctionShellCallOutput","WebSearch","WebSearchTool","user_location","search_context_size","WebSearchToolCall","WebSearchPreview","WebSearchPreviewTool"],"sources":["../src/OpenAiTool.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;AAQA,OAAO,KAAKA,MAAM,MAAM,eAAe;AACvC,OAAO,KAAKC,IAAI,MAAM,yBAAyB;AAC/C,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAmB3C;;;;;;;;AAQA,OAAO,MAAMC,UAAU,gBAAGF,IAAI,CAACG,eAAe,CAAC;EAC7CC,EAAE,EAAE,oBAAoB;EACxBC,UAAU,EAAE,kBAAkB;EAC9BC,YAAY,EAAE,aAAa;EAC3BC,eAAe,EAAE,IAAI;EACrBC,UAAU,eAAET,MAAM,CAACU,MAAM,CAAC;IACxBC,OAAO,EAAET,SAAS,CAACU,kBAAkB,CAACC,MAAM,CAACF,OAAO;IACpDG,SAAS,EAAEZ,SAAS,CAACU,kBAAkB,CAACC,MAAM,CAACC;GAChD,CAAC;EACFC,OAAO,eAAEf,MAAM,CAACU,MAAM,CAAC;IACrBM,MAAM,EAAEd,SAAS,CAACe,wBAAwB,CAACJ,MAAM,CAACG,MAAM;IACxDE,MAAM,EAAEhB,SAAS,CAACe,wBAAwB,CAACJ,MAAM,CAACK;GACnD;CACF,CAAC;AAEF;;;;;;;AAOA,OAAO,MAAMC,eAAe,gBAAGlB,IAAI,CAACG,eAAe,CAAC;EAClDC,EAAE,EAAE,yBAAyB;EAC7BC,UAAU,EAAE,uBAAuB;EACnCC,YAAY,EAAE,kBAAkB;EAChCa,IAAI,eAAEpB,MAAM,CAACU,MAAM,CAAC;IAClBW,SAAS,EAAEnB,SAAS,CAACoB,mBAAmB,CAACT,MAAM,CAACQ;GACjD,CAAC;EACFZ,UAAU,eAAET,MAAM,CAACU,MAAM,CAAC;IACxBa,IAAI,EAAErB,SAAS,CAACsB,uBAAuB,CAACX,MAAM,CAACU,IAAI;IACnDE,YAAY,EAAEvB,SAAS,CAACsB,uBAAuB,CAACX,MAAM,CAACY;GACxD,CAAC;EACFV,OAAO,eAAEf,MAAM,CAACU,MAAM,CAAC;IACrBgB,OAAO,EAAExB,SAAS,CAACsB,uBAAuB,CAACX,MAAM,CAACa;GACnD;CACF,CAAC;AAEF;;;;;;;AAOA,OAAO,MAAMC,UAAU,gBAAG1B,IAAI,CAACG,eAAe,CAAC;EAC7CC,EAAE,EAAE,oBAAoB;EACxBC,UAAU,EAAE,kBAAkB;EAC9BC,YAAY,EAAE,aAAa;EAC3Ba,IAAI,eAAEpB,MAAM,CAACU,MAAM,CAAC;IAClBkB,OAAO,EAAE1B,SAAS,CAAC2B,cAAc,CAAChB,MAAM,CAACe,OAAO;IAChDE,eAAe,EAAE5B,SAAS,CAAC2B,cAAc,CAAChB,MAAM,CAACiB,eAAe;IAChEC,eAAe,EAAE7B,SAAS,CAAC2B,cAAc,CAAChB,MAAM,CAACkB,eAAe;IAChEC,gBAAgB,EAAE9B,SAAS,CAAC2B,cAAc,CAAChB,MAAM,CAACmB;GACnD,CAAC;EACFjB,OAAO,eAAEf,MAAM,CAACU,MAAM,CAAC;IACrBM,MAAM,EAAEd,SAAS,CAAC+B,kBAAkB,CAACpB,MAAM,CAACG,MAAM;IAClDkB,OAAO,EAAEhC,SAAS,CAAC+B,kBAAkB,CAACpB,MAAM,CAACqB,OAAO;IACpDC,OAAO,EAAEjC,SAAS,CAAC+B,kBAAkB,CAACpB,MAAM,CAACsB;GAC9C;CACF,CAAC;AAEF;;;;;;;AAOA,OAAO,MAAMC,eAAe,gBAAGnC,IAAI,CAACG,eAAe,CAAC;EAClDC,EAAE,EAAE,yBAAyB;EAC7BC,UAAU,EAAE,uBAAuB;EACnCC,YAAY,EAAE,kBAAkB;EAChCa,IAAI,eAAEpB,MAAM,CAACU,MAAM,CAAC;IAClB2B,UAAU,EAAEnC,SAAS,CAACoC,YAAY,CAACzB,MAAM,CAACwB,UAAU;IACpDE,cAAc,EAAErC,SAAS,CAACoC,YAAY,CAACzB,MAAM,CAAC0B,cAAc;IAC5DC,gBAAgB,EAAEtC,SAAS,CAACoC,YAAY,CAACzB,MAAM,CAAC2B,gBAAgB;IAChEC,KAAK,EAAEvC,SAAS,CAACoC,YAAY,CAACzB,MAAM,CAAC4B,KAAK;IAC1CC,UAAU,EAAExC,SAAS,CAACoC,YAAY,CAACzB,MAAM,CAAC6B,UAAU;IACpDC,kBAAkB,EAAEzC,SAAS,CAACoC,YAAY,CAACzB,MAAM,CAAC8B,kBAAkB;IACpEC,aAAa,EAAE1C,SAAS,CAACoC,YAAY,CAACzB,MAAM,CAAC+B,aAAa;IAC1DC,cAAc,EAAE3C,SAAS,CAACoC,YAAY,CAACzB,MAAM,CAACgC,cAAc;IAC5DC,OAAO,EAAE5C,SAAS,CAACoC,YAAY,CAACzB,MAAM,CAACiC,OAAO;IAC9CC,IAAI,EAAE7C,SAAS,CAACoC,YAAY,CAACzB,MAAM,CAACkC;GACrC,CAAC;EACFhC,OAAO,eAAEf,MAAM,CAACU,MAAM,CAAC;IACrBsC,MAAM,EAAE9C,SAAS,CAAC+C,gBAAgB,CAACpC,MAAM,CAACmC;GAC3C;CACF,CAAC;AAEF;;;;;;;;AAQA,OAAO,MAAME,UAAU,gBAAGjD,IAAI,CAACG,eAAe,CAAC;EAC7CC,EAAE,EAAE,oBAAoB;EACxBC,UAAU,EAAE,kBAAkB;EAC9BC,YAAY,EAAE,aAAa;EAC3BC,eAAe,EAAE,IAAI;EACrBC,UAAU,eAAET,MAAM,CAACU,MAAM,CAAC;IACxByC,MAAM,EAAEjD,SAAS,CAACkD,kBAAkB,CAACvC,MAAM,CAACsC;GAC7C,CAAC;EACFpC,OAAO,eAAEf,MAAM,CAACU,MAAM,CAAC;IACrBQ,MAAM,EAAEhB,SAAS,CAACmD,wBAAwB,CAACxC,MAAM,CAACK;GACnD;CACF,CAAC;AAEF;;;;;;;AAOA,OAAO,MAAMoC,GAAG,gBAAGrD,IAAI,CAACG,eAAe,CAAC;EACtCC,EAAE,EAAE,YAAY;EAChBC,UAAU,EAAE,WAAW;EACvBC,YAAY,EAAE,KAAK;EACnBa,IAAI,eAAEpB,MAAM,CAACU,MAAM,CAAC;IAClB6C,aAAa,EAAErD,SAAS,CAACsD,OAAO,CAAC3C,MAAM,CAAC0C,aAAa;IACrDE,aAAa,EAAEvD,SAAS,CAACsD,OAAO,CAAC3C,MAAM,CAAC4C,aAAa;IACrDC,YAAY,EAAExD,SAAS,CAACsD,OAAO,CAAC3C,MAAM,CAAC6C,YAAY;IACnDC,gBAAgB,EAAEzD,SAAS,CAACsD,OAAO,CAAC3C,MAAM,CAAC8C,gBAAgB;IAC3DC,kBAAkB,EAAE1D,SAAS,CAACsD,OAAO,CAAC3C,MAAM,CAAC+C,kBAAkB;IAC/DC,YAAY,EAAE3D,SAAS,CAACsD,OAAO,CAAC3C,MAAM,CAACgD,YAAY;IACnDC,UAAU,EAAE5D,SAAS,CAACsD,OAAO,CAAC3C,MAAM,CAACiD;GACtC,CAAC;EACFrD,UAAU,EAAET,MAAM,CAAC+D,OAAO;EAC1BhD,OAAO,eAAEf,MAAM,CAACU,MAAM,CAAC;IACrBsD,IAAI,EAAE9D,SAAS,CAAC+D,WAAW,CAACpD,MAAM,CAACmD,IAAI;IACvCE,IAAI,EAAEhE,SAAS,CAAC+D,WAAW,CAACpD,MAAM,CAACqD,IAAI;IACvCC,SAAS,EAAEjE,SAAS,CAAC+D,WAAW,CAACpD,MAAM,CAACsD,SAAS;IACjDjD,MAAM,EAAEhB,SAAS,CAAC+D,WAAW,CAACpD,MAAM,CAACK,MAAM;IAC3CkD,KAAK,EAAElE,SAAS,CAAC+D,WAAW,CAACpD,MAAM,CAACuD,KAAK;IACzCP,YAAY,EAAE3D,SAAS,CAAC+D,WAAW,CAACpD,MAAM,CAACgD;GAC5C;CACF,CAAC;AAEF;;;;;;;;AAQA,OAAO,MAAMQ,KAAK,gBAAGpE,IAAI,CAACG,eAAe,CAAC;EACxCC,EAAE,EAAE,cAAc;EAClBC,UAAU,EAAE,aAAa;EACzBC,YAAY,EAAE,OAAO;EACrBC,eAAe,EAAE,IAAI;EACrBC,UAAU,eAAET,MAAM,CAACU,MAAM,CAAC;IACxByC,MAAM,EAAEjD,SAAS,CAACoE,iBAAiB,CAACzD,MAAM,CAACsC;GAC5C,CAAC;EACFpC,OAAO,eAAEf,MAAM,CAACU,MAAM,CAAC;IACrBQ,MAAM,EAAEhB,SAAS,CAACqE,uBAAuB,CAAC1D,MAAM,CAACK;GAClD;CACF,CAAC;AAEF;;;;;;;AAOA,OAAO,MAAMsD,SAAS,gBAAGvE,IAAI,CAACG,eAAe,CAAC;EAC5CC,EAAE,EAAE,mBAAmB;EACvBC,UAAU,EAAE,iBAAiB;EAC7BC,YAAY,EAAE,YAAY;EAC1Ba,IAAI,eAAEpB,MAAM,CAACU,MAAM,CAAC;IAClBkB,OAAO,EAAE1B,SAAS,CAACuE,aAAa,CAAC5D,MAAM,CAACe,OAAO;IAC/C8C,aAAa,EAAExE,SAAS,CAACuE,aAAa,CAAC5D,MAAM,CAAC6D,aAAa;IAC3DC,mBAAmB,EAAEzE,SAAS,CAACuE,aAAa,CAAC5D,MAAM,CAAC8D;GACrD,CAAC;EACFlE,UAAU,eAAET,MAAM,CAACU,MAAM,CAAC;IACxByC,MAAM,EAAEjD,SAAS,CAAC0E,iBAAiB,CAAC/D,MAAM,CAACsC;GAC5C,CAAC;EACFpC,OAAO,eAAEf,MAAM,CAACU,MAAM,CAAC;IACrByC,MAAM,EAAEjD,SAAS,CAAC0E,iBAAiB,CAAC/D,MAAM,CAACsC,MAAM;IACjDnC,MAAM,EAAEd,SAAS,CAAC0E,iBAAiB,CAAC/D,MAAM,CAACG;GAC5C;CACF,CAAC;AAEF;;;;;;;AAOA,OAAO,MAAM6D,gBAAgB,gBAAG5E,IAAI,CAACG,eAAe,CAAC;EACnDC,EAAE,EAAE,2BAA2B;EAC/BC,UAAU,EAAE,wBAAwB;EACpCC,YAAY,EAAE,oBAAoB;EAClCa,IAAI,eAAEpB,MAAM,CAACU,MAAM,CAAC;IAClBgE,aAAa,EAAExE,SAAS,CAAC4E,oBAAoB,CAACjE,MAAM,CAAC6D,aAAa;IAClEC,mBAAmB,EAAEzE,SAAS,CAAC4E,oBAAoB,CAACjE,MAAM,CAAC8D;GAC5D,CAAC;EACF5D,OAAO,eAAEf,MAAM,CAACU,MAAM,CAAC;IACrByC,MAAM,EAAEjD,SAAS,CAAC0E,iBAAiB,CAAC/D,MAAM,CAACsC,MAAM;IACjDnC,MAAM,EAAEd,SAAS,CAAC0E,iBAAiB,CAAC/D,MAAM,CAACG;GAC5C;CACF,CAAC","ignoreList":[]}
+{"version":3,"file":"OpenAiTool.js","names":["Schema","Tool","Generated","ApplyPatch","providerDefined","id","customName","providerName","requiresHandler","parameters","Struct","call_id","ApplyPatchToolCall","fields","operation","success","status","ApplyPatchToolCallOutput","output","CodeInterpreter","args","container","CodeInterpreterTool","code","CodeInterpreterToolCall","container_id","outputs","FileSearch","filters","FileSearchTool","max_num_results","ranking_options","vector_store_ids","FileSearchToolCall","queries","results","ImageGeneration","background","ImageGenTool","input_fidelity","input_image_mask","model","moderation","output_compression","output_format","partial_images","quality","size","result","ImageGenToolCall","LocalShell","action","LocalShellToolCall","LocalShellToolCallOutput","Mcp","allowed_tools","MCPTool","authorization","connector_id","require_approval","server_description","server_label","server_url","Unknown","type","MCPToolCall","name","arguments","error","Shell","FunctionShellCall","FunctionShellCallOutput","WebSearch","WebSearchTool","user_location","search_context_size","WebSearchToolCall","WebSearchPreview","WebSearchPreviewTool"],"sources":["../src/OpenAiTool.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,OAAO,KAAKA,MAAM,MAAM,eAAe;AACvC,OAAO,KAAKC,IAAI,MAAM,yBAAyB;AAC/C,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAmB3C;;;;;;;;;;;;;;AAcA,OAAO,MAAMC,UAAU,gBAAGF,IAAI,CAACG,eAAe,CAAC;EAC7CC,EAAE,EAAE,oBAAoB;EACxBC,UAAU,EAAE,kBAAkB;EAC9BC,YAAY,EAAE,aAAa;EAC3BC,eAAe,EAAE,IAAI;EACrBC,UAAU,eAAET,MAAM,CAACU,MAAM,CAAC;IACxBC,OAAO,EAAET,SAAS,CAACU,kBAAkB,CAACC,MAAM,CAACF,OAAO;IACpDG,SAAS,EAAEZ,SAAS,CAACU,kBAAkB,CAACC,MAAM,CAACC;GAChD,CAAC;EACFC,OAAO,eAAEf,MAAM,CAACU,MAAM,CAAC;IACrBM,MAAM,EAAEd,SAAS,CAACe,wBAAwB,CAACJ,MAAM,CAACG,MAAM;IACxDE,MAAM,EAAEhB,SAAS,CAACe,wBAAwB,CAACJ,MAAM,CAACK;GACnD;CACF,CAAC;AAEF;;;;;;;;;;;;;;;;;AAiBA,OAAO,MAAMC,eAAe,gBAAGlB,IAAI,CAACG,eAAe,CAAC;EAClDC,EAAE,EAAE,yBAAyB;EAC7BC,UAAU,EAAE,uBAAuB;EACnCC,YAAY,EAAE,kBAAkB;EAChCa,IAAI,eAAEpB,MAAM,CAACU,MAAM,CAAC;IAClBW,SAAS,EAAEnB,SAAS,CAACoB,mBAAmB,CAACT,MAAM,CAACQ;GACjD,CAAC;EACFZ,UAAU,eAAET,MAAM,CAACU,MAAM,CAAC;IACxBa,IAAI,EAAErB,SAAS,CAACsB,uBAAuB,CAACX,MAAM,CAACU,IAAI;IACnDE,YAAY,EAAEvB,SAAS,CAACsB,uBAAuB,CAACX,MAAM,CAACY;GACxD,CAAC;EACFV,OAAO,eAAEf,MAAM,CAACU,MAAM,CAAC;IACrBgB,OAAO,EAAExB,SAAS,CAACsB,uBAAuB,CAACX,MAAM,CAACa;GACnD;CACF,CAAC;AAEF;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMC,UAAU,gBAAG1B,IAAI,CAACG,eAAe,CAAC;EAC7CC,EAAE,EAAE,oBAAoB;EACxBC,UAAU,EAAE,kBAAkB;EAC9BC,YAAY,EAAE,aAAa;EAC3Ba,IAAI,eAAEpB,MAAM,CAACU,MAAM,CAAC;IAClBkB,OAAO,EAAE1B,SAAS,CAAC2B,cAAc,CAAChB,MAAM,CAACe,OAAO;IAChDE,eAAe,EAAE5B,SAAS,CAAC2B,cAAc,CAAChB,MAAM,CAACiB,eAAe;IAChEC,eAAe,EAAE7B,SAAS,CAAC2B,cAAc,CAAChB,MAAM,CAACkB,eAAe;IAChEC,gBAAgB,EAAE9B,SAAS,CAAC2B,cAAc,CAAChB,MAAM,CAACmB;GACnD,CAAC;EACFjB,OAAO,eAAEf,MAAM,CAACU,MAAM,CAAC;IACrBM,MAAM,EAAEd,SAAS,CAAC+B,kBAAkB,CAACpB,MAAM,CAACG,MAAM;IAClDkB,OAAO,EAAEhC,SAAS,CAAC+B,kBAAkB,CAACpB,MAAM,CAACqB,OAAO;IACpDC,OAAO,EAAEjC,SAAS,CAAC+B,kBAAkB,CAACpB,MAAM,CAACsB;GAC9C;CACF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,MAAMC,eAAe,gBAAGnC,IAAI,CAACG,eAAe,CAAC;EAClDC,EAAE,EAAE,yBAAyB;EAC7BC,UAAU,EAAE,uBAAuB;EACnCC,YAAY,EAAE,kBAAkB;EAChCa,IAAI,eAAEpB,MAAM,CAACU,MAAM,CAAC;IAClB2B,UAAU,EAAEnC,SAAS,CAACoC,YAAY,CAACzB,MAAM,CAACwB,UAAU;IACpDE,cAAc,EAAErC,SAAS,CAACoC,YAAY,CAACzB,MAAM,CAAC0B,cAAc;IAC5DC,gBAAgB,EAAEtC,SAAS,CAACoC,YAAY,CAACzB,MAAM,CAAC2B,gBAAgB;IAChEC,KAAK,EAAEvC,SAAS,CAACoC,YAAY,CAACzB,MAAM,CAAC4B,KAAK;IAC1CC,UAAU,EAAExC,SAAS,CAACoC,YAAY,CAACzB,MAAM,CAAC6B,UAAU;IACpDC,kBAAkB,EAAEzC,SAAS,CAACoC,YAAY,CAACzB,MAAM,CAAC8B,kBAAkB;IACpEC,aAAa,EAAE1C,SAAS,CAACoC,YAAY,CAACzB,MAAM,CAAC+B,aAAa;IAC1DC,cAAc,EAAE3C,SAAS,CAACoC,YAAY,CAACzB,MAAM,CAACgC,cAAc;IAC5DC,OAAO,EAAE5C,SAAS,CAACoC,YAAY,CAACzB,MAAM,CAACiC,OAAO;IAC9CC,IAAI,EAAE7C,SAAS,CAACoC,YAAY,CAACzB,MAAM,CAACkC;GACrC,CAAC;EACFhC,OAAO,eAAEf,MAAM,CAACU,MAAM,CAAC;IACrBsC,MAAM,EAAE9C,SAAS,CAAC+C,gBAAgB,CAACpC,MAAM,CAACmC;GAC3C;CACF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,MAAME,UAAU,gBAAGjD,IAAI,CAACG,eAAe,CAAC;EAC7CC,EAAE,EAAE,oBAAoB;EACxBC,UAAU,EAAE,kBAAkB;EAC9BC,YAAY,EAAE,aAAa;EAC3BC,eAAe,EAAE,IAAI;EACrBC,UAAU,eAAET,MAAM,CAACU,MAAM,CAAC;IACxByC,MAAM,EAAEjD,SAAS,CAACkD,kBAAkB,CAACvC,MAAM,CAACsC;GAC7C,CAAC;EACFpC,OAAO,eAAEf,MAAM,CAACU,MAAM,CAAC;IACrBQ,MAAM,EAAEhB,SAAS,CAACmD,wBAAwB,CAACxC,MAAM,CAACK;GACnD;CACF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;AAuBA,OAAO,MAAMoC,GAAG,gBAAGrD,IAAI,CAACG,eAAe,CAAC;EACtCC,EAAE,EAAE,YAAY;EAChBC,UAAU,EAAE,WAAW;EACvBC,YAAY,EAAE,KAAK;EACnBa,IAAI,eAAEpB,MAAM,CAACU,MAAM,CAAC;IAClB6C,aAAa,EAAErD,SAAS,CAACsD,OAAO,CAAC3C,MAAM,CAAC0C,aAAa;IACrDE,aAAa,EAAEvD,SAAS,CAACsD,OAAO,CAAC3C,MAAM,CAAC4C,aAAa;IACrDC,YAAY,EAAExD,SAAS,CAACsD,OAAO,CAAC3C,MAAM,CAAC6C,YAAY;IACnDC,gBAAgB,EAAEzD,SAAS,CAACsD,OAAO,CAAC3C,MAAM,CAAC8C,gBAAgB;IAC3DC,kBAAkB,EAAE1D,SAAS,CAACsD,OAAO,CAAC3C,MAAM,CAAC+C,kBAAkB;IAC/DC,YAAY,EAAE3D,SAAS,CAACsD,OAAO,CAAC3C,MAAM,CAACgD,YAAY;IACnDC,UAAU,EAAE5D,SAAS,CAACsD,OAAO,CAAC3C,MAAM,CAACiD;GACtC,CAAC;EACFrD,UAAU,EAAET,MAAM,CAAC+D,OAAO;EAC1BhD,OAAO,eAAEf,MAAM,CAACU,MAAM,CAAC;IACrBsD,IAAI,EAAE9D,SAAS,CAAC+D,WAAW,CAACpD,MAAM,CAACmD,IAAI;IACvCE,IAAI,EAAEhE,SAAS,CAAC+D,WAAW,CAACpD,MAAM,CAACqD,IAAI;IACvCC,SAAS,EAAEjE,SAAS,CAAC+D,WAAW,CAACpD,MAAM,CAACsD,SAAS;IACjDjD,MAAM,EAAEhB,SAAS,CAAC+D,WAAW,CAACpD,MAAM,CAACK,MAAM;IAC3CkD,KAAK,EAAElE,SAAS,CAAC+D,WAAW,CAACpD,MAAM,CAACuD,KAAK;IACzCP,YAAY,EAAE3D,SAAS,CAAC+D,WAAW,CAACpD,MAAM,CAACgD;GAC5C;CACF,CAAC;AAEF;;;;;;;;AAQA,OAAO,MAAMQ,KAAK,gBAAGpE,IAAI,CAACG,eAAe,CAAC;EACxCC,EAAE,EAAE,cAAc;EAClBC,UAAU,EAAE,aAAa;EACzBC,YAAY,EAAE,OAAO;EACrBC,eAAe,EAAE,IAAI;EACrBC,UAAU,eAAET,MAAM,CAACU,MAAM,CAAC;IACxByC,MAAM,EAAEjD,SAAS,CAACoE,iBAAiB,CAACzD,MAAM,CAACsC;GAC5C,CAAC;EACFpC,OAAO,eAAEf,MAAM,CAACU,MAAM,CAAC;IACrBQ,MAAM,EAAEhB,SAAS,CAACqE,uBAAuB,CAAC1D,MAAM,CAACK;GAClD;CACF,CAAC;AAEF;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMsD,SAAS,gBAAGvE,IAAI,CAACG,eAAe,CAAC;EAC5CC,EAAE,EAAE,mBAAmB;EACvBC,UAAU,EAAE,iBAAiB;EAC7BC,YAAY,EAAE,YAAY;EAC1Ba,IAAI,eAAEpB,MAAM,CAACU,MAAM,CAAC;IAClBkB,OAAO,EAAE1B,SAAS,CAACuE,aAAa,CAAC5D,MAAM,CAACe,OAAO;IAC/C8C,aAAa,EAAExE,SAAS,CAACuE,aAAa,CAAC5D,MAAM,CAAC6D,aAAa;IAC3DC,mBAAmB,EAAEzE,SAAS,CAACuE,aAAa,CAAC5D,MAAM,CAAC8D;GACrD,CAAC;EACFlE,UAAU,eAAET,MAAM,CAACU,MAAM,CAAC;IACxByC,MAAM,EAAEjD,SAAS,CAAC0E,iBAAiB,CAAC/D,MAAM,CAACsC;GAC5C,CAAC;EACFpC,OAAO,eAAEf,MAAM,CAACU,MAAM,CAAC;IACrByC,MAAM,EAAEjD,SAAS,CAAC0E,iBAAiB,CAAC/D,MAAM,CAACsC,MAAM;IACjDnC,MAAM,EAAEd,SAAS,CAAC0E,iBAAiB,CAAC/D,MAAM,CAACG;GAC5C;CACF,CAAC;AAEF;;;;;;;;;;;;;;;;;AAiBA,OAAO,MAAM6D,gBAAgB,gBAAG5E,IAAI,CAACG,eAAe,CAAC;EACnDC,EAAE,EAAE,2BAA2B;EAC/BC,UAAU,EAAE,wBAAwB;EACpCC,YAAY,EAAE,oBAAoB;EAClCa,IAAI,eAAEpB,MAAM,CAACU,MAAM,CAAC;IAClBgE,aAAa,EAAExE,SAAS,CAAC4E,oBAAoB,CAACjE,MAAM,CAAC6D,aAAa;IAClEC,mBAAmB,EAAEzE,SAAS,CAAC4E,oBAAoB,CAACjE,MAAM,CAAC8D;GAC5D,CAAC;EACF5D,OAAO,eAAEf,MAAM,CAACU,MAAM,CAAC;IACrByC,MAAM,EAAEjD,SAAS,CAAC0E,iBAAiB,CAAC/D,MAAM,CAACsC,MAAM;IACjDnC,MAAM,EAAEd,SAAS,CAAC0E,iBAAiB,CAAC/D,MAAM,CAACG;GAC5C;CACF,CAAC","ignoreList":[]}

package/dist/index.d.ts

@@ -2,15 +2,10 @@
  * @since 4.0.0
  */
 /**
- * @since 4.0.0
+ * @since 1.0.0
  */
 export * as Generated from "./Generated.ts";
 /**
- * OpenAI Client module for interacting with OpenAI's API.
- *
- * Provides a type-safe, Effect-based client for OpenAI operations including
- * completions, embeddings, and streaming responses.
- *
  * @since 4.0.0
  */
 export * as OpenAiClient from "./OpenAiClient.ts";
@@ -19,73 +14,30 @@ export * as OpenAiClient from "./OpenAiClient.ts";
  */
 export * as OpenAiClientGenerated from "./OpenAiClientGenerated.ts";
 /**
- * The `OpenAiConfig` module provides contextual configuration for the
- * `@effect/ai-openai` integration. It is used to customize how OpenAI clients
- * are built and interpreted without threading configuration through every API
- * call manually.
- *
- * The primary use case is installing an HTTP client transform with
- * {@link withClientTransform}. This lets applications adapt the underlying
- * OpenAI HTTP client for cross-cutting concerns such as custom middleware,
- * instrumentation, proxying, or request policy changes while keeping the
- * OpenAI service APIs unchanged.
- *
- * Configuration is scoped through Effect's context, so transforms only apply to
- * the effect they are provided to and anything evaluated inside that scope.
- * When multiple transforms are needed, compose them into a single
- * `HttpClient => HttpClient` function before providing the configuration.
- *
  * @since 4.0.0
  */
 export * as OpenAiConfig from "./OpenAiConfig.ts";
 /**
- * OpenAI Embedding Model implementation.
- *
- * Provides an EmbeddingModel implementation for OpenAI's embeddings API.
- *
  * @since 4.0.0
  */
 export * as OpenAiEmbeddingModel from "./OpenAiEmbeddingModel.ts";
 /**
- * OpenAI error metadata augmentation.
- *
- * Provides OpenAI-specific metadata fields for AI error types through module
- * augmentation, enabling typed access to OpenAI error details.
- *
  * @since 4.0.0
  */
 export * as OpenAiError from "./OpenAiError.ts";
 /**
- * OpenAI Language Model implementation.
- *
- * Provides a LanguageModel implementation for OpenAI's responses API,
- * supporting text generation, structured output, tool calling, and streaming.
- *
  * @since 4.0.0
  */
 export * as OpenAiLanguageModel from "./OpenAiLanguageModel.ts";
 /**
- * Minimal local OpenAI schemas used by the handwritten Responses client path.
- *
  * @since 4.0.0
  */
 export * as OpenAiSchema from "./OpenAiSchema.ts";
 /**
- * OpenAI telemetry attributes for OpenTelemetry integration.
- *
- * Provides OpenAI-specific GenAI telemetry attributes following OpenTelemetry
- * semantic conventions, extending the base GenAI attributes with OpenAI-specific
- * request and response metadata.
- *
  * @since 4.0.0
  */
 export * as OpenAiTelemetry from "./OpenAiTelemetry.ts";
 /**
- * OpenAI provider-defined tools for use with the LanguageModel.
- *
- * Provides tools that are natively supported by OpenAI's API, including
- * code interpreter, file search, and web search functionality.
- *
  * @since 4.0.0
  */
 export * as OpenAiTool from "./OpenAiTool.ts";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;GAEG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;;;;;;GAOG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,qBAAqB,MAAM,4BAA4B,CAAA;AAEnE;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;;;;;GAMG;AACH,OAAO,KAAK,oBAAoB,MAAM,2BAA2B,CAAA;AAEjE;;;;;;;GAOG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;;;;;;GAOG;AACH,OAAO,KAAK,mBAAmB,MAAM,0BAA0B,CAAA;AAE/D;;;;GAIG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;;;;;;;GAQG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;;;;;;GAOG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;GAEG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,qBAAqB,MAAM,4BAA4B,CAAA;AAEnE;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,oBAAoB,MAAM,2BAA2B,CAAA;AAEjE;;GAEG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;GAEG;AACH,OAAO,KAAK,mBAAmB,MAAM,0BAA0B,CAAA;AAE/D;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA"}

package/dist/index.js

@@ -3,15 +3,10 @@
  */
 // @barrel: Auto-generated exports. Do not edit manually.
 /**
- * @since 4.0.0
+ * @since 1.0.0
  */
 export * as Generated from "./Generated.js";
 /**
- * OpenAI Client module for interacting with OpenAI's API.
- *
- * Provides a type-safe, Effect-based client for OpenAI operations including
- * completions, embeddings, and streaming responses.
- *
  * @since 4.0.0
  */
 export * as OpenAiClient from "./OpenAiClient.js";
@@ -20,73 +15,30 @@ export * as OpenAiClient from "./OpenAiClient.js";
  */
 export * as OpenAiClientGenerated from "./OpenAiClientGenerated.js";
 /**
- * The `OpenAiConfig` module provides contextual configuration for the
- * `@effect/ai-openai` integration. It is used to customize how OpenAI clients
- * are built and interpreted without threading configuration through every API
- * call manually.
- *
- * The primary use case is installing an HTTP client transform with
- * {@link withClientTransform}. This lets applications adapt the underlying
- * OpenAI HTTP client for cross-cutting concerns such as custom middleware,
- * instrumentation, proxying, or request policy changes while keeping the
- * OpenAI service APIs unchanged.
- *
- * Configuration is scoped through Effect's context, so transforms only apply to
- * the effect they are provided to and anything evaluated inside that scope.
- * When multiple transforms are needed, compose them into a single
- * `HttpClient => HttpClient` function before providing the configuration.
- *
  * @since 4.0.0
  */
 export * as OpenAiConfig from "./OpenAiConfig.js";
 /**
- * OpenAI Embedding Model implementation.
- *
- * Provides an EmbeddingModel implementation for OpenAI's embeddings API.
- *
  * @since 4.0.0
  */
 export * as OpenAiEmbeddingModel from "./OpenAiEmbeddingModel.js";
 /**
- * OpenAI error metadata augmentation.
- *
- * Provides OpenAI-specific metadata fields for AI error types through module
- * augmentation, enabling typed access to OpenAI error details.
- *
  * @since 4.0.0
  */
 export * as OpenAiError from "./OpenAiError.js";
 /**
- * OpenAI Language Model implementation.
- *
- * Provides a LanguageModel implementation for OpenAI's responses API,
- * supporting text generation, structured output, tool calling, and streaming.
- *
  * @since 4.0.0
  */
 export * as OpenAiLanguageModel from "./OpenAiLanguageModel.js";
 /**
- * Minimal local OpenAI schemas used by the handwritten Responses client path.
- *
  * @since 4.0.0
  */
 export * as OpenAiSchema from "./OpenAiSchema.js";
 /**
- * OpenAI telemetry attributes for OpenTelemetry integration.
- *
- * Provides OpenAI-specific GenAI telemetry attributes following OpenTelemetry
- * semantic conventions, extending the base GenAI attributes with OpenAI-specific
- * request and response metadata.
- *
  * @since 4.0.0
  */
 export * as OpenAiTelemetry from "./OpenAiTelemetry.js";
 /**
- * OpenAI provider-defined tools for use with the LanguageModel.
- *
- * Provides tools that are natively supported by OpenAI's API, including
- * code interpreter, file search, and web search functionality.
- *
  * @since 4.0.0
  */
 export * as OpenAiTool from "./OpenAiTool.js";

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Generated","OpenAiClient","OpenAiClientGenerated","OpenAiConfig","OpenAiEmbeddingModel","OpenAiError","OpenAiLanguageModel","OpenAiSchema","OpenAiTelemetry","OpenAiTool"],"sources":["../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;AAGA,OAAO,KAAKA,SAAS,MAAM,gBAAgB;AAE3C;;;;;;;;AAQA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;AAGA,OAAO,KAAKC,qBAAqB,MAAM,4BAA4B;AAEnE;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;;;;;AAOA,OAAO,KAAKC,oBAAoB,MAAM,2BAA2B;AAEjE;;;;;;;;AAQA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;;;;;;AAQA,OAAO,KAAKC,mBAAmB,MAAM,0BAA0B;AAE/D;;;;;AAKA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;;;;;;;AASA,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AAEvD;;;;;;;;AAQA,OAAO,KAAKC,UAAU,MAAM,iBAAiB","ignoreList":[]}
+{"version":3,"file":"index.js","names":["Generated","OpenAiClient","OpenAiClientGenerated","OpenAiConfig","OpenAiEmbeddingModel","OpenAiError","OpenAiLanguageModel","OpenAiSchema","OpenAiTelemetry","OpenAiTool"],"sources":["../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;AAGA,OAAO,KAAKA,SAAS,MAAM,gBAAgB;AAE3C;;;AAGA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;AAGA,OAAO,KAAKC,qBAAqB,MAAM,4BAA4B;AAEnE;;;AAGA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;AAGA,OAAO,KAAKC,oBAAoB,MAAM,2BAA2B;AAEjE;;;AAGA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;AAGA,OAAO,KAAKC,mBAAmB,MAAM,0BAA0B;AAE/D;;;AAGA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;AAGA,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AAEvD;;;AAGA,OAAO,KAAKC,UAAU,MAAM,iBAAiB","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effect/ai-openai",
-  "version": "4.0.0-beta.70",
+  "version": "4.0.0-beta.71",
   "type": "module",
   "license": "MIT",
   "description": "An OpenAI provider integration for Effect AI SDK",
@@ -43,10 +43,10 @@
     "provenance": true
   },
   "devDependencies": {
-    "effect": "^4.0.0-beta.70"
+    "effect": "^4.0.0-beta.71"
   },
   "peerDependencies": {
-    "effect": "^4.0.0-beta.70"
+    "effect": "^4.0.0-beta.71"
   },
   "scripts": {
     "codegen": "effect-utils codegen",