Imeachtaí ón gcliaint go dtí an freastalaí
Ar an leathanach seo
Na teachtaireachtaí a sheolann tú
Oibríonn API an Ghníomhaire Gutha trí imeachtaí JSON a mhalartú thar WebSocket. Sa cheacht seo, rachaidh tú trí gach imeacht is féidir le d’fheidhmchlár a sheoladh chuig an freastalaí. Tá ról sonrach ag gach ceann acu sa timthriall comhrá.
| Imeacht | Cur síos | Cathain é a úsáid |
|---|---|---|
| session.update | Cumraigh an seisiún | Ag am tosaithe agus chun an chumraíocht a athrú |
| input_audio_buffer.append | Seol smután fuaite base64 | Go leanúnach agus tú ag taifeadadh |
| input_audio_buffer.commit | Daingnigh an maolán fuaime | I mód brú-chun-labhairt (push-to-talk) |
| input_audio_buffer.clear | Folúigh an maolán gan próiseáil | Chun taifeadadh a chealú |
| conversation.item.create | Cuir teachtaireacht nó toradh feidhme leis | Stair, comhthéacs, torthaí feidhme |
| conversation.item.delete | Scrios mír de réir a haitheantóra | Ag glanadh an chomhrá |
| response.create | Iarr freagra | I mód láimhe (uathoibríoch le VAD) |
| response.cancel | Cealaigh freagra atá ar siúl | Nuair a chuireann an t-úsáideoir isteach air |
conversation.item.create
Ligeann an t-imeacht seo duit teachtaireachtaí a instealladh isteach sa chomhrá gan dul tríd an sruth fuaime. Clúdaíonn sé trí phríomhchás.
Teachtaireacht téacs ón úsáideoir a chur leis
{
"type": "conversation.item.create",
"item": {
"type": "message",
"role": "user",
"content": [
{
"type": "input_text",
"text": "What's the status of my order 12345?"
}
]
}
}
Stair an chomhrá a instealladh
Sula dtosaíonn an comhrá gutha, is féidir leat an stair a líonadh roimh ré le malartuithe níos luaithe chun comhthéacs a thabhairt don ghníomhaire:
{
"type": "conversation.item.create",
"item": {
"type": "message",
"role": "assistant",
"content": [
{
"type": "text",
"text": "Hello, I'm your assistant. How can I help you?"
}
]
}
}
Toradh feidhme a thabhairt ar ais
Tar éis glaonna feidhme a rith, seolann tú an toradh ar ais leis an imeacht seo (féach ceacht 13 ar ghlaonna feidhme):
{
"type": "conversation.item.create",
"item": {
"type": "function_call_output",
"call_id": "call_abc123",
"output": "{\"status\": \"shipped\", \"tracking\": \"FR123456789\"}"
}
}
conversation.item.delete
Scriosann sé mír comhrá de réir a aitheantóra:
{
"type": "conversation.item.delete",
"item_id": "item_audio_001"
}
Tá sé seo úsáideach chun teachtaireacht mhícheart a bhaint nó chun cosc a chur ar stair an chomhrá fás ró-mhór.
response.create agus response.cancel
Iarrann response.create go sonrach ar an bhfreastalaí freagra a ghiniúint. I mód VAD, déanann an freastalaí é seo leis féin a luaithe a bhrathann sé deireadh na cainte:
{
"type": "response.create"
}
Stopann response.cancel freagra atá á ghiniúint. Tá sé úsáideach nuair a labhraíonn an t-úsáideoir thar an ngníomhaire:
{
"type": "response.cancel"
}
Príomhphointí
- Is féidir ocht gcineál imeachta a sheoladh ón gcliaint chuig an bhfreastalaí
- Cumraíonn
session.updatean seisiún agus is féidir é a sheoladh roinnt uaireanta - Ligeann
conversation.item.createduit téacs, stair, nó torthaí feidhme a chur leis - Teastaíonn
response.createi mód láimhe agus tá sé uathoibríoch i mód VAD - Ligeann
response.cancelduit cur isteach ar an ngníomhaire nuair a thosaíonn an t-úsáideoir ag caint arís