REST Resource: brands.agents.integrations

Ресурс: Интеграция

Информация об интеграции.

JSON-представление 
{
  "name": string,
  "status": enum (IntegrationStatus),

  // Union field integration_info can be only one of the following:
  "dialogflowEsIntegration": {
    object (DialogflowEsIntegration)
  },
  "dialogflowCxIntegration": {
    object (DialogflowCxIntegration)
  },
  "agentWebhookIntegration": {
    object (AgentWebhookIntegration)
  }
  // End of list of possible types for union field integration_info.
}
Поля
name

string

Только вывод. Уникальный идентификатор интеграции. Только для чтения. Определяется платформой.

status

enum ( IntegrationStatus )

Только вывод. Статус интеграции.

Поле объединения integration_info . Подробная информация об интеграции. integration_info может быть только одним из следующих:
dialogflowEsIntegration

object ( DialogflowEsIntegration )

Информация о связанном проекте Dialogflow ES. https://cloud.google.com/dialogflow/es/docs

dialogflowCxIntegration

object ( DialogflowCxIntegration )

Информация о связанном проекте Dialogflow CX. https://cloud.google.com/dialogflow/cx/docs/basics

agentWebhookIntegration

object ( AgentWebhookIntegration )

Информация о веб-хуке для агента. Если веб-хук настроен на уровне агента, он переопределит веб-хук на уровне партнёра.

Статус интеграции

Статусы интеграции.

Перечисления
INTEGRATION_STATUS_UNSPECIFIED Статус интеграции не указан.
ENABLED Включено.
DISABLED Неполноценный.

DialogflowEsIntegration

Информация об ассоциации агента Business Messages и проекта Dialogflow ES.

JSON-представление 
{
  "dialogflowProjectId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  },
  "dialogflowKnowledgeBases": [
    {
      object (DialogflowKnowledgebase)
    }
  ]
}
Поля
dialogflowProjectId

string

Обязательно. Идентификатор проекта Dialogflow.

Недоступно для редактирования. Чтобы изменить это значение, необходимо удалить проект Dialogflow из этого агента, а затем создать новую интеграцию.

autoResponseStatus

enum ( AutoResponseStatus )

Обязательно. Если ENABLED , Business Messages автоматически отправляет пользователям ответы Dialogflow.

dialogflowServiceAccountEmail

string

Только вывод. Учётная запись службы, которую необходимо настроить в проекте Dialogflow с ролями «Редактор агента консоли Dialogflow» и «Клиент API Dialogflow». Это необходимо для предоставления доступа к API Dialogflow.

operationInfo

object ( OperationInfo )

Только вывод. Информация о рабочем состоянии интеграции Dialogflow.

dialogflowKnowledgeBases[]

object ( DialogflowKnowledgebase )

Базы знаний, связанные с проектом Dialogflow.

Необязательный

AutoResponseStatus

Статус автоответа Dialogflow.

Перечисления
AUTO_RESPONSE_STATUS_UNSPECIFIED Автоматический ответ не указан.
ENABLED Автоматический ответ включен.
DISABLED Автоответ отключен.

OperationInfo

Информация об операции Dialogflow.

JSON-представление 
{
  "operationName": string,
  "operationType": enum (OperationType),
  "operationState": enum (OperationState),
  "error": {
    object (Status)
  }
}
Поля
operationName

string

Только вывод. Имя, назначенное сервером (идентификатор операции), уникально только в пределах той службы, которая изначально его вернула.

operationType

enum ( OperationType )

Только вывод. Тип операции Dialogflow.

operationState

enum ( OperationState )

Только вывод. Состояние операции Dialogflow.

error

object ( Status )

Только вывод. Результат ошибки, если таковой имеется.

Тип операции

Типы операций Dialogflow.

Перечисления
OPERATION_TYPE_UNSPECIFIED Неуказанный тип.
ASSOCIATE_DIALOGFLOW Ассоциированный Dialogflow.
DISSOCIATE_DIALOGFLOW Разъедините Dialogflow.
ADD_DOCUMENT_TO_KNOWLEDGEBASE Добавить документ в базу знаний.
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE Удалить документ из базы знаний.

OperationState

Статусы работы в Dialogflow.

Перечисления
OPERATION_STATE_UNSPECIFIED Неопределенное состояние.
PROCESSING Обработка.
COMPLETED Завершенный.
FAILED Неуспешный.

Статус

Тип Status определяет логическую модель ошибок, подходящую для различных сред программирования, включая REST API и RPC API. Он используется в gRPC . Каждое сообщение Status содержит три фрагмента данных: код ошибки, сообщение об ошибке и сведения об ошибке.

Подробнее об этой модели ошибок и о том, как с ней работать, можно узнать в Руководстве по проектированию API .

JSON-представление 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Поля
code

integer

Код состояния, который должен быть значением перечисления google.rpc.Code .

message

string

Сообщение об ошибке для разработчика, которое должно быть на английском языке. Любое сообщение об ошибке для пользователя должно быть локализовано и отправлено в поле google.rpc.Status.details или локализовано клиентом.

details[]

object

Список сообщений с подробностями об ошибках. Существует общий набор типов сообщений, которые могут использовать API.

Объект, содержащий поля произвольного типа. Дополнительное поле "@type" содержит URI, идентифицирующий тип. Пример: { "id": 1234, "@type": "types.example.com/standard/id" } .

DialogflowKnowledgebase

Информация из базы знаний. База знаний может содержать несколько URL-адресов часто задаваемых вопросов.

JSON-представление 
{
  "name": string,
  "displayName": string,
  "documents": [
    {
      object (DialogflowDocument)
    }
  ],
  "updateTime": string
}
Поля
name

string

Только вывод. Идентификатор базы знаний.

Уникальный идентификатор, возвращаемый сервисом Dialogflow после создания базы знаний. Если идентификатор бренда — «1234», идентификатор агента — «5678», идентификатор интеграции — «9092», а идентификатор базы знаний — «1111», этот параметр преобразуется в «brands/1234/agents/5678/integrations/9092/knowledgebases/1111».

displayName

string

Обязательно. Отображаемое имя базы знаний.

documents[]

object ( DialogflowDocument )

Документы базы знаний.

Необязательный

updateTime

string ( Timestamp format)

Только вывод. Время создания или обновления базы знаний.

Использует RFC 3339, согласно которому сгенерированный вывод всегда будет нормализован по оси Z и содержать 0, 3, 6 или 9 знаков после запятой. Также допускаются смещения, отличные от «Z». Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

DialogflowDocument

Документ базы знаний. Документ может представлять собой URL-адрес веб-сайта или URL-адрес CSV-файла. URL-адреса должны быть общедоступны. CSV-файлы должны содержать одну или несколько пар «вопрос/ответ», по одной строке для каждой пары.

JSON-представление 
{
  "name": string,
  "displayName": string,
  "updateTime": string,
  "operationInfo": {
    object (OperationInfo)
  },

  // Union field content can be only one of the following:
  "faqUrl": string,
  "rawContent": string
  // End of list of possible types for union field content.
}
Поля
name

string

Идентификатор документа, сгенерированный системой.

Если идентификатор бренда — «1234», идентификатор агента — «5678», идентификатор интеграции — «9092», идентификатор базы знаний — «1111» и идентификатор документа — «2222», этот параметр преобразуется в «brands/1234/agents/5678/integrations/9092/knowledgebases/1111/documents/2222».

displayName

string

Обязательно. Отображаемое имя документа FAQ.

updateTime

string ( Timestamp format)

Только вывод. Время создания/обновления документа.

Использует RFC 3339, согласно которому сгенерированный вывод всегда будет нормализован по оси Z и содержать 0, 3, 6 или 9 знаков после запятой. Также допускаются смещения, отличные от «Z». Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

operationInfo

object ( OperationInfo )

Только вывод. Информация об операции заполняется только при добавлении документа в существующую базу знаний.

content поля объединения. Содержимое документа. content может быть только одним из следующих:
faqUrl

string

URL документа FAQ.

rawContent

string ( bytes format)

Исходное содержание документа.

Строка в кодировке base64.

DialogflowCxIntegration

Информация об ассоциации агента Business Messages и проекта Dialogflow CX.

JSON-представление 
{
  "dialogflowProjectId": string,
  "dialogflowAgentId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  }
}
Поля
dialogflowProjectId

string

Обязательно. Идентификатор проекта Dialogflow.

Недоступно для редактирования. Чтобы изменить это значение, необходимо удалить проект Dialogflow из этого агента, а затем создать новую интеграцию.

dialogflowAgentId

string

Обязательно. Идентификатор агента Dialogflow.

autoResponseStatus

enum ( AutoResponseStatus )

Обязательно. Если ENABLED , Business Messages автоматически отправляет пользователям ответы Dialogflow.

dialogflowServiceAccountEmail

string

Только вывод. Учётная запись службы, которую необходимо настроить в проекте Dialogflow с ролями «Редактор агента консоли Dialogflow» и «Клиент API Dialogflow». Это необходимо для предоставления доступа к API Dialogflow.

operationInfo

object ( OperationInfo )

Только вывод. Информация о рабочем состоянии интеграции Dialogflow.

AgentWebhookIntegration

Информация о вебхуке для агента бизнес-сообщений.

JSON-представление 
{
  "webhookUri": string,
  "verificationToken": string
}
Поля
webhookUri

string

Обязательно. URL-адрес веб-перехватчика, куда доставляются сообщения.

verificationToken

string

Только ввод. Токен подтверждения.

Методы

create

 Создать интеграцию.

delete

 Удалить интеграцию.

get

 Получите интеграцию.

list

 Интеграция списков.

patch

 Обновите интеграцию.