@effect/ai-openai 4.0.0-beta.78 → 4.0.0-beta.79

package/dist/OpenAiTool.d.ts

@@ -1,27 +1,9 @@
 /**
- * OpenAI provider-defined tools for Effect AI language model requests.
- *
- * 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.
+ * The `OpenAiTool` module defines OpenAI provider tools for Effect AI language
+ * model requests. It exposes typed descriptors for tools such as Apply Patch,
+ * Code Interpreter, File Search, Image Generation, MCP, Web Search, and
+ * shell-like local tools, including their provider names, configuration
+ * arguments, call parameters, success schemas, and handler requirements.
  *
  * @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;;;;;;;;;;;;;;;;;;;;;;;;;;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;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;QAWhB,CAAA;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAgBpB,CAAA;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAY3B,CAAA"}
+{"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"}

package/dist/OpenAiTool.js

@@ -1,27 +1,9 @@
 /**
- * OpenAI provider-defined tools for Effect AI language model requests.
- *
- * 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.
+ * The `OpenAiTool` module defines OpenAI provider tools for Effect AI language
+ * model requests. It exposes typed descriptors for tools such as Apply Patch,
+ * Code Interpreter, File Search, Image Generation, MCP, Web Search, and
+ * shell-like local tools, including their provider names, configuration
+ * arguments, call parameters, success schemas, and handler requirements.
  *
  * @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;;;;;;;;;;;;;;;;;;;;;;;;;;;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;;;;;;;;;;;;;;;;;AAiBA,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":[]}
+{"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;;;;;;;;;AASA,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;;;;;;;;;;;;;;;;;AAiBA,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effect/ai-openai",
-  "version": "4.0.0-beta.78",
+  "version": "4.0.0-beta.79",
   "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.78"
+    "effect": "^4.0.0-beta.79"
   },
   "peerDependencies": {
-    "effect": "^4.0.0-beta.78"
+    "effect": "^4.0.0-beta.79"
   },
   "scripts": {
     "codegen": "effect-utils codegen",

package/src/OpenAiClient.ts

@@ -1,36 +1,10 @@
 /**
- * The `OpenAiClient` module provides the handwritten Effect service used by
- * the OpenAI integration for Responses API and embedding requests. It builds on
- * the Effect HTTP client, applies OpenAI authentication and organization or
- * project headers, decodes the minimal schemas needed by higher-level modules,
- * and maps transport or decoding failures into `AiError`.
- *
- * The service exposes a configured HTTP client plus helpers for non-streaming
- * responses, server-sent event response streams, and embeddings. It also
- * includes WebSocket mode for response streams when an application wants to use
- * OpenAI's WebSocket transport instead of the default SSE path.
- *
- * **Common tasks**
- *
- * - Construct the service directly with {@link make}
- * - Provide the service with {@link layer} or load settings from `Config` with
- *   {@link layerConfig}
- * - Call `createResponse`, `createResponseStream`, or `createEmbedding` from
- *   code that depends on the `OpenAiClient` service
- * - Enable WebSocket streaming around an effect with {@link withWebSocketMode}
- *   or through layers with {@link layerWebSocketMode}
- *
- * **Gotchas**
- *
- * - The default base URL is `https://api.openai.com/v1`; set `apiUrl` for
- *   proxies, local gateways, or compatible deployments.
- * - A constructor `transformClient` is applied when the service is built, while
- *   scoped `OpenAiConfig` transforms are applied by request helpers when they
- *   run.
- * - WebSocket mode requires a supported `Socket.WebSocketConstructor` layer and
- *   serializes response streams through the shared socket service.
- * - This module is intentionally narrower than the generated OpenAI client; use
- *   `OpenAiClientGenerated` for direct access to generated endpoint helpers.
+ * The `OpenAiClient` module defines the low-level Effect service used by the
+ * OpenAI integration for Responses API and embedding requests. It builds a
+ * configured HTTP client with authentication and OpenAI organization or project
+ * headers, exposes helpers for non-streaming responses, SSE response streams,
+ * WebSocket response streams, and embeddings, and maps transport or decoding
+ * failures into `AiError`.
  *
  * @since 4.0.0
  */

package/src/OpenAiConfig.ts

@@ -1,34 +1,9 @@
 /**
- * The `OpenAiConfig` module carries request-time configuration for the
- * `@effect/ai-openai` package through Effect's context. It currently exposes a
- * scoped HTTP client transform used by OpenAI request helpers when they execute
+ * The `OpenAiConfig` module lets a workflow temporarily customize the HTTP
+ * client used by `@effect/ai-openai` request helpers. OpenAI client, language
+ * model, and embedding code read this scoped transform when they execute
  * provider calls.
  *
- * **Mental model**
- *
- * Client constructors set the baseline HTTP client for an OpenAI service.
- * `OpenAiConfig` is for narrower dynamic scopes: wrap an effect with
- * {@link withClientTransform} and OpenAI requests evaluated inside that effect
- * see the transformed `HttpClient`. Leaving the scope restores the previous
- * configuration.
- *
- * **Common tasks**
- *
- * - Add request middleware, tracing, retry policy, proxy routing, or test
- *   interception around a group of OpenAI calls.
- * - Apply a temporary HTTP client transform without rebuilding the OpenAI
- *   service layer.
- * - Share one transform across all OpenAI helpers executed inside the same
- *   Effect scope.
- *
- * **Gotchas**
- *
- * - Only one `transformClient` value is stored in the scoped config. Compose
- *   transforms into a single `HttpClient => HttpClient` function when multiple
- *   behaviors should apply.
- * - The transform affects OpenAI requests that read this contextual config; it
- *   does not mutate an already constructed HTTP client globally.
- *
  * @since 4.0.0
  */
 import * as Context from "effect/Context"

package/src/OpenAiEmbeddingModel.ts

@@ -1,33 +1,9 @@
 /**
  * The `OpenAiEmbeddingModel` module provides the OpenAI implementation of
- * Effect AI's `EmbeddingModel` service. It adapts the OpenAI embeddings
- * endpoint into Effect AI's batch embedding interface, preserving input order
- * and returning numeric vectors for each requested input.
- *
- * **Mental model**
- *
- * `OpenAiClient` owns transport, authentication, and provider request
- * execution. This module owns embedding-specific configuration, response
- * validation, and the `EmbeddingModel.EmbeddingModel` layer. Use {@link model}
- * when you want an `AiModel` descriptor that also provides the configured
- * embedding dimensions, or {@link layer} / {@link make} when the dimensions are
- * managed separately.
- *
- * **Common tasks**
- *
- * - Provide an OpenAI-backed `EmbeddingModel.EmbeddingModel` from an existing
- *   `OpenAiClient`
- * - Configure the OpenAI embedding model id, dimensions, encoding format, and
- *   other create-embedding request fields
- * - Scope per-request defaults with {@link Config} and
- *   {@link withConfigOverride}
- *
- * **Gotchas**
- *
- * - The service expects OpenAI to return floating-point embedding arrays.
- *   Requesting base64 embeddings causes an `InvalidOutputError`.
- * - Provider results are checked for missing, duplicate, or out-of-range
- *   indexes before they are exposed as Effect AI embedding results.
+ * Effect AI's `EmbeddingModel` service. It sends embedding requests through
+ * `OpenAiClient`, exposes constructors for layers and `AiModel` values,
+ * supports scoped request configuration overrides, and checks that OpenAI
+ * returns one numeric vector for each requested input.
  *
  * @since 4.0.0
  */

package/src/OpenAiLanguageModel.ts

@@ -3,36 +3,8 @@
  * implementation of Effect AI's `LanguageModel` service. It translates Effect
  * AI prompts, files, tools, structured output requests, reasoning metadata, and
  * provider options into OpenAI response requests, then converts OpenAI
- * responses and streams back into Effect AI response parts.
- *
- * **Mental model**
- *
- * `OpenAiClient` owns HTTP transport and provider calls. This module owns
- * protocol translation: request assembly, tool choice conversion, structured
- * output codecs, streaming event handling, response metadata, and GenAI
- * telemetry annotations. {@link model}, {@link layer}, and {@link make} all
- * build the same OpenAI-backed `LanguageModel.LanguageModel` service from a
- * model id and optional request defaults.
- *
- * **Common tasks**
- *
- * - Provide an OpenAI-backed `LanguageModel.LanguageModel` from an existing
- *   `OpenAiClient`
- * - Generate text or stream text through Effect AI's provider-neutral language
- *   model API
- * - Use OpenAI provider metadata for files, reasoning items, tool calls, and
- *   response parts
- * - Scope Responses API defaults with {@link Config} and
- *   {@link withConfigOverride}
- *
- * **Gotchas**
- *
- * - Some OpenAI model families receive system instructions as developer
- *   messages because the Responses API treats them differently.
- * - File prompt parts are sent either as provider file ids or as base64
- *   content, depending on `fileIdPrefixes`.
- * - Structured output and tool-call behavior depends on both Effect AI tool
- *   definitions and OpenAI model capabilities.
+ * non-streaming or streaming response results back into Effect AI response
+ * content and metadata.
  *
  * @since 4.0.0
  */

package/src/OpenAiSchema.ts

@@ -4,36 +4,6 @@
  * the transport boundary for JSON sent to and decoded from the Responses and
  * embeddings endpoints.
  *
- * **Mental model**
- *
- * - Request schemas such as {@link CreateResponse} and
- *   {@link CreateEmbeddingRequest} describe the encoded payloads sent to OpenAI.
- * - Response schemas such as {@link Response}, {@link ResponseStreamEvent}, and
- *   {@link CreateEmbeddingResponse} describe provider data after schema
- *   decoding.
- * - Shared schemas such as {@link InputItem}, {@link Tool}, and
- *   {@link TextResponseFormatConfiguration} cover the message, tool, and output
- *   format fragments reused across request and response shapes.
- *
- * **Common tasks**
- *
- * - Use {@link CreateResponse} with {@link Response} for non-streaming
- *   Responses API calls.
- * - Use {@link ResponseStreamEvent} for server-sent events emitted by streaming
- *   Responses API calls.
- * - Use {@link CreateEmbeddingRequest} and {@link CreateEmbeddingResponse} for
- *   embeddings endpoint payloads.
- * - Use smaller schemas like {@link IncludeEnum}, {@link InputContent}, and
- *   {@link ToolChoice} when validating request fragments.
- *
- * **Gotchas**
- *
- * - The module models the subset of OpenAI shapes supported by this client
- *   path; it is not a complete mirror of every OpenAI REST API field.
- * - Unknown future stream event types decode through
- *   {@link UnknownResponseStreamEvent}, while malformed known event types still
- *   fail schema decoding.
- *
  * @since 4.0.0
  */
 import * as Effect from "effect/Effect"

package/src/OpenAiTelemetry.ts

@@ -1,26 +1,9 @@
 /**
- * OpenAI-specific telemetry annotations for GenAI spans.
- *
- * This module extends the provider-neutral GenAI telemetry model with
- * attributes that only exist on OpenAI requests and responses. Use
- * {@link addGenAIAnnotations} when an OpenAI operation already has an
- * OpenTelemetry span and you want to record both standard GenAI metadata and
- * OpenAI details such as response format, requested service tier, actual
- * service tier, or system fingerprint.
- *
- * **Mental model**
- *
- * The public option shape stays idiomatic TypeScript (`responseFormat`,
- * `serviceTier`, `systemFingerprint`). When annotations are applied, the
- * attributes are written to the span under OpenTelemetry semantic-convention
- * keys such as `gen_ai.openai.request.response_format` and
- * `gen_ai.openai.response.system_fingerprint`.
- *
- * **Gotchas**
- *
- * Annotation mutates the provided span in place. It does not create, end, or
- * export spans, and OpenAI-specific attributes are only added when the
- * `openai.request` or `openai.response` option objects are present.
+ * The `OpenAiTelemetry` module defines OpenAI-specific telemetry attributes
+ * and a helper for adding them to a tracing span. It keeps the standard GenAI
+ * telemetry attributes and adds request and response metadata, such as response
+ * format, service tier, and system fingerprint, under the `gen_ai.openai.*`
+ * OpenTelemetry namespaces.
  *
  * @since 4.0.0
  */

package/src/OpenAiTool.ts

@@ -1,27 +1,9 @@
 /**
- * OpenAI provider-defined tools for Effect AI language model requests.
- *
- * 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.
+ * The `OpenAiTool` module defines OpenAI provider tools for Effect AI language
+ * model requests. It exposes typed descriptors for tools such as Apply Patch,
+ * Code Interpreter, File Search, Image Generation, MCP, Web Search, and
+ * shell-like local tools, including their provider names, configuration
+ * arguments, call parameters, success schemas, and handler requirements.
  *
  * @since 4.0.0
  */