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

package/dist/OpenAiEmbeddingModel.js

@@ -3,7 +3,7 @@
  *
  * Provides an EmbeddingModel implementation for OpenAI's embeddings API.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 import * as Context from "effect/Context";
 import * as Effect from "effect/Effect";
@@ -16,13 +16,15 @@ import { OpenAiClient } from "./OpenAiClient.js";
 /**
  * Service definition for OpenAI embedding model configuration.
  *
- * @since 1.0.0
  * @category services
+ * @since 4.0.0
  */
 export class Config extends /*#__PURE__*/Context.Service()("@effect/ai-openai/OpenAiEmbeddingModel/Config") {}
 /**
- * @since 1.0.0
+ * Creates an `AiModel` for an OpenAI embedding model with its configured vector dimensions.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export const model = (model, options) => AiModel.make("openai", model, Layer.merge(layer({
   model,
@@ -34,8 +36,8 @@ export const model = (model, options) => AiModel.make("openai", model, Layer.mer
 /**
  * Creates an OpenAI embedding model service.
  *
- * @since 1.0.0
  * @category constructors
+ * @since 4.0.0
  */
 export const make = /*#__PURE__*/Effect.fnUntraced(function* ({
   model,
@@ -66,15 +68,15 @@ export const make = /*#__PURE__*/Effect.fnUntraced(function* ({
 /**
  * Creates a layer for the OpenAI embedding model.
  *
- * @since 1.0.0
  * @category layers
+ * @since 4.0.0
  */
 export const layer = options => Layer.effect(EmbeddingModel.EmbeddingModel, make(options));
 /**
  * Provides config overrides for OpenAI embedding model operations.
  *
- * @since 1.0.0
  * @category configuration
+ * @since 4.0.0
  */
 export const withConfigOverride = /*#__PURE__*/dual(2, (self, overrides) => Effect.flatMap(Effect.serviceOption(Config), config => Effect.provideService(self, Config, {
   ...(config._tag === "Some" ? config.value : {}),

package/dist/OpenAiEmbeddingModel.js.map

@@ -1 +1 @@
-{"version":3,"file":"OpenAiEmbeddingModel.js","names":["Context","Effect","dual","Layer","AiError","EmbeddingModel","AiModel","OpenAiClient","Config","Service","model","options","make","merge","layer","config","dimensions","succeed","Dimensions","fnUntraced","providerConfig","client","makeConfig","gen","services","context","mapUnsafe","get","key","embedMany","inputs","response","createEmbedding","input","mapProviderResponse","length","effect","withConfigOverride","self","overrides","flatMap","serviceOption","provideService","_tag","value","inputLength","data","fail","invalidOutput","results","Array","seen","Set","entry","Number","isInteger","index","has","isArray","embedding","add","size","usage","inputTokens","prompt_tokens","description","module","method","reason","InvalidOutputError"],"sources":["../src/OpenAiEmbeddingModel.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;AAOA,OAAO,KAAKA,OAAO,MAAM,gBAAgB;AACzC,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,SAASC,IAAI,QAAQ,iBAAiB;AACtC,OAAO,KAAKC,KAAK,MAAM,cAAc;AAErC,OAAO,KAAKC,OAAO,MAAM,4BAA4B;AACrD,OAAO,KAAKC,cAAc,MAAM,mCAAmC;AACnE,OAAO,KAAKC,OAAO,MAAM,0BAA0B;AACnD,SAASC,YAAY,QAAQ,mBAAmB;AAShD;;;;;;AAMA,OAAM,MAAOC,MAAO,sBAAQR,OAAO,CAACS,OAAO,EAaxC,CAAC,+CAA+C,CAAC;AAEpD;;;;AAIA,OAAO,MAAMC,KAAK,GAAGA,CACnBA,KAA4B,EAC5BC,OAGC,KAEDL,OAAO,CAACM,IAAI,CACV,QAAQ,EACRF,KAAK,EACLP,KAAK,CAACU,KAAK,CACTC,KAAK,CAAC;EACJJ,KAAK;EACLK,MAAM,EAAE;IACN,GAAGJ,OAAO,CAACI,MAAM;IACjBC,UAAU,EAAEL,OAAO,CAACK;;CAEvB,CAAC,EACFb,KAAK,CAACc,OAAO,CAACZ,cAAc,CAACa,UAAU,EAAEP,OAAO,CAACK,UAAU,CAAC,CAC7D,CACF;AAEH;;;;;;AAMA,OAAO,MAAMJ,IAAI,gBAAGX,MAAM,CAACkB,UAAU,CAAC,WAAU;EAAET,KAAK;EAAEK,MAAM,EAAEK;AAAc,CAG9E;EACC,MAAMC,MAAM,GAAG,OAAOd,YAAY;EAElC,MAAMe,UAAU,GAAGrB,MAAM,CAACsB,GAAG,CAAC,aAAS;IACrC,MAAMC,QAAQ,GAAG,OAAOvB,MAAM,CAACwB,OAAO,EAAS;IAC/C,OAAO;MAAEf,KAAK;MAAE,GAAGU,cAAc;MAAE,GAAGI,QAAQ,CAACE,SAAS,CAACC,GAAG,CAACnB,MAAM,CAACoB,GAAG;IAAC,CAAE;EAC5E,CAAC,CAAC;EAEF,OAAO,OAAOvB,cAAc,CAACO,IAAI,CAAC;IAChCiB,SAAS,EAAE5B,MAAM,CAACkB,UAAU,CAAC,WAAU;MAAEW;IAAM,CAAE;MAC/C,MAAMf,MAAM,GAAG,OAAOO,UAAU;MAChC,MAAMS,QAAQ,GAAG,OAAOV,MAAM,CAACW,eAAe,CAAC;QAAE,GAAGjB,MAAM;QAAEkB,KAAK,EAAEH;MAAM,CAAE,CAAC;MAC5E,OAAO,OAAOI,mBAAmB,CAACJ,MAAM,CAACK,MAAM,EAAEJ,QAAQ,CAAC;IAC5D,CAAC;GACF,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;AAMA,OAAO,MAAMjB,KAAK,GAAIH,OAGrB,IACCR,KAAK,CAACiC,MAAM,CAAC/B,cAAc,CAACA,cAAc,EAAEO,IAAI,CAACD,OAAO,CAAC,CAAC;AAE5D;;;;;;AAMA,OAAO,MAAM0B,kBAAkB,gBAe3BnC,IAAI,CAeN,CAAC,EAAE,CAACoC,IAAI,EAAEC,SAAS,KACnBtC,MAAM,CAACuC,OAAO,CACZvC,MAAM,CAACwC,aAAa,CAACjC,MAAM,CAAC,EAC3BO,MAAM,IACLd,MAAM,CAACyC,cAAc,CAACJ,IAAI,EAAE9B,MAAM,EAAE;EAClC,IAAIO,MAAM,CAAC4B,IAAI,KAAK,MAAM,GAAG5B,MAAM,CAAC6B,KAAK,GAAG,EAAE,CAAC;EAC/C,GAAGL;CACJ,CAAC,CACL,CAAC;AAEJ,MAAML,mBAAmB,GAAGA,CAC1BW,WAAmB,EACnBd,QAA0D,KACS;EACnE,IAAIA,QAAQ,CAACe,IAAI,CAACX,MAAM,KAAKU,WAAW,EAAE;IACxC,OAAO5C,MAAM,CAAC8C,IAAI,CAChBC,aAAa,CAAC,oBAAoB,GAAGjB,QAAQ,CAACe,IAAI,CAACX,MAAM,GAAG,2BAA2B,GAAGU,WAAW,CAAC,CACvG;EACH;EAEA,MAAMI,OAAO,GAAG,IAAIC,KAAK,CAAgBL,WAAW,CAAC;EACrD,MAAMM,IAAI,GAAG,IAAIC,GAAG,EAAU;EAE9B,KAAK,MAAMC,KAAK,IAAItB,QAAQ,CAACe,IAAI,EAAE;IACjC,IAAI,CAACQ,MAAM,CAACC,SAAS,CAACF,KAAK,CAACG,KAAK,CAAC,IAAIH,KAAK,CAACG,KAAK,GAAG,CAAC,IAAIH,KAAK,CAACG,KAAK,IAAIX,WAAW,EAAE;MACnF,OAAO5C,MAAM,CAAC8C,IAAI,CAACC,aAAa,CAAC,6CAA6C,GAAGK,KAAK,CAACG,KAAK,CAAC,CAAC;IAChG;IACA,IAAIL,IAAI,CAACM,GAAG,CAACJ,KAAK,CAACG,KAAK,CAAC,EAAE;MACzB,OAAOvD,MAAM,CAAC8C,IAAI,CAACC,aAAa,CAAC,+CAA+C,GAAGK,KAAK,CAACG,KAAK,CAAC,CAAC;IAClG;IACA,IAAI,CAACN,KAAK,CAACQ,OAAO,CAACL,KAAK,CAACM,SAAS,CAAC,EAAE;MACnC,OAAO1D,MAAM,CAAC8C,IAAI,CAACC,aAAa,CAAC,kDAAkD,GAAGK,KAAK,CAACG,KAAK,CAAC,CAAC;IACrG;IAEAL,IAAI,CAACS,GAAG,CAACP,KAAK,CAACG,KAAK,CAAC;IACrBP,OAAO,CAACI,KAAK,CAACG,KAAK,CAAC,GAAG,CAAC,GAAGH,KAAK,CAACM,SAAS,CAAC;EAC7C;EAEA,IAAIR,IAAI,CAACU,IAAI,KAAKhB,WAAW,EAAE;IAC7B,OAAO5C,MAAM,CAAC8C,IAAI,CAChBC,aAAa,CAAC,mCAAmC,GAAGG,IAAI,CAACU,IAAI,GAAG,uBAAuB,GAAGhB,WAAW,CAAC,CACvG;EACH;EAEA,OAAO5C,MAAM,CAACgB,OAAO,CAAC;IACpBgC,OAAO;IACPa,KAAK,EAAE;MACLC,WAAW,EAAEhC,QAAQ,CAAC+B,KAAK,EAAEE;;GAEhC,CAAC;AACJ,CAAC;AAED,MAAMhB,aAAa,GAAIiB,WAAmB,IACxC7D,OAAO,CAACQ,IAAI,CAAC;EACXsD,MAAM,EAAE,sBAAsB;EAC9BC,MAAM,EAAE,WAAW;EACnBC,MAAM,EAAE,IAAIhE,OAAO,CAACiE,kBAAkB,CAAC;IAAEJ;EAAW,CAAE;CACvD,CAAC","ignoreList":[]}
+{"version":3,"file":"OpenAiEmbeddingModel.js","names":["Context","Effect","dual","Layer","AiError","EmbeddingModel","AiModel","OpenAiClient","Config","Service","model","options","make","merge","layer","config","dimensions","succeed","Dimensions","fnUntraced","providerConfig","client","makeConfig","gen","services","context","mapUnsafe","get","key","embedMany","inputs","response","createEmbedding","input","mapProviderResponse","length","effect","withConfigOverride","self","overrides","flatMap","serviceOption","provideService","_tag","value","inputLength","data","fail","invalidOutput","results","Array","seen","Set","entry","Number","isInteger","index","has","isArray","embedding","add","size","usage","inputTokens","prompt_tokens","description","module","method","reason","InvalidOutputError"],"sources":["../src/OpenAiEmbeddingModel.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;AAOA,OAAO,KAAKA,OAAO,MAAM,gBAAgB;AACzC,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,SAASC,IAAI,QAAQ,iBAAiB;AACtC,OAAO,KAAKC,KAAK,MAAM,cAAc;AAErC,OAAO,KAAKC,OAAO,MAAM,4BAA4B;AACrD,OAAO,KAAKC,cAAc,MAAM,mCAAmC;AACnE,OAAO,KAAKC,OAAO,MAAM,0BAA0B;AACnD,SAASC,YAAY,QAAQ,mBAAmB;AAWhD;;;;;;AAMA,OAAM,MAAOC,MAAO,sBAAQR,OAAO,CAACS,OAAO,EAaxC,CAAC,+CAA+C,CAAC;AAEpD;;;;;;AAMA,OAAO,MAAMC,KAAK,GAAGA,CACnBA,KAA4B,EAC5BC,OAGC,KAEDL,OAAO,CAACM,IAAI,CACV,QAAQ,EACRF,KAAK,EACLP,KAAK,CAACU,KAAK,CACTC,KAAK,CAAC;EACJJ,KAAK;EACLK,MAAM,EAAE;IACN,GAAGJ,OAAO,CAACI,MAAM;IACjBC,UAAU,EAAEL,OAAO,CAACK;;CAEvB,CAAC,EACFb,KAAK,CAACc,OAAO,CAACZ,cAAc,CAACa,UAAU,EAAEP,OAAO,CAACK,UAAU,CAAC,CAC7D,CACF;AAEH;;;;;;AAMA,OAAO,MAAMJ,IAAI,gBAAGX,MAAM,CAACkB,UAAU,CAAC,WAAU;EAAET,KAAK;EAAEK,MAAM,EAAEK;AAAc,CAG9E;EACC,MAAMC,MAAM,GAAG,OAAOd,YAAY;EAElC,MAAMe,UAAU,GAAGrB,MAAM,CAACsB,GAAG,CAAC,aAAS;IACrC,MAAMC,QAAQ,GAAG,OAAOvB,MAAM,CAACwB,OAAO,EAAS;IAC/C,OAAO;MAAEf,KAAK;MAAE,GAAGU,cAAc;MAAE,GAAGI,QAAQ,CAACE,SAAS,CAACC,GAAG,CAACnB,MAAM,CAACoB,GAAG;IAAC,CAAE;EAC5E,CAAC,CAAC;EAEF,OAAO,OAAOvB,cAAc,CAACO,IAAI,CAAC;IAChCiB,SAAS,EAAE5B,MAAM,CAACkB,UAAU,CAAC,WAAU;MAAEW;IAAM,CAAE;MAC/C,MAAMf,MAAM,GAAG,OAAOO,UAAU;MAChC,MAAMS,QAAQ,GAAG,OAAOV,MAAM,CAACW,eAAe,CAAC;QAAE,GAAGjB,MAAM;QAAEkB,KAAK,EAAEH;MAAM,CAAE,CAAC;MAC5E,OAAO,OAAOI,mBAAmB,CAACJ,MAAM,CAACK,MAAM,EAAEJ,QAAQ,CAAC;IAC5D,CAAC;GACF,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;AAMA,OAAO,MAAMjB,KAAK,GAAIH,OAGrB,IACCR,KAAK,CAACiC,MAAM,CAAC/B,cAAc,CAACA,cAAc,EAAEO,IAAI,CAACD,OAAO,CAAC,CAAC;AAE5D;;;;;;AAMA,OAAO,MAAM0B,kBAAkB,gBAe3BnC,IAAI,CAeN,CAAC,EAAE,CAACoC,IAAI,EAAEC,SAAS,KACnBtC,MAAM,CAACuC,OAAO,CACZvC,MAAM,CAACwC,aAAa,CAACjC,MAAM,CAAC,EAC3BO,MAAM,IACLd,MAAM,CAACyC,cAAc,CAACJ,IAAI,EAAE9B,MAAM,EAAE;EAClC,IAAIO,MAAM,CAAC4B,IAAI,KAAK,MAAM,GAAG5B,MAAM,CAAC6B,KAAK,GAAG,EAAE,CAAC;EAC/C,GAAGL;CACJ,CAAC,CACL,CAAC;AAEJ,MAAML,mBAAmB,GAAGA,CAC1BW,WAAmB,EACnBd,QAA0D,KACS;EACnE,IAAIA,QAAQ,CAACe,IAAI,CAACX,MAAM,KAAKU,WAAW,EAAE;IACxC,OAAO5C,MAAM,CAAC8C,IAAI,CAChBC,aAAa,CAAC,oBAAoB,GAAGjB,QAAQ,CAACe,IAAI,CAACX,MAAM,GAAG,2BAA2B,GAAGU,WAAW,CAAC,CACvG;EACH;EAEA,MAAMI,OAAO,GAAG,IAAIC,KAAK,CAAgBL,WAAW,CAAC;EACrD,MAAMM,IAAI,GAAG,IAAIC,GAAG,EAAU;EAE9B,KAAK,MAAMC,KAAK,IAAItB,QAAQ,CAACe,IAAI,EAAE;IACjC,IAAI,CAACQ,MAAM,CAACC,SAAS,CAACF,KAAK,CAACG,KAAK,CAAC,IAAIH,KAAK,CAACG,KAAK,GAAG,CAAC,IAAIH,KAAK,CAACG,KAAK,IAAIX,WAAW,EAAE;MACnF,OAAO5C,MAAM,CAAC8C,IAAI,CAACC,aAAa,CAAC,6CAA6C,GAAGK,KAAK,CAACG,KAAK,CAAC,CAAC;IAChG;IACA,IAAIL,IAAI,CAACM,GAAG,CAACJ,KAAK,CAACG,KAAK,CAAC,EAAE;MACzB,OAAOvD,MAAM,CAAC8C,IAAI,CAACC,aAAa,CAAC,+CAA+C,GAAGK,KAAK,CAACG,KAAK,CAAC,CAAC;IAClG;IACA,IAAI,CAACN,KAAK,CAACQ,OAAO,CAACL,KAAK,CAACM,SAAS,CAAC,EAAE;MACnC,OAAO1D,MAAM,CAAC8C,IAAI,CAACC,aAAa,CAAC,kDAAkD,GAAGK,KAAK,CAACG,KAAK,CAAC,CAAC;IACrG;IAEAL,IAAI,CAACS,GAAG,CAACP,KAAK,CAACG,KAAK,CAAC;IACrBP,OAAO,CAACI,KAAK,CAACG,KAAK,CAAC,GAAG,CAAC,GAAGH,KAAK,CAACM,SAAS,CAAC;EAC7C;EAEA,IAAIR,IAAI,CAACU,IAAI,KAAKhB,WAAW,EAAE;IAC7B,OAAO5C,MAAM,CAAC8C,IAAI,CAChBC,aAAa,CAAC,mCAAmC,GAAGG,IAAI,CAACU,IAAI,GAAG,uBAAuB,GAAGhB,WAAW,CAAC,CACvG;EACH;EAEA,OAAO5C,MAAM,CAACgB,OAAO,CAAC;IACpBgC,OAAO;IACPa,KAAK,EAAE;MACLC,WAAW,EAAEhC,QAAQ,CAAC+B,KAAK,EAAEE;;GAEhC,CAAC;AACJ,CAAC;AAED,MAAMhB,aAAa,GAAIiB,WAAmB,IACxC7D,OAAO,CAACQ,IAAI,CAAC;EACXsD,MAAM,EAAE,sBAAsB;EAC9BC,MAAM,EAAE,WAAW;EACnBC,MAAM,EAAE,IAAIhE,OAAO,CAACiE,kBAAkB,CAAC;IAAEJ;EAAW,CAAE;CACvD,CAAC","ignoreList":[]}

package/dist/OpenAiError.d.ts

@@ -4,13 +4,13 @@
  * 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
  */
 /**
  * OpenAI-specific error metadata fields.
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export type OpenAiErrorMetadata = {
     /**
@@ -32,8 +32,8 @@ export type OpenAiErrorMetadata = {
  * Extends base error metadata with rate limit specific information from
  * OpenAI's rate limit headers.
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export type OpenAiRateLimitMetadata = OpenAiErrorMetadata & {
     /**
@@ -54,34 +54,155 @@ export type OpenAiRateLimitMetadata = OpenAiErrorMetadata & {
     readonly resetTokens: string | null;
 };
 declare module "effect/unstable/ai/AiError" {
+    /**
+     * OpenAI metadata attached to `RateLimitError` values.
+     *
+     * Captures OpenAI error details together with rate limit header information
+     * from responses where the provider rejected the request because a limit was
+     * reached.
+     *
+     * @category configuration
+     * @since 4.0.0
+     */
     interface RateLimitErrorMetadata {
+        /**
+         * OpenAI-specific details for the rate limit response.
+         */
         readonly openai?: OpenAiRateLimitMetadata | null;
     }
+    /**
+     * OpenAI metadata attached to `QuotaExhaustedError` values.
+     *
+     * Preserves provider error details for failures caused by exhausted account,
+     * billing, or usage quota.
+     *
+     * @category configuration
+     * @since 4.0.0
+     */
     interface QuotaExhaustedErrorMetadata {
+        /**
+         * OpenAI-specific details for the quota exhaustion response.
+         */
         readonly openai?: OpenAiErrorMetadata | null;
     }
+    /**
+     * OpenAI metadata attached to `AuthenticationError` values.
+     *
+     * Preserves provider error details for failed API key, authorization, or
+     * permission checks.
+     *
+     * @category configuration
+     * @since 4.0.0
+     */
     interface AuthenticationErrorMetadata {
+        /**
+         * OpenAI-specific details for the authentication failure.
+         */
         readonly openai?: OpenAiErrorMetadata | null;
     }
+    /**
+     * OpenAI metadata attached to `ContentPolicyError` values.
+     *
+     * Preserves provider error details when OpenAI rejects input or output because
+     * it violates a content policy.
+     *
+     * @category configuration
+     * @since 4.0.0
+     */
     interface ContentPolicyErrorMetadata {
+        /**
+         * OpenAI-specific details for the content policy response.
+         */
         readonly openai?: OpenAiErrorMetadata | null;
     }
+    /**
+     * OpenAI metadata attached to `InvalidRequestError` values.
+     *
+     * Preserves provider error details for malformed requests, unsupported
+     * parameters, or other request validation failures reported by OpenAI.
+     *
+     * @category configuration
+     * @since 4.0.0
+     */
     interface InvalidRequestErrorMetadata {
+        /**
+         * OpenAI-specific details for the invalid request response.
+         */
         readonly openai?: OpenAiErrorMetadata | null;
     }
+    /**
+     * OpenAI metadata attached to `InternalProviderError` values.
+     *
+     * Preserves provider error details for OpenAI-side failures such as transient
+     * server errors.
+     *
+     * @category configuration
+     * @since 4.0.0
+     */
     interface InternalProviderErrorMetadata {
+        /**
+         * OpenAI-specific details for the internal provider response.
+         */
         readonly openai?: OpenAiErrorMetadata | null;
     }
+    /**
+     * OpenAI metadata attached to `InvalidOutputError` values.
+     *
+     * Preserves provider error details when an OpenAI response cannot be parsed or
+     * validated as the expected output.
+     *
+     * @category configuration
+     * @since 4.0.0
+     */
     interface InvalidOutputErrorMetadata {
+        /**
+         * OpenAI-specific details for the invalid output response.
+         */
         readonly openai?: OpenAiErrorMetadata | null;
     }
+    /**
+     * OpenAI metadata attached to `StructuredOutputError` values.
+     *
+     * Preserves provider error details when OpenAI returns content that does not
+     * satisfy the requested structured output schema.
+     *
+     * @category configuration
+     * @since 4.0.0
+     */
     interface StructuredOutputErrorMetadata {
+        /**
+         * OpenAI-specific details for the structured output failure.
+         */
         readonly openai?: OpenAiErrorMetadata | null;
     }
+    /**
+     * OpenAI metadata attached to `UnsupportedSchemaError` values.
+     *
+     * Preserves provider error details when an unsupported schema failure is
+     * associated with an OpenAI response.
+     *
+     * @category configuration
+     * @since 4.0.0
+     */
     interface UnsupportedSchemaErrorMetadata {
+        /**
+         * OpenAI-specific details for the unsupported schema failure.
+         */
         readonly openai?: OpenAiErrorMetadata | null;
     }
+    /**
+     * OpenAI metadata attached to `UnknownError` values.
+     *
+     * Preserves provider error details for OpenAI failures that do not map cleanly
+     * to a more specific AI error category.
+     *
+     * @category configuration
+     * @since 4.0.0
+     */
     interface UnknownErrorMetadata {
+        /**
+         * OpenAI-specific details for the unclassified provider failure.
+         */
         readonly openai?: OpenAiErrorMetadata | null;
     }
 }

package/dist/OpenAiError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"OpenAiError.d.ts","sourceRoot":"","sources":["../src/OpenAiError.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CAClC,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,uBAAuB,GAAG,mBAAmB,GAAG;IAC1D;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IACrC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;CACpC,CAAA;AAED,OAAO,QAAQ,4BAA4B,CAAC;IAC1C,UAAiB,sBAAsB;QACrC,QAAQ,CAAC,MAAM,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAA;KACjD;IAED,UAAiB,2BAA2B;QAC1C,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED,UAAiB,2BAA2B;QAC1C,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED,UAAiB,0BAA0B;QACzC,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED,UAAiB,2BAA2B;QAC1C,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED,UAAiB,6BAA6B;QAC5C,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED,UAAiB,0BAA0B;QACzC,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED,UAAiB,6BAA6B;QAC5C,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED,UAAiB,8BAA8B;QAC7C,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED,UAAiB,oBAAoB;QACnC,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;CACF"}
+{"version":3,"file":"OpenAiError.d.ts","sourceRoot":"","sources":["../src/OpenAiError.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CAClC,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,uBAAuB,GAAG,mBAAmB,GAAG;IAC1D;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IACrC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;CACpC,CAAA;AAED,OAAO,QAAQ,4BAA4B,CAAC;IAC1C;;;;;;;;;OASG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAA;KACjD;IAED;;;;;;;;OAQG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;OAQG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;OAQG;IACH,UAAiB,0BAA0B;QACzC;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;OAQG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;OAQG;IACH,UAAiB,6BAA6B;QAC5C;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;OAQG;IACH,UAAiB,0BAA0B;QACzC;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;OAQG;IACH,UAAiB,6BAA6B;QAC5C;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;OAQG;IACH,UAAiB,8BAA8B;QAC7C;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;OAQG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;CACF"}

package/dist/OpenAiError.js

@@ -4,7 +4,7 @@
  * 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 {};
 //# sourceMappingURL=OpenAiError.js.map

package/dist/OpenAiLanguageModel.d.ts

@@ -4,7 +4,7 @@
  * 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
  */
 import * as Context from "effect/Context";
 import * as Effect from "effect/Effect";
@@ -17,8 +17,10 @@ import type * as OpenAiSchema from "./OpenAiSchema.ts";
 declare const ResponseModelIds: Schema.Literals<readonly ["o1-pro", "o1-pro-2025-03-19", "o3-pro", "o3-pro-2025-06-10", "o3-deep-research", "o3-deep-research-2025-06-26", "o4-mini-deep-research", "o4-mini-deep-research-2025-06-26", "computer-use-preview", "computer-use-preview-2025-03-11", "gpt-5-codex", "gpt-5-pro", "gpt-5-pro-2025-10-06", "gpt-5.1-codex-max"]>;
 declare const SharedModelIds: Schema.Literals<readonly ["gpt-5.4", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5.4-mini-2026-03-17", "gpt-5.4-nano-2026-03-17", "gpt-5.3-chat-latest", "gpt-5.2", "gpt-5.2-2025-12-11", "gpt-5.2-chat-latest", "gpt-5.2-pro", "gpt-5.2-pro-2025-12-11", "gpt-5.1", "gpt-5.1-2025-11-13", "gpt-5.1-codex", "gpt-5.1-mini", "gpt-5.1-chat-latest", "gpt-5", "gpt-5-mini", "gpt-5-nano", "gpt-5-2025-08-07", "gpt-5-mini-2025-08-07", "gpt-5-nano-2025-08-07", "gpt-5-chat-latest", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-4.1-2025-04-14", "gpt-4.1-mini-2025-04-14", "gpt-4.1-nano-2025-04-14", "o4-mini", "o4-mini-2025-04-16", "o3", "o3-2025-04-16", "o3-mini", "o3-mini-2025-01-31", "o1", "o1-2024-12-17", "o1-preview", "o1-preview-2024-09-12", "o1-mini", "o1-mini-2024-09-12", "gpt-4o", "gpt-4o-2024-11-20", "gpt-4o-2024-08-06", "gpt-4o-2024-05-13", "gpt-4o-audio-preview", "gpt-4o-audio-preview-2024-10-01", "gpt-4o-audio-preview-2024-12-17", "gpt-4o-audio-preview-2025-06-03", "gpt-4o-mini-audio-preview", "gpt-4o-mini-audio-preview-2024-12-17", "gpt-4o-search-preview", "gpt-4o-mini-search-preview", "gpt-4o-search-preview-2025-03-11", "gpt-4o-mini-search-preview-2025-03-11", "chatgpt-4o-latest", "codex-mini-latest", "gpt-4o-mini", "gpt-4o-mini-2024-07-18", "gpt-4-turbo", "gpt-4-turbo-2024-04-09", "gpt-4-0125-preview", "gpt-4-turbo-preview", "gpt-4-1106-preview", "gpt-4-vision-preview", "gpt-4", "gpt-4-0314", "gpt-4-0613", "gpt-4-32k", "gpt-4-32k-0314", "gpt-4-32k-0613", "gpt-3.5-turbo", "gpt-3.5-turbo-16k", "gpt-3.5-turbo-0301", "gpt-3.5-turbo-0613", "gpt-3.5-turbo-1106", "gpt-3.5-turbo-0125", "gpt-3.5-turbo-16k-0613"]>;
 /**
- * @since 1.0.0
+ * OpenAI model identifiers supported by the Responses API language model.
+ *
  * @category models
+ * @since 4.0.0
  */
 export type Model = typeof ResponseModelIds.Encoded | typeof SharedModelIds.Encoded;
 /**
@@ -73,13 +75,22 @@ declare const Config_base: Context.ServiceClass<Config, "@effect/ai-openai/OpenA
 /**
  * Service definition for OpenAI language model configuration.
  *
- * @since 1.0.0
  * @category services
+ * @since 4.0.0
  */
 export declare class Config extends Config_base {
 }
 declare module "effect/unstable/ai/Prompt" {
+    /**
+     * OpenAI-specific options for file prompt parts.
+     *
+     * @category request
+     * @since 4.0.0
+     */
     interface FilePartOptions extends ProviderOptions {
+        /**
+         * Provider-specific file options for the OpenAI Responses API.
+         */
         readonly openai?: {
             /**
              * The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`.
@@ -87,7 +98,16 @@ declare module "effect/unstable/ai/Prompt" {
             readonly imageDetail?: ImageDetail | null;
         } | null;
     }
+    /**
+     * OpenAI-specific options for reasoning prompt parts.
+     *
+     * @category request
+     * @since 4.0.0
+     */
     interface ReasoningPartOptions extends ProviderOptions {
+        /**
+         * Provider-specific reasoning options for the OpenAI Responses API.
+         */
         readonly openai?: {
             /**
              * The ID of the item to reference.
@@ -101,7 +121,16 @@ declare module "effect/unstable/ai/Prompt" {
             readonly encryptedContent?: string | null;
         } | null;
     }
+    /**
+     * OpenAI-specific options for assistant tool-call prompt parts.
+     *
+     * @category request
+     * @since 4.0.0
+     */
     interface ToolCallPartOptions extends ProviderOptions {
+        /**
+         * Provider-specific tool-call options for the OpenAI Responses API.
+         */
         readonly openai?: {
             /**
              * The ID of the item to reference.
@@ -117,7 +146,16 @@ declare module "effect/unstable/ai/Prompt" {
             readonly approvalRequestId?: string | null;
         } | null;
     }
+    /**
+     * OpenAI-specific options for tool-result prompt parts.
+     *
+     * @category request
+     * @since 4.0.0
+     */
     interface ToolResultPartOptions extends ProviderOptions {
+        /**
+         * Provider-specific tool-result options for the OpenAI Responses API.
+         */
         readonly openai?: {
             /**
              * The ID of the item to reference.
@@ -133,7 +171,16 @@ declare module "effect/unstable/ai/Prompt" {
             readonly approvalId?: string | null;
         } | null;
     }
+    /**
+     * OpenAI-specific options for text prompt parts.
+     *
+     * @category request
+     * @since 4.0.0
+     */
     interface TextPartOptions extends ProviderOptions {
+        /**
+         * Provider-specific text options for the OpenAI Responses API.
+         */
         readonly openai?: {
             /**
              * The ID of the item to reference.
@@ -151,8 +198,20 @@ declare module "effect/unstable/ai/Prompt" {
     }
 }
 declare module "effect/unstable/ai/Response" {
+    /**
+     * OpenAI metadata attached to a complete text response part.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface TextPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned for the text part.
+         */
         readonly openai?: {
+            /**
+             * The OpenAI item ID associated with the text part.
+             */
             readonly itemId?: string | null;
             /**
              * If the model emits a refusal content part, the refusal explanation
@@ -170,47 +229,155 @@ declare module "effect/unstable/ai/Response" {
             readonly annotations?: ReadonlyArray<typeof OpenAiSchema.Annotation.Encoded> | null;
         };
     }
+    /**
+     * OpenAI metadata emitted when a streamed text part starts.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface TextStartPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned for the streamed text start.
+         */
         readonly openai?: {
+            /**
+             * The OpenAI item ID associated with the streamed text part.
+             */
             readonly itemId?: string | null;
         } | null;
     }
+    /**
+     * OpenAI metadata emitted when a streamed text part ends.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface TextEndPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned for the streamed text end.
+         */
         readonly openai?: {
+            /**
+             * The OpenAI item ID associated with the streamed text part.
+             */
             readonly itemId?: string | null;
+            /**
+             * The annotations collected for the completed streamed text part.
+             */
             readonly annotations?: ReadonlyArray<typeof OpenAiSchema.Annotation.Encoded> | null;
         } | null;
     }
+    /**
+     * OpenAI metadata attached to a complete reasoning response part.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface ReasoningPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned for the reasoning part.
+         */
         readonly openai?: {
+            /**
+             * The OpenAI item ID associated with the reasoning part.
+             */
             readonly itemId?: string | null;
+            /**
+             * Encrypted reasoning content that can be sent back in later requests.
+             */
             readonly encryptedContent?: string | null;
         } | null;
     }
+    /**
+     * OpenAI metadata emitted when a streamed reasoning part starts.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface ReasoningStartPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned for the streamed reasoning start.
+         */
         readonly openai?: {
+            /**
+             * The OpenAI item ID associated with the reasoning part.
+             */
             readonly itemId?: string | null;
+            /**
+             * Encrypted reasoning content that can be sent back in later requests.
+             */
             readonly encryptedContent?: string | null;
         } | null;
     }
+    /**
+     * OpenAI metadata emitted for a streamed reasoning delta.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface ReasoningDeltaPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned for the streamed reasoning delta.
+         */
         readonly openai?: {
+            /**
+             * The OpenAI item ID associated with the reasoning part.
+             */
             readonly itemId?: string | null;
         } | null;
     }
+    /**
+     * OpenAI metadata emitted when a streamed reasoning part ends.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface ReasoningEndPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned for the streamed reasoning end.
+         */
         readonly openai?: {
+            /**
+             * The OpenAI item ID associated with the reasoning part.
+             */
             readonly itemId?: string | null;
+            /**
+             * Encrypted reasoning content that can be sent back in later requests.
+             */
             readonly encryptedContent?: string;
         } | null;
     }
+    /**
+     * OpenAI metadata attached to tool-call response parts.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface ToolCallPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned for the tool call.
+         */
         readonly openai?: {
+            /**
+             * The OpenAI item ID associated with the tool call.
+             */
             readonly itemId?: string | null;
         } | null;
     }
+    /**
+     * OpenAI metadata attached to document source citations.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface DocumentSourcePartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific citation metadata for the OpenAI Responses API.
+         */
         readonly openai?: {
+            /**
+             * Identifies a citation to an uploaded file.
+             */
             readonly type: "file_citation";
             /**
              * The index of the file in the list of files.
@@ -221,6 +388,9 @@ declare module "effect/unstable/ai/Response" {
              */
             readonly fileId: string;
         } | {
+            /**
+             * Identifies a citation to a generated file path.
+             */
             readonly type: "file_path";
             /**
              * The index of the file in the list of files.
@@ -231,6 +401,9 @@ declare module "effect/unstable/ai/Response" {
              */
             readonly fileId: string;
         } | {
+            /**
+             * Identifies a citation to a file inside a container.
+             */
             readonly type: "container_file_citation";
             /**
              * The ID of the file.
@@ -242,8 +415,20 @@ declare module "effect/unstable/ai/Response" {
             readonly containerId: string;
         } | null;
     }
+    /**
+     * OpenAI metadata attached to URL source citations.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface UrlSourcePartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific URL citation metadata for the OpenAI Responses API.
+         */
         readonly openai?: {
+            /**
+             * Identifies a citation to a URL.
+             */
             readonly type: "url_citation";
             /**
              * The index of the first character of the URL citation in the message.
@@ -255,22 +440,36 @@ declare module "effect/unstable/ai/Response" {
             readonly endIndex: number;
         } | null;
     }
+    /**
+     * OpenAI metadata attached to finish response parts.
+     *
+     * @category response
+     * @since 4.0.0
+     */
     interface FinishPartMetadata extends ProviderMetadata {
+        /**
+         * Provider-specific metadata returned when generation finishes.
+         */
         readonly openai?: {
+            /**
+             * The service tier reported by OpenAI for the response.
+             */
             readonly serviceTier?: "default" | "auto" | "flex" | "scale" | "priority" | null;
         } | null;
     }
 }
 /**
- * @since 1.0.0
+ * Creates an OpenAI language model that can be used with `AiModel.provide`.
+ *
  * @category constructors
+ * @since 4.0.0
  */
 export declare const model: (model: (string & {}) | Model, config?: Omit<typeof Config.Service, "model">) => AiModel.Model<"openai", LanguageModel.LanguageModel, OpenAiClient>;
 /**
  * Creates an OpenAI language model service.
  *
- * @since 1.0.0
  * @category constructors
+ * @since 4.0.0
  */
 export declare const make: (args_0: {
     readonly model: (string & {}) | Model;
@@ -279,8 +478,8 @@ export declare const make: (args_0: {
 /**
  * Creates a layer for the OpenAI language model.
  *
- * @since 1.0.0
  * @category layers
+ * @since 4.0.0
  */
 export declare const layer: (options: {
     readonly model: (string & {}) | Model;
@@ -289,22 +488,22 @@ export declare const layer: (options: {
 /**
  * Provides config overrides for OpenAI language model operations.
  *
- * @since 1.0.0
  * @category configuration
+ * @since 4.0.0
  */
 export declare const withConfigOverride: {
     /**
      * Provides config overrides for OpenAI language model operations.
      *
-     * @since 1.0.0
      * @category configuration
+     * @since 4.0.0
      */
     (overrides: typeof Config.Service): <A, E, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A, E, Exclude<R, Config>>;
     /**
      * Provides config overrides for OpenAI language model operations.
      *
-     * @since 1.0.0
      * @category configuration
+     * @since 4.0.0
      */
     <A, E, R>(self: Effect.Effect<A, E, R>, overrides: typeof Config.Service): Effect.Effect<A, E, Exclude<R, Config>>;
 };