Skip to content

Commit 8d3451f

Browse files
committed
PR feedback on text
1 parent cc81b5e commit 8d3451f

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

articles/ai-services/openai/realtime-audio-reference.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -294,19 +294,19 @@ There are 28 server events that can be received from the server:
294294
| [RealtimeServerEventInputAudioBufferSpeechStopped](#realtimeservereventinputaudiobufferspeechstopped) | Server event in server turn detection mode when speech stops. |
295295
| [RealtimeServerEventRateLimitsUpdated](#realtimeservereventratelimitsupdated) | Emitted after every "response.done" event to indicate the updated rate limits. |
296296
| [RealtimeServerEventResponseAudioDelta](#realtimeservereventresponseaudiodelta) | Server event when the model-generated audio is updated. |
297-
| [RealtimeServerEventResponseAudioDone](#realtimeservereventresponseaudiodone) | Server event when the model-generated audio is done. Also emitted when a response is interrupted, incomplete, or cancelled. |
297+
| [RealtimeServerEventResponseAudioDone](#realtimeservereventresponseaudiodone) | Server event when the model-generated audio is done. Also emitted when a response is interrupted, incomplete, or canceled. |
298298
| [RealtimeServerEventResponseAudioTranscriptDelta](#realtimeservereventresponseaudiotranscriptdelta) | Server event when the model-generated transcription of audio output is updated. |
299-
| [RealtimeServerEventResponseAudioTranscriptDone](#realtimeservereventresponseaudiotranscriptdone) | Server event when the model-generated transcription of audio output is done streaming. Also emitted when a response is interrupted, incomplete, or cancelled. |
299+
| [RealtimeServerEventResponseAudioTranscriptDone](#realtimeservereventresponseaudiotranscriptdone) | Server event when the model-generated transcription of audio output is done streaming. Also emitted when a response is interrupted, incomplete, or canceled. |
300300
| [RealtimeServerEventResponseContentPartAdded](#realtimeservereventresponsecontentpartadded) | Server event when a new content part is added to an assistant message item during response generation. |
301-
| [RealtimeServerEventResponseContentPartDone](#realtimeservereventresponsecontentpartdone) | Server event when a content part is done streaming in an assistant message item. Also emitted when a response is interrupted, incomplete, or cancelled. |
301+
| [RealtimeServerEventResponseContentPartDone](#realtimeservereventresponsecontentpartdone) | Server event when a content part is done streaming in an assistant message item. Also emitted when a response is interrupted, incomplete, or canceled. |
302302
| [RealtimeServerEventResponseCreated](#realtimeservereventresponsecreated) | Server event when a new Response is created. The first event of response creation, where the response is in an initial state of "in_progress". |
303303
| [RealtimeServerEventResponseDone](#realtimeservereventresponsedone) | Server event when a response is done streaming. Always emitted, no matter the final state. |
304304
| [RealtimeServerEventResponseFunctionCallArgumentsDelta](#realtimeservereventresponsefunctioncallargumentsdelta) | Server event when the model-generated function call arguments are updated. |
305-
| [RealtimeServerEventResponseFunctionCallArgumentsDone](#realtimeservereventresponsefunctioncallargumentsdone) | Server event when the model-generated function call arguments are done streaming. Also emitted when a response is interrupted, incomplete, or cancelled. |
305+
| [RealtimeServerEventResponseFunctionCallArgumentsDone](#realtimeservereventresponsefunctioncallargumentsdone) | Server event when the model-generated function call arguments are done streaming. Also emitted when a response is interrupted, incomplete, or canceled. |
306306
| [RealtimeServerEventResponseOutputItemAdded](#realtimeservereventresponseoutputitemadded) | Server event when a new output item is added to a response. |
307-
| [RealtimeServerEventResponseOutputItemDone](#realtimeservereventresponseoutputitemdone) | Server event when an output item is done streaming. Also emitted when a response is interrupted, incomplete, or cancelled. |
307+
| [RealtimeServerEventResponseOutputItemDone](#realtimeservereventresponseoutputitemdone) | Server event when an output item is done streaming. Also emitted when a response is interrupted, incomplete, or canceled. |
308308
| [RealtimeServerEventResponseTextDelta](#realtimeservereventresponsetextdelta) | Server event when the model-generated text is updated. |
309-
| [RealtimeServerEventResponseTextDone](#realtimeservereventresponsetextdone) | Server event when the model-generated text is done. Also emitted when a response is interrupted, incomplete, or cancelled. |
309+
| [RealtimeServerEventResponseTextDone](#realtimeservereventresponsetextdone) | Server event when the model-generated text is done. Also emitted when a response is interrupted, incomplete, or canceled. |
310310
| [RealtimeServerEventSessionCreated](#realtimeservereventsessioncreated) | Server event when a session is created. |
311311
| [RealtimeServerEventSessionUpdated](#realtimeservereventsessionupdated) | Server event when a session is updated. |
312312

@@ -662,7 +662,7 @@ The server `response.audio.delta` event is returned when the model-generated aud
662662

663663
The server `response.audio.done` event is returned when the model-generated audio is done.
664664

665-
This event is also returned when a response is interrupted, incomplete, or cancelled.
665+
This event is also returned when a response is interrupted, incomplete, or canceled.
666666

667667
#### Event structure
668668

@@ -718,7 +718,7 @@ The server `response.audio_transcript.delta` event is returned when the model-ge
718718

719719
The server `response.audio_transcript.done` event is returned when the model-generated transcription of audio output is done streaming.
720720

721-
This event is also returned when a response is interrupted, incomplete, or cancelled.
721+
This event is also returned when a response is interrupted, incomplete, or canceled.
722722

723723
#### Event structure
724724

@@ -781,7 +781,7 @@ The server `response.content_part.added` event is returned when a new content pa
781781

782782
The server `response.content_part.done` event is returned when a content part is done streaming in an assistant message item.
783783

784-
This event is also returned when a response is interrupted, incomplete, or cancelled.
784+
This event is also returned when a response is interrupted, incomplete, or canceled.
785785

786786
#### Event structure
787787

@@ -882,7 +882,7 @@ The server `response.function_call_arguments.delta` event is returned when the m
882882

883883
The server `response.function_call_arguments.done` event is returned when the model-generated function call arguments are done streaming.
884884

885-
This event is also returned when a response is interrupted, incomplete, or cancelled.
885+
This event is also returned when a response is interrupted, incomplete, or canceled.
886886

887887
#### Event structure
888888

@@ -935,7 +935,7 @@ The server `response.output_item.added` event is returned when a new item is cre
935935

936936
The server `response.output_item.done` event is returned when an item is done streaming.
937937

938-
This event is also returned when a response is interrupted, incomplete, or cancelled.
938+
This event is also returned when a response is interrupted, incomplete, or canceled.
939939

940940
#### Event structure
941941

@@ -988,7 +988,7 @@ The server `response.text.delta` event is returned when the model-generated text
988988

989989
The server `response.text.done` event is returned when the model-generated text is done streaming. The text corresponds to the `text` content part of an assistant message item.
990990

991-
This event is also returned when a response is interrupted, incomplete, or cancelled.
991+
This event is also returned when a response is interrupted, incomplete, or canceled.
992992

993993
#### Event structure
994994

@@ -1258,7 +1258,7 @@ The definition of a function tool as used by the realtime endpoint.
12581258
| status | [RealtimeResponseStatus](#realtimeresponsestatus) | The status of the response.<br><br>The default status value is `in_progress`. |
12591259
| status_details | [RealtimeResponseStatusDetails](#realtimeresponsestatusdetails) | The details of the response status.<br><br>This property is nullable. |
12601260
| output | array of [RealtimeConversationResponseItem](#realtimeconversationresponseitem) | The output items of the response. |
1261-
| usage | object | Usage statistics for the response. Each Realtime API session maintains a conversation context and append new items to the conversation. Output from previous turns (text and audio tokens) are input for later turns.<br><br>See nested properties next.|
1261+
| usage | object | Usage statistics for the response. Each Realtime API session maintains a conversation context and appends new items to the conversation. Output from previous turns (text and audio tokens) is input for later turns.<br><br>See nested properties next.|
12621262
| + total_tokens | integer | The total number of tokens in the Response including input and output text and audio tokens.<br><br>A property of the `usage` object. |
12631263
| + input_tokens | integer | The number of input tokens used in the response, including text and audio tokens.<br><br>A property of the `usage` object. |
12641264
| + output_tokens | integer | The number of output tokens sent in the response, including text and audio tokens.<br><br>A property of the `usage` object. |
@@ -1420,7 +1420,7 @@ The response resource.
14201420
| type | string | The type of turn detection.<br><br>Allowed values: `server_vad` |
14211421
| threshold | number | The activation threshold for the server VAD turn detection. In noisy environments, you might need to increase the threshold to avoid false positives. In quiet environments, you might need to decrease the threshold to avoid false negatives.<br><br>Defaults to `0.5`. You can set the threshold to a value between `0.0` and `1.0`. |
14221422
| prefix_padding_ms | string | The duration of speech audio (in milliseconds) to include before the start of detected speech.<br><br>Defaults to `300`. |
1423-
| silence_duration_ms | string | The duration of silence (in milliseconds) to detect the end of speech. You want to detect the end of speech as soon as possible, but not too soon to avoid cutting off the last part of the speech.<br><br>The model will response more quickly if you set this value to a lower number, but it might cut off the last part of the speech. If you set this value to a higher number, the model will wait longer to detect the end of speech, but it might take longer to respond. |
1423+
| silence_duration_ms | string | The duration of silence (in milliseconds) to detect the end of speech. You want to detect the end of speech as soon as possible, but not too soon to avoid cutting off the last part of the speech.<br><br>The model will respond more quickly if you set this value to a lower number, but it might cut off the last part of the speech. If you set this value to a higher number, the model will wait longer to detect the end of speech, but it might take longer to respond. |
14241424

14251425
### RealtimeSessionBase
14261426

0 commit comments

Comments
 (0)