OpenAI models

Follow the steps below to configure the AI Autodocumentation feature in Dataedo with OpenAI models.

Prerequisites

caution

To use the AI Autodocumentation feature with OpenAI, you must generate an API key from OpenAI. It is required to access the OpenAI API and use the AI models for autodocumentation.

You will also need the Admin role in Dataedo Portal to add the engine, and (Power) Data Steward permissions to the Dataedo Repository to create AI-generated descriptions.

OpenAI developer platform

Generate an API key from OpenAI

1. Go to the OpenAI developer platform.

2. Sign up for an account or log in if you already have one.

3. In the side panel on the left, click API keys.

   

4. Create a new API key:

   
   useful tip

   The Name and Projects fields are optional. You can leave the default values unchanged or enter your own.

5. Copy the API key to your clipboard.

Configure AI autodocumentation in Dataedo

1. In Dataedo navigate to Settings > System Settings > LLM (AI) engines.
2. Click + Add engine.
3. In the New engine window, select OpenAI.
4. Fill in the engine details:
   • Title [A]: a user-friendly name shown to users when they choose an engine, for example GPT-5.6 Terra.
   • Model [B]: select GPT-5.6 Sol, GPT-5.6 Terra, or GPT-5.6 Luna. To use another OpenAI model, select Enter custom model... and type its model ID.
   • API key [C]: paste the API key from the OpenAI developer platform.
5. (Optional) Expand Advanced settings [D] to change Max tokens (default 4096) or to add Additional context for the prompts. See Add an AI engine for details.
6. Click Save and test.

Dataedo Portal sends a short test prompt to OpenAI and saves the engine only if it responds. If the test fails, check the error message, correct the settings, and click Save and test again.

Useful resources

Watch the video tutorial on AI autodocumentation to learn more.