Welcome to the Vapi Serverless Vercel sample project. This project demonstrates how you can extend the functionalities of Vapi, an abstraction layer for your personal assistant, to create a unique experience tailored for story writers. Using this project, writers can design characters for their stories through voice interactions with the assistant.
The project showcases the following customizations:
- Function Calling: Writers can invoke custom functions to retrieve character inspirations and generate random names based on specific criteria. For more info click here
- Custom Large Language Model (LLM) Integration: Enhance conversational capabilities by integrating custom LLMs with Vapi for nuanced and context-aware interactions. For more info click here
- Server URL Events: Handle various events during a call's lifecycle, such as function calls and assistant requests, to provide dynamic responses. For more info click here
- Creative Prompts for Character Development: Utilize the function that provides creative prompts for character development to get inspired based on a query provided by the author.
- Random Name Generation: Use a public endpoint to generate random names, with options to specify gender and nationality based on user input.
- Advanced Conversational Interactions: Leverage advanced LLMs to improve natural language understanding and generation for complex conversations.
To get started with this project:
- Clone the repository to your local machine.
- Install the dependencies by running
pnpm install. - Explore the
src/handlersdirectory to understand how the function calling and custom LLM integrations and webhook event handling are set up. - Review the types directory to see the data structures used for handling Vapi events and payloads.
- Check the data directory for sample data that the function for creative character prompts can use.
- Remove any unnecessary code and start adding your own logic.
- There is sample json in
./assistantsfolder. You can use that to create Vapi assistant and then test it.
To execute tasks with Nx use the following syntax:
nx <target> vapiai <...options>
You can also run multiple targets:
nx run-many -t <target1> <target2>
..or add -p to filter specific projects
nx run-many -t <target1> <target2> -p <proj1> <proj2>
Targets can be defined in the package.json or projects.json. Learn more in the docs.
Just run nx build demoapp to build the application. The build artifacts will be stored in the dist/vapiai directory, ready to be deployed.
- Using Dashboard: For you to create an assistant you can create a simple one by directly going to your dashboard and creating one from the UI.
- Using POST Endpoint: You can also create your assistant using POST
https://api.vapi.ai/assistantwith your API Key (Dashboard > Accounts > Vapi Keys) as Bearer Token and choose any body from./assistantsfolder.
Once assistant is created You may setup your server Url (http://<domain>/api/webhook) in the Dashboard > Accounts > Settings > Server URL. This will set the server URL for all assistants. If you want to set the serverUrl per assistant by using serverUrl key in the assistant body while creating.
Here are some examples of how the custom functionalities can be used:
- A writer asks Vapi for help with character development, and Vapi responds with a creative prompt from the function designed for this purpose.
- A writer requests a random name for a character, and Vapi uses the function for random name generation to provide a name with the specified gender and nationality.
This sample project illustrates the power of Vapi customization for specific use cases, such as assisting story writers in their creative process. By following the examples and guidelines provided, developers can create a more versatile and responsive voice assistant that caters to the unique needs of their users.
For additional help and documentation, refer to the official Vapi documentation.