Ресурс: Интеграция
Информация об интеграции.
JSON-представление |
---|
{ "name": string, "status": enum ( |
Поля | |
---|---|
name | Только вывод. Уникальный идентификатор интеграции. Только для чтения. Определяется платформой. |
status | Только вывод. Статус интеграции. |
Поле объединения integration_info . Подробная информация по интеграции. integration_info может быть только одним из следующих: | |
dialogflowEsIntegration | Информация о связанном проекте Dialogflow ES. https://cloud.google.com/dialogflow/es/docs |
dialogflowCxIntegration | Информация о связанном проекте Dialogflow CX. https://cloud.google.com/dialogflow/cx/docs/basics |
agentWebhookIntegration | Информация о вебхуке для агента. Если веб-перехватчик настроен на уровне агента, он переопределит веб-перехватчик на уровне партнера. |
Статус интеграции
Статусы интеграции.
Перечисления | |
---|---|
INTEGRATION_STATUS_UNSPECIFIED | Статус интеграции не указан. |
ENABLED | Включено. |
DISABLED | Неполноценный. |
DialogflowEsIntegration
Информация об ассоциации агента Business Messages и проекта Dialogflow ES.
JSON-представление |
---|
{ "dialogflowProjectId": string, "autoResponseStatus": enum ( |
Поля | |
---|---|
dialogflowProjectId | Необходимый. Идентификатор проекта Dialogflow. Нередактируемый. Чтобы изменить это значение, необходимо удалить проект Dialogflow из этого агента, а затем создать новую интеграцию. |
autoResponseStatus | Необходимый. Если |
dialogflowServiceAccountEmail | Только вывод. Учетная запись службы, которую необходимо настроить в проекте Dialogflow с ролями «Редактор агента консоли Dialogflow» и «Клиент API Dialogflow». Это необходимо для предоставления доступа к API Dialogflow. |
operationInfo | Только вывод. Информация о рабочем состоянии интеграции Dialogflow. |
dialogflowKnowledgeBases[] | Базы знаний, связанные с проектом Dialogflow. Необязательный |
Статус автоответа
Статус автоответа Dialogflow.
Перечисления | |
---|---|
AUTO_RESPONSE_STATUS_UNSPECIFIED | Автоответ не указан. |
ENABLED | Автоответ включен. |
DISABLED | Автоответ отключен. |
Информация об операции
Информация об операции Dialogflow.
JSON-представление |
---|
{ "operationName": string, "operationType": enum ( |
Поля | |
---|---|
operationName | Только вывод. Имя, назначенное сервером (идентификатор операции), уникальное только в пределах той службы, которая первоначально его возвращает. |
operationType | Только вывод. Тип операции диалогового потока. |
operationState | Только вывод. Состояние операции диалогового потока. |
error | Только вывод. Результат ошибки, если таковая имеется. |
Тип операции
Типы операций диалогового потока.
Перечисления | |
---|---|
OPERATION_TYPE_UNSPECIFIED | Неопределенный тип. |
ASSOCIATE_DIALOGFLOW | Ассоциированный диалоговый поток. |
DISSOCIATE_DIALOGFLOW | Диссоциировать диалоговый поток. |
ADD_DOCUMENT_TO_KNOWLEDGEBASE | Добавить документ в базу знаний. |
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE | Удалить документ из базы знаний. |
Состояние операции
Статусы работы в Dialogflow.
Перечисления | |
---|---|
OPERATION_STATE_UNSPECIFIED | Неустановленное состояние. |
PROCESSING | Обработка. |
COMPLETED | Завершенный. |
FAILED | Неуспешный. |
Положение дел
Тип Status
определяет логическую модель ошибок, подходящую для различных сред программирования, включая API REST и API RPC. Он используется gRPC . Каждое сообщение Status
содержит три части данных: код ошибки, сообщение об ошибке и сведения об ошибке.
Подробнее об этой модели ошибок и о том, как с ней работать, можно узнать в API Design Guide .
JSON-представление |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Поля | |
---|---|
code | Код состояния, который должен быть значением перечисления |
message | Сообщение об ошибке для разработчика, которое должно быть на английском языке. Любое сообщение об ошибке, обращенное к пользователю, должно быть локализовано и отправлено в поле |
details[] | Список сообщений, содержащих сведения об ошибке. Существует общий набор типов сообщений для использования API. Объект, содержащий поля произвольного типа. Дополнительное поле |
База знаний Dialogflow
Информация из базы знаний. База знаний может иметь несколько URL-адресов часто задаваемых вопросов.
JSON-представление |
---|
{
"name": string,
"displayName": string,
"documents": [
{
object ( |
Поля | |
---|---|
name | Только вывод. Идентификатор базы знаний. Уникальный идентификатор, возвращаемый сервисом Dialogflow после создания базы знаний. Если идентификатор бренда — «1234», идентификатор агента — «5678», идентификатор интеграции — «9092» и идентификатор базы знаний — «1111», этот параметр разрешается в «brands/1234/agents/5678/integrations/ 9092/базы знаний/1111». |
displayName | Необходимый. Отображаемое имя базы знаний. |
documents[] | Документы базы знаний. Необязательный |
updateTime | Только вывод. Время создания или обновления базы знаний. Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: |
Диалоговый потокДокумент
Документ базы знаний. Документ может представлять собой URL-адрес веб-сайта или URL-адрес файла CSV. URL-адреса должны быть общедоступными. Файлы CSV должны содержать одну или несколько пар вопрос/ответ, по одной строке для каждой пары.
JSON-представление |
---|
{ "name": string, "displayName": string, "updateTime": string, "operationInfo": { object ( |
Поля | |
---|---|
name | Идентификатор документа, сгенерированный системой. Если идентификатор бренда — «1234», идентификатор агента — «5678», идентификатор интеграции — «9092», идентификатор базы знаний — «1111» и идентификатор документа — «2222», этот параметр разрешается в «бренды/ 1234/агенты/5678/интеграции/9092/базы знаний/1111/документы/2222". |
displayName | Необходимый. Отображаемое имя документа с часто задаваемыми вопросами. |
updateTime | Только вывод. Время создания/обновления документа. Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: |
operationInfo | Только вывод. Информация об операции заполняется только тогда, когда документ добавляется в существующую базу знаний. |
content поля объединения. Содержание документа. content может быть только одним из следующих: | |
faqUrl | URL-адрес документа с часто задаваемыми вопросами. |
rawContent | Необработанное содержимое документа. Строка в кодировке Base64. |
DialogflowCxIntegration
Информация об агенте Business Messages и ассоциации проекта Dialogflow CX.
JSON-представление |
---|
{ "dialogflowProjectId": string, "dialogflowAgentId": string, "autoResponseStatus": enum ( |
Поля | |
---|---|
dialogflowProjectId | Необходимый. Идентификатор проекта Dialogflow. Нередактируемый. Чтобы изменить это значение, необходимо удалить проект Dialogflow из этого агента, а затем создать новую интеграцию. |
dialogflowAgentId | Необходимый. Идентификатор агента Dialogflow. |
autoResponseStatus | Необходимый. Если |
dialogflowServiceAccountEmail | Только вывод. Учетная запись службы, которую необходимо настроить в проекте Dialogflow с ролями «Редактор агента консоли Dialogflow» и «Клиент API Dialogflow». Это необходимо для предоставления доступа к API Dialogflow. |
operationInfo | Только вывод. Информация о рабочем состоянии интеграции Dialogflow. |
Интеграция AgentWebhook
Информация о веб-перехватчике для агента Business Messages.
JSON-представление |
---|
{ "webhookUri": string, "verificationToken": string } |
Поля | |
---|---|
webhookUri | Необходимый. URL-адрес веб-перехватчика, по которому доставляются сообщения. |
verificationToken | Только ввод. Токен проверки. |
Методы | |
---|---|
| Создайте интеграцию. |
| Удалить интеграцию. |
| Получите интеграцию. |
| Список интеграций. |
| Обновите интеграцию. |