Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add KoalaFilter docs #67

Merged
merged 3 commits into from
Dec 18, 2024
Merged

Add KoalaFilter docs #67

merged 3 commits into from
Dec 18, 2024

Conversation

markbackman
Copy link
Contributor

pip install pipecat-ai[koala]
```

You'll also need to set up your OpenAI API key as an environment variable: `KOALA_ACCESS_KEY`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

replace OpenAI API


<ParamField path="AudioRawFrame" type="Frame" required>
Raw audio data for noise reduction processing
</ParamField>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AudioRawFrame are not input frames actually. The filter is called directly from the transport. It's actually not a processor.

)
```

## Frame Flow
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if this is considered Frame flow.

Btw, it does support the FilterEnableFrame and the settings one, but because the transport passes it to them (i.e. they don't receive them from the pipeline directly, but indirectly through the transport).

@markbackman
Copy link
Contributor Author

I've made those changes. I think this should be ready to go.

@aconchillo
Copy link
Contributor

LGTM!

@markbackman markbackman merged commit 8dfde61 into main Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants