wx44wx/pipecat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Release prep for 0.0.75 (#2169)

Browse Source 
* Update CHANGELOG for 0.0.75 release

* Add RTVI changes to CHANGELOG

* Update CHANGELOG, add deprecation directives to rtvi.py

---------

Co-authored-by: mattie ruth backman <mattieruth@gmail.com>
This commit is contained in:
Mark Backman
2025-07-08 12:39:44 -07:00
committed by GitHub
parent deea29b5e8
commit d98b6b418d
2 changed files with 80 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
CHANGELOG.md
View File

@@ -5,7 +5,7 @@ All notable changes to **Pipecat** will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
## [0.0.75] - 2025-07-08
### Added
@@ -25,6 +25,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed
- Updated `RTVIObserver` and `RTVIProcessor` to match the new RTVI 1.0.0 protocol.
This includes:
- Deprecating support for all messages related to service configuaration and
actions.
- Adding support for obtaining and logging data about client, including its
RTVI version and optionally included system information (OS/browser/etc.)
- Adding support for handling the new `client-message` RTVI message through
either a `on_client_message` event handler or listening for a new
`RTVIClientMessageFrame`
- Adding support for responding to a `client-message` with a `server-response`
via either a direct call on the `RTVIProcessor` or via pushing a new
`RTVIServerResponseFrame`
- Adding built-in support for handling the new `append-to-context` RTVI message
which allows a client to add to the user or assistant llm context. No extra
code is required for supporting this behavior.
- Updating all JavaScript and React client RTVI examples to use versions 1.0.0
of the clients.
Get started migrating to RTVI protocol 1.0.0 by following the migration guide:
https://docs.pipecat.ai/client/migration-guide
- Refactored `AWSBedrockLLMService` and `AWSPollyTTSService` to work
asynchronously using `aioboto3` instead of the `boto3` library.

60
src/pipecat/processors/frameworks/rtvi.py
View File

@@ -93,8 +93,7 @@ class RTVIServiceOption(BaseModel):
Defines a configurable option that can be set for an RTVI service,
including its name, type, and handler function.
DEPRECATED.
.. deprecated:: 0.0.75
Pipeline Configuration has been removed as part of the RTVI protocol 1.0.0.
Use custom client and server messages instead.
"""
@@ -112,8 +111,7 @@ class RTVIService(BaseModel):
Represents a service that can be configured and used within the RTVI protocol,
containing a name and list of configurable options.
DEPRECATED.
.. deprecated:: 0.0.75
Pipeline Configuration has been removed as part of the RTVI protocol 1.0.0.
Use custom client and server messages instead.
"""
@@ -135,8 +133,7 @@ class RTVIActionArgumentData(BaseModel):
Contains the name and value of an argument passed to an RTVI action.
DEPRECATED.
.. deprecated:: 0.0.75
Actions have been removed as part of the RTVI protocol 1.0.0.
Use custom client and server messages instead.
"""
@@ -150,8 +147,7 @@ class RTVIActionArgument(BaseModel):
Specifies the name and expected type of an argument for an RTVI action.
DEPRECATED.
.. deprecated:: 0.0.75
Actions have been removed as part of the RTVI protocol 1.0.0.
Use custom client and server messages instead.
"""
@@ -166,8 +162,7 @@ class RTVIAction(BaseModel):
Represents an action that can be executed within the RTVI protocol,
including its service, name, arguments, and handler function.
DEPRECATED.
.. deprecated:: 0.0.75
Actions have been removed as part of the RTVI protocol 1.0.0.
Use custom client and server messages instead.
"""
@@ -194,8 +189,7 @@ class RTVIServiceOptionConfig(BaseModel):
Contains the name and value to set for a specific service option.
DEPRECATED.
.. deprecated:: 0.0.75
Pipeline Configuration has been removed as part of the RTVI protocol 1.0.0.
Use custom client and server messages instead.
"""
@@ -209,8 +203,7 @@ class RTVIServiceConfig(BaseModel):
Contains the service name and list of option configurations to apply.
DEPRECATED.
.. deprecated:: 0.0.75
Pipeline Configuration has been removed as part of the RTVI protocol 1.0.0.
Use custom client and server messages instead.
"""
@@ -224,8 +217,7 @@ class RTVIConfig(BaseModel):
Contains the full configuration for all RTVI services.
DEPRECATED.
.. deprecated:: 0.0.75
Pipeline Configuration has been removed as part of the RTVI protocol 1.0.0.
Use custom client and server messages instead.
"""
@@ -244,8 +236,7 @@ class RTVIUpdateConfig(BaseModel):
Contains new configuration settings and whether to interrupt the bot.
DEPRECATED.
.. deprecated:: 0.0.75
Pipeline Configuration has been removed as part of the RTVI protocol 1.0.0.
Use custom client and server messages instead.
"""
@@ -259,8 +250,7 @@ class RTVIActionRunArgument(BaseModel):
Contains the name and value of an argument to pass to an action.
DEPRECATED.
.. deprecated:: 0.0.75
Actions have been removed as part of the RTVI protocol 1.0.0.
Use custom client and server messages instead.
"""
@@ -274,8 +264,7 @@ class RTVIActionRun(BaseModel):
Contains the service, action name, and optional arguments.
DEPRECATED.
.. deprecated:: 0.0.75
Actions have been removed as part of the RTVI protocol 1.0.0.
Use custom client and server messages instead.
"""
@@ -293,8 +282,7 @@ class RTVIActionFrame(DataFrame):
rtvi_action_run: The action to execute.
message_id: Optional message ID for response correlation.
DEPRECATED.
.. deprecated:: 0.0.75
Actions have been removed as part of the RTVI protocol 1.0.0.
Use custom client and server messages instead.
"""
@@ -431,8 +419,7 @@ class RTVIDescribeConfigData(BaseModel):
Contains the list of available services and their options.
DEPRECATED.
.. deprecated:: 0.0.75
Pipeline Configuration has been removed as part of the RTVI protocol 1.0.0.
Use custom client and server messages instead.
"""
@@ -445,8 +432,7 @@ class RTVIDescribeConfig(BaseModel):
Sent in response to a describe-config request.
DEPRECATED.
.. deprecated:: 0.0.75
Pipeline Configuration has been removed as part of the RTVI protocol 1.0.0.
Use custom client and server messages instead.
"""
@@ -462,8 +448,7 @@ class RTVIDescribeActionsData(BaseModel):
Contains the list of available actions that can be executed.
DEPRECATED.
.. deprecated:: 0.0.75
Actions have been removed as part of the RTVI protocol 1.0.0.
Use custom client and server messages instead.
"""
@@ -476,8 +461,7 @@ class RTVIDescribeActions(BaseModel):
Sent in response to a describe-actions request.
DEPRECATED.
.. deprecated:: 0.0.75
Actions have been removed as part of the RTVI protocol 1.0.0.
Use custom client and server messages instead.
"""
@@ -493,8 +477,7 @@ class RTVIConfigResponse(BaseModel):
Sent in response to a get-config request.
DEPRECATED.
.. deprecated:: 0.0.75
Pipeline Configuration has been removed as part of the RTVI protocol 1.0.0.
Use custom client and server messages instead.
"""
@@ -510,8 +493,7 @@ class RTVIActionResponseData(BaseModel):
Contains the result of executing an action.
DEPRECATED.
.. deprecated:: 0.0.75
Actions have been removed as part of the RTVI protocol 1.0.0.
Use custom client and server messages instead.
"""
@@ -524,8 +506,7 @@ class RTVIActionResponse(BaseModel):
Sent after successfully executing an action.
DEPRECATED.
.. deprecated:: 0.0.75
Actions have been removed as part of the RTVI protocol 1.0.0.
Use custom client and server messages instead.
"""
@@ -1278,9 +1259,6 @@ class RTVIProcessor(FrameProcessor):
function_name: Name of the function being called.
llm: The LLM processor making the call.
context: The LLM context.
Note:
This method is deprecated. Use handle_function_call() instead.
"""
import warnings