Knowledge
Give the assistant your documentation to answer from.
Upload your help pages, policies or product documentation, and the assistant can search them to answer questions, and say where its answer came from.
Uploading
On the app's Knowledge tab in the dashboard, upload a document. It is stored straight away and indexed in the background, so it shows as pending for a moment before the assistant can use it. You can re-index or delete it from the same tab.
- Markdown only for now:
.md,.markdownor.mdx. - Up to 10 MB a document.
Markdown only, because its headings are what the assistant searches by, and it is a format we can say how to write well.
The assistant is only offered search when the app has indexed documents, so it never searches an empty library and apologises, or makes something up.
Writing a document it can find things in
Each document is split into sections by its headings, and each section keeps its heading path, such as Billing › Refunds › Partial refunds. A question finds the closest sections. So:
- One topic per section, under a heading that names it. "Partial refunds" finds better than "More details".
- Put the answer near its heading. A section that starts with background and gets to the point in its fourth paragraph matches worse.
- Say things in the words your users use. If they say "cancel my order", write that, not only "order termination".
- Keep each document to one subject. Two small documents beat one that covers everything.
Who can read it
Documents belong to the app, and everyone using the app's assistant can be answered from them. They are not separated per user, or per tenant of yours. Only upload documents every user of that app may read.