Skip to content

Commit 36c6ea4

Browse files
Merge pull request #2028 from eric-urban/eur/realtime-howto
realtime how-to updates
2 parents b6c34c0 + d3db1f3 commit 36c6ea4

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

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

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ The client `input_audio_buffer.append` event is used to append audio bytes to th
143143

144144
In Server VAD (Voice Activity Detection) mode, the audio buffer is used to detect speech and the server decides when to commit. When server VAD is disabled, the client can choose how much audio to place in each event up to a maximum of 15 MiB. For example, streaming smaller chunks from the client can allow the VAD to be more responsive.
145145

146-
Unlike made other client events, the server doesn't send a confirmation response to client `input_audio_buffer.append` event.
146+
Unlike most other client events, the server doesn't send a confirmation response to client `input_audio_buffer.append` event.
147147

148148
#### Event structure
149149

@@ -1117,18 +1117,28 @@ The item to add to the conversation.
11171117

11181118
### RealtimeConversationRequestItem
11191119

1120+
You use the `RealtimeConversationRequestItem` object to create a new item in the conversation via the [conversation.item.create](#realtimeclienteventconversationitemcreate) event.
1121+
11201122
| Field | Type | Description |
11211123
|-------|------|-------------|
11221124
| type | [RealtimeItemType](#realtimeitemtype) | The type of the item. |
1123-
| id | string | The unique ID of the item. |
1125+
| id | string | The unique ID of the item. The ID can be specified by the client to help manage server-side context. If the client doesn't provide an ID, the server generates one. |
11241126

11251127
### RealtimeConversationResponseItem
11261128

1129+
The `RealtimeConversationResponseItem` object represents an item in the conversation. It's used in some of the server events, such as:
1130+
1131+
- [conversation.item.created](#realtimeservereventconversationitemcreated)
1132+
- [response.output_item.added](#realtimeservereventresponseoutputitemadded)
1133+
- [response.output_item.done](#realtimeservereventresponseoutputitemdone)
1134+
- [`response.created`](#realtimeservereventresponsecreated) (via the `response` property type [`RealtimeResponse`](#realtimeresponse))
1135+
- [`response.done`](#realtimeservereventresponsedone) (via the `response` property type [`RealtimeResponse`](#realtimeresponse))
1136+
11271137
| Field | Type | Description |
11281138
|-------|------|-------------|
1129-
| object | string | The conversation response item.<br><br>Allowed values: `realtime.item` |
1130-
| type | [RealtimeItemType](#realtimeitemtype) | The type of the item. |
1131-
| id | string | The unique ID of the item.<br><br>This property is nullable. |
1139+
| object | string | The identifier for the returned API object.<br><br>Allowed values: `realtime.item` |
1140+
| type | [RealtimeItemType](#realtimeitemtype) | The type of the item.<br><br>Allowed values: `message`, `function_call`, `function_call_output` |
1141+
| id | string | The unique ID of the item. The ID can be specified by the client to help manage server-side context. If the client doesn't provide an ID, the server generates one.<br><br>This property is nullable. |
11321142

11331143
### RealtimeFunctionTool
11341144

0 commit comments

Comments
 (0)