diff --git a/fern/docs.yml b/fern/docs.yml index b94985752..881397db3 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -98,8 +98,6 @@ navigation: path: quickstart.mdx - page: Orchestration Models path: how-vapi-works.mdx - - page: Knowledge Base - path: knowledgebase.mdx - section: Pricing contents: - page: Overview @@ -192,6 +190,12 @@ navigation: path: blocks/steps.mdx - page: Block Types path: blocks/block-types.mdx + - section: Knowledge Base + contents: + - page: Introduction + path: knowledge-base/knowledge-base.mdx + - page: Integrating with Trieve + path: knowledge-base/integrating-with-trieve.mdx - section: Server URL contents: - page: Introduction @@ -266,10 +270,6 @@ navigation: path: customization/custom-voices/tavus.mdx - page: Custom Keywords path: customization/custom-keywords.mdx - - section: Bring your own vectors - contents: - - page: Trieve - path: customization/bring-your-own-vectors/trieve.mdx - page: Multilingual path: customization/multilingual.mdx - page: JWT Authentication @@ -568,3 +568,7 @@ redirects: destination: "/enterprise/plans" - source: "/tools-calling" destination: "/assistants/custom-tools" + - source: "/knowledgebase" + destination: "/knowledge-base" + - source: "/customization/bring-your-own-vectors/trieve" + destination: "/knowledge-base/integrating-with-trieve" diff --git a/fern/customization/bring-your-own-vectors/trieve.mdx b/fern/knowledge-base/integrating-with-trieve.mdx similarity index 94% rename from fern/customization/bring-your-own-vectors/trieve.mdx rename to fern/knowledge-base/integrating-with-trieve.mdx index bf2bfa6e1..86a76c750 100644 --- a/fern/customization/bring-your-own-vectors/trieve.mdx +++ b/fern/knowledge-base/integrating-with-trieve.mdx @@ -1,7 +1,7 @@ --- title: Bring your own chunks/vectors from Trieve subtitle: Using Trieve for improved RAG with Vapi -slug: customization/bring-your-own-vectors/trieve +slug: knowledge-base/integrating-with-trieve --- # Using Trieve with Vapi @@ -64,7 +64,7 @@ The BYOK approach offers more flexibility and control over your datasets. You ca 1. Create an account at [Trieve](https://trieve.ai) 2. Create a new dataset using Trieve's dashboard -![Create dataset in Trieve](../../static/images/knowledge-base/create-dataset.png) +![Create dataset in Trieve](../static/images/knowledge-base/create-dataset.png) When creating your dataset in Trieve, selecting the right embedding model is crucial for optimizing performance and accuracy. Here are some of the available options: @@ -92,17 +92,17 @@ When creating your dataset in Trieve, selecting the right embedding model is cru Upload documents directly through Trieve's interface: -![Upload files in Trieve](../../static/images/knowledge-base/upload-files.png) +![Upload files in Trieve](../static/images/knowledge-base/upload-files.png) When uploading files, you can configure advanced chunking options: -![Upload files advanced options in Trieve](../../static/images/knowledge-base/upload-files-advanced.png) +![Upload files advanced options in Trieve](../static/images/knowledge-base/upload-files-advanced.png) #### Edit Individual Chunks After uploading documents, you can edit individual chunks to refine their content: -![Edit chunk interface in Trieve](../../static/images/knowledge-base/edit-chunk.png) +![Edit chunk interface in Trieve](../static/images/knowledge-base/edit-chunk.png) ##### Editing Options @@ -219,7 +219,7 @@ After uploading documents, you can edit individual chunks to refine their conten Trieve offers powerful website crawling capabilities with extensive configuration options: -![Website crawling in Trieve](../../static/images/knowledge-base/crawl.png) +![Website crawling in Trieve](../static/images/knowledge-base/crawl.png) ##### Crawl Configuration Options @@ -287,13 +287,13 @@ Use Trieve's search playground to: - Visualize vector embeddings - Fine-tune relevance scores -![Search playground in Trieve](../../static/images/knowledge-base/search-playground.png) +![Search playground in Trieve](../static/images/knowledge-base/search-playground.png) ### Step 3: Import to Vapi 1. Create your Trieve API key from [Trieve's dashboard](https://dashboard.trieve.ai/org/keys) 2. Add your Trieve API key to Vapi [Provider Credentials](https://dashboard.vapi.ai/keys) - ![Add Trieve API key in Vapi](../../static/images/knowledge-base/trieve-credential.png) + ![Add Trieve API key in Vapi](../static/images/knowledge-base/trieve-credential.png) 3. Once your dataset is optimized in Trieve, import it to Vapi: ```json diff --git a/fern/customization/knowledgebase.mdx b/fern/knowledge-base/knowledge-base.mdx similarity index 98% rename from fern/customization/knowledgebase.mdx rename to fern/knowledge-base/knowledge-base.mdx index d1b931113..5867b1bea 100644 --- a/fern/customization/knowledgebase.mdx +++ b/fern/knowledge-base/knowledge-base.mdx @@ -3,7 +3,7 @@ title: Creating Custom Knowledge Bases for Your Voice AI Assistants subtitle: >- Learn how to create and integrate custom knowledge bases into your voice AI assistants. -slug: knowledgebase +slug: knowledge-base --- ## **What is Vapi's Knowledge Base?** @@ -28,7 +28,7 @@ Navigate to Platform > Files and upload your custom files in Markdown, PDF, plai Adding files to your Knowledge Base