From 31e39bf2d67a21e750c82b7066602cfc85c5d42e Mon Sep 17 00:00:00 2001
From: rumbleFTW <007rajdeepghosh@gmail.com>
Date: Sat, 4 Jan 2025 06:33:27 +0530
Subject: [PATCH] docs: trieve byok

---
 .../bring-your-own-vectors/trieve.mdx         | 59 +++++++++++++++++++
 fern/docs.yml                                 |  8 +--
 2 files changed, 63 insertions(+), 4 deletions(-)
 create mode 100644 fern/customization/bring-your-own-vectors/trieve.mdx

diff --git a/fern/customization/bring-your-own-vectors/trieve.mdx b/fern/customization/bring-your-own-vectors/trieve.mdx
new file mode 100644
index 000000000..9987d265c
--- /dev/null
+++ b/fern/customization/bring-your-own-vectors/trieve.mdx
@@ -0,0 +1,59 @@
+---
+title: Bring your own chunks/vectors from Trieve
+subtitle: Use existing chunks/vectors from [Trieve](https://trieve.ai)
+slug: customization/bring-your-own-vectors/trieve
+---
+
+Vapi supports Trieve as a knowledgebase provider, allowing you to leverage your existing document embeddings and chunks. While Vapi maintains its own storage of documents and vectors, you can seamlessly integrate with your Trieve datasets.
+
+## Use Cases
+
+### Existing Knowledge Base Migration
+
+If you've already invested time in building and organizing your knowledge base in Trieve, you can continue using those vectors without having to reprocess your documents. This is particularly useful for:
+
+- Large document collections that took significant time to process
+- Carefully curated and cleaned datasets
+- Custom-chunked documents with specific segmentation rules
+
+### Parallel Systems
+
+You might want to use both Trieve's native interface and Vapi simultaneously:
+
+- Use Trieve's UI for content management and organization
+- Leverage Vapi's chat interface and API capabilities
+- Maintain consistency across both platforms
+
+## Integration Steps
+
+1. **Configure Trieve Credentials**
+
+   - Navigate to the credentials page in your [Vapi dashboard](https://dashboard.vapi.ai/keys)
+   - Add your Trieve API key for authentication from [Trieve](https://dashboard.trieve.ai/org/keys)
+
+2. **Create a New Knowledge Base**
+
+   - When setting up a new knowledge base, provide:
+     - Your Trieve datasetId as the vectorStoreProviderId
+     - Appropriate search configuration parameters
+   - Vapi will then connect to your existing Trieve vectors
+
+   Example configuration:
+
+   ```json
+   {
+     "name": "byok-test",
+     "provider": "trieve",
+     "vectorStoreSearchPlan": {
+       "scoreThreshold": 0.2,
+       "searchType": "semantic"
+     },
+     "vectorStoreProviderId": "<Your datasetId from Trieve>"
+   }
+   ```
+
+## Best Practices
+
+- Ensure your Trieve API key has appropriate permissions
+- Keep track of which datasetIds correspond to which knowledge bases
+- Monitor vector synchronization to ensure consistency
diff --git a/fern/docs.yml b/fern/docs.yml
index 376033881..adba23da5 100644
--- a/fern/docs.yml
+++ b/fern/docs.yml
@@ -178,8 +178,10 @@ navigation:
                 path: customization/custom-voices/tavus.mdx
           - page: Custom Keywords
             path: customization/custom-keywords.mdx
-          - page: Knowledge Base
-            path: customization/knowledgebase.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
@@ -396,8 +398,6 @@ navigation:
   - tab: changelog
 
 redirects:
-  - source: /customization/knowledgebase
-    destination: /knowledgebase
   - source: /developer-documentation
     destination: /introduction
   - source: /documentation/general/changelog