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

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 = {
     /**
@@ -29,11 +29,13 @@ export type OpenAiErrorMetadata = {
 /**
  * OpenAI-specific rate limit metadata fields.
  *
+ * **Details**
+ *
  * 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,45 +56,176 @@ export type OpenAiRateLimitMetadata = OpenAiErrorMetadata & {
     readonly resetTokens: string | null;
 };
 declare module "effect/unstable/ai/AiError" {
-    interface RateLimitError {
-        readonly metadata: {
-            readonly openai?: OpenAiRateLimitMetadata | null;
-        };
+    /**
+     * OpenAI metadata attached to `RateLimitError` values.
+     *
+     * **Details**
+     *
+     * 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;
     }
-    interface QuotaExhaustedError {
-        readonly metadata: {
-            readonly openai?: OpenAiErrorMetadata | null;
-        };
+    /**
+     * OpenAI metadata attached to `QuotaExhaustedError` values.
+     *
+     * **Details**
+     *
+     * 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;
     }
-    interface AuthenticationError {
-        readonly metadata: {
-            readonly openai?: OpenAiErrorMetadata | null;
-        };
+    /**
+     * OpenAI metadata attached to `AuthenticationError` values.
+     *
+     * **Details**
+     *
+     * 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;
     }
-    interface ContentPolicyError {
-        readonly metadata: {
-            readonly openai?: OpenAiErrorMetadata | null;
-        };
+    /**
+     * OpenAI metadata attached to `ContentPolicyError` values.
+     *
+     * **Details**
+     *
+     * 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;
     }
-    interface InvalidRequestError {
-        readonly metadata: {
-            readonly openai?: OpenAiErrorMetadata | null;
-        };
+    /**
+     * OpenAI metadata attached to `InvalidRequestError` values.
+     *
+     * **Details**
+     *
+     * 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;
     }
-    interface InternalProviderError {
-        readonly metadata: {
-            readonly openai?: OpenAiErrorMetadata | null;
-        };
+    /**
+     * OpenAI metadata attached to `InternalProviderError` values.
+     *
+     * **Details**
+     *
+     * 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.
+     *
+     * **Details**
+     *
+     * 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;
     }
-    interface InvalidOutputError {
-        readonly metadata: {
-            readonly openai?: OpenAiErrorMetadata | null;
-        };
+    /**
+     * OpenAI metadata attached to `StructuredOutputError` values.
+     *
+     * **Details**
+     *
+     * 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;
     }
-    interface UnknownError {
-        readonly metadata: {
-            readonly openai?: OpenAiErrorMetadata | null;
-        };
+    /**
+     * OpenAI metadata attached to `UnsupportedSchemaError` values.
+     *
+     * **Details**
+     *
+     * 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.
+     *
+     * **Details**
+     *
+     * 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;
     }
 }
 //# sourceMappingURL=OpenAiError.d.ts.map

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,cAAc;QAC7B,QAAQ,CAAC,QAAQ,EAAE;YACjB,QAAQ,CAAC,MAAM,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAA;SACjD,CAAA;KACF;IAED,UAAiB,mBAAmB;QAClC,QAAQ,CAAC,QAAQ,EAAE;YACjB,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;SAC7C,CAAA;KACF;IAED,UAAiB,mBAAmB;QAClC,QAAQ,CAAC,QAAQ,EAAE;YACjB,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;SAC7C,CAAA;KACF;IAED,UAAiB,kBAAkB;QACjC,QAAQ,CAAC,QAAQ,EAAE;YACjB,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;SAC7C,CAAA;KACF;IAED,UAAiB,mBAAmB;QAClC,QAAQ,CAAC,QAAQ,EAAE;YACjB,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;SAC7C,CAAA;KACF;IAED,UAAiB,qBAAqB;QACpC,QAAQ,CAAC,QAAQ,EAAE;YACjB,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;SAC7C,CAAA;KACF;IAED,UAAiB,kBAAkB;QACjC,QAAQ,CAAC,QAAQ,EAAE;YACjB,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;SAC7C,CAAA;KACF;IAED,UAAiB,YAAY;QAC3B,QAAQ,CAAC,QAAQ,EAAE;YACjB,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;SAC7C,CAAA;KACF;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;;;;;;;;;;GAUG;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;;;;;;;;;;;OAWG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAA;KACjD;IAED;;;;;;;;;;OAUG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;;;OAUG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;;;OAUG;IACH,UAAiB,0BAA0B;QACzC;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;;;OAUG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;;;OAUG;IACH,UAAiB,6BAA6B;QAC5C;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;;;OAUG;IACH,UAAiB,0BAA0B;QACzC;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;;;OAUG;IACH,UAAiB,6BAA6B;QAC5C;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;;;OAUG;IACH,UAAiB,8BAA8B;QAC7C;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;;;OAUG;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