Avvenimenti mill-klijent għas-server
F'din il-paġna
Il-messaġġi li tibgħat
L-API tal-Aġent Vuċi taħdem billi tiskambja avvenimenti JSON fuq WebSocket. F’din il-lezzjoni, se tgħaddi minn kull avveniment li l-app tiegħek tista’ tibgħat lis-server. Kull wieħed għandu rwol speċifiku fiċ-ċiklu tal-konversazzjoni.
| Avveniment | Deskrizzjoni | Meta tużah |
|---|---|---|
| session.update | Ikkonfigura s-sessjoni | Fil-bidu u biex tbiddel il-konfigurazzjoni |
| input_audio_buffer.append | Ibgħat biċċa awdjo f'base64 | Kontinwament waqt ir-rekording |
| input_audio_buffer.commit | Ikkonferma l-buffer tal-awdjo | Fil-modalità push-to-talk |
| input_audio_buffer.clear | Battal il-buffer mingħajr ma tipproċessa | Biex tikkanċella rekording |
| conversation.item.create | Żid messaġġ jew riżultat ta' funzjoni | Storja, kuntest, riżultati ta' funzjonijiet |
| conversation.item.delete | Ħassar element bl-ID tiegħu | Biex tnaddaf il-konversazzjoni |
| response.create | Itlob tweġiba | Fil-modalità manwali (awtomatiku bil-VAD) |
| response.cancel | Ikkanċella tweġiba għaddejja | Meta l-utent jinterrompi |
conversation.item.create
Dan l-avveniment jippermettilek li tinjetta messaġġi fil-konversazzjoni mingħajr ma tgħaddi mill-fluss tal-awdjo. Jkopri tliet każijiet ewlenin.
Żid messaġġ ta’ test tal-utent
{
"type": "conversation.item.create",
"item": {
"type": "message",
"role": "user",
"content": [
{
"type": "input_text",
"text": "What's the status of my order 12345?"
}
]
}
}
Injetta l-istorja tal-konversazzjoni
Qabel ma tibda l-konversazzjoni bil-vuċi, tista’ timla minn qabel l-istorja b’skambji preċedenti biex tagħti kuntest lill-aġent:
{
"type": "conversation.item.create",
"item": {
"type": "message",
"role": "assistant",
"content": [
{
"type": "text",
"text": "Hello, I'm your assistant. How can I help you?"
}
]
}
}
Irritorna riżultat ta’ funzjoni
Wara li funzjoni tkun ġiet eżegwita, tibgħat lura r-riżultat b’dan l-avveniment (ara l-lezzjoni 13 dwar is-sejħa tal-funzjonijiet):
{
"type": "conversation.item.create",
"item": {
"type": "function_call_output",
"call_id": "call_abc123",
"output": "{\"status\": \"shipped\", \"tracking\": \"FR123456789\"}"
}
}
conversation.item.delete
Iħassar element tal-konversazzjoni bl-ID tiegħu:
{
"type": "conversation.item.delete",
"item_id": "item_audio_001"
}
Dan huwa utli biex tneħħi messaġġ żbaljat jew biex iżżomm l-istorja tal-konversazzjoni milli tikber wisq.
response.create u response.cancel
response.create jitlob espliċitament lis-server biex jiġġenera tweġiba. Fil-modalità VAD, is-server jagħmel dan waħdu ladarba jiskopri t-tmiem tad-diskors:
{
"type": "response.create"
}
response.cancel iwaqqaf tweġiba li qed tiġi ġġenerata. Huwa utli meta l-utent jitkellem fuq l-aġent:
{
"type": "response.cancel"
}
Punti Ewlenin
- Tmien tipi ta’ avvenimenti jistgħu jintbagħtu mill-klijent lis-server
session.updatejikkonfigura s-sessjoni u jista’ jintbagħat diversi drabiconversation.item.createjippermettilek iżżid test, storja, jew riżultati ta’ funzjonijietresponse.createhuwa meħtieġ fil-modalità manwali u awtomatiku fil-modalità VADresponse.canceljippermettilek tinterrompi l-aġent meta l-utent jerġa’ jibda jitkellem