- HTTP isteği
- Yol parametreleri
- İstek gövdesi
- Yanıt metni
- UserInput
- InputType
- Cihaz Özellikleri
- Yüzey
- Yer
- LatLng
- Çıkış
- Kanvas
- İstem
- Basit
- İçerik
- Kart
- Resim
- ImageFill
- Bağlantı
- OpenUrl
- UrlHint
- Tablo
- TableColumn
- HorizontalAlignment
- TableRow
- TableCell
- Medya
- MediaType
- OptionalMediaControls
- MediaObject
- MediaImage
- Koleksiyon
- CollectionItem
- Liste
- ListItem
- Öneri
- Teşhis
- ExecutionEvent
- ExecutionState
- Slotlar
- SlotFillingStatus
- Slot
- SlotMode
- SlotStatus
- Durum
- UserConversationInput
- IntentMatch
- ConditionsEvaluated
- Durum
- OnSceneEnter
- WebhookRequest
- WebhookResponse
- WebhookInitiatedTransition
- SlotMatch
- SlotRequested
- SlotValidated
- FormFilled
- WaitingForUserInput
- EndConversation
Sohbetin 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. Test edilen proje (Proje Kimliği ile belirtilir). Biçim: projeler/{proje} |
İstek içeriği
İstek gövdesi, aşağıdaki yapıya sahip verileri içerir:
JSON gösterimi | |
---|---|
{ "input": { object ( |
Alanlar | |
---|---|
input |
Zorunlu. Kullanıcı tarafından sağlanan giriş. |
deviceProperties |
Zorunlu. İşlemle etkileşim için kullanılan cihazın özellikleri. |
conversationToken |
Önceki etkileşimde SendEngagementResponse'tan alınmış olarak iletilmesi gereken opak jeton. Yeni bir sohbet başlatmak için test oturumunun ilk etkileşimi olarak veya önceki bir sohbetten vazgeçip yeni bir sohbet başlatmak için bu değer ayarlanmadan bırakılabilir. |
Yanıt gövdesi
Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:
Konuşmanın bir turuna 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ı görüşmeye devam etmek için bir sonraki RPC çağrısında SendEngagementRequest'e ayarlanacak opak jeton. |
UserInput
Bir görüşme turunda kullanıcı girişi sağlandı.
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 gösterir.
Sıralamalar | |
---|---|
INPUT_TYPE_UNSPECIFIED |
Belirtilmemiş giriş kaynağı. |
TOUCH |
Bir GUI etkileşiminden yapılan sorgu. |
VOICE |
Sesli sorgu. |
KEYBOARD |
Yazılan sorgu. |
URL |
İşlem bir URL bağlantısı tarafından tetiklendi. |
Cihaz Özellikleri
Cihazın bir görüşme turuyla ilgili özellikleri.
JSON gösterimi | |
---|---|
{ "surface": enum ( |
Alanlar | |
---|---|
surface |
İşlem ile 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). |
timeZone |
Cihazda ayarlanan 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 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 Sohbet'e dokunun. |
SMART_DISPLAY |
Akıllı Ekran Cihazı. |
KAI_OS |
KaiOS'a dokunun. |
Konum
Bir konumu temsil eden kapsayıcı.
JSON gösterimi | |
---|---|
{
"coordinates": {
object ( |
Alanlar | |
---|---|
coordinates |
Coğrafi koordinatlar. [DEVICE_PRECISE_LOCATION] gerekir [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] izni. |
formattedAddress |
Görünen adres, ör. "Basın Sitesi Mahallesi, 215 Sokak, Karabağlar, İzmir 35150". [DEVICE_PRECISE_LOCATION] gerekir [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] izni. |
zipCode |
Posta kodu. [DEVICE_PRECISE_LOCATION] gerekir [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] veya [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] izni. |
city |
Şehir. [DEVICE_PRECISE_LOCATION] gerekir [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] veya [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] izni. |
LatLng
Enlem/boylam çiftini temsil eden bir nesne. Bu, enlem ve boylam derecelerini temsil eden bir çift çift olarak 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 turunda kullanıcının görebildiği çı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 Tuval 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, "firstSimple" ile birlikte kullanılabilir. kullanıcıyla konuşmak için istemdeki alana girin. Yanıtın maksimum boyutu 50 bin bayttır.
JSON gösterimi | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean, "enableFullScreen": boolean } |
Alanlar | |
---|---|
url |
Yüklenecek etkileşimli kanvas web uygulamasının URL'si. Ayarlanmazsa mevcut etkin tuvaldeki URL yeniden kullanılır. |
data[] |
İsteğe bağlı. Tam sayfa deneyim web sayfasına etkinlik olarak aktarılacak JSON verileri. "Geçersiz kıl" içeren istemdeki alanın "false" olması Bu Canvas isteminde tanımlanan veri değerleri, önceki Canvas istemlerinde tanımlanan veri değerlerinden sonra eklenecek. |
suppressMic |
İsteğe bağlı. Varsayılan değer: false. |
enableFullScreen |
|
İstem
Bir kullanıcıya verilen yanıtı temsil etme.
JSON gösterimi | |
---|---|
{ "append": boolean, "override": boolean, "firstSimple": { object ( |
Alanlar | |
---|---|
append |
İsteğe bağlı. Bu iletilerin önceden tanımlanmış iletilerle birleştirilme şekli. "yanlış" önceden tanımlanmış tüm iletileri (ilk ve son basit, içerik, öneri bağlantısı ve tuval) temizler ve bu istemde tanımlanan iletileri ekler. "true" (doğru) bu istemde tanımlanan iletileri önceki yanıtlarda tanımlanan iletilere ekler. Bu alanın "true" olarak ayarlanması Basit istemler, Öneri istemi ve Kanvas istemi (İçerik isteminin bir parçası) içindeki bazı alanlara ekleme özelliğini de etkinleştirir. İstemde tanımlanırsa İçerik ve Bağlantı iletilerinin üzerine her zaman yazılır. Varsayılan değer "false"tur. |
override |
İsteğe bağlı. Bu iletilerin önceden tanımlanmış iletilerle birleştirilme şekli. "true" (doğru) önceden tanımlanmış tüm iletileri (ilk ve son basit, içerik, öneri bağlantısı ve tuval) temizler ve bu istemde tanımlanan iletileri ekler. "yanlış" bu istemde tanımlanan iletileri önceki yanıtlarda tanımlanan iletilere ekler. Bu alan "false" olarak bırakılıyor Basit istemler, Öneriler istemi ve Kanvas istemi (İçerik isteminin bir parçası) içindeki bazı alanlara da ekleme yapılabilir. İstemde tanımlanırsa İçerik ve Bağlantı iletilerinin her zaman üzerine yazılır. Varsayılan değer "false"tur. |
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ı. Son sesli ve yalnızca metin yanıt. |
suggestions[] |
İsteğe bağlı. Kullanıcıya gösterilecek öneriler. Bunlar, her zaman yanıtın sonunda gösterilir. "Geçersiz kıl" alanına "false" (yanlış) değeri eklenirse bu alanda tanımlanan başlıklar, önceden tanımlanmış tüm öneri istemlerinde tanımlanan başlıklara eklenir ve yinelenen değerler kaldırılır. |
link |
İsteğe bağlı. İlişkili uygulama veya siteye bağlantı verebilecek 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önderilmesi için basit bir istemi temsil eder.
JSON gösterimi | |
---|---|
{ "speech": string, "text": string } |
Alanlar | |
---|---|
speech |
İsteğe bağlı. Kullanıcıya söylenecek konuşmayı temsil eder. SSML veya metin okuma olabilir. "Geçersiz kıl" alanındaki istem "true" değerine ayarlandığında, bu alanda tanımlanan konuşma önceki Basit istemin konuşmasının yerini alır. |
text |
Sohbet balonunda görüntülenecek isteğe bağlı metin. Belirtilmezse yukarıdaki konuşma alanının görüntülemesi kullanılır. Uzunluk sınırı 640 karakterdir. "Geçersiz kıl" alanındaki istem "true" ise bu alanda tanımlanan metin önceki Basit istemin metniyle değiştirilir. |
İçerik
Gösterilecek içerik.
JSON gösterimi | |
---|---|
{ // Union field |
Alanlar | ||
---|---|---|
Birleştirme alanı content . İçerik. content şunlardan yalnızca biri olabilir: |
||
card |
Temel kart. |
|
image |
Bir resim. |
|
table |
Tablo kartı. |
|
media |
Oynatılacak bir grup medyayı gösteren yanıt. |
|
canvas |
Etkileşimli tuval deneyimi için kullanılacak yanıt. |
|
collection |
Bir dizi seçenek sunan kart. |
|
list |
Seçebileceğiniz seçeneklerin listesini sunan bir kart. |
Kart
Bazı bilgileri görüntülemek için kullanılan temel kart, ör. bir resim ve/veya metin.
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 dizimi grubunu destekler. Resim mevcut olmadığı sürece gereklidir. |
image |
Kart için hero resim. Yükseklik 192 dp olarak sabitlendi. İ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 bir resim gösteriliyor.
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 etkileyecek olası resim görüntüleme seçenekleri. Bu, resmin en boy oranı, görüntü kapsayıcısının en boy oranıyla eşleşmediğinde kullanılmalıdır.
Sıralamalar | |
---|---|
UNSPECIFIED |
Belirtilmemiş resim dolgusu. |
GRAY |
Resim ile görüntü kapsayıcısı arasındaki boşlukları gri çubuklarla doldurun. |
WHITE |
Resim ile görüntü kapsayıcısı arasındaki boşlukları beyaz çubuklarla doldurun. |
CROPPED |
Resim, genişlik ve yüksekliğinin kapsayıcı boyutlarıyla eşleşecek veya bu boyutların üzerinde olacak şekilde ölçeklendirilir. Bu işlemde, ölçeklendirilmiş resim yüksekliği kapsayıcı yüksekliğinden fazlaysa resmin üst ve alt kısmı kırpılabilir. Ölçeklendirilmiş resim genişliği kapsayıcı genişliğinden fazlaysa resmin sol ve sağ kısmı kırpılabilir. Bu, "Yakınlaştırma Modu"na benzer TV'de YouTube TV'yi izlemeye devam edebilirsiniz. |
Bağlantı
Bağlantı içeriği.
JSON gösterimi | |
---|---|
{
"name": string,
"open": {
object ( |
Alanlar | |
---|---|
name |
Bağlantının adı |
open |
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ı: - Uygulamaya bağlı bir uygulamayı veya web sayfasını açmak için http/https urls |
hint |
URL türüyle ilgili bir ipucunu gösterir. |
UrlHint
Farklı URL ipuçları 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 URL'ye yönlendiren URL. |
Tablo
Bir 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 alt başlık 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österileceği garanti edilir ancak diğerleri belirli yüzeylerde kesilebilir. Belirli bir yüzeyde hangi satırların gösterileceğini görmek için lütfen simülasyon aracıyla test edin. WEB_BROWSER özelliğini 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 |
İçerik sütunuyla yatay hizalama. Belirtilmemişse içerik ön kenarla hizalanır. |
HorizontalAlignment
Hücredeki içeriğin hizalaması.
Sıralamalar | |
---|---|
UNSPECIFIED |
Belirtilmemiş yatay hizalama. |
LEADING |
Hücrenin ön kenarı. Bu, varsayılan ayardır. |
CENTER |
İçerik, sütunun ortasına hizalanır. |
TRAILING |
İçerik, sütunun son kenarıyla 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österileceği 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ülasyon aracıyla test yapın. |
divider |
Her satırdan sonra bir ayırıcı olması gerekip gerekmediğini belirtir. |
TableCell
Bir satırdaki bir 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 gibi bilgileri içerir.
JSON gösterimi | |
---|---|
{ "mediaType": enum ( |
Alanlar | |
---|---|
mediaType |
Medya türü. |
startOffset |
İlk medya nesnesinin başlangıç ofseti. En fazla dokuz kesirli basamağa sahip, " |
optionalMediaControls[] |
Bu medya yanıtı oturumunun destekleyebileceği isteğe bağlı medya kontrolü türleri. Ayarlanırsa belirli bir medya etkinliği gerçekleştiğinde 3. tarafa istek gönderilir. Ayarlanmazsa 3p yine de TAMAMLANDI 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 |
Belirtilmemiş medya türü. |
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 kontrolü türleri
Sıralamalar | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
Belirtilmemiş değer |
PAUSED |
Etkinlik duraklatıldı. Kullanıcı medyayı duraklattığında tetiklenir. |
STOPPED |
Etkinlik durduruldu. Kullanıcı, medya oynatma sırasında 3. oturumdan çı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 gösteren URL. |
image |
Medya kartıyla gösterilecek resim. |
MediaImage
Medya kartıyla gösterilecek resim.
JSON gösterimi | |
---|---|
{ // Union field |
Alanlar | ||
---|---|---|
Birleştirme alanı image . Resim. image şunlardan yalnızca biri olabilir: |
||
large |
Albümün kapağı gibi büyük bir resim. |
|
icon |
Başlığın sağında küçük bir resim simgesi görüntülenir. 36x36 dp olarak yeniden boyutlandırıldı. |
Koleksiyon
Aralarından seçim yapabileceğiniz bir dizi seçenek sunan bir 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[] |
minimum: 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ürdeki giriş anahtarı adıyla eşleşen NLU anahtarı. |
Liste
Seçebileceğ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[] |
minimum: 2 maks: 30 |
ListItem
Listedeki bir öğe
JSON gösterimi | |
---|---|
{ "key": string } |
Alanlar | |
---|---|
key |
Zorunlu. İlişkili Türdeki giriş anahtarı adıyla eşleşen NLU anahtarı. |
Öneri
Kullanıcıya sunulacak giriş önerisi.
JSON gösterimi | |
---|---|
{ "title": string } |
Alanlar | |
---|---|
title |
Zorunlu. Öneri çipinde gösterilen metin. Bu metin dokunulduğunda, kullanıcı yazmış gibi görüşmede olduğu gibi yayınlanır. Her başlık, öneri çipi grubu içinde benzersiz olmalıdır. Maksimum 25 karakter |
Teşhis
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. Actions Builder ve Yalnızca Actions SDK uygulamaları. |
ExecutionEvent
Actions Builder görüşme isteği işlenirken gerçekleşen yürütme etkinliğiyle ilgili bilgileri içerir. Sohbet isteğinde kullanılan 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ı. RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Ö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, geliştiriciye görüşme isteği sırasında keşfedilen 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ı gösterilebilir. |
|
Birleştirme alanı EventData . Görüşme turunun işlenmesine 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şi işleme etkinliği. |
|
intentMatch |
Intent 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 |
Alan eşleştirme etkinliği. |
|
slotRequested |
Alan isteğinde bulunan etkinlik. |
|
slotValidated |
Alan doğrulama etkinliği. |
|
formFilled |
Form doldurma etkinliği. |
|
waitingUserInput |
Kullanıcı giriş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 |
Alanlar doldurulduğunda durum (varsa): 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 |
Yuvalar
Bir sahnenin alanlarının mevcut durumunu temsil eder.
JSON gösterimi | |
---|---|
{ "status": enum ( |
Alanlar | |
---|---|
status |
Boşluk doldurma işleminin mevcut durumu. |
slots |
Geçerli sahneyle ilişkilendirilen alanlar.
|
SlotFillingStatus
Boşluk doldurmanın mevcut durumunu gösterir.
Sıralamalar | |
---|---|
UNSPECIFIED |
Kullanım alanı doldurulmadığında yedek değer. |
INITIALIZED |
Alanlar başlatıldı ancak alan doldurma başlamadı. |
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 |
Alan modu (zorunlu veya isteğe bağlı). Geliştirici tarafından ayarlanabilir. |
status |
Zaman aralığının durumu. |
value |
Alanın değeri. Yanıtta bu değerin değiştirilmesi, alan doldurmadaki değeri değiştirir. |
updated |
Slot değerinin son dönüşte toplanıp toplanmadığını gösterir. Bu alan salt okunurdur. |
prompt |
İsteğe bağlı. Bu istem, gerekli bir alanı doldurması gerektiğinde kullanıcıya gönderilir. Bu istem, konsolda tanımlanmış mevcut istemi geçersiz kılar. Bu alan webhook isteğine dahil değildir. |
SlotMode
Alanın modunu (zorunlu olup olmadığını) temsil eder.
Sıralamalar | |
---|---|
MODE_UNSPECIFIED |
Kullanım alanı doldurulmadığında yedek değer. |
OPTIONAL |
Aralıkın, boşluk doldurmayı tamamlamak için gerekli olmadığını gösterir. |
REQUIRED |
Boşluk doldurma işleminin tamamlanması için zaman aralığının gerektiğini gösterir. |
SlotStatus
Bir alanın durumunu temsil eder.
Sıralamalar | |
---|---|
SLOT_UNSPECIFIED |
Kullanım alanı doldurulmadığında yedek değer. |
EMPTY |
Alanda herhangi bir değer olmadığını gösterir. Bu durum yanıt aracılığıyla değiştirilemez. |
INVALID |
Alan değerinin geçersiz olduğunu gösterir. Bu durum, 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 modelini 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ı.
API Tasarım Kılavuzu'nda bu hata modeli ve bu hata modeliyle nasıl çalışılacağı hakkında daha fazla bilgi edinebilirsiniz.
JSON gösterimi | |
---|---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Alanlar | |
---|---|
code |
|
message |
Geliştiricilere yönelik, İngilizce olması gereken bir 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 kullandığı bir dizi mesaj türü vardır. Rastgele türden alanlar içeren nesne. Ek bir |
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 amaç eşleşmesi (genel veya bir sahne içinde) hakkında bilgi: 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 intent parametreleri.
|
handler |
Bu etkileşime ekli işleyicinin adı. |
nextSceneId |
Bu etkileşimin yönlendirdiği sahne. |
ConditionsEvaluated
Koşul 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
Koşul değerlendirildi.
JSON gösterimi | |
---|---|
{ "expression": string, "handler": string, "nextSceneId": string } |
Alanlar | |
---|---|
expression |
Bu koşulda ifade belirtildi. |
handler |
Değerlendirilen koşulda belirtilen işleyici adı. |
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 istekle ilgili bilgiler: 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 bir yanıtla ilgili 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 yönlendirdiğ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 |
NLU tarafından kullanıcı girişinden ayıklanan parametreler.
|
SlotRequested
Şu anda istenen alan ile ilgili bilgiler: https://developers.google.com/assistant/conversational/scenes#slot_filling
JSON gösterimi | |
---|---|
{
"slot": string,
"prompt": {
object ( |
Alanlar | |
---|---|
slot |
İstenen zaman aralığının adı. |
prompt |
Alan istemi. |
SlotValidated
Şu 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 olan görüşmenin sonlandırıldığını bildiren etkinlik.