update CHANGELOG and create websocker-server instructions
This commit is contained in:
@@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
|
- Added WebsocketServerTransport. This will create a websocket server and will
|
||||||
|
read messages coming from a client. The messages are serialized/deserialized
|
||||||
|
with protobufs. See `examples/websocket-server` for a detailed example.
|
||||||
|
|
||||||
- Added function calling (LLMService.register_function()). This will allow the
|
- Added function calling (LLMService.register_function()). This will allow the
|
||||||
LLM to call functions you have registered when needed. For example, if you
|
LLM to call functions you have registered when needed. For example, if you
|
||||||
register a function to get the weather in Los Angeles and ask the LLM about
|
register a function to get the weather in Los Angeles and ask the LLM about
|
||||||
@@ -24,7 +28,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
- Fixed an issue where `camera_out_enabled` would cause the highg CPU usage if
|
- Fixed an issue where `camera_out_enabled` would cause the highg CPU usage if
|
||||||
no image was provided.
|
no image was provided.
|
||||||
|
|
||||||
|
|
||||||
## [0.0.24] - 2024-05-29
|
## [0.0.24] - 2024-05-29
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|||||||
27
examples/websocket-server/README.md
Normal file
27
examples/websocket-server/README.md
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
# Websocket Server
|
||||||
|
|
||||||
|
This is an example that shows how to use `WebsocketServerTransport` to communicate with a web client.
|
||||||
|
|
||||||
|
## Get started
|
||||||
|
|
||||||
|
```python
|
||||||
|
python3 -m venv venv
|
||||||
|
source venv/bin/activate
|
||||||
|
pip install -r requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
## Run the server
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python server.py
|
||||||
|
```
|
||||||
|
|
||||||
|
## Run the HTTP server
|
||||||
|
|
||||||
|
This will host the static web client:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m http.server
|
||||||
|
```
|
||||||
|
|
||||||
|
Then, visit `http://localhost:8000` in your browser to start a session.
|
||||||
2
examples/websocket-server/requirements.txt
Normal file
2
examples/websocket-server/requirements.txt
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
python-dotenv
|
||||||
|
pipecat-ai[openai,silero,websocket,whisper]
|
||||||
Reference in New Issue
Block a user