Added support for Krisp audio filter
This commit is contained in:
18
README.md
18
README.md
@@ -129,6 +129,24 @@ Pipecat makes use of WebRTC VAD by default when using a WebRTC transport layer.
|
||||
pip install pipecat-ai[silero]
|
||||
```
|
||||
|
||||
## Running the Krisp Audio Filter
|
||||
|
||||
To use the Krisp Filter in this project, you’ll need access to the **Krisp C++ SDK**.
|
||||
|
||||
### Step 1: Obtain Access to the Krisp SDK
|
||||
1. **Create a Krisp Account**: If you don’t already have an account, [sign up at Krisp](https://krisp.ai/) to access the SDK.
|
||||
2. **Download the SDK**: Once you have an account, follow the instructions on the Krisp platform to download the [Krisp's desktop SDKs](https://sdk.krisp.ai/sdk/desktop).
|
||||
3. **Export the path to you krisp SDK**:
|
||||
`export KRISP_SDK_PATH=/PATH/TO/KRISP/SDK`
|
||||
|
||||
### Step 2: Install the `pipecat-krisp` Module
|
||||
Once the environment variable `KRISP_SDK_PATH` is exported, activate your Python virtual environment and install it with `pip`:
|
||||
|
||||
```shell
|
||||
source venv/bin/activate
|
||||
pip install pipecat-ai[krisp]
|
||||
```
|
||||
|
||||
## Hacking on the framework itself
|
||||
|
||||
_Note that you may need to set up a virtual environment before following the instructions below. For instance, you might need to run the following from the root of the repo:_
|
||||
|
||||
Reference in New Issue
Block a user