admin-valentin/WhisperLiveKit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update api

Browse source
This commit is contained in:
Quentin Fuxa 2025-10-05 11:09:12 +02:00
parent 73f36cc0ef
commit 8434ef5efc
1 changed files with 25 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

53
docs/API.md
View file

@ -13,24 +13,24 @@ WLK provides real-time speech transcription, speaker diarization, and translatio
The current API sends complete state snapshots on each update (several time per second) The current API sends complete state snapshots on each update (several time per second)
```json ```typescript
{ {
"type": "transcript_update", "type": str,
"status": "active_transcription", "status": str,
"lines": [ "lines": [
{ {
"speaker": 1, "speaker": int,
"text": "Complete transcription text", "text": str,
"start": "0:00:05", "start": float,
"end": "0:00:08", "end": float,
"translation": "Optional translation", "translation": str | null,
"detected_language": "en" "detected_language": str
} }
], ],
"buffer_transcription": "pending transcription...", "buffer_transcription": str,
"buffer_diarization": "pending diarization...", "buffer_diarization": str,
"remaining_time_transcription": 0.5, "remaining_time_transcription": float,
"remaining_time_diarization": 0.3 "remaining_time_diarization": float
} }
``` ```
@ -181,7 +181,7 @@ The API sends **only changed or new segments**. Clients should:
When language is detected for a segment: When language is detected for a segment:
```json ```jsonc
// Update 1: No language yet // Update 1: No language yet
{ {
"segments": [ "segments": [
@ -205,7 +205,7 @@ Buffers are **per-segment** to handle multi-speaker scenarios correctly.
#### Example: Translation with diarization and translation #### Example: Translation with diarization and translation
```json ```jsonc
// Update 1 // Update 1
{ {
"segments": [ "segments": [
@ -223,13 +223,12 @@ Buffers are **per-segment** to handle multi-speaker scenarios correctly.
] ]
} }
"""
== Frontend ==
<SPEAKER>1</SPEAKER> // ==== Frontend ====
<TRANSCRIPTION>Hello world, how are <DIARIZATION BUFFER> you on</DIARIZATION BUFFER></TRANSCRIPTION> // <SPEAKER>1</SPEAKER>
<TRANSLATION><TRANSLATION BUFFER>Bonjour le monde</TRANSLATION BUFFER></TRANSLATION> // <TRANSCRIPTION>Hello world, how are <DIARIZATION BUFFER> you on</DIARIZATION BUFFER></TRANSCRIPTION>
""" // <TRANSLATION><TRANSLATION BUFFER>Bonjour le monde</TRANSLATION BUFFER></TRANSLATION>
// Update 2 // Update 2
{ {
@ -248,20 +247,18 @@ Buffers are **per-segment** to handle multi-speaker scenarios correctly.
] ]
} }
"""
== Frontend ==
<SPEAKER>1</SPEAKER> // ==== Frontend ====
<TRANSCRIPTION>Hello world, how are you on this<DIARIZATION BUFFER> beautiful day</DIARIZATION BUFFER></TRANSCRIPTION> // <SPEAKER>1</SPEAKER>
<TRANSLATION>Bonjour tout le monde<TRANSLATION BUFFER>, comment</TRANSLATION BUFFER><TRANSLATION> // <TRANSCRIPTION>Hello world, how are you on this<DIARIZATION BUFFER> beautiful day</DIARIZATION BUFFER></TRANSCRIPTION>
""" // <TRANSLATION>Bonjour tout le monde<TRANSLATION BUFFER>, comment</TRANSLATION BUFFER><TRANSLATION>
``` ```
### Silence Segments ### Silence Segments
Silence is represented with the speaker id = `-2`: Silence is represented with the speaker id = `-2`:
```json ```jsonc
{ {
"id": 5, "id": 5,
"speaker": -2, "speaker": -2,