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 ​
| Parameter | Type | Default value |
|---|---|---|
provider | string | undefined |
message | string | undefined |
code | | "ADAPTER_RESPONSE" | "ADAPTER_RATE_LIMIT" | "ADAPTER_AUTH" | "ADAPTER_CONTENT_FILTER" | "ADAPTER_CONTEXT_LENGTH" | "ADAPTER_RESPONSE" |
details | Record<string, unknown> | {} |
cause? | Error | undefined |
Returns ​
AdapterError
Overrides ​
Properties ​
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
code | readonly | AIDKErrorCode | Unique error code for programmatic handling | AIDKError.code | packages/shared/src/errors.ts:100 |
details | readonly | Record<string, unknown> | Additional error details | AIDKError.details | packages/shared/src/errors.ts:103 |
provider | readonly | string | Provider name (openai, google, anthropic, etc.) | - | packages/shared/src/errors.ts:525 |
providerErrorCode? | readonly | string | Provider-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 ​
| Parameter | Type |
|---|---|
provider | string |
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 ​
| Parameter | Type |
|---|---|
provider | string |
maxTokens | number |
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 ​
| Parameter | Type |
|---|---|
json | SerializedAIDKError |
Returns ​
Inherited from ​
rateLimit() ​
ts
static rateLimit(provider: string, retryAfter?: number): AdapterError;Defined in: packages/shared/src/errors.ts:551
Create a rate limit error
Parameters ​
| Parameter | Type |
|---|---|
provider | string |
retryAfter? | number |
Returns ​
AdapterError
toJSON() ​
ts
toJSON(): SerializedAIDKError;Defined in: packages/shared/src/errors.ts:131
Serialize error for transport (JSON-safe)