You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit cf834b6
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: client/rtvi-standard.mdx
+12-8Lines changed: 12 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -391,27 +391,35 @@ What the user said or typed. The observer sends one for each transcription (befo
391
391
392
392
#### bot-output 🤖
393
393
394
-
The best-effort representation of the bot's output text, including both spoken and unspoken text. In addition to transcriptions of spoken text, this message type may also include text that the bot outputs but does not speak (e.g., text sent to the client for display purposes only). Along with the text, this event includes a `text_type` field to indicate what the text represents (e.g. "sentence", "word", "code", "url") and fields describing whether and how far the bot has spoken it.
394
+
The best-effort representation of the bot's output text, including both spoken and unspoken text. In addition to transcriptions of spoken text, this message type may also include text that the bot outputs but does not speak (e.g., text sent to the client for display purposes only). Along with the text, this event includes an `output_type` field to indicate what the text represents (e.g. "sentence", "word", "code", "url") and fields describing whether and how far the bot has spoken it.
395
395
396
396
The bot's output is split into segments, such as sentences, each with its own `segment_id`. For clients of protocol 2.0.0 or later, a spoken segment is reported as it is spoken:
397
397
398
398
- If the TTS service reports word timestamps, the server sends the segment once with `spoken_status: "new"` before it is spoken, then again as each word is spoken, with `spoken_status: "in-progress"` and the last with `"completed"`. Every message carries the segment's full `text` and the same `segment_id`.
399
399
- Otherwise, the server sends the segment once, with `spoken_status: "completed"`, after it is spoken.
400
400
401
-
Text the bot won't speak is sent once, with `will_be_spoken: false` and `spoken_status: "new"`. Clients of protocol 2.0.0 or later don't receive separate `bot-output` messages for individual words (`text_type``"word"`); word-level progress is in `spoken_progress` instead. Clients on 1.x receive each spoken word as its own message and should read `spoken`.
401
+
Text the bot won't speak is sent once, with `will_be_spoken: false` and `spoken_status: "new"`. Clients of protocol 2.0.0 or later don't receive separate `bot-output` messages for individual words (`output_type``"word"`); word-level progress is in `spoken_progress` instead. Clients on 1.x receive each spoken word as its own message and should read `spoken`.
402
402
403
403
-**type**: `'bot-output'`
404
404
-**data**:
405
405
-**text**: `string`
406
406
407
407
The output text from the bot.
408
408
409
-
-**text_type**: `string`
409
+
-**output_type**: `string`
410
410
411
-
Indicates what kind of text this is (e.g., "sentence", "word", "code", "url"). "sentence", "word", and "backchannel" are reserved text types defined by the RTVI standard. Other text types may be defined by custom text aggregators used by the server.
411
+
Indicates what kind of text this is (e.g., "sentence", "word", "code", "url"). "sentence", "word", and "backchannel" are reserved output types defined by the RTVI standard. Other output types may be defined by custom text aggregators used by the server.
412
412
413
413
A short acknowledgment the bot says, such as "Mm-hmm.", has type `backchannel`. It is only sent to clients of protocol 2.2.0 or later.
414
414
415
+
-**text_type**: `string` (deprecated)
416
+
417
+
Deprecated. Use `output_type` instead, which carries the same value. Will be removed in 2.0.0.
418
+
419
+
-**aggregated_by**: `string` (deprecated)
420
+
421
+
Deprecated. Use `output_type` instead, which carries the same value. Will be removed in 2.0.0.
422
+
415
423
-**segment_id**: `number` (optional)
416
424
417
425
Identifies the segment this text belongs to, so a client can match a segment's `"new"`, `"in-progress"`, and `"completed"` messages.
@@ -439,10 +447,6 @@ Text the bot won't speak is sent once, with `will_be_spoken: false` and `spoken_
439
447
440
448
Indicates if this text was spoken by the bot. Clients of protocol 2.0.0 or later should read `will_be_spoken` and `spoken_status` instead.
441
449
442
-
-**aggregated_by**: `string`
443
-
444
-
Deprecated. Use `text_type` instead. The server sends both fields with the same value.
Copy file name to clipboardExpand all lines: llms-full.txt
+12-8Lines changed: 12 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -22835,27 +22835,35 @@ What the user said or typed. The observer sends one for each transcription (befo
22835
22835
22836
22836
#### bot-output 🤖
22837
22837
22838
-
The best-effort representation of the bot's output text, including both spoken and unspoken text. In addition to transcriptions of spoken text, this message type may also include text that the bot outputs but does not speak (e.g., text sent to the client for display purposes only). Along with the text, this event includes a `text_type` field to indicate what the text represents (e.g. "sentence", "word", "code", "url") and fields describing whether and how far the bot has spoken it.
22838
+
The best-effort representation of the bot's output text, including both spoken and unspoken text. In addition to transcriptions of spoken text, this message type may also include text that the bot outputs but does not speak (e.g., text sent to the client for display purposes only). Along with the text, this event includes an `output_type` field to indicate what the text represents (e.g. "sentence", "word", "code", "url") and fields describing whether and how far the bot has spoken it.
22839
22839
22840
22840
The bot's output is split into segments, such as sentences, each with its own `segment_id`. For clients of protocol 2.0.0 or later, a spoken segment is reported as it is spoken:
22841
22841
22842
22842
- If the TTS service reports word timestamps, the server sends the segment once with `spoken_status: "new"` before it is spoken, then again as each word is spoken, with `spoken_status: "in-progress"` and the last with `"completed"`. Every message carries the segment's full `text` and the same `segment_id`.
22843
22843
- Otherwise, the server sends the segment once, with `spoken_status: "completed"`, after it is spoken.
22844
22844
22845
-
Text the bot won't speak is sent once, with `will_be_spoken: false` and `spoken_status: "new"`. Clients of protocol 2.0.0 or later don't receive separate `bot-output` messages for individual words (`text_type` `"word"`); word-level progress is in `spoken_progress` instead. Clients on 1.x receive each spoken word as its own message and should read `spoken`.
22845
+
Text the bot won't speak is sent once, with `will_be_spoken: false` and `spoken_status: "new"`. Clients of protocol 2.0.0 or later don't receive separate `bot-output` messages for individual words (`output_type` `"word"`); word-level progress is in `spoken_progress` instead. Clients on 1.x receive each spoken word as its own message and should read `spoken`.
22846
22846
22847
22847
- **type**: `'bot-output'`
22848
22848
- **data**:
22849
22849
- **text**: `string`
22850
22850
22851
22851
The output text from the bot.
22852
22852
22853
-
- **text_type**: `string`
22853
+
- **output_type**: `string`
22854
22854
22855
-
Indicates what kind of text this is (e.g., "sentence", "word", "code", "url"). "sentence", "word", and "backchannel" are reserved text types defined by the RTVI standard. Other text types may be defined by custom text aggregators used by the server.
22855
+
Indicates what kind of text this is (e.g., "sentence", "word", "code", "url"). "sentence", "word", and "backchannel" are reserved output types defined by the RTVI standard. Other output types may be defined by custom text aggregators used by the server.
22856
22856
22857
22857
A short acknowledgment the bot says, such as "Mm-hmm.", has type `backchannel`. It is only sent to clients of protocol 2.2.0 or later.
22858
22858
22859
+
- **text_type**: `string` (deprecated)
22860
+
22861
+
Deprecated. Use `output_type` instead, which carries the same value. Will be removed in 2.0.0.
22862
+
22863
+
- **aggregated_by**: `string` (deprecated)
22864
+
22865
+
Deprecated. Use `output_type` instead, which carries the same value. Will be removed in 2.0.0.
22866
+
22859
22867
- **segment_id**: `number` (optional)
22860
22868
22861
22869
Identifies the segment this text belongs to, so a client can match a segment's `"new"`, `"in-progress"`, and `"completed"` messages.
@@ -22883,10 +22891,6 @@ Text the bot won't speak is sent once, with `will_be_spoken: false` and `spoken_
22883
22891
22884
22892
Indicates if this text was spoken by the bot. Clients of protocol 2.0.0 or later should read `will_be_spoken` and `spoken_status` instead.
22885
22893
22886
-
- **aggregated_by**: `string`
22887
-
22888
-
Deprecated. Use `text_type` instead. The server sends both fields with the same value.
0 commit comments