From d594257566448e42b75887357c4376156eb0795a Mon Sep 17 00:00:00 2001 From: James Walker Date: Wed, 29 Oct 2025 16:50:55 +0000 Subject: [PATCH 1/8] Add EndOfChannel guidance into the rt dz docs. --- .../realtime/realtime_diarization.mdx | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/speech-to-text/realtime/realtime_diarization.mdx b/docs/speech-to-text/realtime/realtime_diarization.mdx index 0b9e0d9..a434709 100644 --- a/docs/speech-to-text/realtime/realtime_diarization.mdx +++ b/docs/speech-to-text/realtime/realtime_diarization.mdx @@ -215,6 +215,23 @@ Transcripts are returned in the same way as channel diarization, but with indivi When using `channel_and_speaker` diarization, speaker labelling is specific to channels even if the speaker labels are the same. S1 on channel 1 is not necessarily the same as S1 on channel 2. +## Ending Channels + +When you're finished with a channel, you can signal that it's no longer in use by sending an [EndOfChannel](../../api-ref/realtime-transcription-websocket#endofchannel) message. +```json +{ + // highlight-start + "message": "EndOfChannel", + "channel": "New_York", + "last_seq_no": 2564 + // highlight-end +} +``` + +Once this happens, the channel will stop accepting or processing any additional data. When all channels are closed, the session ends - similar to [EndOfStream](../../api-ref/realtime-transcription-websocket#endofstream). + +At this time, closing a channel does not affect pricing for On-Prem or SaaS deployments, but we’re actively working to make that possible in the future. + ### Limits For SaaS customers, the maximum number of channels is 2. From 2724bd8213e6ca03ded8864fb5f5b26260715d21 Mon Sep 17 00:00:00 2001 From: James Walker Date: Wed, 29 Oct 2025 16:56:52 +0000 Subject: [PATCH 2/8] Rename to closing channels --- docs/speech-to-text/realtime/realtime_diarization.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/speech-to-text/realtime/realtime_diarization.mdx b/docs/speech-to-text/realtime/realtime_diarization.mdx index a434709..559b7a6 100644 --- a/docs/speech-to-text/realtime/realtime_diarization.mdx +++ b/docs/speech-to-text/realtime/realtime_diarization.mdx @@ -215,7 +215,7 @@ Transcripts are returned in the same way as channel diarization, but with indivi When using `channel_and_speaker` diarization, speaker labelling is specific to channels even if the speaker labels are the same. S1 on channel 1 is not necessarily the same as S1 on channel 2. -## Ending Channels +## Closing Channels When you're finished with a channel, you can signal that it's no longer in use by sending an [EndOfChannel](../../api-ref/realtime-transcription-websocket#endofchannel) message. ```json From ded9be84b73870e3eb010f52e1600d29ef8cd9b1 Mon Sep 17 00:00:00 2001 From: James Walker Date: Thu, 30 Oct 2025 10:28:06 +0000 Subject: [PATCH 3/8] Add EndOfStream to closing channels section --- docs/speech-to-text/realtime/realtime_diarization.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/speech-to-text/realtime/realtime_diarization.mdx b/docs/speech-to-text/realtime/realtime_diarization.mdx index 559b7a6..94e052d 100644 --- a/docs/speech-to-text/realtime/realtime_diarization.mdx +++ b/docs/speech-to-text/realtime/realtime_diarization.mdx @@ -228,7 +228,9 @@ When you're finished with a channel, you can signal that it's no longer in use b } ``` -Once this happens, the channel will stop accepting or processing any additional data. When all channels are closed, the session ends - similar to [EndOfStream](../../api-ref/realtime-transcription-websocket#endofstream). +Once this happens, the channel will stop accepting or processing any additional data. When all channels are closed, the session ends. + +You can also use [EndOfStream](../../api-ref/realtime-transcription-websocket#endofstream) to simultaneously close all channels. At this time, closing a channel does not affect pricing for On-Prem or SaaS deployments, but we’re actively working to make that possible in the future. From 9bb5aa2eae7af8761ac99064a5600103d4a971fb Mon Sep 17 00:00:00 2001 From: J-Jaywalker <103967935+J-Jaywalker@users.noreply.github.com> Date: Thu, 30 Oct 2025 11:15:45 +0000 Subject: [PATCH 4/8] Update docs/speech-to-text/realtime/realtime_diarization.mdx Change pricing caveat wording. Co-authored-by: Lorna Armstrong --- docs/speech-to-text/realtime/realtime_diarization.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/speech-to-text/realtime/realtime_diarization.mdx b/docs/speech-to-text/realtime/realtime_diarization.mdx index 94e052d..cc4d759 100644 --- a/docs/speech-to-text/realtime/realtime_diarization.mdx +++ b/docs/speech-to-text/realtime/realtime_diarization.mdx @@ -232,7 +232,7 @@ Once this happens, the channel will stop accepting or processing any additional You can also use [EndOfStream](../../api-ref/realtime-transcription-websocket#endofstream) to simultaneously close all channels. -At this time, closing a channel does not affect pricing for On-Prem or SaaS deployments, but we’re actively working to make that possible in the future. +At this time, closing a channel has no impact on pricing for On-Prem or SaaS deployments. Support for this capability is planned for the future. ### Limits From d3630b9ab61e8b3df4274d28383c37938ddbeb5f Mon Sep 17 00:00:00 2001 From: James Walker Date: Mon, 3 Nov 2025 13:28:20 +0000 Subject: [PATCH 5/8] Update wording for rt dz --- docs/speech-to-text/realtime/realtime_diarization.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/speech-to-text/realtime/realtime_diarization.mdx b/docs/speech-to-text/realtime/realtime_diarization.mdx index cc4d759..fc4463a 100644 --- a/docs/speech-to-text/realtime/realtime_diarization.mdx +++ b/docs/speech-to-text/realtime/realtime_diarization.mdx @@ -230,9 +230,9 @@ When you're finished with a channel, you can signal that it's no longer in use b Once this happens, the channel will stop accepting or processing any additional data. When all channels are closed, the session ends. -You can also use [EndOfStream](../../api-ref/realtime-transcription-websocket#endofstream) to simultaneously close all channels. +You can also use [EndOfStream](../../api-ref/realtime-transcription-websocket#endofstream) to simultaneously close all channels. This may be more convenient to use when you know you want to close all channels and the session in one. -At this time, closing a channel has no impact on pricing for On-Prem or SaaS deployments. Support for this capability is planned for the future. +At this time, closing a channel has no impact on pricing for On-Prem or SaaS deployments. ### Limits From eec600b7cc1ce0191ed1c6e2da6b6d303fe7a52f Mon Sep 17 00:00:00 2001 From: J-Jaywalker <103967935+J-Jaywalker@users.noreply.github.com> Date: Mon, 3 Nov 2025 13:40:09 +0000 Subject: [PATCH 6/8] Update docs/speech-to-text/realtime/realtime_diarization.mdx Co-authored-by: Yahia <42359972+yaiir-a@users.noreply.github.com> --- docs/speech-to-text/realtime/realtime_diarization.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/speech-to-text/realtime/realtime_diarization.mdx b/docs/speech-to-text/realtime/realtime_diarization.mdx index fc4463a..568e6e2 100644 --- a/docs/speech-to-text/realtime/realtime_diarization.mdx +++ b/docs/speech-to-text/realtime/realtime_diarization.mdx @@ -230,7 +230,7 @@ When you're finished with a channel, you can signal that it's no longer in use b Once this happens, the channel will stop accepting or processing any additional data. When all channels are closed, the session ends. -You can also use [EndOfStream](../../api-ref/realtime-transcription-websocket#endofstream) to simultaneously close all channels. This may be more convenient to use when you know you want to close all channels and the session in one. +You can also use [EndOfStream](../../api-ref/realtime-transcription-websocket#endofstream) to simultaneously close all channels. This may be more convenient to use when you know you want to close all channels at the same time. At this time, closing a channel has no impact on pricing for On-Prem or SaaS deployments. From 3b940f826f3fe8c72684d431cc1f15028db6ba92 Mon Sep 17 00:00:00 2001 From: J-Jaywalker <103967935+J-Jaywalker@users.noreply.github.com> Date: Mon, 3 Nov 2025 13:40:15 +0000 Subject: [PATCH 7/8] Update docs/speech-to-text/realtime/realtime_diarization.mdx Co-authored-by: Yahia <42359972+yaiir-a@users.noreply.github.com> --- docs/speech-to-text/realtime/realtime_diarization.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/speech-to-text/realtime/realtime_diarization.mdx b/docs/speech-to-text/realtime/realtime_diarization.mdx index 568e6e2..7988dfa 100644 --- a/docs/speech-to-text/realtime/realtime_diarization.mdx +++ b/docs/speech-to-text/realtime/realtime_diarization.mdx @@ -232,7 +232,9 @@ Once this happens, the channel will stop accepting or processing any additional You can also use [EndOfStream](../../api-ref/realtime-transcription-websocket#endofstream) to simultaneously close all channels. This may be more convenient to use when you know you want to close all channels at the same time. -At this time, closing a channel has no impact on pricing for On-Prem or SaaS deployments. +:::info +At this time, closing an individual channel has no impact on pricing. +::: ### Limits From 60c69be047e3af96965b09ca4b227e915812b34b Mon Sep 17 00:00:00 2001 From: J-Jaywalker <103967935+J-Jaywalker@users.noreply.github.com> Date: Mon, 3 Nov 2025 13:40:42 +0000 Subject: [PATCH 8/8] Update docs/speech-to-text/realtime/realtime_diarization.mdx Co-authored-by: Yahia <42359972+yaiir-a@users.noreply.github.com> --- docs/speech-to-text/realtime/realtime_diarization.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/speech-to-text/realtime/realtime_diarization.mdx b/docs/speech-to-text/realtime/realtime_diarization.mdx index 7988dfa..fd5b57d 100644 --- a/docs/speech-to-text/realtime/realtime_diarization.mdx +++ b/docs/speech-to-text/realtime/realtime_diarization.mdx @@ -228,7 +228,7 @@ When you're finished with a channel, you can signal that it's no longer in use b } ``` -Once this happens, the channel will stop accepting or processing any additional data. When all channels are closed, the session ends. +Once this happens, the channel will stop accepting or processing any additional data. When all channels are closed, the session ends. This may be more convenient to use when you don't want to keep track of the number of open channels in a given stream. You can also use [EndOfStream](../../api-ref/realtime-transcription-websocket#endofstream) to simultaneously close all channels. This may be more convenient to use when you know you want to close all channels at the same time.