AIDK API Reference / aidk-openai

aidk-openai

AIDK OpenAI Adapter

Native OpenAI API adapter for AIDK. Provides direct integration with OpenAI models without requiring the Vercel AI SDK.

Features

• Native API - Direct OpenAI API integration
• Streaming - Full streaming support with deltas
• Tool Calling - Native function calling support
• All Models - GPT-4o, GPT-4, GPT-3.5, and more

Quick Start

import { openai } from 'aidk-openai';

const model = openai('gpt-4o');

// Use with engine
const engine = createEngine();
const result = await engine.execute(
  <Model model={model}>
    <System>You are a helpful assistant.</System>
    <User>Hello!</User>
  </Model>
);

Interfaces

Interface	Description
OpenAIModelProps	Props for OpenAIModel component. Extends adapter config with optional Model component props.

Type Aliases

Type Alias	Description
OpenAIAdapter	-

Functions

Function	Description
buildClientOptions	-
createOpenAIModel	Factory function for creating OpenAI model adapter using createModel
mapToolDefinition	Map tool definition to OpenAI format
openai	Factory function for creating OpenAI adapter (alias for createOpenAIModel)
OpenAIModel	OpenAIModel component for declarative model configuration in JSX.
toOpenAIMessages	Convert Message to OpenAI ChatCompletionMessageParam(s)