🛠️Quick Bot Setup
Welcome to the quick start guide for creating a knowledge bot. This guide is designed to help builders and admins within your organization set up a bot for your team members within a few minutes.
Last updated
Welcome to the quick start guide for creating a knowledge bot. This guide is designed to help builders and admins within your organization set up a bot for your team members within a few minutes.
Last updated
Go to your Workshop dashboard. Choose whether you want to build a Nexus or a Retriever. Then Click "Create +".
Here you will configure the bots you want to share with others in your organization.
Begin by giving your bot a unique and memorable name.
This is how users will identify your bot.
Define your bot's core mission, writing style, and any context it should be aware of.
Think of it like a brief job description that the bot will always consider in its responses.
Use the default template or write your own instructions to customize the bot to fit your use case.
For most business use cases, a simple and more generic prompt can perform better than long and complex descriptions.
This is the initial instruction prompt we recommend:
Your task is to provide precise and relevant information. Your communication should be professional yet easy to understand. Your responses must be thorough and detailed, using professional formatting. Clarify Ambiguous or General Inquiries: Ask specific questions to gather additional context. If a query can have multiple interpretations or answers, ask the user for clarification. Inform Users About the Scope of Answers: Let users know that answers may not always be exhaustive, indicating that further research and verification might be necessary. Encourage users to consult the original documents in the reference if they wish to look up more information themselves, or they can ask follow-up questions for further assistance. Methodical Approach: Guide users through the answer to their question methodically. Clearly state the steps to be taken and, where possible, refer to specific sections, figures, and tables in the guidelines and forms. Your ultimate goal is to enhance the expertise and efficiency of users, enabling them to perform their tasks more effectively through quicker access to relevant information.
If you want the Knowledge Bot to behave in a more specific way and limit the scope of its tasks, we recommend to include more context in the instruction prompt, expanding on the default template:
Role/Context: Provide the bot with your unique business context and needs.
e.g. "You are assisting the tech staff with internal IT support."
Task: Describe the bot's main functionality in a concise way.
e.g. "Provide factual responses and step-by-step guides using the provided knowledge base."
For most use cases where the bot's responses are based on a typical knowledge base, the default prompt does not need to be changed.
Tonality: Tailor the writing style to your use case and user group.
e.g. "You write in a professional, yet easy to understand tone. Your answers are very precise and brief. You use professional formatting, like headlines, sub-headlines, bold, italic, underline, or numbering."
Note: When the bot's main purpose it to create content in a certain tone, it is advisable to upload branding guidelines and past content pieces into a knowledge base or into the context as references to teach the bot the required writing style.
e.g. "You write in the same style and tonality as the documents provided by the user."
Guidelines: It is recommended to set guidelines that minimizes the likelihood of hallucinations.
e.g. "Do not make up an answer when you cannot offer a factual answer based on your knowledge base. Tell the user what information you are missing to respond."
To train the bot on your business context and use case, you'll need to equip it with relevant documents.
Select an existing database or click on 'Create New Database' to upload new documents.
Data quality: Only upload documents that contain accurate, up-to-date, and relevant information for the intended use case. Minimizing unnecessary information ensures higher answer quality.
Data format: Ensure that all uploaded documents are readable and formatted properly (PDF, DOCX, TXT, JSON, CSV). Note: Our system currently does not support scanned PDFs.
Image retrieval: Ensure images in documents are clear and correctly positioned within the text. Remove unnecessary logos and visuals from footers/headings to improve image retrieval success. Images must be saved as PNG or JPEG format within PDF documents for image retrieval to work.
Proper use case: Clearly define a use case that utilizes the bot's ability to retrieve relevant information from vast amounts of unstructured data and synthesizing it within your unique business context. Explore typical use cases here.
Don'ts
Sensitive or Personal Data: Do not upload sensitive or personal data without the consent of the respective parties.
Unauthorized Data and Content: Do not upload data or content that your company does not own or that is not publicly available.
Complex Mathematical Calculations: Avoid relying on the bot for complex mathematical calculations. If numerical data need to be retrieved, ensure the results are documented.
Bulk Uploads: Avoid uploading more than 200 documents in a single batch.
File Size Limit: Do not upload documents larger than 100 MB each. Compress larger files if possible.
The final step in the basic bot setup is to turn the sharing preference to 'Public Mode' by enabling the toggle and pressing 'Save'.
People in your organization can now use the Knowledge Bot by adding it to their user dashboard.
