EventHandler

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

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ı yapılacak webhook işleyicisinin adı.

Birleştirme alanı prompt. İstemler satır içine alınabilir veya ada göre referans verilebilir. 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. Bu istemlerden biri, kullanıcıya 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 istemin ne zaman kullanılabileceğini belirleyen bir seçici vardır. Bir istekle eşleşen ilk seçici gönderilir ve geri kalanlar yoksayı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

Bir istemin 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 Action'a istekte bulunmak için kullandığı yüzeyi temsil eder.

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

enum (Capability)

Zorunlu. Yüzeyin İşlem için istekte bulunan özellikleri.

StaticPromptResponse

Kullanıcıya gönderilecek yapılandırılmış yanıtları (ör. metin, konuşma, kart, tuval verileri, öneri çipi) 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ı. Son sesli ve yalnızca metin yanıt.

suggestions[]

object (Suggestion)

İsteğe bağlı. Kullanıcıya gösterilecek öneriler. Bunlar, her zaman yanıtın sonunda gösterilir. İçeren istemdeki append alanı true ise 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.

override

boolean

İsteğe bağlı. Bu iletilerin önceden tanımlanmış iletilerle birleştirilme şekli. true, önceden tanımlanmış tüm iletileri (ilk ve son basit, içerik, öneri bağlantısı ve tuval) temizleyip bu istemde tanımlanan iletileri ekler. false, bu istemde tanımlanan iletileri önceki yanıtlarda tanımlanan iletilere ekler. Bu alan false olarak ayarlanırsa Basit istemler, Öneriler istemi ve Kanvas istemindeki (İçerik isteminin bir parçası) bazı alanlara ekleme de etkinleştirilir. İstemde tanımlanırsa İçerik ve Bağlantı iletilerinin üzerine her zaman yazılır. false varsayılan değerdir.

canvas

object (StaticCanvasPrompt)

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

StaticSimplePrompt

Kullanıcıya gönderilmesi için 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 söylenecek konuşmayı temsil eder. SSML veya metin okuma olabilir. Varsayılan olarak, önceki Basit istemin konuşmasına konuşma 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. Belirtilmezse yukarıdaki konuşma alanının görüntülemesi kullanılır. Uzunluk sınırı 640 karakterdir. Metin, varsayılan olarak önceki Basit istem metnine eklenir. İçeren istemdeki override alanı true ise bu alanda tanımlanan metin önceki Basit istemin metnini geçersiz kılar.

StaticContentPrompt

StaticPrompt'un Content (İçerik) bölümü için 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
Birleştirme alanı content. Bir istemde yalnızca bir içerik türü bulunabilir. content şunlardan yalnızca biri olabilir:
card

object (StaticCardPrompt)

Temel kart.

image

object (StaticImagePrompt)

Bir resim.

table

object (StaticTablePrompt)

Tablo kartı.

media

object (StaticMediaPrompt)

Oynatılacak bir grup medyayı gösteren yanıt.

list

object (StaticListPrompt)

Seçebileceğiniz seçeneklerin listesini sunan bir kart.

collection

object (StaticCollectionPrompt)

Seçebileceğiniz seçeneklerin listesini sunan bir kart.

collectionBrowse

object (StaticCollectionBrowsePrompt)

Açılacak bir web sayfası koleksiyonu sunan kart.

StaticCardPrompt

Bazı bilgileri görüntülemek için kullanılan temel kart, ör. bir resim ve/veya metin.

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 mevcut değilse kartın gövde metni. Biçimlendirme için sınırlı bir Markdown söz dizimi grubunu destekler.

image

object (StaticImagePrompt)

İsteğe bağlı. Kart için hero resim. Yükseklik 192 dp olarak sabitlendi.

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 bir resim gösteriliyor.

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ının bağlantıyı açtığı andaki davranışı tanımlar.

OpenUrl

Kullanıcının bağlantıyı açtığı andaki davranışı tanımlar.

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

string

Şunlardan herhangi biri olabilecek URL alanı: - Uygulamaya bağlı bir uygulamayı veya web sayfasını açmak için http/https urls

hint

enum (UrlHint)

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

StaticTablePrompt

Bir 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ö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

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)

İçerik sütunuyla yatay hizalama. Belirtilmemişse içerik ön kenarla 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ö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

boolean

Her satırdan sonra bir ayırıcı olması gerekip gerekmediğini belirtir.

TableCell

Bir satırdaki bir 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 kesirli basamağa sahip, "s" ile sonlandırılmış, saniye cinsinden süre. Örnek: "3.5s".

optionalMediaControls[]

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

object (MediaObject)

Medya nesnelerinin listesi.

repeatMode

enum (RepeatMode)

Medya Nesneleri listesi için tekrar modu.

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 gösteren URL.

image

object (MediaImage)

Medya kartıyla 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
Birleştirme alanı image. Yalnızca bir MediaImage türüne izin verilir. image şunlardan yalnızca biri olabilir:
large

object (StaticImagePrompt)

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

icon

object (StaticImagePrompt)

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

StaticListPrompt

Seçebileceğ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ıyla eşleşen NLU anahtarı. Öğeye dokunulduğunda, bu anahtar seçim seçeneği parametresi olarak geri yayınlanır.

title

string

Zorunlu. Öğenin başlığı. Bu metin dokunulduğunda, kullanıcı yazmış gibi görüşmede olduğu gibi yayınlanır. Her başlık, öğe grubu 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çenek sunan bir 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ürdeki giriş anahtarı adıyla eşleşen NLU anahtarı. Öğeye dokunulduğunda, bu anahtar seçim seçeneği parametresi olarak geri yayınlanır.

title

string

Zorunlu. Öğenin başlığı. Bu metin dokunulduğunda, kullanıcı yazmış gibi görüşmede olduğu gibi yayınlanır. Her başlık, öğe grubu 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ını, büyük parçalı öğelerin koleksiyonu olarak sunar. İlişkili web dokümanlarını bir web görüntüleyicide başlatmak için öğeler 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

Koleksiyondaki öğe.

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 öğesi için açıklamanın altında görüntülenen altbilgi metni. Üç nokta ile kısaltılmış tek satır metin.

image

object (StaticImagePrompt)

Koleksiyon öğesinin resmi.

openUriAction

object (OpenUrl)

Zorunlu. Öğe seçildiyse açılacak URI.

Öneri

Kolaylık sağlamak amacıyla kullanıcıya gösterilen bir kullanıcı arayüzü öğesi olan öneri çipini temsil eder.

YAML temsili
title: string
Alanlar
title

string

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

StaticCanvasPrompt

Kullanıcıya gönderilecek Etkileşimli Tuval yanıtını temsil eder. Bu, etkileşimli bir tuval yanıtı göstermenin yanı sıra kullanıcıyla konuşmak için içeren istemdeki firstSimple alanıyla birlikte kullanılabilir.

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ı. Tam sayfa deneyim web sayfasına etkinlik olarak aktarılacak JSON verileri. İçeren istemdeki override alanı, bu Canvas isteminde tanımlanan false veri değeri ise önceki Canvas istemlerinde tanımlanan veri değerlerinden sonra eklenir.

suppressMic

boolean

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

sendStateDataToCanvasApp

boolean

İsteğe bağlı. true değerine ayarlanırsa ileti dizisiyle ilgili meta veriler dahil edilir ve tuval uygulamasına geri gönderilir.

enableFullScreen

boolean

İsteğe bağlı. true ise tuval uygulaması tam ekranı kaplar ve üst tarafta başlık içermez. Yükleme ekranında, işlemin görünen adını, geliştiricinin adını ve İşlemden çıkma talimatlarını içeren bir durum mesajı da görüntülenir. Varsayılan değer: false.

continueTtsDuringTouch

boolean

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