update kb docs

VapiAI · Dec 1, 2024 · 3a017c9 · 3a017c9
1 parent bc7467d
commit 3a017c9
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 29 deletions.
diff --git a/fern/community/knowledgebase.mdx b/fern/community/knowledgebase.mdx
@@ -8,32 +8,32 @@ 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.
+A 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.
 
 ## **How to Create a Knowledge Base**
 
 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.
 
-<Frame caption="Adding documents to your Knowledge Base">
+<Frame caption="Adding files to your Knowledge Base">
   <img
-    src="https://cdn.hashnode.com/res/hashnode/image/upload/v1715628063841/rSrWDQ6YM.png"
-    alt="Adding documents to your Knowledge Base"
+    src="./static/images/knowledge-base/files.png"
+    alt="Adding files to your Knowledge Base"
   />
 </Frame>
 
-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' \
@@ -52,11 +52,11 @@ curl --location 'https://api.vapi.ai/knowledge-base' \
 --data '{
     "name": "knowledge-base-test",
     "provider": "trieve",
-    "searchPlan": {
+    "vectorStoreSearchPlan": {
         "scoreThreshold": 0.1,
         "searchType": "hybrid"
     },
-    "chunkPlan": {
+    "vectorStoreCreatePlan": {
         "fileIds": ["<FILE_ID>"]
     }
 }'
@@ -88,9 +88,9 @@ curl --location --request PATCH 'https://api.vapi.ai/assistant/<ASSISTANT_ID>' \
 
 ## **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.
 
 <Tip>
   For more information on creating effective Knowledge Bases, check out our

diff --git a/fern/customization/knowledgebase.mdx b/fern/customization/knowledgebase.mdx
@@ -8,32 +8,32 @@ 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.
+A 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.
 
 ## **How to Create a Knowledge Base**
 
 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.
 
-<Frame caption="Adding documents to your Knowledge Base">
+<Frame caption="Adding files to your Knowledge Base">
   <img
-    src="https://cdn.hashnode.com/res/hashnode/image/upload/v1715628063841/rSrWDQ6YM.png"
-    alt="Adding documents to your Knowledge Base"
+    src="./static/images/knowledge-base/files.png"
+    alt="Adding files to your Knowledge Base"
   />
 </Frame>
 
-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' \
@@ -52,11 +52,11 @@ curl --location 'https://api.vapi.ai/knowledge-base' \
 --data '{
     "name": "knowledge-base-test",
     "provider": "trieve",
-    "searchPlan": {
+    "vectorStoreSearchPlan": {
         "scoreThreshold": 0.1,
         "searchType": "hybrid"
     },
-    "chunkPlan": {
+    "vectorStoreCreatePlan": {
         "fileIds": ["<FILE_ID>"]
     }
 }'
@@ -88,9 +88,9 @@ curl --location --request PATCH 'https://api.vapi.ai/assistant/<ASSISTANT_ID>' \
 
 ## **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.
 
 <Tip>
   For more information on creating effective Knowledge Bases, check out our

diff --git a/fern/knowledgebase.mdx b/fern/knowledgebase.mdx
@@ -8,7 +8,7 @@ slug: knowledgebase
 
 ## **What is Vapi's Knowledge Base?**
 
-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.
+A 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?**
 
@@ -52,11 +52,11 @@ curl --location 'https://api.vapi.ai/knowledge-base' \
 --data '{
     "name": "knowledge-base-test",
     "provider": "trieve",
-    "searchPlan": {
+    "vectorStoreSearchPlan": {
         "scoreThreshold": 0.1,
         "searchType": "hybrid"
     },
-    "chunkPlan": {
+    "vectorStoreCreatePlan": {
         "fileIds": ["<FILE_ID>"]
     }
 }'