Configuring AI Autodocumentation for GPT

Obtaining API key from OpenAI

AI Autodocumentation feature requires an API key for your OpenAI account.

Logging in to the OpenAI platform

To obtain the API key, log in to your OpenAI account on the OpenAI developer platform and:

1. Click the menu icon in the top left corner.
2. Select API keys option.

Creating a new OpenAI API key

1. On the API keys page press Create new secret key
2. Enter the name of your key (optionally)
3. Press Create secret key. Copy the created key and save it for the next steps.

Configuring the AI Autodocumentation in Dataedo Portal

Prerequisites

• OpenAI API key
• Admin permissions to the repository

Opening the settings

1. Click the Settings icon in the top right corner of Dataedo Portal.
2. Click System settings in the menu.
3. Click LLM (AI) engines tab.
4. Select one of the preconfigured engines and expand it. You can also press [Add] button to add a new engine.

AI engine setting form

Complete all fields in the provided form and press [Save] button. You can accept default values optimized for Dataedo Portal or select custom values:

• Engine - Supported AI engines
• Engine name - Name of AI engine (editable)
• API key - Click the eye icon and paste the API key from the OpenAI developer platform
• Max tokens - Maximum amount of tokens per response
• Temperature - Sampling temperature from 0.0 to 2.0. Higher values make the output more random
• Frequency penalty - Penalty value from -2.0 to 2.0. It allows to avoid repeating the same words or phrases too frequently. Higher values give more differentiated texts
• Presence penalty - Penalty value from -2.0 to 2.0. It allows to generate more words that have not yet been included in the generated text. Higher values increase the likelihood of generating completely new concepts and ideas

Learn more

Check this Video Tutorial on AI Autodocumentation in Dataedo Portal.