Skip to content

Commit

Permalink
Merge pull request #710 from pipecat-ai/mb/update-readme-krisp
Browse files Browse the repository at this point in the history
Update Krisp README instructions
  • Loading branch information
markbackman authored Nov 12, 2024
2 parents 2d8aa03 + 70b60c0 commit 70fce52
Showing 1 changed file with 5 additions and 11 deletions.
16 changes: 5 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,21 +129,15 @@ Pipecat makes use of WebRTC VAD by default when using a WebRTC transport layer.
pip install pipecat-ai[silero]
```

## Running the Krisp Audio Filter
## Krisp Audio Filter

To use the Krisp Filter in this project, youll need access to the **Krisp C++ SDK**.
This project includes support for Krisp's noise cancellation SDK. To get started, you'll need a Krisp developer account and SDK access.

### 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`
For complete setup and usage instructions, see our [Krisp Integration Guide](https://docs.pipecat.ai/guides/krisp).

### 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`:
Quick install (after SDK setup):

```shell
source venv/bin/activate
```bash
pip install pipecat-ai[krisp]
```

Expand Down

0 comments on commit 70fce52

Please sign in to comment.