- Rappresentazione JSON
- ConfigFiles
- ConfigFile
- Manifest
- Azioni
- CustomAction
- Coinvolgimento
- PushNotification
- DailyUpdate
- ActionLink
- AssistantLink
- Impostazioni
- Categoria
- SurfaceRequirements
- CapabilityRequirement
- SurfaceCapability
- LocalizedSettings
- ThemeCustomization
- ImageCornerStyle
- AccountLinking
- LinkingType
- AuthGrantType
- Webhook
- Gestore
- HttpsEndpoint
- InlineCloudFunction
- Intenzione
- IntentParameter
- ClassReference
- EntitySetReferences
- EntitySetReference
- Tipo
- SynonymType
- MatchType
- Entità
- EntityDisplay
- RegularExpressionType
- Entità
- FreeTextType
- EntitySet
- Entità
- GlobalIntentEvent
- EventHandler
- StaticPrompt
- StaticPromptCandidate
- Selettore
- SurfaceCapabilities
- Capacità
- StaticPromptResponse
- StaticSimplePrompt
- Variante
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- ImageFill
- StaticLinkPrompt
- OpenUrl
- UrlHint
- StaticTablePrompt
- TableColumn
- HorizontalAlignment
- TableRow
- TableCell
- StaticMediaPrompt
- MediaType
- OptionalMediaControls
- MediaObject
- MediaImage
- RepeatMode
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- StaticCollectionBrowsePrompt
- CollectionBrowseItem
- Suggerimento
- StaticCanvasPrompt
- Scena
- IntentEvent
- ConditionalEvent
- Slot
- PromptSettings
- CommitBehavior
- DefaultValue
- DataFiles
- DataFile
Wrapper per un elenco di file.
Rappresentazione JSON | |
---|---|
{ // Union field |
Campi | ||
---|---|---|
Campo unione file_type . È possibile inviare al server un solo tipo di file alla volta: file di configurazione o file di dati. file_type può essere solo uno dei seguenti: |
||
configFiles |
Elenco dei file di configurazione. Ciò include manifest, impostazioni, bundle di risorse del modello di interazione e altro ancora. |
|
dataFiles |
Elenco dei file di dati. Sono inclusi il codice sorgente di immagini, file audio e funzioni Cloud Functions. |
ConfigFiles
Wrapper per i file di configurazione ripetuti. I campi ripetuti non possono esistere in un elemento.
Rappresentazione JSON | |
---|---|
{
"configFiles": [
{
object ( |
Campi | |
---|---|
configFiles[] |
Più file di configurazione. |
ConfigFile
Rappresenta un singolo file contenente dati strutturati. Gli sviluppatori possono definire la maggior parte del loro progetto utilizzando una configurazione strutturata, tra cui Azioni, Impostazioni e Completamento.
Rappresentazione JSON | |
---|---|
{ "filePath": string, // Union field |
Campi | ||
---|---|---|
filePath |
Percorso relativo del file di configurazione dalla radice del progetto nella struttura del file dell'SDK. Ogni tipo di file indicato di seguito ha un percorso file consentito. Esempio: settings/settings.yaml |
|
Campo unione file . A ogni tipo di file di configurazione deve essere associato un campo. file può essere solo uno dei seguenti: |
||
manifest |
Singolo file manifest. Percorso file consentito: |
|
actions |
Singoli file con tutte le azioni definite. Percorsi file consentiti: |
|
settings |
Configurazione delle singole impostazioni che include impostazioni non localizzabili e impostazioni per le impostazioni internazionali predefinite del progetto (se specificate). Per un file di override delle impostazioni internazionali, verrà compilato solo il campo localizedSettings. Percorsi file consentiti: |
|
webhook |
Definizione di singolo webhook. Percorso file consentito: |
|
intent |
Definizione di singolo intent. Percorsi file consentiti: |
|
type |
Definizione di singolo tipo. Percorsi file consentiti: |
|
entitySet |
Definizione di un singolo set di entità. Percorsi file consentiti: |
|
globalIntentEvent |
Definizione di un singolo evento di intent globale. Percorsi file consentiti: |
|
scene |
Definizione di una singola scena. Percorsi file consentiti: |
|
staticPrompt |
Definizione singola di prompt statico. Percorsi file consentiti: |
|
accountLinkingSecret |
I metadati corrispondenti al client secret utilizzato per il collegamento dell'account. Percorso file consentito: |
|
resourceBundle |
Un singolo bundle di risorse, ovvero una mappa da una stringa a una stringa o un elenco di stringhe. I bundle di risorse possono essere utilizzati per localizzare le stringhe nei prompt statici. Percorsi file consentiti: |
Manifest
Contiene informazioni "trasportabili" Questo significa che non è specifico per un determinato progetto e può essere spostato da un progetto all'altro.
Rappresentazione JSON | |
---|---|
{ "version": string } |
Campi | |
---|---|
version |
Versione del formato file. L'attuale formato di file versione è 1.0 Esempio: "1.0" |
Azioni
Rappresenta l'elenco di azioni definite in un progetto.
Rappresentazione JSON | |
---|---|
{
"custom": {
string: {
object ( |
Campi | |
---|---|
custom |
Mappa gli intent alle azioni personalizzate per configurare la chiamata al progetto. Gli intent di chiamata possono essere di sistema o di intent personalizzati definiti nella sezione "custom/intents/" pacchetto. Tutti gli intent definiti qui (intent di sistema e personalizzati per intent) devono avere un file di intent corrispondente nel campo "custom/global/" pacchetto. Un oggetto contenente un elenco di |
CustomAction
Dettagli relativi a un'azione personalizzata.
Rappresentazione JSON | |
---|---|
{
"engagement": {
object ( |
Campi | |
---|---|
engagement |
Meccanismi di coinvolgimento associati all'azione per aiutare gli utenti finali a iscriversi a notifiche push e aggiornamenti giornalieri. Tieni presente che il nome dell'intent specificato nella configurazione dell'area degli aggiornamenti giornalieri/delle notifiche push deve corrispondere all'intent corrispondente a questa azione affinché gli utenti finali possano abbonarsi a questi aggiornamenti. |
Coinvolgimento
Definisce i meccanismi di coinvolgimento associati a questa azione. In questo modo gli utenti finali possono abbonarsi per ricevere notifiche push e aggiornamenti giornalieri.
Rappresentazione JSON | |
---|---|
{ "title": string, "pushNotification": { object ( |
Campi | |
---|---|
title |
Il titolo dell'interazione che verrà inviato agli utenti finali per richiedere la loro autorizzazione per ricevere aggiornamenti. La richiesta di aggiornamenti giornalieri inviata agli utenti finali sarà simile a "A che ora vuoi che ti invii {title}" ogni giorno e per le notifiche push sarà simile a "Va bene se invio notifiche push per {title}"? Questo campo è localizzabile. |
pushNotification |
Impostazioni delle notifiche push supportate da questa interazione. |
actionLink |
La configurazione dei link per un'azione che determina se la condivisione dei link è abilitata per l'azione e, in caso affermativo, contiene il nome visualizzato intuitivo per il link. ActionLink è deprecato. Usa AssistantLink. |
assistantLink |
La configurazione dei link per un'azione che determina se la condivisione dei link è abilitata per l'azione e, in caso affermativo, contiene il nome visualizzato intuitivo per il link. |
dailyUpdate |
Impostazioni di aggiornamento giornaliere supportate da questa interazione. |
PushNotification
Definisce le impostazioni delle notifiche push supportate da questo coinvolgimento.
DailyUpdate
Definisce le impostazioni di aggiornamento giornaliere supportate da questa interazione.
ActionLink
Indica se la condivisione dei link è abilitata per questa azione e le impostazioni corrispondenti. I link di azione vengono utilizzati per indirizzare un utente a un'azione specifica. ActionLink è deprecato. Usa AssistantLink.
Rappresentazione JSON | |
---|---|
{ "title": string } |
Campi | |
---|---|
title |
Titolo visualizzato intuitivo per il link. |
AssistantLink
Indica se la condivisione dei link è abilitata per questa azione e le impostazioni corrispondenti. I link all'assistente vengono utilizzati per indirizzare un utente a un'azione specifica.
Rappresentazione JSON | |
---|---|
{ "title": string } |
Campi | |
---|---|
title |
Titolo visualizzato intuitivo per il link. |
Impostazioni
Rappresenta le impostazioni di un progetto Actions che non sono specifiche delle impostazioni internazionali. Tag successivo: 22
Rappresentazione JSON | |
---|---|
{ "projectId": string, "defaultLocale": string, "enabledRegions": [ string ], "disabledRegions": [ string ], "category": enum ( |
Campi | |
---|---|
projectId |
ID progetto Actions. |
defaultLocale |
Impostazioni internazionali predefinite per il progetto. Per tutti i file eccetto |
enabledRegions[] |
Rappresenta le regioni in cui gli utenti possono richiamare le tue Azioni, che si basano sulla posizione di presenza dell'utente. Non può essere impostato se |
disabledRegions[] |
Rappresenta le regioni in cui le Azioni sono bloccate, in base alla posizione di presenza dell'utente. Non può essere impostato se |
category |
La categoria per questo progetto Actions. |
usesTransactionsApi |
Indica se le Azioni possono utilizzare le transazioni (ad esempio, effettuare prenotazioni, accettare ordini e così via). Se è false, i tentativi di utilizzare le API Transactions non vanno a buon fine. |
usesDigitalPurchaseApi |
Indica se le Azioni possono eseguire transazioni per prodotti digitali. |
usesInteractiveCanvas |
Indica se le azioni utilizzano Canvas interattivo. |
usesHomeStorage |
Se le Azioni utilizzano la funzionalità di archiviazione della casa. |
designedForFamily |
Se i contenuti di Azioni sono progettati per le famiglie. |
containsAlcoholOrTobaccoContent |
Se le azioni includono contenuti correlati ad alcolici o tabacco. |
keepsMicOpen |
Indica se le azioni possono lasciare aperto il microfono senza un prompt esplicito durante la conversazione. |
surfaceRequirements |
I requisiti della piattaforma che una piattaforma client deve supportare per richiamare le azioni in questo progetto. |
testingInstructions |
Istruzioni per i test in formato libero per il revisore di Azioni (ad esempio, istruzioni per il collegamento dell'account). |
localizedSettings |
Impostazioni localizzate per le impostazioni internazionali predefinite del progetto. Per ogni lingua aggiuntiva deve essere associato un file di impostazioni in una directory specifica. |
accountLinking |
Consenti agli utenti di creare o collegare account tramite Accedi con Google e/o il tuo servizio OAuth. |
selectedAndroidApps[] |
App Android selezionate per accedere agli acquisti su Google Play per le transazioni. Questa è una selezione tra le app per Android collegate al progetto di azioni per verificare la proprietà del brand e attivare funzionalità aggiuntive. Per saperne di più, visita la pagina https://developers.google.com/assistant/console/brand-verification. |
Categoria
Le scelte di categorie per un progetto Actions.
Enum | |
---|---|
CATEGORY_UNSPECIFIED |
Sconosciuto / Non specificato. |
BUSINESS_AND_FINANCE |
Categoria Economia e Finanza. |
EDUCATION_AND_REFERENCE |
Formazione e consultazione. |
FOOD_AND_DRINK |
Categoria Alimenti e bevande. |
GAMES_AND_TRIVIA |
Categoria Giochi e quiz. |
HEALTH_AND_FITNESS |
Categoria Salute e fitness. |
KIDS_AND_FAMILY |
Categoria Bambini e Famiglia. |
LIFESTYLE |
Categoria Stile di vita. |
LOCAL |
Categoria locale. |
MOVIES_AND_TV |
Categoria Film e TV. |
MUSIC_AND_AUDIO |
Categoria Musica e Audio. |
NEWS |
Categoria di notizie, |
NOVELTY_AND_HUMOR |
Categoria Novità e umorismo. |
PRODUCTIVITY |
Categoria produttività. |
SHOPPING |
Categoria di Shopping. |
SOCIAL |
Categoria social. |
SPORTS |
Categoria Sport. |
TRAVEL_AND_TRANSPORTATION |
Categoria Viaggi e trasporti. |
UTILITIES |
Categoria Utilità. |
WEATHER |
Categoria meteo. |
HOME_CONTROL |
Categoria Controllo della casa. |
SurfaceRequirements
Contiene un set di requisiti che la piattaforma client deve supportare per richiamare le azioni nel progetto.
Rappresentazione JSON | |
---|---|
{
"minimumRequirements": [
{
object ( |
Campi | |
---|---|
minimumRequirements[] |
L'insieme minimo di funzionalità necessarie per richiamare le azioni nel tuo progetto. Se nella piattaforma manca uno di questi elementi, l'azione non verrà attivata. |
CapabilityRequirement
Rappresenta un requisito relativo alla disponibilità di una determinata funzionalità.
Rappresentazione JSON | |
---|---|
{
"capability": enum ( |
Campi | |
---|---|
capability |
Il tipo di funzionalità. |
SurfaceCapability
Possibile insieme di capacità della superficie.
Enum | |
---|---|
SURFACE_CAPABILITY_UNSPECIFIED |
Sconosciuto / Non specificato. |
AUDIO_OUTPUT |
Surface supporta l'output audio. |
SCREEN_OUTPUT |
Surface supporta l'output visivo/schermo. |
MEDIA_RESPONSE_AUDIO |
Surface supporta l'audio delle risposte multimediali. |
WEB_BROWSER |
Surface supporta i browser web. |
ACCOUNT_LINKING |
Surface supporta il collegamento degli account. |
INTERACTIVE_CANVAS |
Surface supporta Interactive Canvas. |
HOME_STORAGE |
Surface supporta l'archiviazione in casa. |
LocalizedSettings
Rappresenta le impostazioni di un progetto Actions specifiche per le impostazioni internazionali dell'utente. In questo caso, per utente si intende l'utente finale che richiama le tue azioni. Questo messaggio è localizzabile.
Rappresentazione JSON | |
---|---|
{
"displayName": string,
"pronunciation": string,
"shortDescription": string,
"fullDescription": string,
"smallLogoImage": string,
"largeBannerImage": string,
"developerName": string,
"developerEmail": string,
"termsOfServiceUrl": string,
"voice": string,
"voiceLocale": string,
"privacyPolicyUrl": string,
"sampleInvocations": [
string
],
"themeCustomization": {
object ( |
Campi | |
---|---|
displayName |
Obbligatorio. Il nome visualizzato predefinito per questo progetto Actions (se non è disponibile alcuna traduzione) |
pronunciation |
Obbligatorio. La pronuncia del nome visualizzato per chiamarlo in un contesto vocale (parlato). |
shortDescription |
Obbligatorio. La descrizione breve predefinita per il progetto Actions (se non è disponibile alcuna traduzione). 80 caratteri. |
fullDescription |
Obbligatorio. La descrizione lunga predefinita per il progetto Actions (se non è disponibile alcuna traduzione). 4000 caratteri. |
smallLogoImage |
Obbligatorio. Immagine quadrata piccola, 192 x 192 px. Deve essere specificato come riferimento all'immagine corrispondente nella directory |
largeBannerImage |
(Facoltativo) Immagine orizzontale grande, 1920 x 1080 px. Deve essere specificato come riferimento all'immagine corrispondente nella directory |
developerName |
Obbligatorio. Il nome dello sviluppatore da mostrare agli utenti. |
developerEmail |
Obbligatorio. L'indirizzo email di contatto dello sviluppatore. |
termsOfServiceUrl |
(Facoltativo) URL dei Termini di servizio. |
voice |
Obbligatorio. Il tipo di voce dell'Assistente Google che gli utenti sentono quando interagiscono con le tue Azioni. I valori supportati sono "male_1", "male_2", "female_1" e "female_2". |
voiceLocale |
(Facoltativo) Le impostazioni internazionali della voce specificata. Se non specificato, viene risolto nelle impostazioni internazionali dell'assistente dell'utente. Se specificato, le impostazioni internazionali della voce devono avere la stessa lingua principale delle impostazioni internazionali specificate in LocalizedSettings. |
privacyPolicyUrl |
Obbligatorio. L'URL delle norme sulla privacy. |
sampleInvocations[] |
(Facoltativo) Frasi di chiamata di esempio visualizzate nella descrizione del progetto Actions nella directory dell'assistente. In questo modo gli utenti impareranno a utilizzarla. |
themeCustomization |
(Facoltativo) Personalizzazioni dei temi per i componenti visivi delle Azioni. |
ThemeCustomization
Stili applicati alle schede presentate agli utenti
Rappresentazione JSON | |
---|---|
{
"backgroundColor": string,
"primaryColor": string,
"fontFamily": string,
"imageCornerStyle": enum ( |
Campi | |
---|---|
backgroundColor |
Colore di sfondo delle schede. Agisce da riserva se |
primaryColor |
Il colore del tema principale dell'azione verrà utilizzato per impostare il colore del testo del titolo e il colore di sfondo dell'attività per le schede di Actions on Google. Esempio di utilizzo: #FAFAFA |
fontFamily |
La famiglia di caratteri che verrà utilizzata per il titolo delle schede. Caratteri supportati: - Sans Serif - Sans Serif Medium - Sans Serif Bold - Sans Serif Nero - Sans Serif Condensed - Sans Serif Condensed Medium - Serif - Serif Bold - Monospazio - Cursive - Sans Serif Smallcaps |
imageCornerStyle |
Stile del bordo dell'immagine in primo piano delle schede. Ad esempio, può essere applicata all'immagine in primo piano di una scheda di base o di una scheda carosello. |
landscapeBackgroundImage |
Modalità Orizzontale (minimo 1920 x 1200 pixel). Deve essere specificato come riferimento all'immagine corrispondente nella directory |
portraitBackgroundImage |
Modalità Ritratto (minimo 1200 x 1920 pixel). Deve essere specificato come riferimento all'immagine corrispondente nella directory |
ImageCornerStyle
Descrive come dovrebbero essere visualizzati i bordi delle immagini.
Enum | |
---|---|
IMAGE_CORNER_STYLE_UNSPECIFIED |
Non definito / non specificato. |
CURVED |
Angolo arrotondato per l'immagine. |
ANGLED |
Angolo rettangolare per l'immagine. |
AccountLinking
Il collegamento degli account consente a Google di guidare l'utente nell'accesso ai servizi web dell'app.
Per i tipi di collegamento Accedi con Google e OAuth + Accedi con Google, Google genera un ID client che identifica la tua app per Google ("ID client emesso da Google per le tue Azioni" nell'interfaccia utente della console). Questo campo è di sola lettura e può essere controllato accedendo alla pagina Collegamento dell'account dell'interfaccia utente della console. Consulta la pagina: https://developers.google.com/assistant/identity/google-sign-in
Nota: per tutti i tipi di impostazioni di collegamento dell'account (ad eccezione di Accedi con Google), devi fornire un nome utente e una password per un account di prova in Settings.testing_instructions per consentire al team di revisori di esaminare l'app (non saranno visibili agli utenti).
Rappresentazione JSON | |
---|---|
{ "enableAccountCreation": boolean, "linkingType": enum ( |
Campi | |
---|---|
enableAccountCreation |
Obbligatorio. Se |
linkingType |
Obbligatorio. Il tipo di collegamento da utilizzare. Per ulteriori dettagli sui tipi di collegamento, consulta la pagina https://developers.google.com/assistant/identity. |
authGrantType |
(Facoltativo) Indica il tipo di autenticazione per OAUTH linkingType. |
appClientId |
(Facoltativo) ID client emesso dalla tua app per Google. Si tratta dell'ID client OAuth2 che identifica Google nel tuo servizio. Impostato solo quando si utilizza OAuth. |
authorizationUrl |
(Facoltativo) Endpoint per la pagina web di accesso che supporta il codice OAuth2 o i flussi impliciti. L'URL deve utilizzare HTTPS. Impostato solo quando si utilizza OAuth. |
tokenUrl |
(Facoltativo) Endpoint OAuth2 per lo scambio di token. L'URL deve utilizzare HTTPS. Questa impostazione non viene impostata solo se si utilizza OAuth con concessione IMPLICIT come tipo di collegamento. Impostato solo quando si utilizza OAuth. |
scopes[] |
(Facoltativo) Elenco delle autorizzazioni a cui l'utente deve acconsentire per utilizzare il servizio. Impostato solo quando si utilizza OAuth. Assicurati di fornire i Termini di servizio nelle informazioni della directory della sezione LocalizedSettings.terms_of_service_url se specifichi questo campo. |
learnMoreUrl |
(Facoltativo) Questa è la pagina web del tuo servizio che descrive le autorizzazioni che l'utente concede a Google. Impostalo solo se utilizzi OAuth e Accedi con Google. Assicurati di fornire i Termini di servizio nelle informazioni della directory della sezione LocalizedSettings.terms_of_service_url se specifichi questo campo. |
useBasicAuthHeader |
(Facoltativo) Se impostato su true, consenti a Google di trasmettere l'ID client e il secret tramite l'intestazione di autenticazione di base HTTP. In caso contrario, Google utilizza l'ID client e il secret all'interno del corpo del post. Impostato solo quando si utilizza OAuth. Assicurati di fornire i Termini di servizio nelle informazioni della directory della sezione LocalizedSettings.terms_of_service_url se specifichi questo campo. |
LinkingType
Il tipo di collegamento dell'account da eseguire.
Enum | |
---|---|
LINKING_TYPE_UNSPECIFIED |
Non specificato. |
GOOGLE_SIGN_IN |
Tipo di collegamento Accedi con Google. Se utilizzi questo tipo di collegamento, non è necessario impostare alcun campo relativo a OAuth qui sotto. |
OAUTH_AND_GOOGLE_SIGN_IN |
Tipo di collegamento OAuth e Accedi con Google. |
OAUTH |
Tipo di collegamento OAuth. |
AuthGrantType
Il tipo di autorizzazione OAuth2 utilizzato da Google per guidare l'utente ad accedere al servizio web della tua app.
Enum | |
---|---|
AUTH_GRANT_TYPE_UNSPECIFIED |
Non specificato. |
AUTH_CODE |
Codice di autorizzazione concesso. Richiede di fornire sia l'URL di autenticazione sia l'URL del token di accesso. |
IMPLICIT |
Concessione di codice implicita. Richiede solo che tu fornisca l'URL di autenticazione. |
Webhook
Metadati per diversi tipi di webhook. Se utilizzi inlineCloudFunction
, il codice sorgente deve trovarsi in una directory con lo stesso nome del valore della chiave executeFunction
. Ad esempio, un valore my_webhook
per la chiave executeFunction
avrebbe una struttura di codice simile alla seguente: - /webhooks/my_webhook.yaml
- /webhooks/my_webhook/index.js
- /webhooks/my_webhook/package.json
Rappresentazione JSON | |
---|---|
{ "handlers": [ { object ( |
Campi | ||
---|---|---|
handlers[] |
Elenco di gestori per questo webhook. |
|
Campo unione webhook_type . È supportato un solo tipo di webhook. webhook_type può essere solo uno dei seguenti: |
||
httpsEndpoint |
Endpoint HTTPS del webhook personalizzato. |
|
inlineCloudFunction |
Metadati per la funzione Cloud Functions di cui è stato eseguito il deployment dal codice nella cartella webhooks. |
Handler
Dichiara il nome del gestore webhoook. In un webhook possono essere registrati più gestori. Questi gestori possono essere chiamati da più posizioni nel tuo progetto Actions.
Rappresentazione JSON | |
---|---|
{ "name": string } |
Campi | |
---|---|
name |
Obbligatorio. Nome del gestore. Deve essere univoco in tutti i gestori del progetto Actions. Puoi controllare il nome di questo gestore per richiamare la funzione corretta nel codice sorgente di fulfillment. |
HttpsEndpoint
Endpoint REST per inviare una notifica se non utilizzi l'editor in linea.
Rappresentazione JSON | |
---|---|
{ "baseUrl": string, "httpHeaders": { string: string, ... }, "endpointApiVersion": integer } |
Campi | |
---|---|
baseUrl |
L'URL di base HTTPS dell'endpoint di fulfillment (HTTP non è supportato). I nomi dei gestori vengono aggiunti al percorso dell'URL di base dopo i due punti (seguendo la guida di stile in https://cloud.google.com/apis/design/custom_methods). Ad esempio, un URL di base di "https://gactions.service.com/api" riceverebbe richieste con l'URL "https://gactions.service.com/api:{method}". |
httpHeaders |
Mappa dei parametri HTTP da includere nella richiesta POST. Un oggetto contenente un elenco di |
endpointApiVersion |
Versione del protocollo utilizzato dall'endpoint. Questo è il protocollo condiviso da tutti i tipi di distribuzione e non è specifico per il tipo di completamento Google. |
InlineCloudFunction
Contiene i metadati di una funzione Cloud Functions in linea di cui è stato eseguito il deployment dalla cartella webhook.
Rappresentazione JSON | |
---|---|
{ "executeFunction": string } |
Campi | |
---|---|
executeFunction |
Il nome del punto di ingresso della funzione Cloud Functions. Il valore di questo campo deve corrispondere al nome del metodo esportato dal codice sorgente. |
Intenzione
Gli intent mappano l'input utente aperto agli oggetti strutturati. Le frasi pronunciate vengono associate agli intent grazie alla comprensione del linguaggio naturale (NLU) di Google. Le corrispondenze di intent possono attivare eventi nella progettazione della conversazione per avanzare nella conversazione dell'utente. Il nome dell'intent è specificato nel nome del file.
Rappresentazione JSON | |
---|---|
{
"parameters": [
{
object ( |
Campi | |
---|---|
parameters[] |
L'elenco dei parametri all'interno delle frasi di addestramento. Tutti i parametri devono essere definiti qui per essere utilizzati nella frase di addestramento. |
trainingPhrases[] |
Le frasi di addestramento consentono alla NLU di Google di abbinare automaticamente gli intent all'input dell'utente. Più frasi uniche vengono fornite, maggiori sono le probabilità di trovare una corrispondenza con questo intento. Di seguito è riportato il formato della parte della frase di addestramento annotata. Tieni presente che il campo |
IntentParameter
Definizione di un parametro che può essere utilizzato all'interno delle frasi di addestramento.
Rappresentazione JSON | |
---|---|
{ "name": string, // Union field |
Campi | ||
---|---|---|
name |
Obbligatorio. Nome univoco del parametro intent. Può essere utilizzato in condizioni e risposte per fare riferimento ai parametri di intent estratti da NLU con $intent.params.[name].resolved |
|
Campo unione parameter_type . Il tipo di parametro di intent. parameter_type può essere solo uno dei seguenti: |
||
type |
(Facoltativo) Dichiara il tipo di dati di questo parametro. Non deve essere impostato per gli intent integrati. |
|
entitySetReferences |
(Facoltativo) Fa riferimento agli insiemi di entità consentite per questo parametro intent. Valido solo per i parametri di un intent integrato. Questi riferimenti puntano a set di entità in "custom/entitySets" . |
ClassReference
Un riferimento a una classe utilizzata per dichiarare il tipo di un campo o restituire un valore. Le enum sono anche un tipo di classe a cui si può fare riferimento utilizzando ClassReference.
Rappresentazione JSON | |
---|---|
{ "name": string, "list": boolean } |
Campi | |
---|---|
name |
Obbligatorio. Nome di un tipo integrato o personalizzato del parametro. Esempi: |
list |
(Facoltativo) Indica se il tipo di dati rappresenta un elenco di valori. |
EntitySetReferences
Riferimenti a set di entità per un parametro intent.
Rappresentazione JSON | |
---|---|
{
"entitySetReferences": [
{
object ( |
Campi | |
---|---|
entitySetReferences[] |
Obbligatorio. Riferimenti a set di entità per un parametro intent. |
EntitySetReference
Un riferimento all'insieme di entità consentite per questo parametro intent.
Rappresentazione JSON | |
---|---|
{ "entitySet": string } |
Campi | |
---|---|
entitySet |
Obbligatorio. Identifica la raccolta specifica di entità da prendere in considerazione per un determinato parametro. La definizione del set di entità corrispondente deve essere presente nella directory custom/entitySets/. |
Tipo
Dichiarazione di un tipo personalizzato, al contrario dei tipi integrati. I tipi possono essere assegnati agli slot in una scena o ai parametri delle frasi di addestramento di un intent. In pratica, i tipi possono essere considerati come enumerazioni. Nota: il nome del tipo è specificato nel nome del file.
Rappresentazione JSON | |
---|---|
{ "exclusions": [ string ], // Union field |
Campi | ||
---|---|---|
exclusions[] |
Insieme di parole/frasi eccezionali per cui non occorre trovare corrispondenze in base al tipo. Nota: se la parola o la frase corrisponde al tipo, ma viene elencata come esclusione, non verrà restituita nel risultato dell'estrazione dei parametri. Questo campo è localizzabile. |
|
Campo unione sub_type . Selezione del sottotipo in base al tipo di corrispondenza da eseguire. sub_type può essere solo uno dei seguenti: |
||
synonym |
Tipo di sinonimi, che è essenzialmente un'enumerazione. |
|
regularExpression |
Tipo di espressione regolare, consente la corrispondenza con espressioni regolari. |
|
freeText |
Tipo di testo libero. |
SynonymType
Tipo che corrisponde al testo per insieme di sinonimi.
Rappresentazione JSON | |
---|---|
{ "matchType": enum ( |
Campi | |
---|---|
matchType |
(Facoltativo) Il tipo di corrispondenza del sinonimo. |
acceptUnknownValues |
(Facoltativo) Se impostato su true, corrisponde a parole o frasi sconosciute in base all'input circostante e ai dati di addestramento per intent, ad esempio gli articoli che potrebbero essere aggiunti a una lista della spesa. |
entities |
Obbligatorio. Mappa con nome di entità di sinonimi. Un oggetto contenente un elenco di |
MatchType
Il tipo di corrispondenza che verrà utilizzato dalle voci in questo tipo. In questo modo, tutti i tipi utilizzeranno lo stesso metodo di corrispondenza e consentiranno la variazione della corrispondenza per la corrispondenza dei sinonimi (ad esempio parziale o esatta). Se il valore è UNSPECIFIED
, il valore predefinito sarà EXACT_MATCH
.
Enum | |
---|---|
UNSPECIFIED |
Il valore predefinito è EXACT_MATCH . |
EXACT_MATCH |
Cerca una corrispondenza esatta del sinonimo o del nome. |
FUZZY_MATCH |
Più bassa di EXACT_MATCH . Cerca corrispondenze simili e esatte. |
Entità
Rappresenta un campo di entità di sinonimo che contiene i dettagli di una singola voce all'interno del tipo.
Rappresentazione JSON | |
---|---|
{
"display": {
object ( |
Campi | |
---|---|
display |
(Facoltativo) I dettagli di visualizzazione dell'entità. |
synonyms[] |
(Facoltativo) L'elenco di sinonimi dell'entità. Questo campo è localizzabile. |
EntityDisplay
Elementi che verranno visualizzati nel canvas dopo l'estrazione dell'entità di un determinato tipo da una query. Pertinente solo per le app compatibili con Canvas. Questo messaggio è localizzabile.
Rappresentazione JSON | |
---|---|
{ "iconTitle": string, "iconUrl": string } |
Campi | |
---|---|
iconTitle |
(Facoltativo) Titolo dell'icona. |
iconUrl |
Obbligatorio. URL dell'icona. |
RegularExpressionType
Tipo che corrisponde al testo mediante espressioni regolari. Questo messaggio è localizzabile.
Rappresentazione JSON | |
---|---|
{
"entities": {
string: {
object ( |
Campi | |
---|---|
entities |
Obbligatorio. Mappa con nome di entità contenenti ciascuna stringhe regex. Un oggetto contenente un elenco di |
Entità
Rappresenta un oggetto entità che contiene l'espressione regolare utilizzata per il confronto.
Rappresentazione JSON | |
---|---|
{
"display": {
object ( |
Campi | |
---|---|
display |
(Facoltativo) Elementi che verranno visualizzati nel canvas dopo l'estrazione di un'entità da una query. Pertinente solo per le app compatibili con Canvas. |
regularExpressions[] |
Obbligatorio. Utilizza la sintassi regex RE2 (vedi https://github.com/google/re2/wiki/Syntax per maggiori dettagli) |
FreeTextType
Tipo che corrisponde a qualsiasi testo se il contesto delle parole circostanti è simile agli esempi di addestramento forniti.
Rappresentazione JSON | |
---|---|
{
"display": {
object ( |
Campi | |
---|---|
display |
(Facoltativo) Elementi che verranno visualizzati nel canvas dopo l'estrazione di un'entità da una query. Pertinente solo per le app compatibili con Canvas. |
EntitySet
Gli insiemi di entità descrivono l'insieme predefinito di entità da cui possono provenire i valori dei parametri di intent integrati. È possibile fare riferimento ai set di entità da entitySet nei parametri integrati di intent.
Rappresentazione JSON | |
---|---|
{
"entities": [
{
object ( |
Campi | |
---|---|
entities[] |
Obbligatorio. L'elenco di entità supportate da questo set di entità. |
Entità
Un'entità da cui può provenire il valore integrato di un parametro di intent.
Rappresentazione JSON | |
---|---|
{ "id": string } |
Campi | |
---|---|
id |
Obbligatorio. L'ID dell'entità. Per un elenco dei parametri integrati nell'intent e delle relative entità supportate, consulta la pagina https://developers.google.com/assistant/conversational/build/built-in-intents |
GlobalIntentEvent
Definisce un gestore di intent globale. Gli eventi di intent globali hanno come ambito l'intero progetto Actions e possono essere sostituiti dai gestori di intent in una scena. I nomi degli intent devono essere univoci all'interno di un progetto Actions.
Gli intent globali possono essere abbinati in qualsiasi momento durante una sessione, consentendo agli utenti di accedere a flussi comuni come "Richiedi assistenza" o "tornare alla home page". Possono essere utilizzate anche per collegare gli utenti a flussi specifici quando richiamano un'azione.
Tieni presente che il nome dell'intent è specificato nel nome del file.
Rappresentazione JSON | |
---|---|
{
"transitionToScene": string,
"handler": {
object ( |
Campi | |
---|---|
transitionToScene |
(Facoltativo) Scena di destinazione a cui dovrebbe passare la conversazione. Lo stato della scena attuale viene distrutto durante la transizione. |
handler |
(Facoltativo) Gestore di eventi che viene attivato quando viene trovata una corrispondenza con l'intent. Da eseguire prima del passaggio alla scena di destinazione. Utile per generare prompt in risposta agli eventi. |
EventHandler
Definisce un gestore da eseguire dopo un evento. Esempi di eventi sono quelli basati su intenzione e condizione in una scena.
Rappresentazione JSON | |
---|---|
{ "webhookHandler": string, // Union field |
Campi | ||
---|---|---|
webhookHandler |
Nome del gestore webhook da chiamare. |
|
Campo unione prompt . I prompt possono essere incorporati o indicati per nome. prompt può essere solo uno dei seguenti: |
||
staticPrompt |
Prompt statico incorporato. Può contenere riferimenti a risorse stringa in bundle. |
|
staticPromptName |
Nome del prompt statico da richiamare. |
StaticPrompt
Rappresenta un elenco di candidati, uno dei quali verrà selezionato come prompt da mostrare nella risposta all'utente. Questo messaggio è localizzabile.
Rappresentazione JSON | |
---|---|
{
"candidates": [
{
object ( |
Campi | |
---|---|
candidates[] |
L'elenco di prompt candidati da inviare al client. Ogni prompt ha un selettore per determinare quando può essere utilizzato. Verrà inviato il primo selettore che corrisponde a una richiesta, mentre il resto verrà ignorato. |
StaticPromptCandidate
Rappresenta un candidato di prompt statico.
Rappresentazione JSON | |
---|---|
{ "selector": { object ( |
Campi | |
---|---|
selector |
(Facoltativo) Il criterio per determinare se questo prompt corrisponde a una richiesta. Se il selettore è vuoto, questo prompt verrà attivato sempre. |
promptResponse |
La risposta del prompt associata al selettore. |
Selettore
Definisce i criteri per stabilire se un prompt corrisponde a una richiesta.
Rappresentazione JSON | |
---|---|
{
"surfaceCapabilities": {
object ( |
Campi | |
---|---|
surfaceCapabilities |
L'insieme di capacità di superficie richieste. |
SurfaceCapabilities
Rappresenta la piattaforma utilizzata dall'utente per inviare una richiesta all'azione.
Rappresentazione JSON | |
---|---|
{
"capabilities": [
enum ( |
Campi | |
---|---|
capabilities[] |
Obbligatorio. Le capacità della superficie che effettua una richiesta all'Azione. |
Capacità
Funzionalità supportate dalla piattaforma del dispositivo al momento della richiesta.
Enum | |
---|---|
UNSPECIFIED |
Capacità di superficie non specificata. |
SPEECH |
Il dispositivo può parlare con l'utente tramite la sintesi vocale o SSML. |
RICH_RESPONSE |
Il dispositivo può visualizzare risposte avanzate come schede, elenchi e tabelle. |
LONG_FORM_AUDIO |
Il dispositivo può riprodurre contenuti multimediali audio nel formato lungo, come musica e podcast. |
INTERACTIVE_CANVAS |
Il dispositivo può visualizzare una risposta canvas interattiva. |
WEB_LINK |
Il dispositivo può usare link web nelle risposte avanzate per aprire un browser web. |
HOME_STORAGE |
Il dispositivo può supportare il salvataggio e il recupero dello spazio di archiviazione della casa. |
StaticPromptResponse
Rappresenta risposte strutturate da inviare all'utente, come testo, voce, schede, dati canvas, chip di suggerimenti e così via.
Rappresentazione JSON | |
---|---|
{ "firstSimple": { object ( |
Campi | |
---|---|
firstSimple |
(Facoltativo) La prima risposta vocale e di solo testo. |
content |
(Facoltativo) Contenuti come una scheda, un elenco o contenuti multimediali da mostrare all'utente. |
lastSimple |
(Facoltativo) L'ultima risposta vocale e di solo testo. |
suggestions[] |
(Facoltativo) Suggerimenti da mostrare all'utente, che saranno sempre visualizzati alla fine della risposta. Se il campo |
link |
(Facoltativo) Un chip di suggerimento aggiuntivo che può rimandare all'app o al sito associato. Il chip verrà visualizzato con il titolo "Apri |
override |
(Facoltativo) Modalità per unire questi messaggi a messaggi definiti in precedenza. |
canvas |
Una risposta da utilizzare per l'esperienza interattiva sulla tela. |
StaticSimplePrompt
Rappresenta un semplice prompt da inviare a un utente.
Rappresentazione JSON | |
---|---|
{
"variants": [
{
object ( |
Campi | |
---|---|
variants[] |
Elenco delle possibili varianti. |
Variante
Rappresenta una variante che fa parte del prompt semplice.
Rappresentazione JSON | |
---|---|
{ "speech": string, "text": string } |
Campi | |
---|---|
speech |
(Facoltativo) Rappresenta il discorso da pronunciare all'utente. Può essere SSML o sintesi vocale. Per impostazione predefinita, la voce verrà aggiunta alla voce del prompt semplice precedente. Se il campo |
text |
(Facoltativo) Testo da visualizzare nel fumetto della chat. Se non viene specificato, verrà utilizzato il rendering del campo vocale riportato sopra. Limitato a 640 caratteri. Per impostazione predefinita, il testo verrà aggiunto al testo del prompt semplice precedente. Se il campo |
StaticContentPrompt
Un segnaposto per la parte relativa ai contenuti di un prompt statico.
Rappresentazione JSON | |
---|---|
{ // Union field |
Campi | ||
---|---|---|
Campo unione content . In un prompt può essere presente un solo tipo di contenuto. content può essere solo uno dei seguenti: |
||
card |
Una carta di base. |
|
image |
Un'immagine. |
|
table |
Scheda tabella. |
|
media |
Risposta che indica un insieme di contenuti multimediali da riprodurre. |
|
list |
Una scheda per presentare un elenco di opzioni tra cui scegliere. |
|
collection |
Una scheda che presenta un elenco di opzioni tra cui scegliere. |
|
collectionBrowse |
Una scheda con una raccolta di pagine web da aprire. |
StaticCardPrompt
Una scheda di base per visualizzare alcune informazioni, ad esempio un'immagine e/o del testo.
Rappresentazione JSON | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
Campi | |
---|---|
title |
(Facoltativo) Titolo generale della scheda. |
subtitle |
(Facoltativo) Sottotitolo della scheda. |
text |
Obbligatorio. Il corpo del testo della scheda, necessario, a meno che non sia presente un'immagine. Supporta un insieme limitato di sintassi di Markdown per la formattazione. |
image |
(Facoltativo) Un'immagine hero per la carta. L'altezza è fissa a 192 dp. |
imageFill |
(Facoltativo) Il modo in cui lo sfondo dell'immagine verrà riempito. |
button |
(Facoltativo) Un pulsante cliccabile da mostrare nella scheda. |
StaticImagePrompt
Un'immagine visualizzata nella scheda.
Rappresentazione JSON | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
Campi | |
---|---|
url |
Obbligatorio. L'URL di origine dell'immagine. Le immagini possono essere in formato JPG, PNG e GIF (animate e non animate). Ad esempio, |
alt |
Obbligatorio. Una descrizione testuale dell'immagine da utilizzare per l'accessibilità, ad es. screen reader. |
height |
(Facoltativo) L'altezza dell'immagine in pixel. |
width |
(Facoltativo) La larghezza dell'immagine in pixel. |
ImageFill
Possibili opzioni di visualizzazione dell'immagine che influiscono sulla presentazione dell'immagine stessa. Questa opzione deve essere utilizzata quando le proporzioni dell'immagine non corrispondono a quelle del contenitore di immagini.
Enum | |
---|---|
UNSPECIFIED |
ImageFill non specificato. |
GRAY |
Riempi gli spazi vuoti tra l'immagine e il contenitore di immagini con barre grigie. |
WHITE |
Riempi gli spazi vuoti tra l'immagine e il contenitore di immagini con barre bianche. |
CROPPED |
L'immagine viene ridimensionata in modo che la larghezza e l'altezza dell'immagine corrispondano o superino le dimensioni del contenitore. In questo modo, la parte superiore e inferiore dell'immagine potrebbero essere ritagliate se l'altezza dell'immagine scalata è superiore all'altezza del contenitore oppure potrebbe essere ritagliata a sinistra e a destra dell'immagine se la larghezza dell'immagine scalata è superiore a quella del contenitore. È simile alla "Modalità zoom" su una TV widescreen durante la riproduzione di un video in 4:3. |
StaticLinkPrompt
Definisce un link che verrà visualizzato come chip di suggerimento e può essere aperto dall'utente.
Rappresentazione JSON | |
---|---|
{
"name": string,
"open": {
object ( |
Campi | |
---|---|
name |
Nome del link |
open |
Definisce il comportamento quando l'utente apre il link. |
OpenUrl
Definisce il comportamento quando l'utente apre il link.
Rappresentazione JSON | |
---|---|
{
"url": string,
"hint": enum ( |
Campi | |
---|---|
url |
Il campo url che può essere uno dei seguenti: - URL http/https per l'apertura di un'app collegata all'app o di una pagina web |
hint |
Indica un suggerimento per il tipo di URL. |
UrlHint
Diversi tipi di suggerimenti URL.
Enum | |
---|---|
HINT_UNSPECIFIED |
Non specificato |
AMP |
URL che indirizza direttamente ai contenuti AMP o a un URL canonico che fa riferimento ai contenuti AMP tramite <link rel="amphtml"> . |
StaticTablePrompt
Una scheda per visualizzare una tabella di testo.
Rappresentazione JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Campi | |
---|---|
title |
(Facoltativo) Titolo generale della tabella. Deve essere impostato se sono stati impostati i sottotitoli. |
subtitle |
(Facoltativo) Sottotitolo per la tabella. |
image |
(Facoltativo) Immagine associata alla tabella. |
columns[] |
(Facoltativo) Intestazioni e allineamento delle colonne. |
rows[] |
(Facoltativo) Dati delle righe della tabella. È garantita la visualizzazione delle prime tre righe, ma altre potrebbero essere tagliate su determinate superfici. Esegui un test con il simulatore per vedere quali righe verranno visualizzate per una determinata superficie. Sulle piattaforme che supportano la funzionalità |
button |
(Facoltativo) Pulsante. |
TableColumn
Descrive una colonna della tabella.
Rappresentazione JSON | |
---|---|
{
"header": string,
"align": enum ( |
Campi | |
---|---|
header |
Testo dell'intestazione per la colonna. |
align |
Allineamento orizzontale dei contenuti rispetto alla colonna. Se non specificato, i contenuti verranno allineati al bordo iniziale. |
HorizontalAlignment
L'allineamento dei contenuti all'interno della cella.
Enum | |
---|---|
UNSPECIFIED |
Allineamento orizzontale non specificato. |
LEADING |
Bordo d'ingresso della cella. Questa è l'impostazione predefinita. |
CENTER |
I contenuti sono allineati al centro della colonna. |
TRAILING |
Il contenuto è allineato al bordo finale della colonna. |
TableRow
Descrive una riga della tabella.
Rappresentazione JSON | |
---|---|
{
"cells": [
{
object ( |
Campi | |
---|---|
cells[] |
Celle in questa riga. È garantita la visualizzazione delle prime 3 celle, ma le altre potrebbero essere tagliate su determinate superfici. Esegui un test con il simulatore per vedere quali celle verranno visualizzate per una determinata superficie. |
divider |
Indica se deve esserci un divisore dopo ogni riga. |
TableCell
Descrive una cella in una riga.
Rappresentazione JSON | |
---|---|
{ "text": string } |
Campi | |
---|---|
text |
Contenuto testuale della cella. |
StaticMediaPrompt
Contiene informazioni sui contenuti multimediali, come nome, descrizione, URL e così via. Next id: 11
Rappresentazione JSON | |
---|---|
{ "mediaType": enum ( |
Campi | |
---|---|
mediaType |
Tipo multimediale di questa risposta. |
startOffset |
Offset iniziale del primo oggetto multimediale. Durata in secondi con un massimo di nove cifre frazionarie, terminata da " |
optionalMediaControls[] |
Tipi facoltativi di controlli multimediali supportati da questa sessione di risposte multimediali. Se impostato, la richiesta verrà effettuata a terze parti quando si verifica un determinato evento multimediale. Se non viene configurato, 3p deve comunque gestire due tipi di controllo predefiniti, FINISHED e FAILED. |
mediaObjects[] |
Elenco di oggetti multimediali. |
repeatMode |
Modalità di ripetizione per l'elenco di oggetti multimediali. |
MediaType
Tipo multimediale di questa risposta.
Enum | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
Valore NON SPECIFICATO |
AUDIO |
File audio. |
MEDIA_STATUS_ACK |
Risposta per confermare un report sullo stato dei media. |
OptionalMediaControls
Tipi di controlli multimediali che la risposta multimediale può supportare facoltativamente
Enum | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
Valore non specificato |
PAUSED |
Evento in pausa. Si attiva quando l'utente mette in pausa i contenuti multimediali. |
STOPPED |
Evento interrotto. Si attiva quando l'utente esce dalla sessione di terze parti durante la riproduzione di contenuti multimediali. |
MediaObject
Rappresenta un singolo oggetto multimediale.
Rappresentazione JSON | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
Campi | |
---|---|
name |
Nome dell'oggetto multimediale. |
description |
Descrizione di questo oggetto multimediale. |
url |
L'URL che rimanda ai contenuti multimediali. |
image |
Immagine da mostrare con la scheda dei contenuti multimediali. |
MediaImage
Immagine da mostrare all'interno di un MediaPrompt.
Rappresentazione JSON | |
---|---|
{ // Union field |
Campi | ||
---|---|---|
Campo unione image . È consentito un solo tipo di MediaImage. image può essere solo uno dei seguenti: |
||
large |
Un'immagine di grandi dimensioni, come la copertina dell'album e così via. |
|
icon |
Una piccola icona immagine visualizzata a destra rispetto al titolo. Viene ridimensionato a 36 x 36 dp. |
RepeatMode
I tipi di modalità di ripetizione per un elenco di oggetti multimediali.
Enum | |
---|---|
REPEAT_MODE_UNSPECIFIED |
Equivale a OFF. |
OFF |
Termina sessione multimediale alla fine dell'ultimo oggetto multimediale. |
ALL |
Consente di ripetere continuamente l'inizio del primo oggetto multimediale quando viene raggiunta la fine dell'ultimo oggetto multimediale. |
StaticListPrompt
Una scheda per presentare un elenco di opzioni tra cui scegliere.
Rappresentazione JSON | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
Campi | |
---|---|
title |
(Facoltativo) Titolo dell'elenco. |
subtitle |
(Facoltativo) Sottotitolo dell'elenco. |
items[] |
Obbligatorio. Voci dell'elenco. |
ListItem
Un elemento dell'elenco.
Rappresentazione JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Campi | |
---|---|
key |
Obbligatorio. La chiave NLU corrispondente al nome della chiave di accesso nel tipo associato. Quando l'elemento viene toccato, questa chiave viene pubblicata come parametro di opzione di selezione. |
title |
Obbligatorio. Titolo dell'articolo. Se toccato, il testo viene pubblicato nella conversazione parola per parola, come se l'utente lo avesse digitato. Ogni titolo deve essere unico nell'insieme di elementi. |
description |
(Facoltativo) Corpo del testo dell'elemento. |
image |
(Facoltativo) Immagine elemento. |
StaticCollectionPrompt
Una scheda per presentare una raccolta di opzioni tra cui scegliere.
Rappresentazione JSON | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
Campi | |
---|---|
title |
(Facoltativo) Titolo della raccolta. |
subtitle |
(Facoltativo) Sottotitolo della raccolta. |
items[] |
Obbligatorio. Elementi della raccolta. |
imageFill |
(Facoltativo) Tipo di opzione di visualizzazione dell'immagine. |
CollectionItem
Un elemento nella raccolta.
Rappresentazione JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Campi | |
---|---|
key |
Obbligatorio. La chiave NLU corrispondente al nome della chiave di accesso nel tipo associato. Quando l'elemento viene toccato, questa chiave viene pubblicata come parametro di opzione di selezione. |
title |
Obbligatorio. Titolo dell'articolo. Se toccato, il testo viene pubblicato nella conversazione parola per parola, come se l'utente lo avesse digitato. Ogni titolo deve essere unico nell'insieme di elementi. |
description |
(Facoltativo) Corpo del testo dell'elemento. |
image |
(Facoltativo) Immagine elemento. |
StaticCollectionBrowsePrompt
Presenta un insieme di documenti web come raccolta di elementi di grandi dimensioni. Gli elementi possono essere selezionati per avviare il documento web associato in un visualizzatore web.
Rappresentazione JSON | |
---|---|
{ "items": [ { object ( |
Campi | |
---|---|
items[] |
Elementi nella raccolta Sfoglia. La dimensione dell'elenco deve essere compresa nell'intervallo [2, 10]. |
imageFill |
Opzione di visualizzazione delle immagini per le immagini nella raccolta. |
CollectionBrowseItem
Elemento della raccolta.
Rappresentazione JSON | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
Campi | |
---|---|
title |
Obbligatorio. Titolo dell'elemento della raccolta. |
description |
Descrizione dell'elemento della raccolta. |
footer |
Testo a piè di pagina per l'elemento della raccolta, visualizzato sotto la descrizione. Una singola riga di testo, troncata con i puntini di sospensione. |
image |
Immagine per l'elemento della raccolta. |
openUriAction |
Obbligatorio. URI da aprire se l'elemento selezionato. |
Suggerimento
Rappresenta un chip di suggerimento, un elemento UI mostrato all'utente per comodità.
Rappresentazione JSON | |
---|---|
{ "title": string } |
Campi | |
---|---|
title |
Obbligatorio. Il testo mostrato nel chip di suggerimento. Se toccato, il testo viene pubblicato nella conversazione parola per parola, come se l'utente lo avesse digitato. Ogni titolo deve essere univoco tra l'insieme di chip di suggerimento. Massimo 25 caratteri |
StaticCanvasPrompt
Rappresenta una risposta di Canvas interattiva da inviare all'utente. Può essere utilizzato in combinazione con il campo firstSimple
nella richiesta contenente di parlare con l'utente, oltre a visualizzare una risposta canvas interattiva.
Rappresentazione JSON | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean, "sendStateDataToCanvasApp": boolean, "enableFullScreen": boolean } |
Campi | |
---|---|
url |
Obbligatorio. URL della vista web da caricare. |
data[] |
(Facoltativo) Dati JSON da trasmettere alla pagina web dell'esperienza immersiva sotto forma di evento. Se il campo |
suppressMic |
(Facoltativo) Un valore reale indica che il microfono non si aprirà per acquisire l'input dopo aver presentato questa risposta immersiva all'utente. |
sendStateDataToCanvasApp |
(Facoltativo) Se |
enableFullScreen |
(Facoltativo) Se |
Scena
La scena è l'unità di base del flusso di controllo durante la progettazione di una conversazione. Possono essere concatenati ad altre scene, generare prompt per l'utente finale e definire slot. Il nome della scena è specificato nel nome del file.
Rappresentazione JSON | |
---|---|
{ "onEnter": { object ( |
Campi | |
---|---|
onEnter |
Gestore da richiamare durante il passaggio a questa scena. |
intentEvents[] |
L'elenco di eventi che si attivano in base agli intent. Questi eventi possono essere attivati in qualsiasi momento dopo la chiamata del gestore on_load. Importante: questi eventi definiscono l'insieme di intent che hanno come ambito questa scena e avranno la precedenza su qualsiasi evento definito a livello globale che abbia gli stessi intent o frasi di attivazione. I nomi degli intent devono essere univoci all'interno di una scena. |
conditionalEvents[] |
L'elenco di eventi da attivare in base alle istruzioni condizionali. Questi vengono valutati dopo che il modulo è stato compilato o immediatamente dopo on_load se la scena non ha un modulo (la valutazione viene eseguita una sola volta). Verrà attivato solo il primo evento corrispondente. |
slots[] |
Elenco ordinato di slot. Ogni slot definisce il tipo di dati che verranno risolti e la configurazione per personalizzare l'esperienza di questa risoluzione (ad es. prompt). |
onSlotUpdated |
Il gestore viene chiamato quando si verifica un cambiamento di stato di uno slot non causato da aggiornamenti all'interno di un altro gestore. Ciò consente l'annullamento della validità degli slot, dell'annullamento della validità della scena o di altre modifiche allo stato della scena. |
IntentEvent
Registra gli eventi che si attivano in seguito a una corrispondenza di intent.
Rappresentazione JSON | |
---|---|
{
"intent": string,
"transitionToScene": string,
"handler": {
object ( |
Campi | |
---|---|
intent |
Obbligatorio. Intento che attiva l'evento. |
transitionToScene |
(Facoltativo) Scena di destinazione a cui dovrebbe passare la conversazione. Lo stato della scena attuale viene distrutto durante la transizione. |
handler |
(Facoltativo) Gestore di eventi che viene attivato quando viene trovata una corrispondenza con l'intent. Da eseguire prima del passaggio alla scena di destinazione. Utile per generare prompt in risposta agli eventi. |
ConditionalEvent
Registra gli eventi che si attivano in seguito a una condizione true.
Rappresentazione JSON | |
---|---|
{
"condition": string,
"transitionToScene": string,
"handler": {
object ( |
Campi | |
---|---|
condition |
Obbligatorio. Filtra le condizioni per attivare questo evento. Se la condizione viene valutata su true, viene attivato il |
transitionToScene |
(Facoltativo) Scena di destinazione a cui deve passare la conversazione quando la condizione associata viene valutata su true. Lo stato della scena attuale viene distrutto durante la transizione. |
handler |
(Facoltativo) Gestore di eventi che viene attivato quando la condizione associata viene valutata in |
Slot
Configurazione per uno slot. Le slot sono singole unità di dati che possono essere riempite tramite linguaggio naturale (ovvero parametri di intent), parametri di sessione e altre origini.
Rappresentazione JSON | |
---|---|
{ "name": string, "type": { object ( |
Campi | |
---|---|
name |
Obbligatorio. Nome dell'area. |
type |
Obbligatorio. Dichiara il tipo di dati di questo slot. |
required |
(Facoltativo) Indica se lo spazio deve essere riempito prima di avanzare. Gli slot obbligatori non riempiti attiveranno un prompt personalizzabile per l'utente. |
promptSettings |
(Facoltativo) Registra i prompt per le diverse fasi di riempimento degli slot. |
commitBehavior |
(Facoltativo) Comportamento del commit associato all'area. |
config |
(Facoltativo) Configurazione aggiuntiva associata allo slot utilizzata per riempire lo slot. Il formato della configurazione è specifico per il tipo di area annuncio. A questa configurazione puoi aggiungere riferimenti delle risorse al parametro utente o di sessione. Questa configurazione è necessaria per riempire gli slot relativi alle transazioni e al coinvolgimento degli utenti. Esempio: per un'area di tipo actions.type.CompletePurchaseValue, la seguente configurazione propone un ordine per prodotti digitali con un riferimento a un parametro di sessione definito dal cliente { "@type": "type.googleapis.com/ google.actions.transactions.v3.CompletePurchaseValueSpec", "skuId": { "skuType": "SKU_TYPE_IN_APP", "id": "$session.params.userSelectedSkuId", "packageName": "com.example.company" } |
defaultValue |
(Facoltativo) Configurazione per compilare un valore predefinito per questa area annuncio. |
PromptSettings
Un unico posto in cui vengono definiti i prompt di slot.
Rappresentazione JSON | |
---|---|
{ "initialPrompt": { object ( |
Campi | |
---|---|
initialPrompt |
Richiede il valore dello slot stesso. Esempio: "Quale taglia volevi?" |
noMatchPrompt1 |
Prompt da fornire quando l'input dell'utente non corrisponde per la prima volta al tipo di valore previsto per lo slot. Esempio: "Non ho capito". |
noMatchPrompt2 |
Richiesta da fornire quando l'input dell'utente non corrisponde per la seconda volta al tipo di valore previsto per lo slot. Esempio: "Non ho capito". |
noMatchFinalPrompt |
Prompt da fornire quando l'input dell'utente non corrisponde al tipo di valore previsto per lo slot per l'ultima volta. Esempio: "Non ho capito". |
noInputPrompt1 |
Richiesta da fornire quando l'utente non fornisce un input per la prima volta. Esempio: "Non ho capito". |
noInputPrompt2 |
Richiesta da fornire quando l'utente non fornisce un input per la seconda volta. Esempio: "Non ho capito". |
noInputFinalPrompt |
Prompt da mostrare quando l'utente non fornisce un input per l'ultima volta. Esempio: "Non ho capito". |
CommitBehavior
Messaggio che descrive il comportamento di commit associato allo slot dopo che è stato riempito correttamente.
Rappresentazione JSON | |
---|---|
{ "writeSessionParam": string } |
Campi | |
---|---|
writeSessionParam |
Il parametro di sessione per scrivere il valore dello slot dopo averlo riempito. Tieni presente che i percorsi nidificati non sono attualmente supportati. "$$" viene utilizzato per scrivere il valore slot in un parametro di sessione con lo stesso nome dello slot. Ad esempio: writeSessionParam = "fruit" corrisponde a "$session.params.fruit". writeSessionParam = "ticket" corrisponde a "$session.params.ticket". |
DefaultValue
Configurazione per compilare un valore predefinito per questa area annuncio.
Rappresentazione JSON | |
---|---|
{ "sessionParam": string, "constant": value } |
Campi | |
---|---|
sessionParam |
(Facoltativo) Il parametro di sessione da utilizzare per inizializzare il valore slot, se ha un valore non vuoto. Il tipo del valore deve corrispondere al tipo di area. Tieni presente che i percorsi nidificati non sono attualmente supportati. Ad esempio: |
constant |
(Facoltativo) Valore predefinito costante per l'area. Verrà utilizzato solo se un valore per questa area non è stato compilato tramite |
DataFiles
Wrapper per i file di dati ripetuti. I campi ripetuti non possono esistere in un elemento.
Rappresentazione JSON | |
---|---|
{
"dataFiles": [
{
object ( |
Campi | |
---|---|
dataFiles[] |
Più file di dati. |
DataFile
Rappresenta un singolo file contenente dati non strutturati. Alcuni esempi sono file immagine, file audio e codice sorgente delle funzioni Cloud Functions.
Rappresentazione JSON | |
---|---|
{ "filePath": string, "contentType": string, "payload": string } |
Campi | |
---|---|
filePath |
Percorso relativo del file di dati dalla directory principale del progetto nella struttura del file dell'SDK. Percorsi file consentiti: - Immagini: |
contentType |
Obbligatorio. Il tipo di contenuti di questa risorsa. Esempio: |
payload |
Contenuti del file di dati. Alcuni esempi potrebbero essere byte non elaborati di immagini, file audio o formato ZIP delle funzioni Cloud Functions. Esiste un limite fisso di 10 MB per le dimensioni del payload. Una stringa con codifica base64. |