Recurso: Integración
Información sobre la integración.
Representación JSON |
---|
{ "name": string, "status": enum ( |
Campos | |
---|---|
name |
Solo salida. Es el identificador único de la integración. Solo lectura. Definido por la plataforma |
status |
Solo salida. Estado de la integración. |
Campo de unión integration_info . Información detallada de la integración. Las direcciones (integration_info ) solo pueden ser una de las siguientes opciones: |
|
dialogflowEsIntegration |
Información sobre un proyecto de Dialogflow ES asociado. https://cloud.google.com/dialogflow/es/docs |
dialogflowCxIntegration |
Información sobre un proyecto de Dialogflow CX asociado. https://cloud.google.com/dialogflow/cx/docs/basics |
IntegrationStatus
Estados de la integración.
Enumeraciones | |
---|---|
INTEGRATION_STATUS_UNSPECIFIED |
No se especificó el estado de la integración. |
ENABLED |
Habilitada |
DISABLED |
Inhabilitada |
DialogflowEsIntegration
Información sobre la asociación de un agente de Business Messages y el proyecto de Dialogflow ES.
Representación JSON |
---|
{ "dialogflowProjectId": string, "autoResponseStatus": enum ( |
Campos | |
---|---|
dialogflowProjectId |
Obligatorio. El ID del proyecto de Dialogflow. No se puede modificar. Para cambiar este valor, debes borrar el proyecto de Dialogflow de este agente y, luego, crear una integración nueva. |
autoResponseStatus |
Obligatorio. Si es |
dialogflowServiceAccountEmail |
Solo salida. La cuenta de servicio que se debe configurar en el proyecto de Dialogflow con el “Editor del agente en la consola de Dialogflow” y “Cliente de la API de Dialogflow” roles de seguridad. Esto es necesario para proporcionar acceso a la API de Dialogflow. |
operationInfo |
Solo salida. Información sobre el estado operativo de la integración de Dialogflow. |
dialogflowKnowledgeBases[] |
Bases de conocimiento asociadas con el proyecto de Dialogflow. Opcional |
AutoResponseStatus
Estado de la respuesta automática de Dialogflow.
Enumeraciones | |
---|---|
AUTO_RESPONSE_STATUS_UNSPECIFIED |
Respuesta automática no especificada. |
ENABLED |
La respuesta automática está habilitada. |
DISABLED |
La respuesta automática está inhabilitada. |
OperationInfo
La información de la operación de Dialogflow.
Representación JSON |
---|
{ "operationName": string, "operationType": enum ( |
Campos | |
---|---|
operationName |
Solo salida. El nombre asignado por el servidor (ID de operación), que solo es único dentro del mismo servicio que lo muestra en un principio. |
operationType |
Solo salida. Tipo de operación de Dialogflow. |
operationState |
Solo salida. Estado de la operación de Dialogflow. |
error |
Solo salida. Resultado del error, si corresponde. |
OperationType
Tipos de operaciones de Dialogflow.
Enumeraciones | |
---|---|
OPERATION_TYPE_UNSPECIFIED |
Tipo no especificado |
ASSOCIATE_DIALOGFLOW |
Asociar Dialogflow. |
DISSOCIATE_DIALOGFLOW |
Desasociar Dialogflow. |
ADD_DOCUMENT_TO_KNOWLEDGEBASE |
Agregar documento a la base de conocimiento. |
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE |
Borrar documento de la base de conocimiento |
OperationState
Estados de las operaciones en Dialogflow
Enumeraciones | |
---|---|
OPERATION_STATE_UNSPECIFIED |
Estado sin especificar. |
PROCESSING |
Procesando. |
COMPLETED |
Completado. |
FAILED |
Se produjo un error. |
Estado
El tipo de Status
define un modelo de error lógico que es adecuado para entornos de programación diferentes, incluidas las API de REST y las API de RPC. Lo usa gRPC. Cada mensaje Status
contiene tres datos: código de error, mensaje de error y detalles del error.
Puedes obtener más información sobre este modelo de error y cómo trabajar con él en la guía de diseño de API.
Representación JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Campos | |
---|---|
code |
El código de estado, que debe ser un valor enum de |
message |
Un mensaje de error dirigido al desarrollador, que debe estar en inglés. Cualquier mensaje de error dirigido al usuario debe localizarse y enviarse al campo |
details[] |
Una lista de mensajes que contienen los detalles del error. Hay un conjunto común de tipos de mensajes para que usen las API. Un objeto que contiene campos de un tipo arbitrario. Un campo adicional |
DialogflowKnowledgebase
Información de la base de conocimiento. Una base de conocimiento puede tener varias URLs de preguntas frecuentes.
Representación JSON |
---|
{
"name": string,
"displayName": string,
"documents": [
{
object ( |
Campos | |
---|---|
name |
Solo salida. ID de la base de conocimiento. Es el identificador único que muestra el servicio de Dialogflow después de la creación de una base de conocimiento. Si el identificador de marca es "1234", el identificador del agente es "5678", el identificador de integración es "9092" y el identificador de la base de conocimiento es "1111", este parámetro se resuelve como "brands/1234/agents/5678/integrations/9092/conocimientobases/1111". |
displayName |
Obligatorio. Es el nombre visible de la base de conocimiento. |
documents[] |
Documentos de la base de conocimiento. Opcional |
updateTime |
Solo salida. Hora en la que se creó o actualizó la base de conocimiento. Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
DialogflowDocument
Un documento de la base de conocimiento. Un documento puede ser una URL de sitio web o una URL a un archivo CSV. Las URLs deben estar disponibles de forma pública. Los archivos CSV deben contener uno o más pares de pregunta y respuesta, con una fila para cada par.
Representación JSON |
---|
{ "name": string, "displayName": string, "updateTime": string, "operationInfo": { object ( |
Campos | |
---|---|
name |
Es el ID de documento generado por el sistema. Si el identificador de marca es "1234", el identificador del agente es "5678", el identificador de integración es "9092", el identificador de la base de conocimiento es "1111" y el identificador de documento es "2222", este parámetro se resuelve como "brands/1234/agents/5678/integrations/9092/conocimientobases/1112/documents/22". |
displayName |
Obligatorio. Es el nombre visible de un documento de Preguntas frecuentes. |
updateTime |
Solo salida. Hora en la que se creó o actualizó el documento. Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
operationInfo |
Solo salida. La información de las operaciones se propaga solo cuando se agrega un documento a una base de conocimiento existente. |
Campo de unión content . Contenido del documento. Las direcciones (content ) solo pueden ser una de las siguientes opciones: |
|
faqUrl |
URL de un documento de preguntas frecuentes. |
rawContent |
Es el contenido sin procesar del documento. String codificada en base64. |
DialogflowCxIntegration
Información sobre la asociación de un agente de Business Messages y el proyecto de Dialogflow CX.
Representación JSON |
---|
{ "dialogflowProjectId": string, "dialogflowAgentId": string, "autoResponseStatus": enum ( |
Campos | |
---|---|
dialogflowProjectId |
Obligatorio. El ID del proyecto de Dialogflow. No se puede modificar. Para cambiar este valor, debes borrar el proyecto de Dialogflow de este agente y, luego, crear una integración nueva. |
dialogflowAgentId |
Obligatorio. El ID del agente de Dialogflow. |
autoResponseStatus |
Obligatorio. Si es |
dialogflowServiceAccountEmail |
Solo salida. La cuenta de servicio que se debe configurar en el proyecto de Dialogflow con el “Editor del agente en la consola de Dialogflow” y “Cliente de la API de Dialogflow” roles de seguridad. Esto es necesario para proporcionar acceso a la API de Dialogflow. |
operationInfo |
Solo salida. Información sobre el estado operativo de la integración de Dialogflow. |
Métodos |
|
---|---|
|
Crea una integración. |
|
Borra una integración. |
|
Obtén una integración. |
|
Enumera integraciones. |
|
Actualiza una integración. |