AI autodocumentation
The AI Autodocumentation feature in Dataedo leverages the power of Large Language Models (LLMs) to automatically generate documentation for your data sources. With this feature you can quickly and efficiently document glossary terms, KPIs, as well as database objects like tables, views, and their columns.
LLMs at a glance
Large Language Models (LLMs) are sophisticated AI systems designed to understand and generate human-like text. Trained on vast amounts of text data, these models can perform various tasks, such as text summarization, translation, question answering, and content generation. In the context of Dataedo, LLMs help automate the process of documentation creation by generating meaningful descriptions for data elements.
Prerequisites
Supported LLMs
The AI Autodocumentation feature in Dataedo supports the following Open AI LLMs:
- GPT 3.5 Turbo
- GPT 3.5 16K Turbo
- GPT 4
- GPT 4 Turbo
- GPT 4 Omni
- Azure OpenAI
You must provide an OpenAI API key for these models to work with Dataedo. See Configuration for more details.
Required permissions
To use the AI Autodocumentation feature, you must have Admin, or (Power) Data Steward permissions, as only these roles are authorized to generate AI-generated descriptions. Users with lower access privileges won't be able to create these descriptions.
However, any user with at least Viewer rights to a particular object will be able to view both the regular and AI-generated description fields associated with that object.
Required licenses
AI Autodocumentation is available only in Dataedo and Dataedo Unlimited plans.
If your license doesn't provide this feature, please consider switching to another licensing plan. This will enable a lot of other great features, too. For further details please visit the pricing page or contact the Sales Team.
Metadata sent to OpenAI
The AI Autodocumentation feature requires sending prompts to the OpenAI API. To ensure the best quality of generated text, the following metadata are sent to OpenAI in the prompts:
| Object to Generate Description For | Metadata Sent to OpenAI |
|---|---|
Column | Id, Name, DataType, IsNullable, IsUniqueKey, PkConstraint, FkTargetName, DefaultValue, CalculationFormula, ParentName, ParentObjectType |
Table/View | Id, Name, ObjectType, Description, Title, Schema, List of linked terms |
Term/KPI | Id, DisplayName, Code, Description, Title, List of related terms |
In this section
Need help?
If you run into any problems or have questions, reach out to Dataedo support.
