@effect/ai-openai 4.0.0-beta.66 → 4.0.0-beta.67

package/dist/OpenAiTelemetry.d.ts

@@ -7,24 +7,24 @@ import * as Telemetry from "effect/unstable/ai/Telemetry";
  *
  * {@see https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/}
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export type OpenAiTelemetryAttributes = Simplify<Telemetry.GenAITelemetryAttributes & Telemetry.AttributesWithPrefix<RequestAttributes, "gen_ai.openai.request"> & Telemetry.AttributesWithPrefix<ResponseAttributes, "gen_ai.openai.request">>;
 /**
  * All telemetry attributes which are part of the GenAI specification,
  * including the OpenAi-specific attributes.
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export type AllAttributes = Telemetry.AllAttributes & RequestAttributes & ResponseAttributes;
 /**
  * Telemetry attributes which are part of the GenAI specification and are
  * namespaced by `gen_ai.openai.request`.
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export interface RequestAttributes {
     /**
@@ -40,8 +40,8 @@ export interface RequestAttributes {
  * Telemetry attributes which are part of the GenAI specification and are
  * namespaced by `gen_ai.openai.response`.
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export interface ResponseAttributes {
     /**
@@ -61,8 +61,8 @@ export interface ResponseAttributes {
  * If one of them applies, then the respective value **MUST** be used;
  * otherwise, a custom value **MAY** be used.
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export type WellKnownResponseFormat = "json_object" | "json_schema" | "text";
 /**
@@ -72,12 +72,15 @@ export type WellKnownResponseFormat = "json_object" | "json_schema" | "text";
  * If one of them applies, then the respective value **MUST** be used;
  * otherwise, a custom value **MAY** be used.
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export type WellKnownServiceTier = "auto" | "default";
 /**
- * @since 1.0.0
+ * Options accepted by `addGenAIAnnotations`, combining standard GenAI
+ * telemetry attributes with optional OpenAI request and response attributes.
+ *
+ * @since 4.0.0
  * @since models
  */
 export type OpenAiTelemetryAttributeOptions = Telemetry.GenAITelemetryAttributeOptions & {
@@ -92,7 +95,7 @@ export type OpenAiTelemetryAttributeOptions = Telemetry.GenAITelemetryAttributeO
  *
  * **NOTE**: This method will mutate the `Span` **in-place**.
  *
- * @since 1.0.0
+ * @since 4.0.0
  * @since utilities
  */
 export declare const addGenAIAnnotations: {
@@ -102,7 +105,7 @@ export declare const addGenAIAnnotations: {
      *
      * **NOTE**: This method will mutate the `Span` **in-place**.
      *
-     * @since 1.0.0
+     * @since 4.0.0
      * @since utilities
      */
     (options: OpenAiTelemetryAttributeOptions): (span: Span) => void;
@@ -112,7 +115,7 @@ export declare const addGenAIAnnotations: {
      *
      * **NOTE**: This method will mutate the `Span` **in-place**.
      *
-     * @since 1.0.0
+     * @since 4.0.0
      * @since utilities
      */
     (span: Span, options: OpenAiTelemetryAttributeOptions): void;

package/dist/OpenAiTelemetry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"OpenAiTelemetry.d.ts","sourceRoot":"","sources":["../src/OpenAiTelemetry.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA;AACzC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAC5C,OAAO,KAAK,SAAS,MAAM,8BAA8B,CAAA;AAEzD;;;;;;;;GAQG;AACH,MAAM,MAAM,yBAAyB,GAAG,QAAQ,CAC5C,SAAS,CAAC,wBAAwB,GAClC,SAAS,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,uBAAuB,CAAC,GAC1E,SAAS,CAAC,oBAAoB,CAAC,kBAAkB,EAAE,uBAAuB,CAAC,CAC9E,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,CAAC,aAAa,GAAG,iBAAiB,GAAG,kBAAkB,CAAA;AAE5F;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,uBAAuB,GAAG,IAAI,GAAG,SAAS,CAAA;IACpF;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,oBAAoB,GAAG,IAAI,GAAG,SAAS,CAAA;CAC/E;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;IAChD;;;OAGG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;CACvD;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,uBAAuB,GAAG,aAAa,GAAG,aAAa,GAAG,MAAM,CAAA;AAE5E;;;;;;;;;GASG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,SAAS,CAAA;AAErD;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG,SAAS,CAAC,8BAA8B,GAAG;IACvF,MAAM,CAAC,EAAE;QACP,OAAO,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAA;QACvC,QAAQ,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAA;KAC1C,GAAG,SAAS,CAAA;CACd,CAAA;AASD;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,EAAE;IAChC;;;;;;;;OAQG;IACH,CAAC,OAAO,EAAE,+BAA+B,GAAG,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,CAAA;IAChE;;;;;;;;OAQG;IACH,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,+BAA+B,GAAG,IAAI,CAAA;CAW5D,CAAA"}
+{"version":3,"file":"OpenAiTelemetry.d.ts","sourceRoot":"","sources":["../src/OpenAiTelemetry.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA;AACzC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAC5C,OAAO,KAAK,SAAS,MAAM,8BAA8B,CAAA;AAEzD;;;;;;;;GAQG;AACH,MAAM,MAAM,yBAAyB,GAAG,QAAQ,CAC5C,SAAS,CAAC,wBAAwB,GAClC,SAAS,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,uBAAuB,CAAC,GAC1E,SAAS,CAAC,oBAAoB,CAAC,kBAAkB,EAAE,uBAAuB,CAAC,CAC9E,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,CAAC,aAAa,GAAG,iBAAiB,GAAG,kBAAkB,CAAA;AAE5F;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,uBAAuB,GAAG,IAAI,GAAG,SAAS,CAAA;IACpF;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,oBAAoB,GAAG,IAAI,GAAG,SAAS,CAAA;CAC/E;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;IAChD;;;OAGG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;CACvD;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,uBAAuB,GAAG,aAAa,GAAG,aAAa,GAAG,MAAM,CAAA;AAE5E;;;;;;;;;GASG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,SAAS,CAAA;AAErD;;;;;;GAMG;AACH,MAAM,MAAM,+BAA+B,GAAG,SAAS,CAAC,8BAA8B,GAAG;IACvF,MAAM,CAAC,EAAE;QACP,OAAO,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAA;QACvC,QAAQ,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAA;KAC1C,GAAG,SAAS,CAAA;CACd,CAAA;AASD;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,EAAE;IAChC;;;;;;;;OAQG;IACH,CAAC,OAAO,EAAE,+BAA+B,GAAG,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,CAAA;IAChE;;;;;;;;OAQG;IACH,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,+BAA+B,GAAG,IAAI,CAAA;CAW5D,CAAA"}

package/dist/OpenAiTelemetry.js

@@ -5,7 +5,7 @@
  * semantic conventions, extending the base GenAI attributes with OpenAI-specific
  * request and response metadata.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 import { dual } from "effect/Function";
 import * as String from "effect/String";
@@ -18,7 +18,7 @@ const addOpenAiResponseAttributes = /*#__PURE__*/Telemetry.addSpanAttributes("ge
  *
  * **NOTE**: This method will mutate the `Span` **in-place**.
  *
- * @since 1.0.0
+ * @since 4.0.0
  * @since utilities
  */
 export const addGenAIAnnotations = /*#__PURE__*/dual(2, (span, options) => {

package/dist/OpenAiTelemetry.js.map

@@ -1 +1 @@
-{"version":3,"file":"OpenAiTelemetry.js","names":["dual","String","Telemetry","addOpenAiRequestAttributes","addSpanAttributes","camelToSnake","addOpenAiResponseAttributes","addGenAIAnnotations","span","options","openai","request","response"],"sources":["../src/OpenAiTelemetry.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;AASA,SAASA,IAAI,QAAQ,iBAAiB;AACtC,OAAO,KAAKC,MAAM,MAAM,eAAe;AAGvC,OAAO,KAAKC,SAAS,MAAM,8BAA8B;AAkGzD,MAAMC,0BAA0B,gBAAGD,SAAS,CAACE,iBAAiB,CAAC,uBAAuB,EAAEH,MAAM,CAACI,YAAY,CAE1G;AACD,MAAMC,2BAA2B,gBAAGJ,SAAS,CAACE,iBAAiB,CAAC,wBAAwB,EAAEH,MAAM,CAACI,YAAY,CAE5G;AAED;;;;;;;;;AASA,OAAO,MAAME,mBAAmB,gBAqB5BP,IAAI,CAAC,CAAC,EAAE,CAACQ,IAAU,EAAEC,OAAwC,KAAI;EACnEP,SAAS,CAACK,mBAAmB,CAACC,IAAI,EAAEC,OAAO,CAAC;EAC5C,IAAIA,OAAO,CAACC,MAAM,IAAI,IAAI,EAAE;IAC1B,IAAID,OAAO,CAACC,MAAM,CAACC,OAAO,IAAI,IAAI,EAAE;MAClCR,0BAA0B,CAACK,IAAI,EAAEC,OAAO,CAACC,MAAM,CAACC,OAAO,CAAC;IAC1D;IACA,IAAIF,OAAO,CAACC,MAAM,CAACE,QAAQ,IAAI,IAAI,EAAE;MACnCN,2BAA2B,CAACE,IAAI,EAAEC,OAAO,CAACC,MAAM,CAACE,QAAQ,CAAC;IAC5D;EACF;AACF,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"OpenAiTelemetry.js","names":["dual","String","Telemetry","addOpenAiRequestAttributes","addSpanAttributes","camelToSnake","addOpenAiResponseAttributes","addGenAIAnnotations","span","options","openai","request","response"],"sources":["../src/OpenAiTelemetry.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;AASA,SAASA,IAAI,QAAQ,iBAAiB;AACtC,OAAO,KAAKC,MAAM,MAAM,eAAe;AAGvC,OAAO,KAAKC,SAAS,MAAM,8BAA8B;AAqGzD,MAAMC,0BAA0B,gBAAGD,SAAS,CAACE,iBAAiB,CAAC,uBAAuB,EAAEH,MAAM,CAACI,YAAY,CAE1G;AACD,MAAMC,2BAA2B,gBAAGJ,SAAS,CAACE,iBAAiB,CAAC,wBAAwB,EAAEH,MAAM,CAACI,YAAY,CAE5G;AAED;;;;;;;;;AASA,OAAO,MAAME,mBAAmB,gBAqB5BP,IAAI,CAAC,CAAC,EAAE,CAACQ,IAAU,EAAEC,OAAwC,KAAI;EACnEP,SAAS,CAACK,mBAAmB,CAACC,IAAI,EAAEC,OAAO,CAAC;EAC5C,IAAIA,OAAO,CAACC,MAAM,IAAI,IAAI,EAAE;IAC1B,IAAID,OAAO,CAACC,MAAM,CAACC,OAAO,IAAI,IAAI,EAAE;MAClCR,0BAA0B,CAACK,IAAI,EAAEC,OAAO,CAACC,MAAM,CAACC,OAAO,CAAC;IAC1D;IACA,IAAIF,OAAO,CAACC,MAAM,CAACE,QAAQ,IAAI,IAAI,EAAE;MACnCN,2BAA2B,CAACE,IAAI,EAAEC,OAAO,CAACC,MAAM,CAACE,QAAQ,CAAC;IAC5D;EACF;AACF,CAAC,CAAC","ignoreList":[]}

package/dist/OpenAiTool.d.ts

@@ -4,15 +4,15 @@
  * Provides tools that are natively supported by OpenAI's API, including
  * code interpreter, file search, and web search functionality.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 import * as Schema from "effect/Schema";
 import * as Tool from "effect/unstable/ai/Tool";
 /**
  * Union of all OpenAI provider-defined tools.
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export type OpenAiTool = ReturnType<typeof ApplyPatch> | ReturnType<typeof CodeInterpreter> | ReturnType<typeof FileSearch> | ReturnType<typeof Shell> | ReturnType<typeof ImageGeneration> | ReturnType<typeof LocalShell> | ReturnType<typeof Mcp> | ReturnType<typeof WebSearch> | ReturnType<typeof WebSearchPreview>;
 /**
@@ -22,8 +22,8 @@ export type OpenAiTool = ReturnType<typeof ApplyPatch> | ReturnType<typeof CodeI
  * This is a local tool that runs in your environment and requires a handler
  * to execute file operations.
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export declare const ApplyPatch: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
     readonly failureMode?: Mode | undefined;
@@ -56,8 +56,8 @@ export declare const ApplyPatch: <Mode extends Tool.FailureMode | undefined = un
  *
  * Allows the model to execute Python code in a sandboxed environment.
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export declare const CodeInterpreter: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
     readonly container: string | {
@@ -116,8 +116,8 @@ export declare const CodeInterpreter: <Mode extends Tool.FailureMode | undefined
  *
  * Enables the model to search through uploaded files and vector stores.
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export declare const FileSearch: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
     readonly vector_store_ids: readonly string[];
@@ -183,8 +183,8 @@ export declare const FileSearch: <Mode extends Tool.FailureMode | undefined = un
  *
  * Enables the model to generate images using the GPT image models.
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export declare const ImageGeneration: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
     readonly background?: "auto" | "transparent" | "opaque";
@@ -229,8 +229,8 @@ export declare const ImageGeneration: <Mode extends Tool.FailureMode | undefined
  * Enables the model to run a command with a local shell. This is a local tool
  * that runs in your environment and requires a handler to execute commands.
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export declare const LocalShell: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
     readonly failureMode?: Mode | undefined;
@@ -258,8 +258,8 @@ export declare const LocalShell: <Mode extends Tool.FailureMode | undefined = un
  * Gives the model access to additional tools via remote Model Context Protocol
  * (MCP) servers
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export declare const Mcp: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
     readonly server_label: string;
@@ -322,8 +322,8 @@ export declare const Mcp: <Mode extends Tool.FailureMode | undefined = undefined
  * environment. This is a local tool that runs in your environment and requires
  * a handler to execute commands.
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export declare const Shell: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
     readonly failureMode?: Mode | undefined;
@@ -357,8 +357,8 @@ export declare const Shell: <Mode extends Tool.FailureMode | undefined = undefin
  *
  * Enables the model to search the web for information.
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export declare const WebSearch: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
     readonly filters?: {
@@ -431,8 +431,8 @@ export declare const WebSearch: <Mode extends Tool.FailureMode | undefined = und
  *
  * Preview version of the web search tool with additional features.
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export declare const WebSearchPreview: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
     readonly user_location?: {

package/dist/OpenAiTool.js

@@ -4,7 +4,7 @@
  * Provides tools that are natively supported by OpenAI's API, including
  * code interpreter, file search, and web search functionality.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 import * as Schema from "effect/Schema";
 import * as Tool from "effect/unstable/ai/Tool";
@@ -16,8 +16,8 @@ import * as Generated from "./Generated.js";
  * This is a local tool that runs in your environment and requires a handler
  * to execute file operations.
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export const ApplyPatch = /*#__PURE__*/Tool.providerDefined({
   id: "openai.apply_patch",
@@ -38,8 +38,8 @@ export const ApplyPatch = /*#__PURE__*/Tool.providerDefined({
  *
  * Allows the model to execute Python code in a sandboxed environment.
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export const CodeInterpreter = /*#__PURE__*/Tool.providerDefined({
   id: "openai.code_interpreter",
@@ -61,8 +61,8 @@ export const CodeInterpreter = /*#__PURE__*/Tool.providerDefined({
  *
  * Enables the model to search through uploaded files and vector stores.
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export const FileSearch = /*#__PURE__*/Tool.providerDefined({
   id: "openai.file_search",
@@ -85,8 +85,8 @@ export const FileSearch = /*#__PURE__*/Tool.providerDefined({
  *
  * Enables the model to generate images using the GPT image models.
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export const ImageGeneration = /*#__PURE__*/Tool.providerDefined({
   id: "openai.image_generation",
@@ -114,8 +114,8 @@ export const ImageGeneration = /*#__PURE__*/Tool.providerDefined({
  * Enables the model to run a command with a local shell. This is a local tool
  * that runs in your environment and requires a handler to execute commands.
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export const LocalShell = /*#__PURE__*/Tool.providerDefined({
   id: "openai.local_shell",
@@ -135,8 +135,8 @@ export const LocalShell = /*#__PURE__*/Tool.providerDefined({
  * Gives the model access to additional tools via remote Model Context Protocol
  * (MCP) servers
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export const Mcp = /*#__PURE__*/Tool.providerDefined({
   id: "openai.mcp",
@@ -168,8 +168,8 @@ export const Mcp = /*#__PURE__*/Tool.providerDefined({
  * environment. This is a local tool that runs in your environment and requires
  * a handler to execute commands.
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export const Shell = /*#__PURE__*/Tool.providerDefined({
   id: "openai.shell",
@@ -188,8 +188,8 @@ export const Shell = /*#__PURE__*/Tool.providerDefined({
  *
  * Enables the model to search the web for information.
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export const WebSearch = /*#__PURE__*/Tool.providerDefined({
   id: "openai.web_search",
@@ -213,8 +213,8 @@ export const WebSearch = /*#__PURE__*/Tool.providerDefined({
  *
  * Preview version of the web search tool with additional features.
  *
- * @since 1.0.0
  * @category tools
+ * @since 4.0.0
  */
 export const WebSearchPreview = /*#__PURE__*/Tool.providerDefined({
   id: "openai.web_search_preview",

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as Generated from "./Generated.ts";
 /**
@@ -11,15 +11,15 @@ export * as Generated from "./Generated.ts";
  * Provides a type-safe, Effect-based client for OpenAI operations including
  * completions, embeddings, and streaming responses.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiClient from "./OpenAiClient.ts";
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiClientGenerated from "./OpenAiClientGenerated.ts";
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiConfig from "./OpenAiConfig.ts";
 /**
@@ -27,7 +27,7 @@ export * as OpenAiConfig from "./OpenAiConfig.ts";
  *
  * Provides an EmbeddingModel implementation for OpenAI's embeddings API.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiEmbeddingModel from "./OpenAiEmbeddingModel.ts";
 /**
@@ -36,7 +36,7 @@ export * as OpenAiEmbeddingModel from "./OpenAiEmbeddingModel.ts";
  * Provides OpenAI-specific metadata fields for AI error types through module
  * augmentation, enabling typed access to OpenAI error details.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiError from "./OpenAiError.ts";
 /**
@@ -45,13 +45,13 @@ export * as OpenAiError from "./OpenAiError.ts";
  * Provides a LanguageModel implementation for OpenAI's responses API,
  * supporting text generation, structured output, tool calling, and streaming.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiLanguageModel from "./OpenAiLanguageModel.ts";
 /**
  * Minimal local OpenAI schemas used by the handwritten Responses client path.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiSchema from "./OpenAiSchema.ts";
 /**
@@ -61,7 +61,7 @@ export * as OpenAiSchema from "./OpenAiSchema.ts";
  * semantic conventions, extending the base GenAI attributes with OpenAI-specific
  * request and response metadata.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiTelemetry from "./OpenAiTelemetry.ts";
 /**
@@ -70,7 +70,7 @@ export * as OpenAiTelemetry from "./OpenAiTelemetry.ts";
  * Provides tools that are natively supported by OpenAI's API, including
  * code interpreter, file search, and web search functionality.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiTool from "./OpenAiTool.ts";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,9 +1,9 @@
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 // @barrel: Auto-generated exports. Do not edit manually.
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as Generated from "./Generated.js";
 /**
@@ -12,15 +12,15 @@ export * as Generated from "./Generated.js";
  * Provides a type-safe, Effect-based client for OpenAI operations including
  * completions, embeddings, and streaming responses.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiClient from "./OpenAiClient.js";
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiClientGenerated from "./OpenAiClientGenerated.js";
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiConfig from "./OpenAiConfig.js";
 /**
@@ -28,7 +28,7 @@ export * as OpenAiConfig from "./OpenAiConfig.js";
  *
  * Provides an EmbeddingModel implementation for OpenAI's embeddings API.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiEmbeddingModel from "./OpenAiEmbeddingModel.js";
 /**
@@ -37,7 +37,7 @@ export * as OpenAiEmbeddingModel from "./OpenAiEmbeddingModel.js";
  * Provides OpenAI-specific metadata fields for AI error types through module
  * augmentation, enabling typed access to OpenAI error details.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiError from "./OpenAiError.js";
 /**
@@ -46,13 +46,13 @@ export * as OpenAiError from "./OpenAiError.js";
  * Provides a LanguageModel implementation for OpenAI's responses API,
  * supporting text generation, structured output, tool calling, and streaming.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiLanguageModel from "./OpenAiLanguageModel.js";
 /**
  * Minimal local OpenAI schemas used by the handwritten Responses client path.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiSchema from "./OpenAiSchema.js";
 /**
@@ -62,7 +62,7 @@ export * as OpenAiSchema from "./OpenAiSchema.js";
  * semantic conventions, extending the base GenAI attributes with OpenAI-specific
  * request and response metadata.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiTelemetry from "./OpenAiTelemetry.js";
 /**
@@ -71,7 +71,7 @@ export * as OpenAiTelemetry from "./OpenAiTelemetry.js";
  * Provides tools that are natively supported by OpenAI's API, including
  * code interpreter, file search, and web search functionality.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as OpenAiTool from "./OpenAiTool.js";
 //# sourceMappingURL=index.js.map

package/package.json

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

package/src/Generated.ts

@@ -1,5 +1,5 @@
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 
 import * as Data from "effect/Data"

package/src/OpenAiClient.ts

@@ -4,7 +4,7 @@
  * Provides a type-safe, Effect-based client for OpenAI operations including
  * completions, embeddings, and streaming responses.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 import * as Array from "effect/Array"
 import type * as Config from "effect/Config"
@@ -39,10 +39,13 @@ import * as OpenAiSchema from "./OpenAiSchema.ts"
 // =============================================================================
 
 /**
- * The OpenAI client interface.
+ * Effect service interface for the handwritten OpenAI client.
+ *
+ * **Details**
+ * Provides the configured HTTP client plus helpers for Responses API calls, streaming Responses events, and embeddings. Transport and schema decoding failures are mapped to `AiError`.
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export interface Service {
   /**
@@ -88,8 +91,8 @@ export interface Service {
 /**
  * Service identifier for the OpenAI client.
  *
- * @since 1.0.0
  * @category service
+ * @since 4.0.0
  */
 export class OpenAiClient extends Context.Service<OpenAiClient, Service>()(
   "@effect/ai-openai/OpenAiClient"
@@ -102,8 +105,8 @@ export class OpenAiClient extends Context.Service<OpenAiClient, Service>()(
 /**
  * Options for configuring the OpenAI client.
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export type Options = {
   /**
@@ -146,8 +149,8 @@ const RedactedOpenAiHeaders = {
 /**
  * Creates an OpenAI client service with the given options.
  *
- * @since 1.0.0
  * @category constructors
+ * @since 4.0.0
  */
 export const make = Effect.fnUntraced(
   function*(
@@ -298,8 +301,8 @@ export const make = Effect.fnUntraced(
 /**
  * Creates a layer for the OpenAI client with the given options.
  *
- * @since 1.0.0
  * @category layers
+ * @since 4.0.0
  */
 export const layer = (options: Options): Layer.Layer<OpenAiClient, never, HttpClient.HttpClient> =>
   Layer.effect(OpenAiClient, make(options))
@@ -308,8 +311,8 @@ export const layer = (options: Options): Layer.Layer<OpenAiClient, never, HttpCl
  * Creates a layer for the OpenAI client, loading the requisite configuration
  * via Effect's `Config` module.
  *
- * @since 1.0.0
  * @category layers
+ * @since 4.0.0
  */
 export const layerConfig = (options?: {
   /**
@@ -367,14 +370,18 @@ export const layerConfig = (options?: {
 // =============================================================================
 
 /**
- * @since 1.0.0
+ * Response stream event emitted by the OpenAI Responses API.
+ *
  * @category Events
+ * @since 4.0.0
  */
 export type ResponseStreamEvent = typeof OpenAiSchema.ResponseStreamEvent.Type
 
 /**
- * @since 1.0.0
+ * Service for creating OpenAI response streams over a WebSocket connection.
+ *
  * @category Websocket mode
+ * @since 4.0.0
  */
 export class OpenAiSocket extends Context.Service<OpenAiSocket, {
   /**
@@ -587,8 +594,8 @@ const decodeEvent = Schema.decodeUnknownSync(Schema.fromJsonString(AllEvents))
  * This is because it needs to use non-standard options for setting the
  * Authorization header.
  *
- * @since 1.0.0
  * @category Websocket mode
+ * @since 4.0.0
  */
 export const withWebSocketMode = <A, E, R>(
   effect: Effect.Effect<A, E, R>
@@ -615,8 +622,8 @@ export const withWebSocketMode = <A, E, R>(
  * This is because it needs to use non-standard options for setting the
  * Authorization header.
  *
- * @since 1.0.0
  * @category Websocket mode
+ * @since 4.0.0
  */
 export const layerWebSocketMode: Layer.Layer<
   OpenAiSocket | ResponseIdTracker.ResponseIdTracker,

package/src/OpenAiClientGenerated.ts

@@ -1,5 +1,5 @@
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 import * as Array from "effect/Array"
 import type * as Config from "effect/Config"
@@ -23,7 +23,7 @@ import { OpenAiConfig } from "./OpenAiConfig.ts"
 /**
  * Service identifier for the generated OpenAI client.
  *
- * @since 1.0.0
+ * @since 4.0.0
  * @category service
  */
 export class OpenAiClientGenerated extends Context.Service<OpenAiClientGenerated, Generated.OpenAiClient>()(
@@ -37,7 +37,7 @@ export class OpenAiClientGenerated extends Context.Service<OpenAiClientGenerated
 /**
  * Options for configuring the generated OpenAI client.
  *
- * @since 1.0.0
+ * @since 4.0.0
  * @category models
  */
 export type Options = {
@@ -81,7 +81,7 @@ const RedactedOpenAiHeaders = {
 /**
  * Creates a generated OpenAI client service with the given options.
  *
- * @since 1.0.0
+ * @since 4.0.0
  * @category constructors
  */
 export const make = Effect.fnUntraced(
@@ -137,7 +137,7 @@ export const make = Effect.fnUntraced(
 /**
  * Creates a layer for the generated OpenAI client with the given options.
  *
- * @since 1.0.0
+ * @since 4.0.0
  * @category layers
  */
 export const layer = (options: Options): Layer.Layer<OpenAiClientGenerated, never, HttpClient.HttpClient> =>
@@ -147,7 +147,7 @@ export const layer = (options: Options): Layer.Layer<OpenAiClientGenerated, neve
  * Creates a layer for the generated OpenAI client, loading the requisite
  * configuration via Effect's `Config` module.
  *
- * @since 1.0.0
+ * @since 4.0.0
  * @category layers
  */
 export const layerConfig = (options?: {