AIDK API Reference / aidk-ai-sdk
aidk-ai-sdk ​
AIDK Vercel AI SDK Adapter ​
Bidirectional integration between AIDK and the Vercel AI SDK. Use AI SDK models in AIDK agents, or use AIDK's JSX components with AI SDK's execution.
Two Directions ​
1. AI SDK → AIDK (Use AI SDK models in AIDK Engine) ​
typescript
import { Engine } from 'aidk';
import { aiSdk } from 'aidk-ai-sdk';
import { openai } from '@ai-sdk/openai';
const engine = new Engine({
model: aiSdk(openai('gpt-4')),
});2. AIDK → AI SDK (Use AIDK components with AI SDK) ​
Progressive adoption from simple to full-featured:
typescript
import { compile, createCompiler, generateText } from 'aidk-ai-sdk';
// Level 1: Compile JSX to AI SDK messages
const { messages, tools } = await compile(<MyAgent />);
// Level 2: Managed single execution
const compiler = createCompiler();
const result = await compiler.run(<MyAgent />, executor);
// Level 3: Streaming execution
for await (const event of compiler.stream(<MyAgent />, executor)) {
// Handle streaming events
}
// Level 4: Drop-in replacement for AI SDK
const result = await generateText(<MyAgent />);See ​
- aiSdk - Create AI SDK model adapter
- compile - Compile JSX to AI SDK format
- AiSdkCompiler - Full compiler with execution management
Classes ​
| Class | Description |
|---|---|
| AiSdkCompiler | AI SDK Compiler. |
Interfaces ​
| Interface | Description |
|---|---|
| AiSdkAdapterConfig | Configuration options for the AI SDK adapter |
| AiSdkModelProps | Props for AiSdkModel component. Extends adapter config with optional Model component props. |
| CompiledInput | Library-native compiled output. This is what compile() returns - ready to pass to generateText/streamText. |
| CompilerConfig | Configuration for the compiler. |
| MessageProps | Props for ai-sdk-style Message component. Uses ai-sdk's role and content format. |
| ToolResultProps | Props for ai-sdk-style ToolResult component. |
Type Aliases ​
| Type Alias | Description |
|---|---|
| AiSdkAdapter | - |
| AiSdkContent | AI SDK compatible message content. Supports string (simple text) or content parts array. |
| AiSdkContentPart | AI SDK content part types we support. |
| CompilerStreamEvent | Events emitted during streaming. |
| Executor | Executor function signature. User provides this to control model execution. |
| GenerateOptions | Options for generateText/streamText methods. Matches ai-sdk's options interface. |
| StreamExecutor | Stream executor function signature. |
Functions ​
| Function | Description |
|---|---|
| aiSdk | Shorthand factory for creating AI SDK adapter. |
| aiSdkMessagesToEngineInput | Convert AI SDK messages directly to EngineInput. Convenience function that chains fromAiSdkInputMessages → messagesToEngineInput. |
| Assistant | AI SDK-style Assistant message component. |
| compile | Compile JSX to library-native input. |
| createAiSdkModel | Create an AI SDK adapter for use with the engine. |
| createCompiler | Create an AI SDK compiler. |
| fromAiSdkInputMessages | Convert AI SDK input messages to our Message[] format. This is the inverse of toAiSdkMessages. |
| fromAiSdkMessages | - |
| generateText | Generate text using JSX. |
| mapAiSdkContentToContentBlocks | - |
| mapAiSdkPartToContentBlock | - |
| mapContentBlocksToAiSdkContent | - |
| mapContentBlockToAiSdkPart | - |
| mapToolResultToContentBlocks | - |
| Message | AI SDK-style Message component. |
| Model | AiSdkModel component for declarative model configuration in JSX. |
| streamText | Stream text using JSX. |
| System | AI SDK-style System message component. |
| toAiSdkCompiledInput | Convert compiled output (COMInput) to AI SDK CompiledInput format. Used by the compiler adapter to produce library-native output. |
| toAiSdkMessages | - |
| ToolResult | AI SDK-style ToolResult component. |
| User | AI SDK-style User message component. |
References ​
AiSdkModel ​
Renames and re-exports Model
createAiSdkCompiler ​
Renames and re-exports createCompiler
Timeline ​
Re-exports Timeline