Skip to content

Commit ad9f307

Browse files
authored
VAP-2295 [DOCS] Update KB & Bring your own trieve docs for new schema (#153)
* docs: kb v2 * img path
1 parent 2151663 commit ad9f307

File tree

4 files changed

+62
-35
lines changed

4 files changed

+62
-35
lines changed

fern/community/knowledgebase.mdx

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Navigate to Platform > Files and upload your custom files in Markdown, PDF, plai
2828

2929
<Frame caption="Adding files to your Knowledge Base">
3030
<img
31-
src="../static/images/knowledge-base/files.png"
31+
src="/static/images/knowledge-base/files.png"
3232
alt="Adding files to your Knowledge Base"
3333
/>
3434
</Frame>
@@ -46,20 +46,28 @@ curl --location 'https://api.vapi.ai/file' \
4646
Use the ID of the uploaded file to create a Knowledge Base. Currently we support [trieve](https://trieve.ai) as a provider.
4747

4848
```bash
49-
curl --location 'https://api.vapi.ai/knowledge-base' \
49+
curl --location 'http://localhost:3001/knowledge-base' \
5050
--header 'Content-Type: text/plain' \
51-
--header 'Authorization: Bearer <YOUR_API_KEY>' \
51+
--header 'Authorization: Bearer 4beb7e10-f4be-4588-be65-712235f07f68' \
5252
--data '{
53-
"name": "knowledge-base-test",
53+
"name": "v2",
5454
"provider": "trieve",
55-
"vectorStoreSearchPlan": {
56-
"scoreThreshold": 0.1,
57-
"searchType": "hybrid"
55+
"searchPlan": {
56+
"scoreThreshold": 0.2,
57+
"searchType": "semantic"
5858
},
59-
"vectorStoreCreatePlan": {
60-
"fileIds": ["<FILE_ID>"]
59+
"createPlan": {
60+
"type": "create",
61+
"chunkPlans": [
62+
{
63+
"fileIds": ["<FILE_ID_1>", "<FILE_ID_2>"],
64+
"websites": ["<WEBSITE_1>", "<WEBSITE_2>"],
65+
"targetSplitsPerChunk": 50,
66+
"rebalanceChunks": true
67+
}
68+
]
6169
}
62-
}'
70+
}''
6371
```
6472
6573
### **Step 3: Create an Assistant**

fern/customization/bring-your-own-vectors/trieve.mdx

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,21 +34,24 @@ You might want to use both Trieve's native interface and Vapi simultaneously:
3434
2. **Create a New Knowledge Base**
3535

3636
- When setting up a new knowledge base, provide:
37-
- Your Trieve datasetId as the vectorStoreProviderId
38-
- Appropriate search configuration parameters
39-
- Vapi will then connect to your existing Trieve vectors
37+
- Your Trieve datasetId as the providerId.
38+
- Appropriate search configuration parameters.
39+
- Vapi will then automatically use your Trieve dataset as the knowledge base.
4040

4141
Example configuration:
4242

4343
```json
4444
{
45-
"name": "byok-test",
45+
"name": "trieve-byok",
4646
"provider": "trieve",
47-
"vectorStoreSearchPlan": {
47+
"searchPlan": {
4848
"scoreThreshold": 0.2,
4949
"searchType": "semantic"
5050
},
51-
"vectorStoreProviderId": "<Your datasetId from Trieve>"
51+
"createPlan": {
52+
"type": "import",
53+
"providerId": "<Your datasetId from Trieve>"
54+
}
5255
}
5356
```
5457

fern/customization/knowledgebase.mdx

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Navigate to Platform > Files and upload your custom files in Markdown, PDF, plai
2828

2929
<Frame caption="Adding files to your Knowledge Base">
3030
<img
31-
src="../static/images/knowledge-base/files.png"
31+
src="./static/images/knowledge-base/files.png"
3232
alt="Adding files to your Knowledge Base"
3333
/>
3434
</Frame>
@@ -46,20 +46,28 @@ curl --location 'https://api.vapi.ai/file' \
4646
Use the ID of the uploaded file to create a Knowledge Base. Currently we support [trieve](https://trieve.ai) as a provider.
4747

4848
```bash
49-
curl --location 'https://api.vapi.ai/knowledge-base' \
49+
curl --location 'http://localhost:3001/knowledge-base' \
5050
--header 'Content-Type: text/plain' \
51-
--header 'Authorization: Bearer <YOUR_API_KEY>' \
51+
--header 'Authorization: Bearer 4beb7e10-f4be-4588-be65-712235f07f68' \
5252
--data '{
53-
"name": "knowledge-base-test",
53+
"name": "v2",
5454
"provider": "trieve",
55-
"vectorStoreSearchPlan": {
56-
"scoreThreshold": 0.1,
57-
"searchType": "hybrid"
55+
"searchPlan": {
56+
"scoreThreshold": 0.2,
57+
"searchType": "semantic"
5858
},
59-
"vectorStoreCreatePlan": {
60-
"fileIds": ["<FILE_ID>"]
59+
"createPlan": {
60+
"type": "create",
61+
"chunkPlans": [
62+
{
63+
"fileIds": ["<FILE_ID_1>", "<FILE_ID_2>"],
64+
"websites": ["<WEBSITE_1>", "<WEBSITE_2>"],
65+
"targetSplitsPerChunk": 50,
66+
"rebalanceChunks": true
67+
}
68+
]
6169
}
62-
}'
70+
}''
6371
```
6472
6573
### **Step 3: Create an Assistant**

fern/knowledgebase.mdx

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,20 +46,28 @@ curl --location 'https://api.vapi.ai/file' \
4646
Use the ID of the uploaded file to create a Knowledge Base. Currently we support [trieve](https://trieve.ai) as a provider.
4747

4848
```bash
49-
curl --location 'https://api.vapi.ai/knowledge-base' \
49+
curl --location 'http://localhost:3001/knowledge-base' \
5050
--header 'Content-Type: text/plain' \
51-
--header 'Authorization: Bearer <YOUR_API_KEY>' \
51+
--header 'Authorization: Bearer 4beb7e10-f4be-4588-be65-712235f07f68' \
5252
--data '{
53-
"name": "knowledge-base-test",
53+
"name": "v2",
5454
"provider": "trieve",
55-
"vectorStoreSearchPlan": {
56-
"scoreThreshold": 0.1,
57-
"searchType": "hybrid"
55+
"searchPlan": {
56+
"scoreThreshold": 0.2,
57+
"searchType": "semantic"
5858
},
59-
"vectorStoreCreatePlan": {
60-
"fileIds": ["<FILE_ID>"]
59+
"createPlan": {
60+
"type": "create",
61+
"chunkPlans": [
62+
{
63+
"fileIds": ["<FILE_ID_1>", "<FILE_ID_2>"],
64+
"websites": ["<WEBSITE_1>", "<WEBSITE_2>"],
65+
"targetSplitsPerChunk": 50,
66+
"rebalanceChunks": true
67+
}
68+
]
6169
}
62-
}'
70+
}''
6371
```
6472
6573
### **Step 3: Create an Assistant**

0 commit comments

Comments
 (0)