yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-07-04 07:33:56 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenMetadata/openmetadata-docs/content/v1.8.x/collate-ai/documentation-agent.md

1.8 KiB
Raw Permalink Blame History

title slug collate
Automate Metadata Descriptions with Collate AI Documentation Agent /collateai/documentation-agent true

Collate AI Documentation Agent

Overview

The Documentation Agent utilizes generative AI to automatically generate metadata descriptions for data assets, facilitating better understanding and accessibility.

Key Features

  • Automated Schema Labeling: Generates clear and concise descriptions for tables and columns, reducing manual documentation efforts.
  • Natural Language SQL Query Generation: Enables users to create SQL queries by interacting with the MetaPilot chatbot using everyday language.
  • Intelligent Query Assistance: Assists in building, refining, and optimizing SQL queries, including handling table joins and relationships.

Setup Instructions

  1. Navigate to Applications: Go to Settings > Applications.

{% image src="/images/v1.8/collate-ai/collate-ai-agent.png" alt="Navigate to Applications" caption="Navigate to Applications" /%}

  1. Install the Agent: Click on "Add Apps" to access the marketplace and install the Collate AI Documentation Agent.

{% image src="/images/v1.8/collate-ai/collate-ai-documentation-agent.png" alt="Installation" caption="Installation" /%}

  1. Configure the Agent:
    • Filter: Use the UI Query Filter builder to select assets based on properties like service, database, schema, name, owners, domain, or custom properties.
    • Add Description If Empty: Enable this option to automatically add descriptions to assets lacking them.

{% image src="/images/v1.8/collate-ai/collate-ai-documentation-agent1.png" alt="Configuration" caption="Configuration" /%}

  1. Scheduling: Set up regular intervals for the agent to run and update metadata.

{% image src="/images/v1.8/collate-ai/collate-ai-documentation-agent2.png" alt="Scheduling" caption="Scheduling" /%}