Skip to content

Commit 53f6200

Browse files
document start_recognition_timeout error
1 parent bca9aa2 commit 53f6200

File tree

4 files changed

+16
-10
lines changed

4 files changed

+16
-10
lines changed

docs/api-ref/realtime-transcription-websocket.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,7 @@ In the Realtime SaaS, an in-band error message can be followed by a WebSocket cl
169169
| 4005 | `quota_exceeded` |
170170
| 4006 | `timelimit_exceeded` |
171171
| 4013 | `job_error` |
172+
<!-- | 4xxx | `start_recognition_timeout` | TODO -->
172173

173174
{/* Manually generated TOC, since we're using JSX sections */}
174175
export const toc = [

docs/speech-to-text/features/audio-filtering.mdx

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: "Learn how to utilize Audio Filtering to remove background speech"
2+
description: "Learn how to utilize audio filtering to remove background speech"
33
keywords:
44
[
55
speechmatics,
@@ -15,19 +15,19 @@ keywords:
1515
import Tabs from "@theme/Tabs";
1616
import TabItem from "@theme/TabItem";
1717

18-
# Audio Filtering
18+
# Audio filtering
1919

20-
Audio Filtering pre-processes input audio to remove low-volume background speech which might otherwise be detected and transcribed.
20+
Audio filtering pre-processes input audio to remove low-volume background speech which might otherwise be detected and transcribed.
2121

2222
:::info
23-
This can be useful, for example, in a call center to avoid transcribing other agents' speech from the background.
23+
This can be useful, for example, in a call center to avoid transcribing other agents' background speech.
2424
:::
2525

26-
If you're new to Speechmatics, start by exploring our guides on [Transcribing a File](/speech-to-text/batch/quickstart) or [Transcribing in Real-Time](/speech-to-text/realtime/quickstart).
26+
If you're new to Speechmatics, start by exploring our guides on [transcribing a file](/speech-to-text/batch/quickstart) or [transcribing in real-time](/speech-to-text/realtime/quickstart).
2727

2828
## Example
2929

30-
To activate Audio Filtering, include the following configuration:
30+
To activate audio filtering, include the following configuration:
3131

3232
```json
3333
{
@@ -41,13 +41,15 @@ To activate Audio Filtering, include the following configuration:
4141
}
4242
}
4343
```
44-
This will avoid processing any audio which is below the `3.4` volume threshold. For technical details on how this threshold is used see [here](#technical-details)
44+
This will avoid processing any audio which is below the `3.4` volume threshold. For technical details on how this threshold is calculated and used, see [here](#technical-details)
4545

4646
`volume_threshold` supports a range of `0 - 100` where `0` does not filter any audio and `100` removes all audio.
4747

48-
## Volume Labelling
48+
In realtime mode, the threshold can be adjusted dynamically with the [SetRecognitionConfig](/api-ref/realtime-transcription-websocket#setrecognitionconfig) message.
4949

50-
If Audio Filtering is configured, words will be labelled with their volume like this (range for `volume_threshold` is `0-100`):
50+
## Volume labelling
51+
52+
If audio filtering is configured, words will be labelled with their volume like this (the range for `volume_threshold` is `0-100`):
5153

5254
```json
5355
{
@@ -69,7 +71,7 @@ These values can be used as a guide to setting the volume threshold, but we reco
6971

7072
To obtain volume labelling without filtering any audio, supply an empty config object (`{}`) or set the `volume_threshold` to `0.0`.
7173

72-
## Technical Details
74+
## Technical details
7375

7476
Once the audio is in a raw format (16kHz 16bit mono), it is split into 0.01s chunks. For each chunk, the root mean square amplitude of the signal is calculated, and scaled to the range `0 - 100`. If the volume is less than the supplied cut-off, the chunk will be replaced with silence.
7577

spec/flow-api.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,7 @@ components:
234234
- timelimit_exceeded
235235
- quota_exceeded
236236
- unknown_error
237+
- start_recognition_timeout
237238

238239
ToolTypeEnum:
239240
type: string

spec/realtime.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1067,6 +1067,7 @@ components:
10671067
| `data_error` | Unable to accept the data specified - usually because there is too much data being sent at once |
10681068
| `buffer_error` | Unable to fit the data in a corresponding buffer. This can happen for clients sending the input data faster than real-time. |
10691069
| `protocol_error` | Message received was syntactically correct, but could not be accepted due to protocol limitations. This is usually caused by messages sent in the wrong order. |
1070+
| `start_recognition_timeout` | The timeout for sending StartRecognition has been exceeded (SaaS only) |
10701071
| `quota_exceeded` | Maximum number of concurrent connections allowed for the contract has been reached |
10711072
| `timelimit_exceeded` | Usage quota for the contract has been reached |
10721073
| `idle_timeout` | Idle duration limit was reached (no audio data sent within the last hour), a closing handshake with code 1008 follows this in-band error. |
@@ -1093,6 +1094,7 @@ components:
10931094
- data_error
10941095
- buffer_error
10951096
- protocol_error
1097+
- start_recognition_timeout
10961098
- quota_exceeded
10971099
- timelimit_exceeded
10981100
- idle_timeout

0 commit comments

Comments
 (0)