Method: projects.sendInteraction

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

string

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 (UserInput)
  },
  "deviceProperties": {
    object (DeviceProperties)
  },
  "conversationToken": string
}
Alanlar
input

object (UserInput)

Zorunlu. Kullanıcı tarafından sağlanan giriş.

deviceProperties

object (DeviceProperties)

Zorunlu. İşlemle etkileşim için kullanılan cihazın özellikleri.

conversationToken

string

Ö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 (Output)
  },
  "diagnostics": {
    object (Diagnostics)
  },
  "conversationToken": string
}
Alanlar
output

object (Output)

Kullanıcıya sağlanan çıkış.

diagnostics

object (Diagnostics)

İsteğin nasıl işlendiğini açıklayan teşhis bilgileri.

conversationToken

string

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 (InputType)
}
Alanlar
query

string

Kullanıcı tarafından gönderilen girişin içeriği.

type

enum (InputType)

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 (Surface),
  "location": {
    object (Location)
  },
  "locale": string,
  "timeZone": string
}
Alanlar
surface

enum (Surface)

İşlem ile etkileşim için kullanılan yüzey.

location

object (Location)

Enlem, boylam ve biçimlendirilmiş adres gibi cihaz konumu.

locale

string

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

string

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 (LatLng)
  },
  "formattedAddress": string,
  "zipCode": string,
  "city": string
}
Alanlar
coordinates

object (LatLng)

Coğrafi koordinatlar. [DEVICE_PRECISE_LOCATION] gerekir [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] izni.

formattedAddress

string

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

string

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

string

Ş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

number

Derece cinsinden enlem. [-90,0, +90,0] aralığında olmalıdır.

longitude

number

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 (Canvas)
  },
  "actionsBuilderPrompt": {
    object (Prompt)
  }
}
Alanlar
text

string

Kullanıcıya düz dize olarak gönderilen sözlü yanıt.

speech[]

string

İşlem tarafından oluşturulan konuşma içeriği. Bu, SSML gibi işaretleme öğelerini içerebilir.

canvas

object (Canvas)

Etkileşimli Tuval içeriği.

actionsBuilderPrompt

object (Prompt)

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

string

Yüklenecek etkileşimli kanvas web uygulamasının URL'si. Ayarlanmazsa mevcut etkin tuvaldeki URL yeniden kullanılır.

data[]

value (Value format)

İ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

boolean

İsteğe bağlı. Varsayılan değer: false.

enableFullScreen

boolean

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.

İstem

Bir kullanıcıya verilen yanıtı temsil etme.

JSON gösterimi
{
  "append": boolean,
  "override": boolean,
  "firstSimple": {
    object (Simple)
  },
  "content": {
    object (Content)
  },
  "lastSimple": {
    object (Simple)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (Link)
  },
  "canvas": {
    object (Canvas)
  }
}
Alanlar
append
(deprecated)

boolean

İ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

boolean

İ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

object (Simple)

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

content

object (Content)

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

lastSimple

object (Simple)

İ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. "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.

canvas

object (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

string

İ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

string

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 content can be only one of the following:
  "card": {
    object (Card)
  },
  "image": {
    object (Image)
  },
  "table": {
    object (Table)
  },
  "media": {
    object (Media)
  },
  "canvas": {
    object (Canvas)
  },
  "collection": {
    object (Collection)
  },
  "list": {
    object (List)
  }
  // End of list of possible types for union field content.
}
Alanlar
Birleştirme alanı content. İçerik. content şunlardan yalnızca biri olabilir:
card

object (Card)

Temel kart.

image

object (Image)

Bir resim.

table

object (Table)

Tablo kartı.

media

object (Media)

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

canvas
(deprecated)

object (Canvas)

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

collection

object (Collection)

Bir dizi seçenek sunan kart.

list

object (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 (Image)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (Link)
  }
}
Alanlar
title

string

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

subtitle

string

İsteğe bağlı.

text

string

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

object (Image)

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

imageFill

enum (ImageFill)

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

button

object (Link)

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

string

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

alt

string

Erişilebilirlik için kullanılacak resmin metin açıklaması, ör. Ekran okuyucular. Zorunlu.

height

integer

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

width

integer

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.

OpenUrl

Kullanıcı bir bağlantıyı açtığında gerçekleştirilen işlem.

JSON gösterimi
{
  "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.

UrlHint

Farklı URL ipuçları türleri.

Sıralamalar
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 (Image)
  },
  "columns": [
    {
      object (TableColumn)
    }
  ],
  "rows": [
    {
      object (TableRow)
    }
  ],
  "button": {
    object (Link)
  }
}
Alanlar
title

string

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

subtitle

string

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

image

object (Image)

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

columns[]

object (TableColumn)

Başlıklar ve sütunların hizalaması.

rows[]

object (TableRow)

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 (Link)

Düğme.

TableColumn

Tablodaki bir sütunu açıklar.

JSON gösterimi
{
  "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.

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 (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.

JSON gösterimi
{
  "text": string
}
Alanlar
text

string

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 (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ]
}
Alanlar
mediaType

enum (MediaType)

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 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 (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

Medya kartıyla gösterilecek resim.

JSON gösterimi
{

  // Union field image can be only one of the following:
  "large": {
    object (Image)
  },
  "icon": {
    object (Image)
  }
  // End of list of possible types for union field image.
}
Alanlar
Birleştirme alanı image. Resim. image şunlardan yalnızca biri olabilir:
large

object (Image)

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

icon

object (Image)

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 (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
Alanlar
title

string

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

subtitle

string

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

items[]

object (CollectionItem)

minimum: 2 maks: 10

imageFill

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

string

Zorunlu. İlişkili Türdeki giriş anahtarı adıyla eşleşen NLU anahtarı.

Liste

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

JSON gösterimi
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}
Alanlar
title

string

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

subtitle

string

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

items[]

object (ListItem)

minimum: 2 maks: 30

ListItem

Listedeki bir öğe

JSON gösterimi
{
  "key": string
}
Alanlar
key

string

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

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

Teşhis

Görüşme turuyla ilgili teşhis bilgileri.

JSON gösterimi
{
  "actionsBuilderEvents": [
    {
      object (ExecutionEvent)
    }
  ]
}
Alanlar
actionsBuilderEvents[]

object (ExecutionEvent)

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 (ExecutionState)
  },
  "status": {
    object (Status)
  },
  "warningMessages": [
    string
  ],

  // Union field EventData can be only one of the following:
  "userInput": {
    object (UserConversationInput)
  },
  "intentMatch": {
    object (IntentMatch)
  },
  "conditionsEvaluated": {
    object (ConditionsEvaluated)
  },
  "onSceneEnter": {
    object (OnSceneEnter)
  },
  "webhookRequest": {
    object (WebhookRequest)
  },
  "webhookResponse": {
    object (WebhookResponse)
  },
  "webhookInitiatedTransition": {
    object (WebhookInitiatedTransition)
  },
  "slotMatch": {
    object (SlotMatch)
  },
  "slotRequested": {
    object (SlotRequested)
  },
  "slotValidated": {
    object (SlotValidated)
  },
  "formFilled": {
    object (FormFilled)
  },
  "waitingUserInput": {
    object (WaitingForUserInput)
  },
  "endConversation": {
    object (EndConversation)
  }
  // End of list of possible types for union field EventData.
}
Alanlar
eventTime

string (Timestamp format)

Etkinliğin gerçekleştiği zaman damgası.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

executionState

object (ExecutionState)

Bu etkinlik sırasındaki yürütme durumu.

status

object (Status)

Belirli bir yürütme adımının sonuç durumu.

warningMessages[]

string

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

object (UserConversationInput)

Kullanıcı girişi işleme etkinliği.

intentMatch

object (IntentMatch)

Intent eşleştirme etkinliği.

conditionsEvaluated

object (ConditionsEvaluated)

Durum değerlendirme etkinliği.

onSceneEnter

object (OnSceneEnter)

OnSceneEnter yürütme etkinliği.

webhookRequest

object (WebhookRequest)

Webhook isteği gönderme etkinliği.

webhookResponse

object (WebhookResponse)

Webhook yanıt makbuzu etkinliği.

webhookInitiatedTransition

object (WebhookInitiatedTransition)

Webhook tarafından başlatılan geçiş etkinliği.

slotMatch

object (SlotMatch)

Alan eşleştirme etkinliği.

slotRequested

object (SlotRequested)

Alan isteğinde bulunan etkinlik.

slotValidated

object (SlotValidated)

Alan doğrulama etkinliği.

formFilled

object (FormFilled)

Form doldurma etkinliği.

waitingUserInput

object (WaitingForUserInput)

Kullanıcı girişi bekleniyor.

endConversation

object (EndConversation)

Görüşme sonu etkinliği.

ExecutionState

Yürütmenin mevcut durumu.

JSON gösterimi
{
  "currentSceneId": string,
  "sessionStorage": {
    object
  },
  "slots": {
    object (Slots)
  },
  "promptQueue": [
    {
      object (Prompt)
    }
  ],
  "userStorage": {
    object
  },
  "householdStorage": {
    object
  }
}
Alanlar
currentSceneId

string

Şu anda etkin olan sahnenin kimliği.

sessionStorage

object (Struct format)

Oturum depolama alanının durumu: https://developers.google.com/assistant/conversational/storage-session

slots

object (Slots)

Alanlar doldurulduğunda durum (varsa): https://developers.google.com/assistant/conversational/scenes#slot_filling

promptQueue[]

object (Prompt)

İstem sırası: https://developers.google.com/assistant/conversational/prompts

userStorage

object (Struct format)

Kullanıcı depolama alanının durumu: https://developers.google.com/assistant/conversational/storage-user

householdStorage

object (Struct format)

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 (SlotFillingStatus),
  "slots": {
    string: {
      object (Slot)
    },
    ...
  }
}
Alanlar
status

enum (SlotFillingStatus)

Boşluk doldurma işleminin mevcut durumu.

slots

map (key: string, value: object (Slot))

Geçerli sahneyle ilişkilendirilen alanlar.

"key": value çiftlerinin listesini içeren bir nesne. Örnek: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

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 (SlotMode),
  "status": enum (SlotStatus),
  "value": value,
  "updated": boolean,
  "prompt": {
    object (Prompt)
  }
}
Alanlar
mode

enum (SlotMode)

Alan modu (zorunlu veya isteğe bağlı). Geliştirici tarafından ayarlanabilir.

status

enum (SlotStatus)

Zaman aralığının durumu.

value

value (Value format)

Alanın değeri. Yanıtta bu değerin değiştirilmesi, alan doldurmadaki değeri değiştirir.

updated

boolean

Slot değerinin son dönüşte toplanıp toplanmadığını gösterir. Bu alan salt okunurdur.

prompt

object (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

integer

google.rpc.Code olması gereken durum kodu.

message

string

Geliştiricilere yönelik, İngilizce olması gereken bir hata mesajı. Kullanıcılara yönelik tüm hata mesajları yerelleştirilip google.rpc.Status.details alanında gönderilmeli veya istemci tarafından yerelleştirilmelidir.

details[]

object

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 "@type" alanı, türü tanımlayan bir URI içerir. Örnek: { "id": 1234, "@type": "types.example.com/standard/id" }.

UserConversationInput

Kullanıcı girişiyle ilgili bilgiler.

JSON gösterimi
{
  "type": string,
  "originalQuery": string
}
Alanlar
type

string

Kullanıcı girişinin türü. Ör. klavye, ses, dokunma vb.

originalQuery

string

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 (IntentParameterValue)
    },
    ...
  },
  "handler": string,
  "nextSceneId": string
}
Alanlar
intentId

string

Bu etkileşimi tetikleyen amaç kimliği.

intentParameters

map (key: string, value: object (IntentParameterValue))

Bu etkileşimi tetikleyen intent parametreleri.

"key": value çiftlerinin listesini içeren bir nesne. Örnek: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

handler

string

Bu etkileşime ekli işleyicinin adı.

nextSceneId

string

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 (Condition)
    }
  ],
  "successCondition": {
    object (Condition)
  }
}
Alanlar
failedConditions[]

object (Condition)

"Yanlış" olarak değerlendirilen koşulların listesi.

successCondition

object (Condition)

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

string

Bu koşulda ifade belirtildi.

handler

string

Değerlendirilen koşulda belirtilen işleyici adı.

nextSceneId

string

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

string

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

string

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

string

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

string

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 (IntentParameterValue)
    },
    ...
  }
}
Alanlar
nluParameters

map (key: string, value: object (IntentParameterValue))

NLU tarafından kullanıcı girişinden ayıklanan parametreler.

"key": value çiftlerinin listesini içeren bir nesne. Örnek: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

SlotRequested

Şu anda istenen alan ile ilgili bilgiler: https://developers.google.com/assistant/conversational/scenes#slot_filling

JSON gösterimi
{
  "slot": string,
  "prompt": {
    object (Prompt)
  }
}
Alanlar
slot

string

İstenen zaman aralığının adı.

prompt

object (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.