|
| 1 | +--- |
| 2 | +title: Bring your own chunks/vectors from Trieve |
| 3 | +subtitle: Use existing chunks/vectors from [Trieve](https://trieve.ai) |
| 4 | +slug: customization/bring-your-own-vectors/trieve |
| 5 | +--- |
| 6 | + |
| 7 | +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. |
| 8 | + |
| 9 | +## Use Cases |
| 10 | + |
| 11 | +### Existing Knowledge Base Migration |
| 12 | + |
| 13 | +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: |
| 14 | + |
| 15 | +- Large document collections that took significant time to process |
| 16 | +- Carefully curated and cleaned datasets |
| 17 | +- Custom-chunked documents with specific segmentation rules |
| 18 | + |
| 19 | +### Parallel Systems |
| 20 | + |
| 21 | +You might want to use both Trieve's native interface and Vapi simultaneously: |
| 22 | + |
| 23 | +- Use Trieve's UI for content management and organization |
| 24 | +- Leverage Vapi's chat interface and API capabilities |
| 25 | +- Maintain consistency across both platforms |
| 26 | + |
| 27 | +## Integration Steps |
| 28 | + |
| 29 | +1. **Configure Trieve Credentials** |
| 30 | + |
| 31 | + - Navigate to the credentials page in your [Vapi dashboard](https://dashboard.vapi.ai/keys) |
| 32 | + - Add your Trieve API key for authentication from [Trieve](https://dashboard.trieve.ai/org/keys) |
| 33 | + |
| 34 | +2. **Create a New Knowledge Base** |
| 35 | + |
| 36 | + - 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 |
| 40 | + |
| 41 | + Example configuration: |
| 42 | + |
| 43 | + ```json |
| 44 | + { |
| 45 | + "name": "byok-test", |
| 46 | + "provider": "trieve", |
| 47 | + "vectorStoreSearchPlan": { |
| 48 | + "scoreThreshold": 0.2, |
| 49 | + "searchType": "semantic" |
| 50 | + }, |
| 51 | + "vectorStoreProviderId": "<Your datasetId from Trieve>" |
| 52 | + } |
| 53 | + ``` |
| 54 | + |
| 55 | +## Best Practices |
| 56 | + |
| 57 | +- Ensure your Trieve API key has appropriate permissions |
| 58 | +- Keep track of which datasetIds correspond to which knowledge bases |
| 59 | +- Monitor vector synchronization to ensure consistency |
0 commit comments