Събития от клиент към сървър
На тази страница
Съобщенията, които изпращате
Voice Agent API работи чрез размяна на JSON събития през WebSocket. В този урок ще разгледате всяко събитие, което Вашето приложение може да изпрати до сървъра. Всяко от тях има специфична роля в цикъла на разговора.
| Събитие | Описание | Кога да го използвате |
|---|---|---|
| session.update | Конфигуриране на сесията | При стартиране и за промяна на конфигурацията |
| input_audio_buffer.append | Изпращане на аудио чанк в base64 | Непрекъснато по време на запис |
| input_audio_buffer.commit | Фиксиране на аудио буфера | В режим „натисни и говори“ |
| input_audio_buffer.clear | Изпразване на буфера без обработка | За отмяна на запис |
| conversation.item.create | Добавяне на съобщение или резултат от функция | История, контекст, резултати от функции |
| conversation.item.delete | Изтриване на елемент по ID | Почистване на разговора |
| response.create | Заявка за генериране на отговор | В ръчен режим (автоматично при VAD) |
| response.cancel | Отмяна на отговор в процес на генериране | Когато потребителят прекъсне |
conversation.item.create
Това събитие Ви позволява да инжектирате съобщения в разговора, без да минавате през аудио потока. То обхваща три основни случая.
Добавяне на текстово съобщение от потребителя
{
"type": "conversation.item.create",
"item": {
"type": "message",
"role": "user",
"content": [
{
"type": "input_text",
"text": "What's the status of my order 12345?"
}
]
}
}
Инжектиране на история на разговора
Преди гласовият разговор да започне, можете предварително да попълните историята с предишни размени, за да осигурите контекст на агента:
{
"type": "conversation.item.create",
"item": {
"type": "message",
"role": "assistant",
"content": [
{
"type": "text",
"text": "Hello, I'm your assistant. How can I help you?"
}
]
}
}
Връщане на резултат от функция
След изпълнението на дадена функция, изпращате резултата обратно чрез това събитие (вижте урок 13 за извикване на функции):
{
"type": "conversation.item.create",
"item": {
"type": "function_call_output",
"call_id": "call_abc123",
"output": "{\"status\": \"shipped\", \"tracking\": \"FR123456789\"}"
}
}
conversation.item.delete
Изтрива елемент от разговора по неговия ID:
{
"type": "conversation.item.delete",
"item_id": "item_audio_001"
}
Това е полезно за премахване на грешно съобщение или за предотвратяване на прекомерното нарастване на историята на разговора.
response.create и response.cancel
response.create изрично иска от сървъра да генерира отговор. В режим VAD сървърът прави това автоматично, щом открие края на речта:
{
"type": "response.create"
}
response.cancel спира отговор, който се генерира в момента. Това е полезно, когато потребителят говори върху агента:
{
"type": "response.cancel"
}
Ключови изводи
- Осем типа събития могат да бъдат изпратени от клиента към сървъра
session.updateконфигурира сесията и може да се изпраща няколко пътиconversation.item.createВи позволява да добавяте текст, история или резултати от функцииresponse.createе задължително в ръчен режим и автоматично в режим VADresponse.cancelВи позволява да прекъснете агента, когато потребителят започне да говори отново