diff --git a/fern/community/knowledgebase.mdx b/fern/community/knowledgebase.mdx index 35a80c02b..9dbb855fa 100644 --- a/fern/community/knowledgebase.mdx +++ b/fern/community/knowledgebase.mdx @@ -28,7 +28,7 @@ Navigate to Platform > Files and upload your custom files in Markdown, PDF, plai Adding files to your Knowledge Base @@ -46,20 +46,28 @@ curl --location 'https://api.vapi.ai/file' \ Use the ID of the uploaded file to create a Knowledge Base. Currently we support [trieve](https://trieve.ai) as a provider. ```bash -curl --location 'https://api.vapi.ai/knowledge-base' \ +curl --location 'http://localhost:3001/knowledge-base' \ --header 'Content-Type: text/plain' \ ---header 'Authorization: Bearer ' \ +--header 'Authorization: Bearer 4beb7e10-f4be-4588-be65-712235f07f68' \ --data '{ - "name": "knowledge-base-test", + "name": "v2", "provider": "trieve", - "vectorStoreSearchPlan": { - "scoreThreshold": 0.1, - "searchType": "hybrid" + "searchPlan": { + "scoreThreshold": 0.2, + "searchType": "semantic" }, - "vectorStoreCreatePlan": { - "fileIds": [""] + "createPlan": { + "type": "create", + "chunkPlans": [ + { + "fileIds": ["", ""], + "websites": ["", ""], + "targetSplitsPerChunk": 50, + "rebalanceChunks": true + } + ] } -}' +}'' ``` ### **Step 3: Create an Assistant** diff --git a/fern/customization/bring-your-own-vectors/trieve.mdx b/fern/customization/bring-your-own-vectors/trieve.mdx index 9987d265c..34bec1faf 100644 --- a/fern/customization/bring-your-own-vectors/trieve.mdx +++ b/fern/customization/bring-your-own-vectors/trieve.mdx @@ -34,21 +34,24 @@ You might want to use both Trieve's native interface and Vapi simultaneously: 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 + - Your Trieve datasetId as the providerId. + - Appropriate search configuration parameters. + - Vapi will then automatically use your Trieve dataset as the knowledge base. Example configuration: ```json { - "name": "byok-test", + "name": "trieve-byok", "provider": "trieve", - "vectorStoreSearchPlan": { + "searchPlan": { "scoreThreshold": 0.2, "searchType": "semantic" }, - "vectorStoreProviderId": "" + "createPlan": { + "type": "import", + "providerId": "" + } } ``` diff --git a/fern/customization/knowledgebase.mdx b/fern/customization/knowledgebase.mdx index 35a80c02b..dc8d2a4fb 100644 --- a/fern/customization/knowledgebase.mdx +++ b/fern/customization/knowledgebase.mdx @@ -28,7 +28,7 @@ Navigate to Platform > Files and upload your custom files in Markdown, PDF, plai Adding files to your Knowledge Base @@ -46,20 +46,28 @@ curl --location 'https://api.vapi.ai/file' \ Use the ID of the uploaded file to create a Knowledge Base. Currently we support [trieve](https://trieve.ai) as a provider. ```bash -curl --location 'https://api.vapi.ai/knowledge-base' \ +curl --location 'http://localhost:3001/knowledge-base' \ --header 'Content-Type: text/plain' \ ---header 'Authorization: Bearer ' \ +--header 'Authorization: Bearer 4beb7e10-f4be-4588-be65-712235f07f68' \ --data '{ - "name": "knowledge-base-test", + "name": "v2", "provider": "trieve", - "vectorStoreSearchPlan": { - "scoreThreshold": 0.1, - "searchType": "hybrid" + "searchPlan": { + "scoreThreshold": 0.2, + "searchType": "semantic" }, - "vectorStoreCreatePlan": { - "fileIds": [""] + "createPlan": { + "type": "create", + "chunkPlans": [ + { + "fileIds": ["", ""], + "websites": ["", ""], + "targetSplitsPerChunk": 50, + "rebalanceChunks": true + } + ] } -}' +}'' ``` ### **Step 3: Create an Assistant** diff --git a/fern/knowledgebase.mdx b/fern/knowledgebase.mdx index 1764fc6c2..dc8d2a4fb 100644 --- a/fern/knowledgebase.mdx +++ b/fern/knowledgebase.mdx @@ -46,20 +46,28 @@ curl --location 'https://api.vapi.ai/file' \ Use the ID of the uploaded file to create a Knowledge Base. Currently we support [trieve](https://trieve.ai) as a provider. ```bash -curl --location 'https://api.vapi.ai/knowledge-base' \ +curl --location 'http://localhost:3001/knowledge-base' \ --header 'Content-Type: text/plain' \ ---header 'Authorization: Bearer ' \ +--header 'Authorization: Bearer 4beb7e10-f4be-4588-be65-712235f07f68' \ --data '{ - "name": "knowledge-base-test", + "name": "v2", "provider": "trieve", - "vectorStoreSearchPlan": { - "scoreThreshold": 0.1, - "searchType": "hybrid" + "searchPlan": { + "scoreThreshold": 0.2, + "searchType": "semantic" }, - "vectorStoreCreatePlan": { - "fileIds": [""] + "createPlan": { + "type": "create", + "chunkPlans": [ + { + "fileIds": ["", ""], + "websites": ["", ""], + "targetSplitsPerChunk": 50, + "rebalanceChunks": true + } + ] } -}' +}'' ``` ### **Step 3: Create an Assistant**