Skip to content

Commit 2713ecb

Browse files
rumbleFTWrumbleFTW
authored
update kb docs (#76)
1 parent dc940ba commit 2713ecb

File tree

3 files changed

+29
-29
lines changed

3 files changed

+29
-29
lines changed

‎fern/community/knowledgebase.mdx‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,32 +8,32 @@ slug: knowledgebase
88

99
## **What is Vapi's Knowledge Base?**
1010

11-
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.
11+
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.
1212

1313
### **Why Use a Knowledge Base?**
1414

1515
Using a Knowledge Base with your voice AI assistant offers several benefits:
1616

17-
- **Improved accuracy**: By integrating custom documents into your assistant, you can ensure that it provides accurate and up-to-date information to users.
17+
- **Improved accuracy**: By integrating custom files into your assistant, you can ensure that it provides accurate and up-to-date information to users.
1818
- **Enhanced capabilities**: A Knowledge Base enables your assistant to answer complex queries and provide detailed responses to user inquiries.
1919
- **Customization**: With a Knowledge Base, you can tailor your assistant's responses to specific domains or topics, making it more effective and informative.
2020

2121
## **How to Create a Knowledge Base**
2222

2323
To create a Knowledge Base, follow these steps:
2424

25-
### **Step 1: Upload Your Documents**
25+
### **Step 1: Upload Your Files**
2626

27-
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.
27+
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.
2828

29-
<Frame caption="Adding documents to your Knowledge Base">
29+
<Frame caption="Adding files to your Knowledge Base">
3030
<img
31-
src="https://cdn.hashnode.com/res/hashnode/image/upload/v1715628063841/rSrWDQ6YM.png"
32-
alt="Adding documents to your Knowledge Base"
31+
src="./static/images/knowledge-base/files.png"
32+
alt="Adding files to your Knowledge Base"
3333
/>
3434
</Frame>
3535

36-
Alternatively you can upload your documents via the API.
36+
Alternatively you can upload your files via the API.
3737

3838
```bash
3939
curl --location 'https://api.vapi.ai/file' \
@@ -52,11 +52,11 @@ curl --location 'https://api.vapi.ai/knowledge-base' \
5252
--data '{
5353
"name": "knowledge-base-test",
5454
"provider": "trieve",
55-
"searchPlan": {
55+
"vectorStoreSearchPlan": {
5656
"scoreThreshold": 0.1,
5757
"searchType": "hybrid"
5858
},
59-
"chunkPlan": {
59+
"vectorStoreCreatePlan": {
6060
"fileIds": ["<FILE_ID>"]
6161
}
6262
}'
@@ -88,9 +88,9 @@ curl --location --request PATCH 'https://api.vapi.ai/assistant/<ASSISTANT_ID>' \
8888

8989
## **Best Practices for Creating Effective Knowledge Bases**
9090

91-
- **Organize Your documents**: Organize your documents by topic or category to ensure that your assistant can quickly retrieve relevant information.
92-
- **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.
93-
- **Keep your documents up-to-date**: Regularly update your documents to ensure that your assistant provides the most accurate and up-to-date information.
91+
- **Organize Your files**: Organize your files by topic or category to ensure that your assistant can quickly retrieve relevant information.
92+
- **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.
93+
- **Keep your files up-to-date**: Regularly update your files to ensure that your assistant provides the most accurate and up-to-date information.
9494

9595
<Tip>
9696
For more information on creating effective Knowledge Bases, check out our

‎fern/customization/knowledgebase.mdx‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,32 +8,32 @@ slug: knowledgebase
88

99
## **What is Vapi's Knowledge Base?**
1010

11-
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.
11+
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.
1212

1313
### **Why Use a Knowledge Base?**
1414

1515
Using a Knowledge Base with your voice AI assistant offers several benefits:
1616

17-
- **Improved accuracy**: By integrating custom documents into your assistant, you can ensure that it provides accurate and up-to-date information to users.
17+
- **Improved accuracy**: By integrating custom files into your assistant, you can ensure that it provides accurate and up-to-date information to users.
1818
- **Enhanced capabilities**: A Knowledge Base enables your assistant to answer complex queries and provide detailed responses to user inquiries.
1919
- **Customization**: With a Knowledge Base, you can tailor your assistant's responses to specific domains or topics, making it more effective and informative.
2020

2121
## **How to Create a Knowledge Base**
2222

2323
To create a Knowledge Base, follow these steps:
2424

25-
### **Step 1: Upload Your Documents**
25+
### **Step 1: Upload Your Files**
2626

27-
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.
27+
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.
2828

29-
<Frame caption="Adding documents to your Knowledge Base">
29+
<Frame caption="Adding files to your Knowledge Base">
3030
<img
31-
src="https://cdn.hashnode.com/res/hashnode/image/upload/v1715628063841/rSrWDQ6YM.png"
32-
alt="Adding documents to your Knowledge Base"
31+
src="./static/images/knowledge-base/files.png"
32+
alt="Adding files to your Knowledge Base"
3333
/>
3434
</Frame>
3535

36-
Alternatively you can upload your documents via the API.
36+
Alternatively you can upload your files via the API.
3737

3838
```bash
3939
curl --location 'https://api.vapi.ai/file' \
@@ -52,11 +52,11 @@ curl --location 'https://api.vapi.ai/knowledge-base' \
5252
--data '{
5353
"name": "knowledge-base-test",
5454
"provider": "trieve",
55-
"searchPlan": {
55+
"vectorStoreSearchPlan": {
5656
"scoreThreshold": 0.1,
5757
"searchType": "hybrid"
5858
},
59-
"chunkPlan": {
59+
"vectorStoreCreatePlan": {
6060
"fileIds": ["<FILE_ID>"]
6161
}
6262
}'
@@ -88,9 +88,9 @@ curl --location --request PATCH 'https://api.vapi.ai/assistant/<ASSISTANT_ID>' \
8888

8989
## **Best Practices for Creating Effective Knowledge Bases**
9090

91-
- **Organize Your documents**: Organize your documents by topic or category to ensure that your assistant can quickly retrieve relevant information.
92-
- **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.
93-
- **Keep your documents up-to-date**: Regularly update your documents to ensure that your assistant provides the most accurate and up-to-date information.
91+
- **Organize Your files**: Organize your files by topic or category to ensure that your assistant can quickly retrieve relevant information.
92+
- **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.
93+
- **Keep your files up-to-date**: Regularly update your files to ensure that your assistant provides the most accurate and up-to-date information.
9494

9595
<Tip>
9696
For more information on creating effective Knowledge Bases, check out our

‎fern/knowledgebase.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ slug: knowledgebase
88

99
## **What is Vapi's Knowledge Base?**
1010

11-
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.
11+
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.
1212

1313
### **Why Use a Knowledge Base?**
1414

@@ -52,11 +52,11 @@ curl --location 'https://api.vapi.ai/knowledge-base' \
5252
--data '{
5353
"name": "knowledge-base-test",
5454
"provider": "trieve",
55-
"searchPlan": {
55+
"vectorStoreSearchPlan": {
5656
"scoreThreshold": 0.1,
5757
"searchType": "hybrid"
5858
},
59-
"chunkPlan": {
59+
"vectorStoreCreatePlan": {
6060
"fileIds": ["<FILE_ID>"]
6161
}
6262
}'

0 commit comments

Comments
 (0)