From 042b5f1e6c7b89707020c91dfd8b1ebb1bd4aaf8 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 21 May 2026 14:06:16 +0000 Subject: [PATCH] docs: clarify knowledge document file types and relevance ratings --- guides/ai-agents/best-practices.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/guides/ai-agents/best-practices.mdx b/guides/ai-agents/best-practices.mdx index e08823f7..44d3bb7d 100644 --- a/guides/ai-agents/best-practices.mdx +++ b/guides/ai-agents/best-practices.mdx @@ -169,7 +169,7 @@ When you upload a document, Lightdash reads it and writes a short summary of wha A few things worth knowing: - **The agent decides when to open a document.** If your document is never being used, the summary probably isn't specific enough about what it's for. Renaming the document or making its purpose clearer in the content usually fixes it. -- **Each document gets a relevance rating against your project.** After uploading, check the relevance card. If a document is rated low or unrelated, the agent has been told not to rely on it for data questions — you'll want to revise it, or scope it to a different agent where it's more relevant. +- **Each document gets a relevance rating against your project.** After uploading, check the relevance card. Documents are rated `high`, `medium`, `low`, or `none` against the explores the agent can see. If a document is rated low or unrelated, the agent has been told not to rely on it for data questions — you'll want to revise it, or scope it to a different agent where it's more relevant. ### What to upload @@ -192,7 +192,7 @@ Good candidates are anything a new analyst on your team would need to read befor ### Practical tips - **Keep documents focused and short.** Each document is capped at 20KB and the org-wide quota is 5MB, but the practical limit is much lower: a focused one-page note is consulted more reliably than a sprawling wiki export. Split large references into one document per topic. -- **Use Markdown.** `.md` and `.txt` are supported. Markdown headings and lists make summaries more accurate. +- **Use Markdown.** `.md`, `.markdown`, and `.txt` files are supported. Markdown headings and lists make summaries more accurate. - **Name documents like a `use when` clue.** `Revenue recognition rules.md` is better than `notes.md` — the name is part of what the agent sees. - **Scope documents per-agent.** A document uploaded for your Finance agent shouldn't pollute your Marketing agent's context. Use the per-agent access setting to keep documents relevant. - **Re-check after big changes.** When you add new explores or rename fields, revisit the relevance rating on existing documents — `relatedExploreNames` references exact explore names and can go stale.