Поделиться через


Логика AtBot

AtBot — это служба создания бота без кода, которая позволяет быстро создавать диалоговые интерфейсы без каких-либо возможностей программирования.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Стандарт Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Стандарт Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Стандарт Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Поддержка AtBot
URL https://admin.atbot.io/Docs
Адрес электронной почты support@atbot.io
Метаданные соединителя
Publisher H3 Solutions Inc.
Веб-сайт https://www.atbot.io
Политика конфиденциальности https://admin.atbot.io/privacy
Категории Искусственный интеллект; Продуктивность

Соединитель Логики AtBot используется для создания навыков бота для ботов, встроенных в службу AtBot. С помощью действий в соединителе можно создать сложные навыки общения для ботов и подключить их к другим службам с помощью дополнительных соединителей. AtBot бесплатно попробовать в Microsoft Teams с версией premium, доступной для создания пользовательских ботов на дополнительных платформах. Дополнительные сведения см . на веб-сайте AtBot .

Предпосылки

Чтобы использовать бесплатную версию AtBot, необходимо иметь учетную запись Microsoft Teams и скачать бот AtBot из магазина приложений.

Чтобы использовать версию premium, в которой можно создавать собственные пользовательские боты, необходимо зарегистрироваться в AtBot Premium. При регистрации на Premium вы будете давать $ 25 кредит, чтобы попробовать службу.

Получение учетных данных

Вы всегда войдете в соединитель AtBot с помощью учетной записи Microsoft Entra ID Work или School.

Известные проблемы и ограничения

Мы отменяли поддержку LUIS в триггере ключевых слов. Используйте векторы намерений LUIS для создания навыков, распознающих естественный язык.

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Запуск новой групповой беседы

Эта операция используется для запуска новой групповой беседы в канале.

Запуск новой частной беседы

Эта операция используется для запуска нового частного диалога с пользователем.

Обновление адаптивной карточки, отправленной на вкладку

Эта операция используется для обновления карточки, отправленной на вкладку.

Отправка ответа

Эта операция используется для отправки ответа на действие, активировающее поток.

Отправка ответа адаптивной карточки

Эта операция используется для отправки ответа адаптивной карточки на действие, активировающее поток.

Отправка ответа адаптивной карточки

Эта операция используется для отправки ответа набора адаптивных карточек на действие, активировающее поток. Набор может находиться в форме List или Carousel.

Отправка события

Эта операция используется для отправки события клиенту бота.

Получение ответа datetime от пользователя

Эта операция используется для того, чтобы попросить пользователя ввести данные даты и времени.

Получение ответа адаптивной карточки от пользователя

Эта операция используется для того, чтобы попросить пользователя ввести данные с помощью адаптивной карточки.

Получение ответа вектора намерения от пользователя

Эта операция используется для того, чтобы запросить у пользователя входные данные NLP.

Получение ответа на память от пользователя

Эта операция используется для получения пользователем ввода памяти бота.

Получение ответа от пользователя

Эта операция используется для того, чтобы запросить у пользователя входные данные.

Получение ответа от пользователя

Эта операция используется для того, чтобы запросить у пользователя входные данные средства выбора людей.

Получение ответа от пользователя

Эта операция используется для того, чтобы запросить у пользователя входные данные.

Получение ответа списка выбора от пользователя

Эта операция используется для того, чтобы запросить у пользователя входные данные списка выбора.

Получение элементов памяти бота по типу

Получение всех элементов памяти Бота по типу.

Регистрация моста чата между двумя или более беседами

Эта операция используется для запуска моста чата между двумя или более пользователями.

Создание адаптивной карточки

Эта операция используется для создания адаптивной карточки, которая будет использоваться позже для отображения списка или каруселя карт.

Сохранение в памяти бота

Эта операция используется для сохранения фрагмента информации в памяти в боте.

Удаление из памяти бота

Эта операция используется для удаления фрагмента информации из памяти в боте.

Запуск новой групповой беседы

Эта операция используется для запуска новой групповой беседы в канале.

Параметры

Имя Ключ Обязательно Тип Описание
Целевой бот
EnterpriseBot True string

Выберите бот.

Перечисление каналов
teamIDStr True object

Вывод выходных данных канала.

Имя канала
channelId True string

Канал для публикации беседы. Введите имя.

Текст беседы
message True string

Сообщение, с которым начинается беседа.

Возвращаемое значение

Запуск новой частной беседы

Эта операция используется для запуска нового частного диалога с пользователем.

Параметры

Имя Ключ Обязательно Тип Описание
Целевой бот
EnterpriseBot True string

Выберите бот.

Текст беседы
message True string

Сообщение, с которым начинается беседа.

User
user True string

Имя участника-пользователя (UPN).

Возвращаемое значение

Обновление адаптивной карточки, отправленной на вкладку

Эта операция используется для обновления карточки, отправленной на вкладку.

Параметры

Имя Ключ Обязательно Тип Описание
Адаптивная карточка
card True object

Предоставьте карточку, используемую в качестве обновления.

Действие ответа
activityJson True string

Действие ответа от бота.

Возвращаемое значение

Тело
BotReplyResponse

Отправка ответа

Эта операция используется для отправки ответа на действие, активировающее поток.

Параметры

Имя Ключ Обязательно Тип Описание
Текст ответа
message True string

Сообщение, которое будет отвечать пользователю.

Действие ответа
activityJson True string

Ответное действие бота

Показать в чате
showInChat boolean

Если это звонок Teams, отобразите это сообщение в чате. В противном случае бот будет говорить только сообщение.

Пользовательские данные канала
customChannelDataJson string

Json пользовательских данных канала для сообщения (поддерживается только в Direct Line)

JSON ответа сигнала
signalResponse string

Строка JSON ответа сигнала

Идентификатор сообщения
messageId string

(Необязательно) Идентификатор предыдущего сообщения в той же беседе для замены. Если он указан, бот заменит существующее сообщение чата этим сообщением.

Возвращаемое значение

Тело
BotReplyResponse

Отправка ответа адаптивной карточки

Эта операция используется для отправки ответа адаптивной карточки на действие, активировающее поток.

Параметры

Имя Ключ Обязательно Тип Описание
Выбранная адаптивная карточка
selectedCard True string

Выберите адаптивную карточку.

содержимое
content True dynamic

Возвращаемое значение

Тело
BotReplyResponse

Отправка ответа адаптивной карточки

Эта операция используется для отправки ответа набора адаптивных карточек на действие, активировающее поток. Набор может находиться в форме List или Carousel.

Параметры

Имя Ключ Обязательно Тип Описание
Адаптивный набор карточек
cards True object

Укажите объект набора карточек.

Стиль отображения
displayStyle True string

Выберите используемый стиль отображения.

Действие ответа
activityJson True string

Действие ответа от бота.

Показать на вкладке
showInTab boolean

Отображение этого набора карточек на вкладке вместо встроенного чата.

Метка кнопки tab
deepLinkButtonLabel string

Метка кнопки для отображения на вкладке.

Сообщение "Кнопка вкладки"
deepLinkMessage string

Сообщение для отправки с кнопкой при отображении на вкладке.

Возвращаемое значение

Тело
BotReplyResponse

Отправка события

Эта операция используется для отправки события клиенту бота.

Параметры

Имя Ключ Обязательно Тип Описание
Действие ответа
activityJson True string

Ответное действие бота

Json события
eventObject True object

Объект JSON, отправляемый в событии чата.

Получение ответа datetime от пользователя

Эта операция используется для того, чтобы попросить пользователя ввести данные даты и времени.

Параметры

Имя Ключ Обязательно Тип Описание
filters
filters array of string
headers
headers object
properties
properties object
Область даты
dateScope True string

Выберите область значения даты.

Message
message True string

Введите сообщение для отправки пользователю.

Действие ответа
activityJson True string

Действие ответа от бота.

Принять ответ из
acceptResponseFrom string

Примите ответ от конкретного пользователя или любого пользователя.

Разрешить ветвление
allowBranching string

Перед предоставлением ответа пользователь может активировать навыки ветвления.

Показать в чате
showInChat boolean

Если это звонок Teams, отобразите это сообщение в чате. В противном случае бот будет говорить только сообщение.

Возвращаемое значение

Тело
BotResponse_Date

Получение ответа адаптивной карточки от пользователя

Эта операция используется для того, чтобы попросить пользователя ввести данные с помощью адаптивной карточки.

Параметры

Имя Ключ Обязательно Тип Описание
Выбранная адаптивная карточка
selectedCard True string

Выберите адаптивную карточку.

веб-перехватчик
webHook dynamic

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение ответа вектора намерения от пользователя

Эта операция используется для того, чтобы запросить у пользователя входные данные NLP.

Параметры

Имя Ключ Обязательно Тип Описание
filters
filters array of string
headers
headers object
properties
properties object
Message
message True string

Введите сообщение для отправки пользователю.

Вектор намерений LUIS
intentVector True string

Выберите вектор намерений LUIS.

Действие ответа
activityJson True string

Действие ответа от бота.

Принять ответ из
acceptResponseFrom string

Примите ответ от конкретного пользователя или любого пользователя.

Разрешить ветвление
allowBranching string

Перед предоставлением ответа пользователь может активировать навыки ветвления.

Показать в чате
showInChat boolean

Если это звонок Teams, отобразите это сообщение в чате. В противном случае бот будет говорить только сообщение.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Получение ответа на память от пользователя

Эта операция используется для получения пользователем ввода памяти бота.

Параметры

Имя Ключ Обязательно Тип Описание
filters
filters array of string
headers
headers object
properties
properties object
Message
message True string

Введите сообщение для отправки пользователю.

Тип памяти
type True string

Укажите тип памяти для списка.

Действие ответа
activityJson True string

Действие ответа от бота.

URL-адрес значка;
icon string

Введите абсолютный URL-адрес значка, отображаемого для каждого элемента выбора.

Принять ответ из
acceptResponseFrom string

Примите ответ от конкретного пользователя или любого пользователя.

Целевой пользователь
targetUserMemory string

При необходимости укажите имя участника-пользователя, из который бот должен извлекать элементы памяти. Если осталось пустым, он извлекнет элементы памяти от пользователя, инициирующего навык. В случае групповой беседы, запущенной из бота, она извлекнет элементы памяти из пользователя, прошедшего проверку подлинности в Flow.

Разрешить ветвление
allowBranching string

Перед предоставлением ответа пользователь может активировать навыки ветвления.

Показать в чате
showInChat boolean

Если это звонок Teams, отобразите это сообщение в чате. В противном случае бот будет говорить только сообщение.

Возвращаемое значение

Получение ответа от пользователя

Эта операция используется для того, чтобы запросить у пользователя входные данные.

Параметры

Имя Ключ Обязательно Тип Описание
filters
filters array of string
headers
headers object
properties
properties object
Message
message True string

Введите сообщение для отправки пользователю.

Значения выбора
choices True string

Укажите каждый выбор в отдельной строке.

Действие ответа
activityJson True string

Действие ответа от бота.

Принять ответ из
acceptResponseFrom string

Примите ответ от конкретного пользователя или любого пользователя.

Разрешить ветвление
allowBranching string

Перед предоставлением ответа пользователь может активировать навыки ветвления.

Показать в чате
showInChat boolean

Если это звонок Teams, отобразите это сообщение в чате. В противном случае бот будет говорить только сообщение.

Прослушивание голосового ответа
listenForInput boolean

Если это вызов Teams, это свойство определяет, прослушивает ли бот голосовой ответ. Если нет, или нет, вызов бота не будет немедленно прослушивать голосовой ответ.

Возвращаемое значение

Получение ответа от пользователя

Эта операция используется для того, чтобы запросить у пользователя входные данные средства выбора людей.

Параметры

Имя Ключ Обязательно Тип Описание
filters
filters array of string
headers
headers object
properties
properties object
Message
message True string

Введите сообщение для отправки пользователю.

Mode
mode True string

Попросите пользователя выбрать одного или нескольких пользователей.

Строка поиска
searchstr string

При необходимости укажите начальную строку поиска.

Действие ответа
activityJson True string

Действие ответа от бота.

Принять ответ из
acceptResponseFrom string

Примите ответ от конкретного пользователя или любого пользователя.

Разрешить ветвление
allowBranching string

Перед предоставлением ответа пользователь может активировать навыки ветвления.

Показать в чате
showInChat boolean

Если это звонок Teams, отобразите это сообщение в чате. В противном случае бот будет говорить только сообщение.

Прослушивание голосового ответа
listenForInput boolean

Если это вызов Teams, это свойство определяет, прослушивает ли бот голосовой ответ. Если нет, или нет, вызов бота не будет немедленно прослушивать голосовой ответ.

Возвращаемое значение

Получение ответа от пользователя

Эта операция используется для того, чтобы запросить у пользователя входные данные.

Параметры

Имя Ключ Обязательно Тип Описание
filters
filters array of string
headers
headers object
properties
properties object
Message
message True string

Введите сообщение для отправки пользователю.

Действие ответа
activityJson True string

Действие ответа от бота.

Принять ответ из
acceptResponseFrom string

Примите ответ от конкретного пользователя или любого пользователя.

Показать в чате
showInChat boolean

Если это звонок Teams, отобразите это сообщение в чате. В противном случае бот будет говорить только сообщение.

Возвращаемое значение

Тело
BotResponse

Получение ответа списка выбора от пользователя

Эта операция используется для того, чтобы запросить у пользователя входные данные списка выбора.

Параметры

Имя Ключ Обязательно Тип Описание
filters
filters array of string
headers
headers object
properties
properties object
URL-адрес значка;
icon string

Введите абсолютный URL-адрес значка, отображаемого для каждого элемента выбора.

Message
message True string

Введите сообщение для отправки пользователю.

Значения выбора
choices True object

Укажите объект массива выбора.

Действие ответа
activityJson True string

Действие ответа от бота.

Принять ответ из
acceptResponseFrom string

Примите ответ от конкретного пользователя или любого пользователя.

Разрешить ветвление
allowBranching string

Перед предоставлением ответа пользователь может активировать навыки ветвления.

Показать в чате
showInChat boolean

Если это звонок Teams, отобразите это сообщение в чате. В противном случае бот будет говорить только сообщение.

Прослушивание голосового ответа
listenForInput boolean

Если это вызов Teams, это свойство определяет, прослушивает ли бот голосовой ответ. Если нет, или нет, вызов бота не будет немедленно прослушивать голосовой ответ.

Возвращаемое значение

Получение элементов памяти бота по типу

Получение всех элементов памяти Бота по типу.

Параметры

Имя Ключ Обязательно Тип Описание
Имя участника-пользователя.
user True string

Укажите имя участника-пользователя.

Тип памяти
type True string

Укажите тип памяти для списка.

Возвращаемое значение

Регистрация моста чата между двумя или более беседами

Эта операция используется для запуска моста чата между двумя или более пользователями.

Параметры

Имя Ключ Обязательно Тип Описание
filters
filters array of string
headers
headers object
properties
properties object
Имя пользователя
chatUserName True string

Отображаемое имя пользователя чата.

Сообщение об инициировании
chatInitiationMessage string

Сообщение для отправки этому пользователю при установке моста чата.

Действие ответа
activityJson True string

Действие ответа для пользователя чата.

Команда End Chat
endBridgeCommand True string

Команда ключевого слова для отправки боту для завершения моста чата.

Время ожидания перед переходом в режим простоя
idleTimeoutDuration True integer

Длительность (в минутах) простоя действия для активации времени ожидания.

Возвращаемое значение

Тело
BridgeOutcome

Создание адаптивной карточки

Эта операция используется для создания адаптивной карточки, которая будет использоваться позже для отображения списка или каруселя карт.

Параметры

Имя Ключ Обязательно Тип Описание
Выбранная адаптивная карточка
selectedCard True string

Выберите адаптивную карточку.

содержимое
content dynamic

Возвращаемое значение

response
object

Сохранение в памяти бота

Эта операция используется для сохранения фрагмента информации в памяти в боте.

Параметры

Имя Ключ Обязательно Тип Описание
Основное имя пользователя
user True string

Пользователь, на который нужно сохранить элемент памяти.

Тип памяти
type True string

Тип памяти.

Название
title True string

Заголовок элемента памяти.

Ценность
value True string

Значение элемента памяти.

Возвращаемое значение

Удаление из памяти бота

Эта операция используется для удаления фрагмента информации из памяти в боте.

Параметры

Имя Ключ Обязательно Тип Описание
Основное имя пользователя
user True string

Пользователь, на который нужно сохранить элемент памяти.

Тип памяти
type True string

Тип памяти.

Ценность
value True string

Значение элемента памяти.

Возвращаемое значение

Триггеры

Если вектор намерения распознается

Эта операция активируется, когда заданный вектор намерений LUIS распознается ботом.

При использовании ключевого слова

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

Если вектор намерения распознается

Эта операция активируется, когда заданный вектор намерений LUIS распознается ботом.

Параметры

Имя Ключ Обязательно Тип Описание
filters
filters array of string
headers
headers object
properties
properties object
Описание триггера
triggerDescription True string

Описание, показанное в диалоговом окне справки бота.

Тип триггера бота
triggerType True string

Выберите тип триггера.

Вектор намерений LUIS
intentVector string

Выберите вектор намерений LUIS.

Разрешить ветвление
allowBranching string

Разрешить пользователю активировать навыки ветвления при ответе на следующие вопросы.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

При использовании ключевого слова

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

Параметры

Имя Ключ Обязательно Тип Описание
filters
filters array of string
headers
headers object
properties
properties object
Описание триггера
triggerDescription True string

Описание, показанное в диалоговом окне справки бота

Тип триггера бота
triggerType True string

Выберите тип триггера.

Ключевые слова
keywords string

Введите пользовательские ключевые слова, которые активируют поток.

(не рекомендуется) Ключ API LUIS
luisApiKey string

(не рекомендуется) Предоставьте AtBot ключу API LUIS. Этот параметр не рекомендуется. Используйте триггер "Вектор намерения" для использования LUIS.

(не рекомендуется) Приложение LUIS
luisAppId string

(не рекомендуется) Выберите приложение LUIS. Этот параметр не рекомендуется. Используйте триггер "Вектор намерения" для использования LUIS.

(не рекомендуется) Намерение LUIS
luisIntent string

(не рекомендуется) Выберите намерение LUIS использовать. Этот параметр не рекомендуется. Используйте триггер "Вектор намерения" для использования LUIS.

Возвращаемое значение

Выходные данные этой операции являются динамическими.

Определения

BotReplyResponse

Имя Путь Тип Описание
Идентификатор сообщения
id string

Идентификатор сообщения, созданного из ответа. Используется для обновления сообщения.

BotResponse

Имя Путь Тип Описание
Текст ответа
text string

Ответ, введенный пользователем.

Уведомление об отмене
cancelNotice boolean

Этот флаг будет true, если пользователь отвечает на ключевое слово отмены.

Ответ пользователя
respondingUser string

Пользователь отвечает на бот.

files
files array of object
Имя файла
files.name string

Имя файла.

Тип файла
files.content-type string

Тип файла.

Байты файлов
files.bytes byte

Байты файла.

BotResponse_Date

Имя Путь Тип Описание
Дата ответа
text date-time

Дата отклика, введенный пользователем.

Дата ответа (UTC)
text_UTC date-time

Дата отклика, введенный пользователем в формате UTC.

Уведомление об отмене
cancelNotice boolean

Этот флаг будет true, если пользователь отвечает на ключевое слово отмены.

Ответ пользователя
respondingUser string

Пользователь отвечает на бот.

BotResponse_Choice

Имя Путь Тип Описание
Выбор ответа
text string

Ответ, введенный пользователем.

Уведомление об отмене
cancelNotice boolean

Этот флаг будет true, если пользователь отвечает на ключевое слово отмены.

Ответ пользователя
respondingUser string

Пользователь отвечает на бот.

BotResponse_ChoiceList

Имя Путь Тип Описание
Выбранный заголовок списка выбора
title string

Выбранный заголовок списка выбора.

Выбранный список выбора подзаголовок
subtitle string

Выбранный подзаголовок списка выбора.

Выбранное значение списка выбора
value string

Выбранное значение списка выбора.

Уведомление об отмене
cancelNotice boolean

Этот флаг будет true, если пользователь отвечает на ключевое слово отмены.

Ответ пользователя
respondingUser string

Пользователь отвечает на бот.

BotResponse_People

Имя Путь Тип Описание
people
people array of object
Основное имя пользователя
people.upn string

Основное имя пользователя.

Идентификатор пользователя
people.userid string

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

Полное имя
people.fullname string

Полное имя пользователя.

Адрес электронной почты
people.email string

Электронная почта пользователя.

Уведомление об отмене
cancelNotice boolean

Этот флаг будет true, если пользователь отвечает на ключевое слово отмены.

Ответ пользователя
respondingUser string

Пользователь отвечает на бот.

BotResponse_Memory

Имя Путь Тип Описание
Заголовок элемента памяти
title string

Заголовок элемента памяти.

Значение элемента памяти
value string

Значение элемента памяти.

Уведомление об отмене
cancelNotice boolean

Этот флаг будет true, если пользователь отвечает на ключевое слово отмены.

Ответ пользователя
respondingUser string

Пользователь отвечает на бот.

Response_SaveBotMemory

Имя Путь Тип Описание
Результат сохранения памяти бота
text string

Результат сохранения памяти бота.

Response_DeleteBotMemory

Имя Путь Тип Описание
Результат удаления памяти бота
text string

Результат удаления из памяти бота.

BotGroupConversationStartResponse

Имя Путь Тип Описание
ИД разговора
id string

Идентификатор беседы, созданной из начальной групповой беседы. Используется для обновления беседы.

Идентификатор сообщения
messageId string

Идентификатор сообщения, созданного из начальной групповой беседы. Используется для обновления сообщения.

Действие ответа
activityJson string

Json действия.

BotConversationStartResponse

Имя Путь Тип Описание
Идентификатор сообщения
id string

Идентификатор сообщения, созданного из ответа. Используется для обновления сообщения.

Действие ответа
activityJson string

Json действия.

BridgeOutcome

Имя Путь Тип Описание
Результат
outcome string

Результат моста.

Мост закрыт
bridgeClosedBy string

Пользователь, закрывающий мост.

MemoryItem

Имя Путь Тип Описание
Заголовок элемента памяти
title string

Заголовок элемента памяти.

Значение элемента памяти
value string

Значение элемента памяти.

объект

Это тип object.