Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions fern/customization/bring-your-own-vectors/trieve.mdx
Original file line number Diff line number Diff line change
@@ -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
8 changes: 4 additions & 4 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -396,8 +398,6 @@ navigation:
- tab: changelog

redirects:
- source: /customization/knowledgebase
destination: /knowledgebase
- source: /developer-documentation
destination: /introduction
- source: /documentation/general/changelog
Expand Down
Loading