Skip to content

AIDK API Reference / aidk-shared / AdapterError

Class: AdapterError ​

Defined in: packages/shared/src/errors.ts:523

Error thrown by model adapters for provider-specific errors.

Example ​

typescript
throw new AdapterError('openai', 'No message in response', 'ADAPTER_RESPONSE');
throw new AdapterError('google', 'Rate limit exceeded', 'ADAPTER_RATE_LIMIT', { retryAfter: 60 });
throw new AdapterError('anthropic', 'Content blocked', 'ADAPTER_CONTENT_FILTER');

Extends ​

Constructors ​

Constructor ​

ts
new AdapterError(
   provider: string, 
   message: string, 
   code: 
  | "ADAPTER_RESPONSE"
  | "ADAPTER_RATE_LIMIT"
  | "ADAPTER_AUTH"
  | "ADAPTER_CONTENT_FILTER"
  | "ADAPTER_CONTEXT_LENGTH", 
   details: Record<string, unknown>, 
   cause?: Error): AdapterError;

Defined in: packages/shared/src/errors.ts:530

Parameters ​

ParameterTypeDefault value
providerstringundefined
messagestringundefined
code| "ADAPTER_RESPONSE" | "ADAPTER_RATE_LIMIT" | "ADAPTER_AUTH" | "ADAPTER_CONTENT_FILTER" | "ADAPTER_CONTEXT_LENGTH""ADAPTER_RESPONSE"
detailsRecord<string, unknown>{}
cause?Errorundefined

Returns ​

AdapterError

Overrides ​

AIDKError.constructor

Properties ​

PropertyModifierTypeDescriptionInherited fromDefined in
codereadonlyAIDKErrorCodeUnique error code for programmatic handlingAIDKError.codepackages/shared/src/errors.ts:100
detailsreadonlyRecord<string, unknown>Additional error detailsAIDKError.detailspackages/shared/src/errors.ts:103
providerreadonlystringProvider name (openai, google, anthropic, etc.)-packages/shared/src/errors.ts:525
providerErrorCode?readonlystringProvider-specific error code-packages/shared/src/errors.ts:528

Methods ​

contentFiltered() ​

ts
static contentFiltered(provider: string, reason?: string): AdapterError;

Defined in: packages/shared/src/errors.ts:563

Create a content filter error

Parameters ​

ParameterType
providerstring
reason?string

Returns ​

AdapterError


contextLength() ​

ts
static contextLength(
   provider: string, 
   maxTokens: number, 
   requestedTokens?: number): AdapterError;

Defined in: packages/shared/src/errors.ts:575

Create a context length error

Parameters ​

ParameterType
providerstring
maxTokensnumber
requestedTokens?number

Returns ​

AdapterError


fromJSON() ​

ts
static fromJSON(json: SerializedAIDKError): AIDKError;

Defined in: packages/shared/src/errors.ts:163

Create error from serialized format

Parameters ​

ParameterType
jsonSerializedAIDKError

Returns ​

AIDKError

Inherited from ​

AIDKError.fromJSON


rateLimit() ​

ts
static rateLimit(provider: string, retryAfter?: number): AdapterError;

Defined in: packages/shared/src/errors.ts:551

Create a rate limit error

Parameters ​

ParameterType
providerstring
retryAfter?number

Returns ​

AdapterError


toJSON() ​

ts
toJSON(): SerializedAIDKError;

Defined in: packages/shared/src/errors.ts:131

Serialize error for transport (JSON-safe)

Returns ​

SerializedAIDKError

Inherited from ​

AIDKError.toJSON

Released under the MIT License.