From 71e6a646c50dbc740ed48d9f4c253b797a325829 Mon Sep 17 00:00:00 2001 From: Quantstruct Bot Date: Wed, 27 Nov 2024 12:14:26 -0800 Subject: [PATCH] Update knowledge base tutorial --- fern/knowledgebase.mdx | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/fern/knowledgebase.mdx b/fern/knowledgebase.mdx index adc06aa..90f6cc4 100644 --- a/fern/knowledgebase.mdx +++ b/fern/knowledgebase.mdx @@ -8,13 +8,13 @@ slug: knowledgebase ## **What is Vapi's Knowledge Base?** -Our Knowledge Base is a collection of custom documents that contain information on specific topics or domains. By integrating a Knowledge Base into your voice AI assistant, you can enable it to provide more accurate and informative responses to user queries. This is currently available in Vapi via the API, and will be on the dashboard soon. +Our Knowledge Base is a collection of custom files that contain information on specific topics or domains. By integrating a Knowledge Base into your voice AI assistant, you can enable it to provide more accurate and informative responses to user queries. This is currently available in Vapi via the API, and will be on the dashboard soon. ### **Why Use a Knowledge Base?** Using a Knowledge Base with your voice AI assistant offers several benefits: -- **Improved accuracy**: By integrating custom documents into your assistant, you can ensure that it provides accurate and up-to-date information to users. +- **Improved accuracy**: By integrating custom files into your assistant, you can ensure that it provides accurate and up-to-date information to users. - **Enhanced capabilities**: A Knowledge Base enables your assistant to answer complex queries and provide detailed responses to user inquiries. - **Customization**: With a Knowledge Base, you can tailor your assistant's responses to specific domains or topics, making it more effective and informative. @@ -22,18 +22,18 @@ Using a Knowledge Base with your voice AI assistant offers several benefits: To create a Knowledge Base, follow these steps: -### **Step 1: Upload Your Documents** +### **Step 1: Upload Your Files** -Navigate to Overview > Documents and upload your custom documents in Markdown, PDF, plain text, or Microsoft Word (.doc and .docx) format to Vapi's Knowledge Base. +Navigate to Platform > Files and upload your custom files in Markdown, PDF, plain text, or Microsoft Word (.doc and .docx) format to Vapi's Knowledge Base. - + Adding documents to your Knowledge Base -Alternatively you can upload your documents via the API. +Alternatively you can upload your files via the API. ```bash curl --location 'https://api.vapi.ai/file' \ @@ -88,9 +88,9 @@ curl --location --request PATCH 'https://api.vapi.ai/assistant/' \ ## **Best Practices for Creating Effective Knowledge Bases** -- **Organize Your documents**: Organize your documents by topic or category to ensure that your assistant can quickly retrieve relevant information. -- **Use Clear and concise language**: Use clear and concise language in your documents to ensure that your assistant can accurately understand and respond to user queries. -- **Keep your documents up-to-date**: Regularly update your documents to ensure that your assistant provides the most accurate and up-to-date information. +- **Organize Your files**: Organize your files by topic or category to ensure that your assistant can quickly retrieve relevant information. +- **Use Clear and concise language**: Use clear and concise language in your files to ensure that your assistant can accurately understand and respond to user queries. +- **Keep your files up-to-date**: Regularly update your files to ensure that your assistant provides the most accurate and up-to-date information. For more information on creating effective Knowledge Bases, check out our