EventHandler

Bir etkinlikten sonra yürütülecek bir işleyici tanımlar. Etkinliklere örnek olarak, bir sahnedeki amaç ve koşula dayalı etkinlikler verilebilir.

YAML temsili
webhookHandler: string

# Union field prompt can be only one of the following:
staticPrompt: 
  object (StaticPrompt)
staticPromptName: string
# End of list of possible types for union field prompt.
Alanlar
webhookHandler

string

Çağrılacak webhook işleyicinin adı.

prompt alanı. İstemler satır içine alınabilir veya ada göre referans gösterilebilir. prompt şunlardan yalnızca biri olabilir:
staticPrompt

object (StaticPrompt)

Satır içi statik istem. Paketlerdeki dize kaynaklarına referanslar içerebilir.

staticPromptName

string

Çağrılacak statik istemin adı.

StaticPrompt

İstem adaylarının listesini temsil eder. Bunlardan biri kullanıcıya verilen yanıtta gösterilecek istem olarak seçilir. Bu mesaj yerelleştirilebilir.

YAML temsili
candidates: 
  - object (StaticPromptCandidate)
Alanlar
candidates[]

object (StaticPromptCandidate)

Müşteriye gönderilecek aday istemlerinin listesi. Her istemde, ne zaman kullanılabileceğini belirleyen bir seçici bulunur. Bir istekle eşleşen ilk seçici gönderilir ve geri kalanı yok sayılır.

StaticPromptCandidate

Statik bir istem adayını temsil eder.

YAML temsili
selector: 
  object (Selector)
promptResponse: 
  object (StaticPromptResponse)
Alanlar
selector

object (Selector)

İsteğe bağlı. Bu istemin bir istekle eşleşip eşleşmediğine ilişkin ölçütler. Seçici boşsa bu istem her zaman tetiklenir.

promptResponse

object (StaticPromptResponse)

Seçiciyle ilişkili istem yanıtı.

Seçici

İstemin bir istekle eşleşip eşleşmediğine ilişkin ölçütleri tanımlar.

YAML temsili
surfaceCapabilities: 
  object (SurfaceCapabilities)
Alanlar
surfaceCapabilities

object (SurfaceCapabilities)

Gerekli yüzey özellikleri grubu.

SurfaceCapabilities

Kullanıcının işlem için istekte bulunmak üzere kullandığı yüzeyi temsil eder.

YAML temsili
capabilities: 
  - enum (Capability)
Alanlar
capabilities[]

enum (Capability)

Zorunlu. İşlem'e istekte bulunan yüzeyin özellikleri.

StaticPromptResponse

Kullanıcıya gönderilecek yapılandırılmış yanıtları (ör. metin, konuşma, kartlar, tuval verileri, öneri çipleri) temsil eder.

YAML temsili
firstSimple: 
  object (StaticSimplePrompt)
content: 
  object (StaticContentPrompt)
lastSimple: 
  object (StaticSimplePrompt)
suggestions: 
  - object (Suggestion)
link: 
  object (StaticLinkPrompt)
override: boolean
canvas: 
  object (StaticCanvasPrompt)
Alanlar
firstSimple

object (StaticSimplePrompt)

İsteğe bağlı. İlk sesli ve yalnızca metin yanıtı.

content

object (StaticContentPrompt)

İsteğe bağlı. Kullanıcıya gösterilecek kart, liste veya medya gibi bir içerik.

lastSimple

object (StaticSimplePrompt)

İsteğe bağlı. Sesli ve yalnızca metin içeren son yanıt.

suggestions[]

object (Suggestion)

İsteğe bağlı. Öneriler her zaman yanıtın sonunda görünür ve kullanıcıya gösterilir. İçeren istemdeki append alanı true ise 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.

override

boolean

İsteğe bağlı. Bu mesajların önceden tanımlanmış iletilerle nasıl birleştirileceğini belirleyen mod. true, önceden tanımlanmış tüm mesajları (ilk ve son basit, içerik, öneriler bağlantısı ve tuval) temizler ve bu istemde tanımlanan mesajları ekler. false, bu istemde tanımlanan mesajları önceki yanıtlarda tanımlanan mesajlara ekler. Bu alanın false olarak ayarlanması, Basit istemler, Öneriler istemi ve Tuval istemi (İçerik isteminin bir parçası) içindeki bazı alanlara eklenmesi de etkinleştirilir. İstemde tanımlanırsa İçerik ve Bağlantı mesajlarının her zaman üzerine yazılır. false, varsayılan değerdir.

canvas

object (StaticCanvasPrompt)

Etkileşimli tuval deneyimi için kullanılacak bir yanıt.

StaticSimplePrompt

Kullanıcıya gönderilecek basit bir istemi temsil eder.

YAML temsili
variants: 
  - object (Variant)
Alanlar
variants[]

object (Variant)

Olası varyantların listesi.

Varyant

Basit istemin parçası olan bir varyantı temsil eder.

YAML temsili
speech: string
text: string
Alanlar
speech

string

İsteğe bağlı. Kullanıcıya konuşulacak konuşmayı temsil eder. SSML veya metin okuma olabilir. Varsayılan olarak konuşma, önceki Basit istemin konuşmasına eklenir. İçeren istemdeki override alanı true ise bu alanda tanımlanan konuşma, önceki Basit istemin konuşmasını geçersiz kılar.

text

string

İsteğe bağlı. Sohbet balonunda gösterilecek 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. Metin, varsayılan olarak önceki Basit istemin metnine eklenir. İçeren istemdeki override alanı true ise bu alanda tanımlanan metin, önceki Basit istemin metnini geçersiz kılar.

StaticContentPrompt

StaticPrompt'un İçerik bölümü için bir yer tutucu.

YAML temsili
# Union field content can be only one of the following:
card: 
  object (StaticCardPrompt)
image: 
  object (StaticImagePrompt)
table: 
  object (StaticTablePrompt)
media: 
  object (StaticMediaPrompt)
list: 
  object (StaticListPrompt)
collection: 
  object (StaticCollectionPrompt)
collectionBrowse: 
  object (StaticCollectionBrowsePrompt)
# End of list of possible types for union field content.
Alanlar
content alanı. İstemde yalnızca bir içerik türü bulunabilir. content şunlardan yalnızca biri olabilir:
card

object (StaticCardPrompt)

Temel bir kart.

image

object (StaticImagePrompt)

Bir resim.

table

object (StaticTablePrompt)

Tablo kartı.

media

object (StaticMediaPrompt)

Oynatılacak medya grubunu belirten yanıt.

list

object (StaticListPrompt)

Aralarından seçim yapabileceğiniz seçeneklerin listesini sunan bir kart.

collection

object (StaticCollectionPrompt)

Aralarından seçim yapabileceğiniz seçeneklerin listesini gösteren bir kart.

collectionBrowse

object (StaticCollectionBrowsePrompt)

Açılacak web sayfaları koleksiyonunu gösteren bir kart.

StaticCardPrompt

Bazı bilgileri (ör. resim ve/veya metin) gösteren temel bir kart.

YAML temsili
title: string
subtitle: string
text: string
image: 
  object (StaticImagePrompt)
imageFill: enum (ImageFill)
button: 
  object (StaticLinkPrompt)
Alanlar
title

string

İsteğe bağlı. Kartın genel başlığı.

subtitle

string

İsteğe bağlı. Kartın alt başlığı.

text

string

Zorunlu. Resim yoksa gereken kart gövde metni. Biçimlendirme için sınırlı bir Markdown söz dizimini destekler.

image

object (StaticImagePrompt)

İsteğe bağlı. Kartın lokomotif resmi. Yükseklik 192 dp'ye sabitlenir.

imageFill

enum (ImageFill)

İsteğe bağlı. Resim arka planının nasıl doldurulacağı.

button

object (StaticLinkPrompt)

İsteğe bağlı. Kartta gösterilecek tıklanabilir bir düğme.

StaticImagePrompt

Kartta gösterilen bir resim.

YAML temsili
url: string
alt: string
height: integer
width: integer
Alanlar
url

string

Zorunlu. Resmin kaynak URL'si. Resimler JPG, PNG ve GIF (animasyonlu ve animasyonsuz) olabilir. Örneğin,https://www.agentx.com/logo.png.

alt

string

Zorunlu. Erişilebilirlik için kullanılacak resmin metin açıklaması (ör. ekran okuyucular).

height

integer

İsteğe bağlı. Resmin piksel cinsinden yüksekliği.

width

integer

İsteğe bağlı. Resmin piksel cinsinden genişliği.

StaticLinkPrompt

Öneri çipi olarak gösterilecek ve kullanıcı tarafından açılabilecek bir bağlantıyı tanımlar.

YAML temsili
name: string
open: 
  object (OpenUrl)
Alanlar
name

string

Bağlantının adı

open

object (OpenUrl)

Kullanıcı bağlantıyı açtığında nasıl davranacağını tanımlar.

OpenUrl

Kullanıcı bağlantıyı açtığında nasıl davranacağını tanımlar.

YAML temsili
url: string
hint: enum (UrlHint)
Alanlar
url

string

Şunlardan herhangi biri olabilecek URL alanı: - Uygulamayla Bağlantılı Uygulama veya web sayfası açmak için http/https URL'leri

hint

enum (UrlHint)

URL türüyle ilgili bir ipucu gösterir.

StaticTablePrompt

Metin tablosunu gösteren tablo kartı.

YAML temsili
title: string
subtitle: string
image: 
  object (StaticImagePrompt)
columns: 
  - object (TableColumn)
rows: 
  - object (TableRow)
button: 
  object (StaticLinkPrompt)
Alanlar
title

string

İsteğe bağlı. Tablonun genel başlığı. Altyazı ayarlanmışsa ayarlanmalıdır.

subtitle

string

İsteğe bağlı. Tablonun alt başlığı.

image

object (StaticImagePrompt)

İsteğe bağlı. Tabloyla ilişkilendirilen resim.

columns[]

object (TableColumn)

İsteğe bağlı. Başlıklar ve sütunların hizalaması.

rows[]

object (TableRow)

İsteğe bağlı. 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 özelliğini destekleyen yüzeylerde kullanıcıyı daha fazla veri içeren bir web sayfasına yönlendirebilirsiniz.

button

object (StaticLinkPrompt)

İsteğe bağlı. Düğme.

TableColumn

Tablodaki bir sütunu açıklar.

YAML temsili
header: string
align: enum (HorizontalAlignment)
Alanlar
header

string

Sütunun başlık metni.

align

enum (HorizontalAlignment)

İçeriğin sütunla yatay hizalaması. Belirtilmemişse içerik ön kenara hizalanır.

TableRow

Tablodaki bir satırı açıklar.

YAML temsili
cells: 
  - object (TableCell)
divider: boolean
Alanlar
cells[]

object (TableCell)

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

boolean

Her satırdan sonra ayırıcı olup olmadığını gösterir.

TableCell

Bir satırdaki hücreyi açıklar.

YAML temsili
text: string
Alanlar
text

string

Hücrenin metin içeriği.

StaticMediaPrompt

Medya hakkında ad, açıklama, url vb. bilgiler içerir. Sonraki kimlik: 11

YAML temsili
mediaType: enum (MediaType)
startOffset: string
optionalMediaControls: 
  - enum (OptionalMediaControls)
mediaObjects: 
  - object (MediaObject)
repeatMode: enum (RepeatMode)
Alanlar
mediaType

enum (MediaType)

Bu yanıtın medya türü.

startOffset

string (Duration format)

İlk medya nesnesinin başlangıç ofseti.

En fazla dokuz kesir basamağı içeren ve "s" ile sonlandırılan saniye cinsinden bir süre. Örnek: "3.5s".

optionalMediaControls[]

enum (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[]

object (MediaObject)

Medya nesnelerinin listesi.

repeatMode

enum (RepeatMode)

Medya Nesneleri listesi için modu tekrar edin.

MediaObject

Tek bir medya nesnesini temsil eder.

YAML temsili
name: string
description: string
url: string
image: 
  object (MediaImage)
Alanlar
name

string

Bu medya nesnesinin adı.

description

string

Bu medya nesnesinin açıklaması.

url

string

Medya içeriğini işaret eden URL.

image

object (MediaImage)

Medya kartıyla birlikte gösterilecek resim.

MediaImage

MediaPrompt içinde gösterilecek resim.

YAML temsili
# Union field image can be only one of the following:
large: 
  object (StaticImagePrompt)
icon: 
  object (StaticImagePrompt)
# End of list of possible types for union field image.
Alanlar
image alanı. Yalnızca bir MediaImage türüne izin verilir. image şunlardan yalnızca biri olabilir:
large

object (StaticImagePrompt)

Albümün kapağı vb. büyük bir resim.

icon

object (StaticImagePrompt)

Başlığın sağında gösterilen küçük resim simgesi. 36x36 dp olarak yeniden boyutlandırıldı.

StaticListPrompt

Aralarından seçim yapabileceğiniz seçeneklerin listesini sunan bir kart.

YAML temsili
title: string
subtitle: string
items: 
  - object (ListItem)
Alanlar
title

string

İsteğe bağlı. Listenin başlığı.

subtitle

string

İsteğe bağlı. Listenin alt başlığı.

items[]

object (ListItem)

Zorunlu. Liste öğeleri.

ListItem

Listedeki bir öğe.

YAML temsili
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
Alanlar
key

string

Zorunlu. İlişkili türdeki giriş anahtarı adıyla eşleşen NLU anahtarı. Öğeye dokunulduğunda bu anahtar seçim parametresi olarak geri gönderilir.

title

string

Zorunlu. Öğenin başlığı. Bu metine dokunulduğunda, kullanıcı yazmış gibi, görüşmede aynen geri gönderilir. Her başlık, öğe kümesi içinde benzersiz olmalıdır.

description

string

İsteğe bağlı. Öğenin gövde metni.

image

object (StaticImagePrompt)

İsteğe bağlı. Öğe resmi.

StaticCollectionPrompt

Aralarından seçim yapabileceğiniz bir dizi seçeneği sunan kart.

YAML temsili
title: string
subtitle: string
items: 
  - object (CollectionItem)
imageFill: enum (ImageFill)
Alanlar
title

string

İsteğe bağlı. Koleksiyonun başlığı.

subtitle

string

İsteğe bağlı. Koleksiyonun alt başlığı.

items[]

object (CollectionItem)

Zorunlu. Koleksiyon öğeleri'ne dokunun.

imageFill

enum (ImageFill)

İsteğe bağlı. Resim görüntüleme seçeneğinin türü.

CollectionItem

Koleksiyondaki bir öğe.

YAML temsili
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
Alanlar
key

string

Zorunlu. İlişkili Tür'deki giriş anahtarı adıyla eşleşen NLU anahtarı. Öğeye dokunulduğunda bu anahtar seçim parametresi olarak geri gönderilir.

title

string

Zorunlu. Öğenin başlığı. Bu metine dokunulduğunda, kullanıcı yazmış gibi, görüşmede aynen geri gönderilir. Her başlık, öğe kümesi içinde benzersiz olmalıdır.

description

string

İsteğe bağlı. Öğenin gövde metni.

image

object (StaticImagePrompt)

İsteğe bağlı. Öğe resmi.

StaticCollectionBrowsePrompt

Bir dizi web dokümanı, büyük parçalardan oluşan bir koleksiyon olarak sunulur. Öğeler, ilişkili web dokümanını bir web görüntüleyicide başlatmak için seçilebilir.

YAML temsili
items: 
  - object (CollectionBrowseItem)
imageFill: enum (ImageFill)
Alanlar
items[]

object (CollectionBrowseItem)

Göz atma koleksiyonundaki öğeler. Liste boyutu [2, 10] aralığında olmalıdır.

imageFill

enum (ImageFill)

Koleksiyondaki resimler için resim görüntüleme seçeneği.

CollectionBrowseItem

Öğe koleksiyonda.

YAML temsili
title: string
description: string
footer: string
image: 
  object (StaticImagePrompt)
openUriAction: 
  object (OpenUrl)
Alanlar
title

string

Zorunlu. Koleksiyon öğesinin başlığı.

description

string

Koleksiyon öğesinin açıklaması.

footer

string

Koleksiyon öğesinin açıklamanın altında görüntülenen altbilgi metni. Üç nokta ile kısaltılmış tek satırlık metin.

image

object (StaticImagePrompt)

Koleksiyon öğesinin resmi.

openUriAction

object (OpenUrl)

Zorunlu. Öğe seçilmişse açılacak URI.

Öneri

Bir öneri çipini temsil eder. Kolaylık sağlamak için kullanıcıya gösterilen bir kullanıcı arayüzü öğesidir.

YAML temsili
title: string
Alanlar
title

string

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

StaticCanvasPrompt

Kullanıcıya gönderilecek Etkileşimli Tuval yanıtını temsil eder. Bu, kullanıcıyla konuşmak için yer alan istemdeki firstSimple alanıyla birlikte kullanılabilir ve etkileşimli bir tuval yanıtı görüntüleyebilir.

YAML temsili
url: string
data: 
  - value
suppressMic: boolean
sendStateDataToCanvasApp: boolean
enableFullScreen: boolean
continueTtsDuringTouch: boolean
Alanlar
url

string

Zorunlu. Yüklenecek web görünümünün URL'si.

data[]

value (Value format)

İsteğe bağlı. Kapsamlı deneyim web sayfasına etkinlik olarak aktarılacak JSON verileri. İçeren istemdeki override alanı, bu Canvas isteminde tanımlanan false veri değerleriyse önceki Canvas istemlerinde tanımlanan veri değerlerinin ardından eklenir.

suppressMic

boolean

İsteğe bağlı. Doğru değeri, bu kapsamlı yanıt kullanıcıya sunulduktan sonra mikrofonun giriş yakalamak için açılmayacağı anlamına gelir.

sendStateDataToCanvasApp

boolean

İsteğe bağlı. true ise görüşmeyle ilgili meta veriler dahil edilir ve tuval uygulamasına geri gönderilir.

enableFullScreen

boolean

İsteğe bağlı. true ise tuval uygulaması tüm ekranı kaplar ve en üstte bir başlık gösterilmez. Yükleme ekranında işlemin görünen adını, geliştiricinin adını ve İşlemden çıkışla ilgili talimatları içeren bir kısa mesaj da gösterilir. Varsayılan değer: false.

continueTtsDuringTouch

boolean

İsteğe bağlı. Doğru değerine ayarlanırsa ekrana dokunmak tüm tuval oturumu boyunca TTS'yi durdurmaz. Varsayılan değer: false.