Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -278,14 +278,6 @@
"group": "Context",
"pages": ["server/utilities/context-summarization"]
},
{
"group": "Events",
"pages": [
"server/utilities/events",
"server/utilities/frame-processor-events",
"server/utilities/service-events"
]
},
{
"group": "Extensions",
"pages": [
Expand Down Expand Up @@ -381,6 +373,14 @@
}
]
},
{
"group": "Events",
"pages": [
"server/events/overview",
"server/events/frame-processor-events",
"server/events/service-events"
]
},
{
"group": "Frameworks",
"pages": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,6 @@ async def on_after_push(processor, frame):

## Related

- [Events](/server/utilities/events) - Overview of all events in Pipecat
- [Events](/server/events/overview) - Overview of all events in Pipecat
- [PipelineTask](/server/pipeline/pipeline-task#event-handlers) - Pipeline lifecycle events
- [Observer Pattern](/server/utilities/observers/observer-pattern) - Non-intrusive pipeline monitoring
8 changes: 4 additions & 4 deletions server/utilities/events.mdx → server/events/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Events on [`PipelineTask`](/server/pipeline/pipeline-task#event-handlers).

### Frame Processor

Events on every [`FrameProcessor`](/server/utilities/frame-processor-events). Since all services, transports, and processors inherit from `FrameProcessor`, these events are available on any processor in your pipeline.
Events on every [`FrameProcessor`](/server/events/frame-processor-events). Since all services, transports, and processors inherit from `FrameProcessor`, these events are available on any processor in your pipeline.

| Event | Description |
| ------------------------- | --------------------------------------------------- |
Expand Down Expand Up @@ -118,7 +118,7 @@ Events on context aggregators from [`LLMContextAggregatorPair`](/server/utilitie

### STT Services

Events on STT service instances. Available on all WebSocket-based STT services. See [Service Events](/server/utilities/service-events) for details.
Events on STT service instances. Available on all WebSocket-based STT services. See [Service Events](/server/events/service-events) for details.

| Event | Description |
| --------------------- | ----------------------------------- |
Expand Down Expand Up @@ -161,7 +161,7 @@ Some STT services have additional events:

### TTS Services

Events on TTS service instances. Available on all WebSocket-based TTS services. See [Service Events](/server/utilities/service-events) for details.
Events on TTS service instances. Available on all WebSocket-based TTS services. See [Service Events](/server/events/service-events) for details.

| Event | Description |
| --------------------- | ------------------------------------- |
Expand All @@ -172,7 +172,7 @@ Events on TTS service instances. Available on all WebSocket-based TTS services.

### LLM Services

Events on LLM service instances. See [Service Events](/server/utilities/service-events) for details.
Events on LLM service instances. See [Service Events](/server/events/service-events) for details.

| Event | Description |
| --------------------------- | ------------------------------------------ |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,6 @@ async def on_completion_timeout(service):

## Related

- [Events Overview](/server/utilities/events) - Overview of all events in Pipecat
- [FrameProcessor Events](/server/utilities/frame-processor-events) - Error handling and frame monitoring events
- [Events Overview](/server/events/overview) - Overview of all events in Pipecat
- [FrameProcessor Events](/server/events/frame-processor-events) - Error handling and frame monitoring events
- [Turn Events](/server/utilities/turn-management/turn-events) - User and assistant turn lifecycle events
2 changes: 1 addition & 1 deletion server/services/llm/anthropic.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ await task.queue_frame(

## Event Handlers

`AnthropicLLMService` supports the following event handlers, inherited from [LLMService](/server/utilities/service-events):
`AnthropicLLMService` supports the following event handlers, inherited from [LLMService](/server/events/service-events):

| Event | Description |
| --------------------------- | ----------------------------------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion server/services/llm/aws.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ await task.queue_frame(

## Event Handlers

`AWSBedrockLLMService` supports the following event handlers, inherited from [LLMService](/server/utilities/service-events):
`AWSBedrockLLMService` supports the following event handlers, inherited from [LLMService](/server/events/service-events):

| Event | Description |
| --------------------------- | ----------------------------------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion server/services/llm/azure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ await task.queue_frame(

## Event Handlers

`AzureLLMService` supports the same event handlers as `OpenAILLMService`, inherited from [LLMService](/server/utilities/service-events):
`AzureLLMService` supports the same event handlers as `OpenAILLMService`, inherited from [LLMService](/server/events/service-events):

| Event | Description |
| --------------------------- | ----------------------------------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion server/services/llm/google.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ await task.queue_frame(

## Event Handlers

`GoogleLLMService` supports the following event handlers, inherited from [LLMService](/server/utilities/service-events):
`GoogleLLMService` supports the following event handlers, inherited from [LLMService](/server/events/service-events):

| Event | Description |
| --------------------------- | --------------------------------------------------------------------------- |
Expand Down
14 changes: 11 additions & 3 deletions server/services/llm/openai-responses.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@ description: "Large Language Model services using OpenAI's Responses API"
`OpenAIResponsesLLMService` provides chat completion capabilities using OpenAI's Responses API, supporting streaming text responses, function calling, usage metrics, and out-of-band inference. This service works with the universal `LLMContext` and `LLMContextAggregatorPair`.

<Note>
The Responses API is a newer OpenAI API designed for conversational AI applications. It differs from the Chat Completions API in its request/response structure and streaming format. See [OpenAI Responses API documentation](https://platform.openai.com/docs/api-reference/responses) for more details.
The Responses API is a newer OpenAI API designed for conversational AI
applications. It differs from the Chat Completions API in its request/response
structure and streaming format. See [OpenAI Responses API
documentation](https://platform.openai.com/docs/api-reference/responses) for
more details.
</Note>

<CardGroup cols={2}>
Expand Down Expand Up @@ -92,7 +96,11 @@ Before using OpenAI Responses LLM services, you need:
Service tier to use (e.g., "auto", "flex", "priority").
</ParamField>

<ParamField path="settings" type="OpenAIResponsesLLMService.Settings" default="None">
<ParamField
path="settings"
type="OpenAIResponsesLLMService.Settings"
default="None"
>
Runtime-configurable model settings. See [Settings](#settings) below.
</ParamField>

Expand Down Expand Up @@ -198,7 +206,7 @@ print(response) # "The capital of France is Paris."

## Event Handlers

`OpenAIResponsesLLMService` supports the following event handlers, inherited from [LLMService](/server/utilities/service-events):
`OpenAIResponsesLLMService` supports the following event handlers, inherited from [LLMService](/server/events/service-events):

| Event | Description |
| --------------------------- | ----------------------------------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion server/services/llm/openai.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ await task.queue_frame(

## Event Handlers

`OpenAILLMService` supports the following event handlers, inherited from [LLMService](/server/utilities/service-events):
`OpenAILLMService` supports the following event handlers, inherited from [LLMService](/server/events/service-events):

| Event | Description |
| --------------------------- | ----------------------------------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion server/services/stt/assemblyai.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ stt = AssemblyAISTTService(

## Event Handlers

AssemblyAI STT supports the standard [service connection events](/server/utilities/service-events):
AssemblyAI STT supports the standard [service connection events](/server/events/service-events):

| Event | Description |
| ----------------- | -------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion server/services/stt/aws.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ stt = AWSTranscribeSTTService(

## Event Handlers

AWS Transcribe STT supports the standard [service connection events](/server/utilities/service-events):
AWS Transcribe STT supports the standard [service connection events](/server/events/service-events):

| Event | Description |
| ----------------- | ------------------------------------------ |
Expand Down
2 changes: 1 addition & 1 deletion server/services/stt/cartesia.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ stt = CartesiaSTTService(

## Event Handlers

Cartesia STT supports the standard [service connection events](/server/utilities/service-events):
Cartesia STT supports the standard [service connection events](/server/events/service-events):

| Event | Description |
| ----------------- | ------------------------------------ |
Expand Down
6 changes: 3 additions & 3 deletions server/services/stt/deepgram.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ stt = DeepgramSTTService(

### Event Handlers

Supports the standard [service connection events](/server/utilities/service-events) (`on_connected`, `on_disconnected`, `on_connection_error`), plus:
Supports the standard [service connection events](/server/events/service-events) (`on_connected`, `on_disconnected`, `on_connection_error`), plus:

| Event | Description |
| ------------------- | ------------------------------------- |
Expand Down Expand Up @@ -375,7 +375,7 @@ This sends a `Configure` message to Deepgram over the existing WebSocket connect

### Event Handlers

Supports the standard [service connection events](/server/utilities/service-events) (`on_connected`, `on_disconnected`, `on_connection_error`), plus turn-level events for more granular conversation tracking:
Supports the standard [service connection events](/server/events/service-events) (`on_connected`, `on_disconnected`, `on_connection_error`), plus turn-level events for more granular conversation tracking:

| Event | Description |
| ---------------------- | ------------------------------------ |
Expand Down Expand Up @@ -486,7 +486,7 @@ stt = DeepgramSageMakerSTTService(

### Event Handlers

Supports the standard [service connection events](/server/utilities/service-events) (`on_connected`, `on_disconnected`, `on_connection_error`).
Supports the standard [service connection events](/server/events/service-events) (`on_connected`, `on_disconnected`, `on_connection_error`).

<Tip>
The `InputParams` / `params=` / `live_options=` pattern is deprecated as of
Expand Down
2 changes: 1 addition & 1 deletion server/services/stt/elevenlabs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ stt = ElevenLabsRealtimeSTTService(

### Event Handlers

Supports the standard [service connection events](/server/utilities/service-events):
Supports the standard [service connection events](/server/events/service-events):

| Event | Description |
| ----------------- | --------------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion server/services/stt/gladia.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ stt = GladiaSTTService(

## Event Handlers

Gladia STT supports the standard [service connection events](/server/utilities/service-events):
Gladia STT supports the standard [service connection events](/server/events/service-events):

| Event | Description |
| ----------------- | ---------------------------------- |
Expand Down
39 changes: 22 additions & 17 deletions server/services/stt/google.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -84,14 +84,19 @@ Before using Google Cloud STT services, you need:
rate.
</ParamField>

<ParamField path="params" type="GoogleSTTService.InputParams" default="None" deprecated>
<ParamField
path="params"
type="GoogleSTTService.InputParams"
default="None"
deprecated
>
Configuration parameters for the STT service. *Deprecated in v0.0.105. Use
`settings=GoogleSTTService.Settings(...)` instead.*
</ParamField>

<ParamField path="settings" type="GoogleSTTService.Settings" default="None">
Runtime-configurable settings for the STT service. See
[Settings](#settings) below.
Runtime-configurable settings for the STT service. See [Settings](#settings)
below.
</ParamField>

<ParamField path="ttfs_p99_latency" type="float" default="GOOGLE_TTFS_P99">
Expand All @@ -109,20 +114,20 @@ Before using Google Cloud STT services, you need:

Runtime-configurable settings passed via the `settings` constructor argument using `GoogleSTTService.Settings(...)`. These can be updated mid-conversation with `STTUpdateSettingsFrame`. See [Service Settings](/guides/fundamentals/service-settings) for details.

| Parameter | Type | Default | Description |
| -------------------------------------- | ----------------------------- | ------------------ | ---------------------------------------------------------------------------- |
| `model` | `str` | `"latest_long"` | Speech recognition model to use. *(Inherited from base STT settings.)* |
| `language` | `Language \| str` | `None` | Language for speech recognition. *(Inherited from base STT settings.)* |
| Parameter | Type | Default | Description |
| -------------------------------------- | ---------------------------- | ------------------ | ---------------------------------------------------------------------------- |
| `model` | `str` | `"latest_long"` | Speech recognition model to use. _(Inherited from base STT settings.)_ |
| `language` | `Language \| str` | `None` | Language for speech recognition. _(Inherited from base STT settings.)_ |
| `languages` | `Language \| List[Language]` | `[Language.EN_US]` | Single language or list of recognition languages. First language is primary. |
| `use_separate_recognition_per_channel` | `bool` | `False` | Process each audio channel separately. |
| `enable_automatic_punctuation` | `bool` | `True` | Add punctuation to transcripts. |
| `enable_spoken_punctuation` | `bool` | `False` | Include spoken punctuation in transcript. |
| `enable_spoken_emojis` | `bool` | `False` | Include spoken emojis in transcript. |
| `profanity_filter` | `bool` | `False` | Filter profanity from transcript. |
| `enable_word_time_offsets` | `bool` | `False` | Include timing information for each word. |
| `enable_word_confidence` | `bool` | `False` | Include confidence scores for each word. |
| `enable_interim_results` | `bool` | `True` | Stream partial recognition results. |
| `enable_voice_activity_events` | `bool` | `False` | Detect voice activity in audio. |
| `use_separate_recognition_per_channel` | `bool` | `False` | Process each audio channel separately. |
| `enable_automatic_punctuation` | `bool` | `True` | Add punctuation to transcripts. |
| `enable_spoken_punctuation` | `bool` | `False` | Include spoken punctuation in transcript. |
| `enable_spoken_emojis` | `bool` | `False` | Include spoken emojis in transcript. |
| `profanity_filter` | `bool` | `False` | Filter profanity from transcript. |
| `enable_word_time_offsets` | `bool` | `False` | Include timing information for each word. |
| `enable_word_confidence` | `bool` | `False` | Include confidence scores for each word. |
| `enable_interim_results` | `bool` | `True` | Stream partial recognition results. |
| `enable_voice_activity_events` | `bool` | `False` | Detect voice activity in audio. |

## Usage

Expand Down Expand Up @@ -201,7 +206,7 @@ await task.queue_frame(

## Event Handlers

Google STT supports the standard [service connection events](/server/utilities/service-events):
Google STT supports the standard [service connection events](/server/events/service-events):

| Event | Description |
| ----------------- | --------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion server/services/stt/gradium.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ stt = GradiumSTTService(

## Event Handlers

Gradium STT supports the standard [service connection events](/server/utilities/service-events):
Gradium STT supports the standard [service connection events](/server/events/service-events):

| Event | Description |
| ----------------- | ----------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion server/services/stt/openai.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ stt = OpenAIRealtimeSTTService(

### Event Handlers

Supports the standard [service connection events](/server/utilities/service-events):
Supports the standard [service connection events](/server/events/service-events):

| Event | Description |
| ----------------- | ------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion server/services/stt/sarvam.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ stt = SarvamSTTService(

## Event Handlers

In addition to the standard [service connection events](/server/utilities/service-events) (`on_connected`, `on_disconnected`, `on_connection_error`), Sarvam STT provides:
In addition to the standard [service connection events](/server/events/service-events) (`on_connected`, `on_disconnected`, `on_connection_error`), Sarvam STT provides:

| Event | Description |
| ------------------- | ----------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion server/services/stt/soniox.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ stt = SonioxSTTService(

## Event Handlers

Soniox STT supports the standard [service connection events](/server/utilities/service-events):
Soniox STT supports the standard [service connection events](/server/events/service-events):

| Event | Description |
| ----------------- | ---------------------------------- |
Expand Down
Loading
Loading