OpenAiError
The OpenAiError module defines OpenAI-specific metadata that can be attached to the shared AiError error types used by the AI packages. It is primarily used by OpenAI-compatible clients to preserve provider details such as error codes, error types, request IDs, and rate limit headers while still exposing errors through the provider-neutral Effect AI error model.
Use this module when mapping OpenAI API failures into AiError values and when consumers need enough structured metadata to debug failed requests, inspect quota or rate limit responses, or correlate an error with OpenAI support. The exported types are metadata shapes only; the module augmentation makes those shapes available on the corresponding shared AI error metadata interfaces without defining new runtime error classes.
Models
OpenAiErrorMetadata type
Signature
type OpenAiErrorMetadata = {
readonly errorCode: string | null;
readonly errorType: string | null;
readonly requestId: string | null;
};OpenAiRateLimitMetadata type
OpenAI-specific rate limit metadata fields.
Details
Extends base error metadata with rate limit specific information from OpenAI's rate limit headers.
Signature
type OpenAiRateLimitMetadata = OpenAiErrorMetadata & {
readonly limit: string | null;
readonly remaining: number | null;
readonly resetRequests: string | null;
readonly resetTokens: string | null;
};
OpenAI-specific error metadata fields.