Skip to content

AIDK API Reference / aidk-openai / OpenAIModel

Function: OpenAIModel() ​

ts
function OpenAIModel(props: OpenAIModelProps): Element;

Defined in: packages/adapters/openai/src/openai-model.tsx:46

OpenAIModel component for declarative model configuration in JSX.

Creates an OpenAI model adapter internally and wraps it in a Model component.

Parameters ​

ParameterType
propsOpenAIModelProps

Returns ​

Element

Example ​

tsx
// Basic usage
<OpenAIModel model="gpt-4o" />

// With config
<OpenAIModel
  model="gpt-4o"
  temperature={0.7}
  maxTokens={1000}
/>

// With custom base URL (e.g., Azure OpenAI)
<OpenAIModel
  model="gpt-4"
  baseURL="https://my-resource.openai.azure.com"
  apiKey={process.env.AZURE_OPENAI_KEY}
/>

Released under the MIT License.