Ressource: Intégration
Informations sur l'intégration.
Représentation JSON |
---|
{ "name": string, "status": enum ( |
Champs | |
---|---|
name |
Uniquement en sortie. Identifiant unique de l'intégration. Lecture seule. Définie par la plate-forme. |
status |
Uniquement en sortie. État de l'intégration. |
Champ d'union integration_info . Informations détaillées sur l'intégration. integration_info ne peut être qu'un des éléments suivants : |
|
dialogflowEsIntegration |
Informations sur un projet Dialogflow ES associé. https://cloud.google.com/dialogflow/es/docs |
dialogflowCxIntegration |
Informations sur un projet Dialogflow CX associé. https://cloud.google.com/dialogflow/cx/docs/basics |
agentWebhookIntegration |
Informations sur le webhook pour un agent. Si un webhook est configuré au niveau de l'agent, il remplace le webhook au niveau du partenaire. |
IntegrationStatus
États d'intégration.
Enums | |
---|---|
INTEGRATION_STATUS_UNSPECIFIED |
L'état de l'intégration n'est pas spécifié. |
ENABLED |
Activé |
DISABLED |
Désactivée. |
DialogflowEsIntegration
Informations sur un agent Business Messages et l'association d'un projet Dialogflow ES.
Représentation JSON |
---|
{ "dialogflowProjectId": string, "autoResponseStatus": enum ( |
Champs | |
---|---|
dialogflowProjectId |
Obligatoire. ID du projet Dialogflow. Non modifiable. Pour modifier cette valeur, vous devez supprimer le projet Dialogflow de cet agent, puis créer une intégration. |
autoResponseStatus |
Obligatoire. Si la valeur est |
dialogflowServiceAccountEmail |
Uniquement en sortie. Compte de service qui doit être configuré dans le projet Dialogflow avec les rôles "Éditeur d'agent de la console Dialogflow" et "Client de l'API Dialogflow". Cette étape est obligatoire pour fournir l'accès à l'API Dialogflow. |
operationInfo |
Uniquement en sortie. Informations sur l'état de fonctionnement de l'intégration Dialogflow. |
dialogflowKnowledgeBases[] |
Bases de connaissances associées au projet Dialogflow. Facultatif |
AutoResponseStatus
État de la réponse automatique Dialogflow.
Enums | |
---|---|
AUTO_RESPONSE_STATUS_UNSPECIFIED |
La réponse automatique n'est pas spécifiée. |
ENABLED |
La réponse automatique est activée. |
DISABLED |
La réponse automatique est désactivée. |
OperationInfo
Informations sur l'opération Dialogflow.
Représentation JSON |
---|
{ "operationName": string, "operationType": enum ( |
Champs | |
---|---|
operationName |
Uniquement en sortie. Le nom attribué par le serveur (identifiant d'opération), qui est unique uniquement au sein du même service qui le renvoie initialement. |
operationType |
Uniquement en sortie. Type d'opération Dialogflow. |
operationState |
Uniquement en sortie. État de l'opération Dialogflow. |
error |
Uniquement en sortie. Résultat de l'erreur, le cas échéant. |
OperationType
Types d'opérations Dialogflow
Enums | |
---|---|
OPERATION_TYPE_UNSPECIFIED |
Type non spécifié. |
ASSOCIATE_DIALOGFLOW |
Associer Dialogflow |
DISSOCIATE_DIALOGFLOW |
Dissocier Dialogflow. |
ADD_DOCUMENT_TO_KNOWLEDGEBASE |
Ajouter le document à la base de connaissances. |
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE |
Supprimer le document de la base de connaissances. |
OperationState
États des opérations dans Dialogflow.
Enums | |
---|---|
OPERATION_STATE_UNSPECIFIED |
État non spécifié. |
PROCESSING |
Traitement en cours. |
COMPLETED |
Terminé. |
FAILED |
Échec. |
État
Le type Status
définit un modèle d'erreur logique adapté aux différents environnements de programmation, y compris les API REST et RPC. Il est utilisé par le protocole gRPC. Chaque message Status
contient trois éléments de données : un code d'erreur, un message d'erreur et les détails de l'erreur.
Pour en savoir plus sur ce modèle d'erreur et sur son utilisation, consultez le Guide de conception d'API.
Représentation JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Champs | |
---|---|
code |
Code d'état, qui doit être une valeur d'énumération de |
message |
Message d'erreur destiné au développeur, qui doit être en anglais. Tout message d'erreur destiné aux utilisateurs doit être localisé et envoyé dans le champ |
details[] |
Liste de messages comportant les détails de l'erreur. Il existe un ensemble commun de types de message utilisable par les API. Objet contenant des champs d'un type arbitraire. Un champ supplémentaire |
DialogflowKnowledgebase
Informations sur la base de connaissances. Une base de connaissances peut comporter plusieurs URL de questions fréquentes.
Représentation JSON |
---|
{
"name": string,
"displayName": string,
"documents": [
{
object ( |
Champs | |
---|---|
name |
Uniquement en sortie. ID de la base de connaissances. Identifiant unique renvoyé par le service Dialogflow après la création d'une base de connaissances. Si l'identifiant de marque est "1234", l'identifiant d'agent est "5678", l'identifiant d'intégration est "9092" et l'identifiant de la base de connaissances est "1111", ce paramètre correspond à "brands/1234/agents/5678/integrations/9092/knowledgebases/1111". |
displayName |
Obligatoire. Nom à afficher de la base de connaissances. |
documents[] |
Documents de la base de connaissances. Facultatif |
updateTime |
Uniquement en sortie. Heure à laquelle la base de connaissances a été créée ou mise à jour. Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: |
DialogflowDocument
Un document de base de connaissances. Un document peut être une URL de site Web ou une URL vers un fichier CSV. Les URL doivent être accessibles au public. Les fichiers CSV doivent contenir une ou plusieurs paires question/réponse, chacune correspondant à une ligne.
Représentation JSON |
---|
{ "name": string, "displayName": string, "updateTime": string, "operationInfo": { object ( |
Champs | |
---|---|
name |
ID du document généré par le système Si l'identifiant de marque est "1234", l'identifiant d'agent est "5678", l'identifiant d'intégration est "9092", l'identifiant de la base de connaissances est "1111" et l'identifiant de document est "2222", ce paramètre correspond à "brands/1234/agents/5678/integrations/9092/knowledgebases/1111/documents/2222". |
displayName |
Obligatoire. Nom à afficher d'un document de FAQ. |
updateTime |
Uniquement en sortie. Heure à laquelle le document a été créé/mis à jour. Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: |
operationInfo |
Uniquement en sortie. Les informations sur les opérations ne sont renseignées que lorsqu'un document est ajouté à une base de connaissances existante. |
Champ d'union content . Contenu du document. content ne peut être qu'un des éléments suivants : |
|
faqUrl |
URL d'une FAQ. |
rawContent |
Contenu brut du document. Chaîne encodée en base64. |
DialogflowCxIntegration
Informations sur l'association d'un agent Business Messages et d'un projet Dialogflow CX
Représentation JSON |
---|
{ "dialogflowProjectId": string, "dialogflowAgentId": string, "autoResponseStatus": enum ( |
Champs | |
---|---|
dialogflowProjectId |
Obligatoire. ID du projet Dialogflow. Non modifiable. Pour modifier cette valeur, vous devez supprimer le projet Dialogflow de cet agent, puis créer une intégration. |
dialogflowAgentId |
Obligatoire. ID de l'agent Dialogflow. |
autoResponseStatus |
Obligatoire. Si la valeur est |
dialogflowServiceAccountEmail |
Uniquement en sortie. Compte de service qui doit être configuré dans le projet Dialogflow avec les rôles "Éditeur d'agent de la console Dialogflow" et "Client de l'API Dialogflow". Cette étape est obligatoire pour fournir l'accès à l'API Dialogflow. |
operationInfo |
Uniquement en sortie. Informations sur l'état de fonctionnement de l'intégration Dialogflow. |
AgentWebhookIntegration
Informations sur le webhook pour un agent Business Messages.
Représentation JSON |
---|
{ "webhookUri": string, "verificationToken": string } |
Champs | |
---|---|
webhookUri |
Obligatoire. URL de webhook vers laquelle les messages sont distribués. |
verificationToken |
Uniquement en entrée. Jeton de validation. |
Méthodes |
|
---|---|
|
Créez une intégration. |
|
Supprimer une intégration |
|
Obtenez une intégration. |
|
Lister les intégrations |
|
Mettre à jour une intégration |