-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/main' into bryant/assembly-ai-docs
- Loading branch information
Showing
9 changed files
with
347 additions
and
123 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| 1. **New Knowledge Base API Endpoints**: You can now create a knowledge base with [`POST /knowledge-base`](https://api.vapi.ai/api#/Knowledge%20Base/KnowledgeBaseController_create), list knowledge bases with [`GET /knowledge-base`](https://api.vapi.ai/api#/Knowledge%20Base/KnowledgeBaseController_findAll) or [`GET /knowledge-base/{id}`](https://api.vapi.ai/api#/Knowledge%20Base/KnowledgeBaseController_findOne) for a specific knowledge base, update a knowledge base with [`PATCH /knowledge-base/{id}`](https://api.vapi.ai/api#/Knowledge%20Base/KnowledgeBaseController_update), or delete a knowledge base with [`DELETE /knowledge-base/{id}`](https://api.vapi.ai/api#/Knowledge%20Base/KnowledgeBaseController_remove). Refer to the [Vapi API endpoints](https://api.vapi.ai/api#/) for more details. | ||
|
|
||
| <Frame caption="Refer to the `Knowledge Base` endpoints for more information: https://api.vapi.ai/api"> | ||
| <img src="../static/images/changelog/knowledge-base-endpoints.png" /> | ||
| </Frame> | ||
|
|
||
|
|
||
| 2. **Configure Custom Knowledge Bases for your Assistant**: Configure a custom knowledge base for your assistant in three steps by first uploading a file [through the dashboard](https://dashboard.vapi.ai/files) or [the API](https://api.vapi.ai/api#/Files/FileController_create), then [create a knowledge base](https://docs.vapi.ai/knowledgebase#step-2-create-a-knowledge-base), and lastly [updating your assistant](https://docs.vapi.ai/knowledgebase#step-3-create-an-assistant) with the knowledge base id. You can also assign a knowledge base to models like `GroqModel`, `VapiModel`, `GoogleModel`, and others using the new `knowledgeBaseId` property. | ||
|
|
||
|
|
||
| 3. **Integration with Trieve Knowledge Base**: Vapi now supports [Trieve](https://trieve.ai/) as our first knowledge base provider. Refer to [our docs](https://docs.vapi.ai/knowledgebase#step-2-create-a-knowledge-base) for an example of how to use Trieve. | ||
|
|
||
|
|
||
| 4. **Inflection AI Credential Management**: You can now manage Inflection AI credentials through the [updated providers credentials](https://dashboard.vapi.ai/keys) page. `Call.endedReason` also now enumerates new values like `'pipeline-error-inflection-ai-llm-failed'` to indicate specific Inflection AI errors. | ||
|
|
||
| <Frame caption="Use the updated provider credentials page to manage Inflection AI credentials: https://dashboard.vapi.ai/keys"> | ||
| <img src="../static/images/changelog/inflection-ai.png" /> | ||
| </Frame> | ||
|
|
||
|
|
||
| 5. **New Transfer Mode with Summary in SIP Header**: You can now configure `TransferPlan.mode` to `'blind-transfer-add-summary-to-sip-header'` to forward calls and include a summary in the SIP header called `X-Transfer-Summary`. You can also add custom SIP headers during a transfer call using the `sipHeaders` property in `TransferDestinationSip`. | ||
|
|
||
|
|
||
| 6. **Azure Credential Service Default**: When creating or updating Azure credentials in the [updated providers credentials](https://dashboard.vapi.ai/keys), the `service` field now defaults to `'speech'`. | ||
|
|
||
|
|
||
| 7. **Support for Cantonese in Deepgram Transcriber**: The `DeepgramTranscriber.language` option now includes `'zh-HK'` for Cantonese (Hong Kong). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,63 +1,101 @@ | ||
| --- | ||
| title: Knowledgebase | ||
| subtitle: Videos showcasing Vapi out in the wild. | ||
| slug: community/knowledgebase | ||
| 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 | ||
| --- | ||
|
|
||
| ## **What is Vapi's Knowledge Base?** | ||
|
|
||
| Here are some videos made by people in our community showcasing what Vapi can do: | ||
| Our Knowledge Base is a collection of custom documents that contain information on specific topics or domains. By integrating a Knowledge Base into your voice AI assistant, you can enable it to provide more accurate and informative responses to user queries. This is currently available in Vapi via the API, and will be on the dashboard soon. | ||
|
|
||
| <div class="video-grid"> | ||
| <iframe | ||
| src="https://www.youtube.com/embed/9MD1VM7038Q?si=G1at__w9gAm0dqEA" | ||
| title="YouTube video player" | ||
| frameborder="0" | ||
| allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" | ||
| referrerpolicy="strict-origin-when-cross-origin" | ||
| allowfullscreen | ||
| /> | ||
| <iframe | ||
| src="https://www.youtube.com/embed/xCdfLSrwbjc?si=xn1jIHmV4J7VTsTr" | ||
| title="YouTube video player" | ||
| frameborder="0" | ||
| allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" | ||
| referrerpolicy="strict-origin-when-cross-origin" | ||
| allowfullscreen | ||
| /> | ||
| <iframe | ||
| width="100%" | ||
| height="315" | ||
| src="https://www.youtube.com/embed/g0SKKwBpp7g?si=b8uXyopKo9fZYowX" | ||
| title="YouTube video player" | ||
| frameborder="0" | ||
| allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" | ||
| referrerpolicy="strict-origin-when-cross-origin" | ||
| allowfullscreen | ||
| /> | ||
| ### **Why Use a Knowledge Base?** | ||
|
|
||
| Using a Knowledge Base with your voice AI assistant offers several benefits: | ||
|
|
||
| - **Improved accuracy**: By integrating custom documents into your assistant, you can ensure that it provides accurate and up-to-date information to users. | ||
| - **Enhanced capabilities**: A Knowledge Base enables your assistant to answer complex queries and provide detailed responses to user inquiries. | ||
| - **Customization**: With a Knowledge Base, you can tailor your assistant's responses to specific domains or topics, making it more effective and informative. | ||
|
|
||
| ## **How to Create a Knowledge Base** | ||
|
|
||
| <iframe | ||
| width="100%" | ||
| height="315" | ||
| src="https://www.youtube.com/embed/4_9IOCiC7hc" | ||
| title="YouTube video player" | ||
| frameborder="0" | ||
| allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" | ||
| referrerpolicy="strict-origin-when-cross-origin" | ||
| allowfullscreen | ||
| To create a Knowledge Base, follow these steps: | ||
|
|
||
| ### **Step 1: Upload Your Documents** | ||
|
|
||
| Navigate to Overview > Documents and upload your custom documents in Markdown, PDF, plain text, or Microsoft Word (.doc and .docx) format to Vapi's Knowledge Base. | ||
|
|
||
| <Frame caption="Adding documents to your Knowledge Base"> | ||
| <img | ||
| src="https://cdn.hashnode.com/res/hashnode/image/upload/v1715628063841/rSrWDQ6YM.png" | ||
| alt="Adding documents to your Knowledge Base" | ||
| /> | ||
| </div> | ||
|
|
||
| ## Send Us Your Video | ||
|
|
||
| Have a video showcasing Vapi that you want us to feature? Let us know: | ||
|
|
||
| <CardGroup cols={2}> | ||
| <Card | ||
| title="Send Us Your Video" | ||
| icon="video-arrow-up-right" | ||
| iconType="solid" | ||
| href="https://tally.so/r/3yD9Wx" | ||
| > | ||
| Send us your video showcasing what Vapi can do, we'd like to feature it. | ||
| </Card> | ||
| </CardGroup> | ||
| </Frame> | ||
|
|
||
| Alternatively you can upload your documents via the API. | ||
|
|
||
| ```bash | ||
| curl --location 'https://api.vapi.ai/file' \ | ||
| --header 'Authorization: Bearer <YOUR_API_KEY>' \ | ||
| --form 'file=@"<PATH_TO_YOUR_FILE>"' | ||
| ``` | ||
|
|
||
| ### **Step 2: Create a Knowledge Base** | ||
|
|
||
| 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' \ | ||
| --header 'Content-Type: text/plain' \ | ||
| --header 'Authorization: Bearer <YOUR_API_KEY>' \ | ||
| --data '{ | ||
| "name": "knowledge-base-test", | ||
| "provider": "trieve", | ||
| "searchPlan": { | ||
| "scoreThreshold": 0.1, | ||
| "searchType": "hybrid" | ||
| }, | ||
| "chunkPlan": { | ||
| "fileIds": ["<FILE_ID>"] | ||
| } | ||
| }' | ||
| ``` | ||
|
|
||
| ### **Step 3: Create an Assistant** | ||
|
|
||
| Create a new assistant in Vapi and, on the right sidebar menu. Add the Knowledge Base to your assistant via the PATCH endpoint. Also make sure you customize your assistant's system prompt to utilize the Knowledge Base for responding to user queries. | ||
|
|
||
| ```bash | ||
| curl --location --request PATCH 'https://api.vapi.ai/assistant/<ASSISTANT_ID>' \ | ||
| --header 'Content-Type: text/plain' \ | ||
| --header 'Authorization: Bearer <YOUR_API_KEY>' \ | ||
| --data '{ | ||
| "model": { | ||
| "knowledgeBaseId": "<KNOWLEDGE_BASE_ID>", | ||
| "temperature": 0.2, | ||
| "provider": "openai", | ||
| "model": "gpt-4o", | ||
| "messages": [ | ||
| { | ||
| "content": "You are a smart assistant who responds to user queries using the information you know, or information supplied by outside context.", | ||
| "role": "system" | ||
| } | ||
| ] | ||
| } | ||
| }' | ||
| ``` | ||
|
|
||
| ## **Best Practices for Creating Effective Knowledge Bases** | ||
|
|
||
| - **Organize Your documents**: Organize your documents by topic or category to ensure that your assistant can quickly retrieve relevant information. | ||
| - **Use Clear and concise language**: Use clear and concise language in your documents to ensure that your assistant can accurately understand and respond to user queries. | ||
| - **Keep your documents up-to-date**: Regularly update your documents to ensure that your assistant provides the most accurate and up-to-date information. | ||
|
|
||
| <Tip> | ||
| For more information on creating effective Knowledge Bases, check out our | ||
| tutorial on [Best Practices for Knowledge Base | ||
| Creation](https://youtu.be/i5mvqC5sZxU). | ||
| </Tip> | ||
|
|
||
| By following these guidelines, you can create a comprehensive Knowledge Base that enhances the capabilities of your voice AI assistant and provides valuable information to users. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.