Catalog Scribe ✨

Your very own personal assistant to write documentation

The magic

In spite of our best effort to create a beautiful app, writing documentation just isn't fun 😢. Catalog AI is here to support you 🦸‍♂️

Table and dashboard read-mes

Catalog AI can generate for you a detailed read-me describing the content and use cases for tables and dashboards that have source SQL queries.

Table's column descriptions

Leverage AI to document your columns as well. On any table you just have to click on this button

It will generate the documentation for first thirty columns at a time. For each documented column you'll see "From AI Assistant" so you can easily identify them.

Catalog also completes your column documentation with the following features:

Catalog Auto DocColumn Description Propagation ✨Description Auto-Complete

Knowledge pages

Catalog AI can also come to your help to create knowledge pages. The scribe is tailored for different types of documentation:

  • Metrics

  • Data entities

  • Data domains

  • Acronyms

You simply need to specify the page name and type for the AI to do its' magic.

If you want none of the specified types correspond to your needs, you can always chose the type "Other" 😉.

Safety

The Scribe uses OpenAI models. The feature requires admin approval (before then, no metadata will be shared with OpenAI). Once the feature is activated, only queries for which a user requests an explanation are shared with OpenAI. It is worth noting that we filter out PII information from queries. For more details, please view the Catalog AI safety page.

Activate Catalog AI on your account

To see this live in your Catalog account, an admin just needs to reach out to [email protected] 😊

Last updated

Was this helpful?