- HTTP isteği
- Yol parametreleri
- İstek metni
- Yanıt metni
- UserInput
- InputType
- DeviceProperties
- Yüzey
- Konum
- LatLng
- Çıkış
- Tuval
- İstem
- Basit
- İçerik
- Kart
- Resim
- ImageFill
- Bağlantı
- OpenUrl
- UrlHint
- Tablo
- TableColumn
- HorizontalAlignment
- TableRow
- TableCell
- Medya
- MediaType
- OptionalMediaControls
- MediaObject
- MediaImage
- Toplama
- CollectionItem
- Liste
- ListItem
- Öneri
- Teşhis
- ExecutionEvent
- ExecutionState
- Slotlar
- SlotFillingStatus
- Yuva
- SlotMode
- SlotStatus
- Durum
- UserConversationInput
- IntentMatch
- ConditionsEvaluated
- Durum
- OnSceneEnter
- WebhookRequest
- WebhookResponse
- WebhookInitiatedTransition
- SlotMatch
- SlotRequested
- SlotValidated
- FormFilled
- WaitingForUserInput
- EndConversation
İleti dizisinin bir turunu oynatır.
HTTP isteği
POST https://actions.googleapis.com/v2/{project=projects/*}:sendInteraction
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
Yol parametreleri
Parametreler | |
---|---|
project |
Zorunlu. Proje Kimliği ile belirtilen, test edilmekte olan proje. Biçim: projeler/{project} |
İstek içeriği
İstek gövdesi, aşağıdaki yapıyla birlikte veriler içerir:
JSON gösterimi | |
---|---|
{ "input": { object ( |
Alanlar | |
---|---|
input |
Zorunlu. Kullanıcı tarafından sağlanan giriş. |
deviceProperties |
Zorunlu. İşlemle etkileşim kurmak için kullanılan cihazın özellikleri. |
conversationToken |
Önceki etkileşimde SendEngagementResponse'tan alınması gereken opak jeton. Bu ayar, test oturumunun ilk etkileşimi olarak yeni bir görüşme başlatmak için veya önceki bir görüşmeyi bırakıp yeni bir görüşme başlatmak üzere ayarlanmadan bırakılabilir. |
Yanıt gövdesi
Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:
Sohbette verilen bir tura verilen yanıt.
JSON gösterimi | |
---|---|
{ "output": { object ( |
Alanlar | |
---|---|
output |
Kullanıcıya sağlanan çıkış. |
diagnostics |
İsteğin nasıl işlendiğini açıklayan teşhis bilgileri. |
conversationToken |
Aynı ileti dizisini sürdürmek için sonraki RPC çağrısında SendEngagementRequest'te ayarlanacak opak jeton. |
UserInput
Görüşme sırasında kullanıcı girişi sağlanır.
JSON gösterimi | |
---|---|
{
"query": string,
"type": enum ( |
Alanlar | |
---|---|
query |
Kullanıcı tarafından gönderilen girişin içeriği. |
type |
Girişin türü. |
InputType
Giriş kaynağını, yazılan sorguyu veya sesli sorguyu belirtir.
Sıralamalar | |
---|---|
INPUT_TYPE_UNSPECIFIED |
Belirtilmemiş giriş kaynağı. |
TOUCH |
GUI etkileşiminden sorgu. |
VOICE |
Sesli sorgu'ya dokunun. |
KEYBOARD |
Yazılan sorgu. |
URL |
İşlem, bir URL bağlantısı tarafından tetiklendi. |
DeviceProperties
Bir görüşmeyle ilgili cihazın özellikleri.
JSON gösterimi | |
---|---|
{ "surface": enum ( |
Alanlar | |
---|---|
surface |
İşlemle etkileşim için kullanılan yüzey. |
location |
Enlem, boylam ve biçimlendirilmiş adres gibi cihaz konumu. |
locale |
Cihazda belirlenen yerel ayar. Biçim, BCP 47'ye uygun olmalıdır: https://tools.ietf.org/html/bcp47 Örnekler: en, en-US, es-419 (daha fazla örnek için https://tools.ietf.org/html/bcp47#appendix-A) adresine bakın.) |
timeZone |
Cihazda ayarlandığı şekliyle saat dilimi. Biçim, IANA Saat Dilimi Veritabanı'na uygun olmalıdır (ör. "America/New_York": https://www.iana.org/time-zones) |
Platform
İşlemle etkileşim kurmak için kullanılan olası yüzeyler. Gelecekte başka değerler de eklenebilir.
Sıralamalar | |
---|---|
SURFACE_UNSPECIFIED |
Varsayılan değer. Bu değer kullanılmıyor. |
SPEAKER |
Hoparlör (ör. Google Home). |
PHONE |
Telefon'a dokunun. |
ALLO |
Allo Sohbeti. |
SMART_DISPLAY |
Akıllı Ekran Cihazı. |
KAI_OS |
KaiOS'ta mevcut. |
Konum
Bir konumu temsil eden kapsayıcı.
JSON gösterimi | |
---|---|
{
"coordinates": {
object ( |
Alanlar | |
---|---|
coordinates |
Coğrafi koordinatlar. [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] iznini gerektirir. |
formattedAddress |
Görünen adres, ör. "Talatpaşa Bulvarı No.: 22, İstanbul, 34111". [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] iznini gerektirir. |
zipCode |
Posta kodu. [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] veya [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] iznini gerektirir. |
city |
Şehir. [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] veya [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] iznini gerektirir. |
LatLng
Enlem/boylam çiftini temsil eden bir nesne. Bu, enlem ve boylam derecelerini temsil eden bir çift çiftle ifade edilir. Aksi belirtilmedikçe bu nesne WGS84 standardına uygun olmalıdır. Değerler normalleştirilmiş aralıklar içinde olmalıdır.
JSON gösterimi | |
---|---|
{ "latitude": number, "longitude": number } |
Alanlar | |
---|---|
latitude |
Derece cinsinden enlem. [-90.0, +90.0] aralığında olmalıdır. |
longitude |
Derece cinsinden boylam. [-180.0, +180.0] aralığında olmalıdır. |
Çıkış
Görüşme turu için kullanıcı tarafından görülebilen çıkış.
JSON gösterimi | |
---|---|
{ "text": string, "speech": [ string ], "canvas": { object ( |
Alanlar | |
---|---|
text |
Kullanıcıya düz dize olarak gönderilen sözlü yanıt. |
speech[] |
İşlem tarafından oluşturulan konuşma içeriği. Bu, SSML gibi işaretleme öğelerini içerebilir. |
canvas |
Etkileşimli Canvas içeriği. |
actionsBuilderPrompt |
Görüşme turunun sonundaki istemin durumu. İstem hakkında daha fazla bilgi: https://developers.google.com/assistant/conversational/prompts |
Tuval
Kullanıcıya gönderilecek Etkileşimli Tuval yanıtını temsil eder. Bu, etkileşimli bir tuval yanıtı görüntülemenin yanı sıra kullanıcıyla konuşmayı içeren istemdeki "first Simple" alanıyla birlikte kullanılabilir. Yanıtın maksimum boyutu 50.000 bayttır.
JSON gösterimi | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean, "enableFullScreen": boolean } |
Alanlar | |
---|---|
url |
Yüklenecek etkileşimli tuval web uygulamasının URL'si. Ayarlanmazsa mevcut etkin tuvaldeki URL yeniden kullanılır. |
data[] |
İsteğe bağlı. Kapsamlı deneyim web sayfasına etkinlik olarak aktarılacak JSON verileri. İçeren istemdeki "geçersiz kıl" alanı "false" (yanlış) değerine sahipse bu Canvas isteminde tanımlanan veri değerleri önceki Canvas istemlerinde tanımlanan veri değerlerinden sonra eklenir. |
suppressMic |
İsteğe bağlı. Varsayılan değer: false. |
enableFullScreen |
|
İstem
Kullanıcıya verilen yanıtı temsil etme.
JSON gösterimi | |
---|---|
{ "append": boolean, "override": boolean, "firstSimple": { object ( |
Alanlar | |
---|---|
append |
İsteğe bağlı. Bu mesajların önceden tanımlanmış iletilerle nasıl birleştirileceğini belirleyen mod. "false", önceden tanımlanmış tüm iletileri (ilk ve son basit, içerik, öneriler bağlantısı ve tuval) temizler ve bu istemde tanımlanan iletileri ekler. "true", bu istemde tanımlanan mesajları önceki yanıtlarda tanımlanan iletilere ekler. Bu alanın "true" (doğru) değerine ayarlanması, Basit istemler, Öneri istemi ve Kanvas istemi (İçerik isteminin bir bölümü) içindeki bazı alanlara da eklenmesini sağlar. İstemde tanımlanırsa İçerik ve Bağlantı mesajlarının her zaman üzerine yazılır. Varsayılan değer "false" (yanlış) değeridir. |
override |
İsteğe bağlı. Bu mesajların önceden tanımlanmış iletilerle nasıl birleştirileceğini belirleyen mod. "true", önceden tanımlanmış tüm iletileri (ilk ve son basit, içerik, öneriler bağlantısı ve tuval) temizler ve bu istemde tanımlanan iletileri ekler. "false", bu istemde tanımlanan iletileri önceki yanıtlarda tanımlanan iletilere ekler. Bu alanın "false" olarak bırakılması, Basit istemler, Öneriler istemi ve Tuval istemi (İçerik isteminin bir bölümü) içindeki bazı alanlara da eklenmesine olanak tanır. İstemde tanımlanırsa İçerik ve Bağlantı mesajlarının her zaman üzerine yazılır. Varsayılan değer "false" (yanlış) değeridir. |
firstSimple |
İsteğe bağlı. İlk sesli ve yalnızca metin yanıtı. |
content |
İsteğe bağlı. Kullanıcıya gösterilecek kart, liste veya medya gibi bir içerik. |
lastSimple |
İsteğe bağlı. Sesli ve yalnızca metin içeren son yanıt. |
suggestions[] |
İsteğe bağlı. Öneriler her zaman yanıtın sonunda görünür ve kullanıcıya gösterilir. İçeren istemdeki "geçersiz kıl" alanı "false" (yanlış) değerine ayarlanırsa bu alanda tanımlanan başlıklar, önceden tanımlanmış öneri istemlerinde tanımlanan başlıklara eklenir ve yinelenen değerler kaldırılır. |
link |
İsteğe bağlı. İlişkilendirilmiş uygulamaya veya siteye bağlantı verebilen ek bir öneri çipi. Çip, "Aç |
canvas |
İsteğe bağlı. Kullanıcıya gönderilecek Etkileşimli Tuval yanıtını temsil eder. |
Basit
Kullanıcıya gönderilecek basit bir istemi temsil eder.
JSON gösterimi | |
---|---|
{ "speech": string, "text": string } |
Alanlar | |
---|---|
speech |
İsteğe bağlı. Kullanıcıya konuşulacak konuşmayı temsil eder. SSML veya metin okuma olabilir. İçeren istemdeki "geçersiz kıl" alanı "true" (doğru) değerine sahipse bu alanda tanımlanan konuşma, önceki Basit istemin konuşmasının yerini alır. |
text |
Sohbet balonunda gösterilecek isteğe bağlı metin. Sağlanmazsa yukarıdaki konuşma alanının bir ekran oluşturma işlemi kullanılır. Uzunluk sınırı 640 karakterdir. İçeren istemdeki "geçersiz kıl" alanı "true" (doğru) değerine sahipse bu alanda tanımlanan metin, önceki Basit istemin metniyle değiştirilir. |
İçerik
Gösterilecek içerik.
JSON gösterimi | |
---|---|
{ // Union field |
Alanlar | ||
---|---|---|
content alanı. İçerik. content şunlardan yalnızca biri olabilir: |
||
card |
Temel bir kart. |
|
image |
Bir resim. |
|
table |
Tablo kartı. |
|
media |
Oynatılacak medya grubunu belirten yanıt. |
|
canvas |
Etkileşimli tuval deneyimi için kullanılacak bir yanıt. |
|
collection |
Aralarından seçim yapabileceğiniz bir dizi seçenek sunan kart. |
|
list |
Aralarından seçim yapabileceğiniz seçeneklerin listesini gösteren bir kart. |
Kart
Bazı bilgileri (ör. resim ve/veya metin) gösteren temel bir kart.
JSON gösterimi | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
Alanlar | |
---|---|
title |
Kartın genel başlığı. İsteğe bağlı. |
subtitle |
İsteğe bağlı. |
text |
Kartın gövde metni. Biçimlendirme için sınırlı bir Markdown söz dizimini destekler. Resim yoksa gereklidir. |
image |
Kartın lokomotif resmi. Yükseklik 192 dp'ye sabitlenir. İsteğe bağlı. |
imageFill |
Resim arka planının nasıl doldurulacağı. İsteğe bağlı. |
button |
Düğme. İsteğe bağlı. |
Resim
Kartta gösterilen bir resim.
JSON gösterimi | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
Alanlar | |
---|---|
url |
Resmin kaynak URL'si. Resimler JPG, PNG ve GIF (animasyonlu ve animasyonsuz) olabilir. Örneğin, |
alt |
Erişilebilirlik için kullanılacak resmin metin açıklaması (ör. ekran okuyucular). Zorunlu. |
height |
Resmin piksel cinsinden yüksekliği. İsteğe bağlı. |
width |
Resmin piksel cinsinden genişliği. İsteğe bağlı. |
ImageFill
Resmin sunumunu etkilemek için kullanılabilecek olası resim görüntüleme seçenekleri. Bu, resmin en boy oranı, resim kapsayıcısının en boy oranıyla eşleşmediğinde kullanılmalıdır.
Sıralamalar | |
---|---|
UNSPECIFIED |
Resim dolgusu belirtilmedi. |
GRAY |
Resim ile resim kapsayıcısı arasındaki boşlukları gri çubuklarla doldurun. |
WHITE |
Resim ile resim kapsayıcısı arasındaki boşlukları beyaz çubuklarla doldurun. |
CROPPED |
Resim, resim genişliği ve yüksekliği kapsayıcı boyutlarıyla eşleşecek veya bu boyutları aşacak şekilde ölçeklendirilir. Ölçeklendirilmiş resmin yüksekliği kapsayıcı yüksekliğinden fazlaysa resmin üst ve alt kısmı kırpılabilir. Ölçeklendirilmiş resmin genişliği kapsayıcı genişliğinden fazlaysa resmin sol ve sağ tarafı kırpılabilir. Bu, 4:3 oranındaki bir video oynatırken geniş ekran TV'deki "Yakınlaştırma Modu"na benzer. |
Bağlantı
İçeriği bağlayın.
JSON gösterimi | |
---|---|
{
"name": string,
"open": {
object ( |
Alanlar | |
---|---|
name |
Bağlantının adı |
open |
Bir kullanıcı bağlantıyı açtığında ne olur? |
OpenUrl
Kullanıcı bir bağlantıyı açtığında gerçekleştirilen işlem.
JSON gösterimi | |
---|---|
{
"url": string,
"hint": enum ( |
Alanlar | |
---|---|
url |
Şunlardan herhangi biri olabilecek URL alanı: - Uygulamayla Bağlantılı Uygulama veya web sayfası açmak için http/https URL'leri |
hint |
URL türüyle ilgili bir ipucu gösterir. |
UrlHint
Farklı URL ipucu türleri.
Sıralamalar | |
---|---|
LINK_UNSPECIFIED |
Belirtilmedi |
AMP |
Doğrudan AMP içeriğine veya aracılığıyla AMP içeriğine başvuruda bulunan standart bir URL'ye yönlendiren URL. |
Tablo
Metin tablosunu gösteren tablo kartı.
JSON gösterimi | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Alanlar | |
---|---|
title |
Tablonun genel başlığı. İsteğe bağlıdır ancak altyazı ayarlanmışsa ayarlanmalıdır. |
subtitle |
Tablonun alt başlığı. İsteğe bağlı. |
image |
Tabloyla ilişkilendirilen resim. İsteğe bağlı. |
columns[] |
Başlıklar ve sütunların hizalaması. |
rows[] |
Tablonun satır verileri. İlk 3 satırın gösterilmesi garanti edilir ancak diğerleri belirli yüzeylerde kesilebilir. Belirli bir yüzey için hangi satırların gösterileceğini görmek üzere lütfen simülatörle test yapın. WEB_BROWSER işlevini destekleyen yüzeylerde kullanıcıyı daha fazla veri içeren bir web sayfasına yönlendirebilirsiniz. |
button |
Düğme. |
TableColumn
Tablodaki bir sütunu açıklar.
JSON gösterimi | |
---|---|
{
"header": string,
"align": enum ( |
Alanlar | |
---|---|
header |
Sütunun başlık metni. |
align |
İçeriğin sütunla yatay hizalaması. Belirtilmemişse içerik ön kenara hizalanır. |
HorizontalAlignment
Hücre içindeki içeriğin hizalaması.
Sıralamalar | |
---|---|
UNSPECIFIED |
Belirtilmemiş yatay hizalama. |
LEADING |
Hücrenin baş kenarı. Bu varsayılan seçenektir. |
CENTER |
İçerik, sütunun ortasına hizalanır. |
TRAILING |
İçerik, sütunun son kenarına hizalanır. |
TableRow
Tablodaki bir satırı açıklar.
JSON gösterimi | |
---|---|
{
"cells": [
{
object ( |
Alanlar | |
---|---|
cells[] |
Bu satırdaki hücreler. İlk 3 hücrenin gösterilmesi garanti edilir ancak diğerleri belirli yüzeylerde kesilebilir. Belirli bir yüzey için hangi hücrelerin gösterileceğini görmek üzere lütfen simülatörle test yapın. |
divider |
Her satırdan sonra ayırıcı olup olmadığını gösterir. |
TableCell
Bir satırdaki hücreyi açıklar.
JSON gösterimi | |
---|---|
{ "text": string } |
Alanlar | |
---|---|
text |
Hücrenin metin içeriği. |
Medya
Bir medya nesnesini temsil eder. Medya hakkında ad, açıklama, URL vb. bilgiler içerir.
JSON gösterimi | |
---|---|
{ "mediaType": enum ( |
Alanlar | |
---|---|
mediaType |
Medya türü. |
startOffset |
İlk medya nesnesinin başlangıç ofseti. En fazla dokuz kesir basamağı içeren ve " |
optionalMediaControls[] |
Bu medya yanıt oturumunun destekleyebileceği isteğe bağlı medya denetimi türleri. Ayarlanırsa belirli bir medya etkinliği gerçekleştiğinde 3p'ye istek gönderilir. Ayarlanmazsa 3p yine de TAMAM ve BAŞARISIZ olmak üzere iki varsayılan kontrol türünü işlemelidir. |
mediaObjects[] |
Medya Nesneleri Listesi |
MediaType
Bu yanıtın medya türü.
Sıralamalar | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
Medya türü belirtilmedi. |
AUDIO |
Ses dosyası. |
MEDIA_STATUS_ACK |
Medya durum raporunu onaylama yanıtı. |
OptionalMediaControls
Medya yanıtının destekleyebileceği isteğe bağlı medya denetimi türleri
Sıralamalar | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
Değer belirtilmemiş |
PAUSED |
Etkinlik duraklatıldı. Kullanıcı medyayı duraklattığında tetiklenir. |
STOPPED |
Etkinlik durduruldu. Kullanıcı, medya oynatma sırasında 3p oturumundan çıktığında tetiklenir. |
MediaObject
Tek bir medya nesnesini temsil eder
JSON gösterimi | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
Alanlar | |
---|---|
name |
Bu medya nesnesinin adı. |
description |
Bu medya nesnesinin açıklaması. |
url |
Medya içeriğini işaret eden URL. |
image |
Medya kartıyla birlikte gösterilecek resim. |
MediaImage
Medya kartıyla birlikte gösterilecek resim.
JSON gösterimi | |
---|---|
{ // Union field |
Alanlar | ||
---|---|---|
image alanı. Resim. image şunlardan yalnızca biri olabilir: |
||
large |
Albümün kapağı vb. büyük bir resim. |
|
icon |
Başlığın sağında gösterilen küçük resim simgesi. 36x36 dp olarak yeniden boyutlandırıldı. |
Koleksiyon
Aralarından seçim yapabileceğiniz bir dizi seçeneği sunan kart.
JSON gösterimi | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
Alanlar | |
---|---|
title |
Koleksiyonun başlığı. İsteğe bağlı. |
subtitle |
Koleksiyonun alt başlığı. İsteğe bağlı. |
items[] |
min: 2 maks.: 10 |
imageFill |
Koleksiyon öğelerinin resim arka planlarının nasıl doldurulacağı. İsteğe bağlı. |
CollectionItem
Koleksiyondaki bir öğe
JSON gösterimi | |
---|---|
{ "key": string } |
Alanlar | |
---|---|
key |
Zorunlu. İlişkili Tür'deki giriş anahtarı adıyla eşleşen NLU anahtarı. |
Liste
Aralarından seçim yapabileceğiniz seçeneklerin listesini sunan bir kart.
JSON gösterimi | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
Alanlar | |
---|---|
title |
Listenin başlığı. İsteğe bağlı. |
subtitle |
Listenin alt başlığı. İsteğe bağlı. |
items[] |
min: 2 maks.: 30 |
ListItem
Listedeki bir öğe
JSON gösterimi | |
---|---|
{ "key": string } |
Alanlar | |
---|---|
key |
Zorunlu. İlişkili Tür'deki giriş anahtarı adıyla eşleşen NLU anahtarı. |
Öneri
Kullanıcıya sunulacak öneri.
JSON gösterimi | |
---|---|
{ "title": string } |
Alanlar | |
---|---|
title |
Zorunlu. Öneri çipinde gösterilen metin. Bu metine dokunulduğunda, kullanıcı yazmış gibi, görüşmede aynen geri gönderilir. Öneri çipi grubundaki her başlık benzersiz olmalıdır. Maks. 25 karakter |
Teşhisler
Görüşme turuyla ilgili teşhis bilgileri.
JSON gösterimi | |
---|---|
{
"actionsBuilderEvents": [
{
object ( |
Alanlar | |
---|---|
actionsBuilderEvents[] |
Actions Builder etkileşim modelinin aşamalarında görüşme turunun işlenmesiyle ilgili ayrıntıları içeren etkinliklerin listesi. Yalnızca Actions Builder & Actions SDK'sı uygulamaları için doldurulur. |
ExecutionEvent
Actions Builder görüşme isteği işlenirken gerçekleşen yürütme etkinliğiyle ilgili bilgileri içerir. Bir görüşme isteğinde yer alan aşamalara genel bakış için https://developers.google.com/assistant/conversational/actions adresine göz atın.
JSON gösterimi | |
---|---|
{ "eventTime": string, "executionState": { object ( |
Alanlar | ||
---|---|---|
eventTime |
Etkinliğin gerçekleştiği zaman damgası. Nanosaniye çözünürlüğe ve en fazla dokuz kesir basamağına sahip, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: |
|
executionState |
Bu etkinlik sırasındaki yürütme durumu. |
|
status |
Belirli bir yürütme adımının sonuç durumu. |
|
warningMessages[] |
Bu etkinliğin yürütülmesi sırasında oluşturulan uyarıların listesi. Uyarılar, görüşme isteği sırasında keşfedilen geliştiriciye yönelik ipuçlarıdır. Bunlar genellikle kritik değildir ve isteğin yürütülmesini durdurmaz. Örneğin, webhook, mevcut olmayan bir özel Türü geçersiz kılmaya çalıştığında uyarı oluşturulabilir. Hatalar başarısız durum kodu olarak raporlanır ancak durum normal olsa bile uyarılar gösterilebilir. |
|
EventData alanı. Bir görüşmenin yürütülmesine dahil olabilecek farklı etkinliklere özel ayrıntılı bilgiler. Burada ayarlanan alan bu etkinliğin türünü tanımlar. EventData şunlardan yalnızca biri olabilir: |
||
userInput |
Kullanıcı girişini işleme etkinliği. |
|
intentMatch |
Amaç eşleştirme etkinliği. |
|
conditionsEvaluated |
Durum değerlendirme etkinliği. |
|
onSceneEnter |
OnSceneEnter yürütme etkinliği. |
|
webhookRequest |
Webhook isteği gönderme etkinliği. |
|
webhookResponse |
Webhook yanıt makbuzu etkinliği. |
|
webhookInitiatedTransition |
Webhook tarafından başlatılan geçiş etkinliği. |
|
slotMatch |
Slot eşleştirme etkinliği. |
|
slotRequested |
Etkinlik isteyen alan. |
|
slotValidated |
Slot doğrulama etkinliği. |
|
formFilled |
Form doldurma etkinliği. |
|
waitingUserInput |
User-input etkinliği bekleniyor. |
|
endConversation |
Görüşme sonu etkinliği. |
ExecutionState
Yürütmenin mevcut durumu.
JSON gösterimi | |
---|---|
{ "currentSceneId": string, "sessionStorage": { object }, "slots": { object ( |
Alanlar | |
---|---|
currentSceneId |
Şu anda etkin olan sahnenin kimliği. |
sessionStorage |
Oturum depolama alanının durumu: https://developers.google.com/assistant/conversational/storage-session |
slots |
Varsa alanların doldurulma durumu: https://developers.google.com/assistant/conversational/scenes#slot_filling |
promptQueue[] |
İstem sırası: https://developers.google.com/assistant/conversational/prompts |
userStorage |
Kullanıcı depolama alanının durumu: https://developers.google.com/assistant/conversational/storage-user |
householdStorage |
Ev depolama alanının durumu: https://developers.google.com/assistant/conversational/storage-home |
Slotlar
Sahneye ait yuvaların mevcut durumunu gösterir.
JSON gösterimi | |
---|---|
{ "status": enum ( |
Alanlar | |
---|---|
status |
Slot doldurmanın mevcut durumu. |
slots |
Geçerli sahneyle ilişkilendirilen alanlar.
|
SlotFillingStatus
Slot doldurmanın mevcut durumunu gösterir.
Sıralamalar | |
---|---|
UNSPECIFIED |
Kullanım alanı doldurulmadığında kullanılacak yedek değer. |
INITIALIZED |
Slotlar başlatıldı ancak slot doldurma işlemi başlatılmadı. |
COLLECTING |
Alan değerleri toplanıyor. |
FINAL |
Tüm alan değerleri nihaidir ve değiştirilemez. |
Alan
Bir alanı temsil eder.
JSON gösterimi | |
---|---|
{ "mode": enum ( |
Alanlar | |
---|---|
mode |
Yuvanın modu (zorunlu veya isteğe bağlı). Geliştirici tarafından ayarlanabilir. |
status |
Alanın durumu. |
value |
Alanın değeri. Yanıtta bu değer değiştirildiğinde, slot doldurma değeri de değişir. |
updated |
Slot değerinin son dönüşte toplanıp toplanmadığını gösterir. Bu alan salt okunurdur. |
prompt |
İsteğe bağlı. Gerekli bir alanı doldurması gerektiğinde bu istem kullanıcıya gönderilir. Bu istem, konsolda tanımlanan mevcut istemi geçersiz kılar. Bu alan, webhook isteğine dahil değildir. |
SlotMode
Bir slotun modunu, yani gerekli olup olmadığını gösterir.
Sıralamalar | |
---|---|
MODE_UNSPECIFIED |
Kullanım alanı doldurulmadığında kullanılacak yedek değer. |
OPTIONAL |
Slot doldurma işlemini tamamlamak için gerekli olmadığını gösterir. |
REQUIRED |
Slot doldurmanın tamamlanması için alanın gerekli olduğunu gösterir. |
SlotStatus
Bir alanın durumunu gösterir.
Sıralamalar | |
---|---|
SLOT_UNSPECIFIED |
Kullanım alanı doldurulmadığında kullanılacak yedek değer. |
EMPTY |
Alanın herhangi bir değere sahip olmadığını gösterir. Bu durum, yanıt aracılığıyla değiştirilemez. |
INVALID |
Alan değerinin geçersiz olduğunu belirtir. Bu durum, alınan yanıt aracılığıyla ayarlanabilir. |
FILLED |
Alanda bir değer olduğunu gösterir. Bu durum, yanıt aracılığıyla değiştirilemez. |
Durum
Status
türü, REST API'ler ve RPC API'leri dahil olmak üzere farklı programlama ortamları için uygun bir mantıksal hata modeli tanımlar. gRPC tarafından kullanılır. Her Status
mesajı üç veri parçası içerir: hata kodu, hata mesajı ve hata ayrıntıları.
Bu hata modeli ve modelle nasıl çalışılacağı hakkında daha fazla bilgiyi API Tasarım Kılavuzu'nda bulabilirsiniz.
JSON gösterimi | |
---|---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Alanlar | |
---|---|
code |
|
message |
Geliştiricinin karşılaştığı İngilizce hata mesajı. Kullanıcılara yönelik tüm hata mesajları yerelleştirilip |
details[] |
Hata ayrıntılarını içeren mesajların listesi. API'lerin kullanabileceği yaygın bir dizi mesaj türü vardır. Rastgele türde alanlar içeren bir nesne. |
UserConversationInput
Kullanıcı girişiyle ilgili bilgiler.
JSON gösterimi | |
---|---|
{ "type": string, "originalQuery": string } |
Alanlar | |
---|---|
type |
Kullanıcı girişinin türü. Ör. klavye, ses, dokunma vb. |
originalQuery |
Kullanıcının orijinal metin girişi. |
IntentMatch
Tetiklenen intent eşleştirme ile ilgili bilgiler (genel veya sahne içinde): https://developers.google.com/assistant/conversational/intents
JSON gösterimi | |
---|---|
{
"intentId": string,
"intentParameters": {
string: {
object ( |
Alanlar | |
---|---|
intentId |
Bu etkileşimi tetikleyen amaç kimliği. |
intentParameters |
Bu etkileşimi tetikleyen amaç parametreleri.
|
handler |
Bu etkileşime ekli işleyicinin adı. |
nextSceneId |
Bu etkileşimin götürdüğü sahne. |
ConditionsEvaluated
Durum değerlendirmesinin sonuçları: https://developers.google.com/assistant/conversational/scenes#conditions
JSON gösterimi | |
---|---|
{ "failedConditions": [ { object ( |
Alanlar | |
---|---|
failedConditions[] |
"Yanlış" olarak değerlendirilen koşulların listesi. |
successCondition |
Varsa "doğru" olarak değerlendirilen ilk koşul. |
Koşul
Değerlendirilen koşul.
JSON gösterimi | |
---|---|
{ "expression": string, "handler": string, "nextSceneId": string } |
Alanlar | |
---|---|
expression |
Bu koşulda ifade belirtildi. |
handler |
Değerlendirilen koşulda işleyici adı belirtildi. |
nextSceneId |
Değerlendirilen koşulda belirtilen hedef sahne. |
OnSceneEnter
onSceneEnter aşamasının yürütülmesi hakkında bilgi: https://developers.google.com/assistant/conversational/scenes#onEnter
JSON gösterimi | |
---|---|
{ "handler": string } |
Alanlar | |
---|---|
handler |
onSceneEnter etkinliğinde belirtilen işleyici adı. |
WebhookRequest
İşlem webhook'una gönderilen bir istek hakkında bilgi: https://developers.google.com/assistant/conversational/webhooks#payloads
JSON gösterimi | |
---|---|
{ "requestJson": string } |
Alanlar | |
---|---|
requestJson |
Webhook isteğinin yükü. |
WebhookResponse
İşlem webhook'undan alınan yanıt hakkında bilgi: https://developers.google.com/assistant/conversational/webhooks#payloads
JSON gösterimi | |
---|---|
{ "responseJson": string } |
Alanlar | |
---|---|
responseJson |
Webhook yanıtının yükü |
WebhookInitiatedTransition
Webhook'tan döndürülen hedef sahne tarafından tetiklenen etkinlik: https://developers.google.com/assistant/conversational/webhooks#transition_scenes
JSON gösterimi | |
---|---|
{ "nextSceneId": string } |
Alanlar | |
---|---|
nextSceneId |
Geçişin gittiği sahnenin kimliği. |
SlotMatch
Eşleşen alanlar hakkında bilgi: https://developers.google.com/assistant/conversational/scenes#slot_filling
JSON gösterimi | |
---|---|
{
"nluParameters": {
string: {
object ( |
Alanlar | |
---|---|
nluParameters |
Kullanıcı girişinden NLU tarafından çıkarılan parametreler.
|
SlotRequested
Şu anda istenen alan hakkında bilgi: https://developers.google.com/assistant/conversational/scenes#slot_filling
JSON gösterimi | |
---|---|
{
"slot": string,
"prompt": {
object ( |
Alanlar | |
---|---|
slot |
İstenen alanın adı. |
prompt |
Slot istemi. |
SlotValidated
Alanlar için webhook doğrulaması tamamlandıktan sonra gerçekleşen etkinlik: https://developers.google.com/assistant/conversational/scenes#slot_filling
FormFilled
Form tamamen doldurulduğunda gerçekleşen etkinlik: https://developers.google.com/assistant/conversational/scenes#slot_filling
WaitingForUserInput
Sistemin kullanıcı girişine ihtiyacı olduğunda gerçekleşen etkinlik: https://developers.google.com/assistant/conversational/scenes#input
EndConversation
Temsilciyle görüşmenin sona erdiğini bildiren etkinlik.