COSMO Bot (предварительная версия)

COSMO Bot повышает эффективность бизнеса благодаря повышению эффективности в повседневной жизни. Если вы ответите на стандартный вопрос сегодня, вы тратить время. В контакте с клиентами это часто хорошая возможность познакомиться друг с другом и установить отношения. Но внутренне, от сотрудника до сотрудника, или когда просто слишком много делать, это роскошь, что не все могут позволить себе. Этот соединитель позволяет расширить функциональные возможности бота и интегрировать другие системы.

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

Услуга	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих:      — Регионы Azure для государственных организаций      — Регионы Azure Для Китая      - Министерство обороны США (DoD)
Power Apps	Премия	Все регионы Power Apps , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Power Automate	Премия	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)

Контакт
Имя	Поддержка COSMO CONSULT
URL	https://de.cosmoconsult.com/service/support/
Адрес электронной почты	support.west@cosmoconsult.com

Метаданные соединителя
Publisher	COSMO CONSULT GmbH
Веб-сайт	https://cosma.link/cc-bot
Политика конфиденциальности	https://www.cosmoconsult.com/data-protection/
Категории	Искусственный интеллект; Коммуникация

Предпосылки

Чтобы использовать этот соединитель, необходимо иметь административный доступ к экземпляру COSMO Bot. Что такое COSMO Bot?Как получить экземпляр COSMO Bot?

Как получить учетные данные?

Получив административный доступ к экземпляру COSMO Bot, перейдите к интерфейсу чата (т. е. https://cosma.cosmoconsult.com/) и перейдите на вкладку "Администрирование", щелкнув "Администрирование" в правом верхнем углу. Перейдите к разделу "Ключи API" и создайте новую или скопируйте существующую.

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

По умолчанию	Параметры для создания подключения.	Все регионы	Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

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

Имя	Тип	Description	Обязательно
URL-адрес экземпляра бота	струна	URL-адрес, в котором можно получить экземпляр бота.	True
Ключ API	securestring	Ключ API для доступа к этому экземпляру бота	True

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

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

Действия

Добавление нового набора ответов на вопросы	Добавляет новый набор ответов на вопросы в подключенный экземпляр.
Добавление нового раздела	Добавляет новый раздел в подключенный экземпляр.
Добавление эксперта в раздел	Бот добавит эксперта в указанный раздел.
Задайте вопрос о COSMO Bot	Бот будет выполнять поиск по базе знаний и возвращать ответ с лучшим совпадением. Также возвращает оценку.
Закрытие билета	Закрывает открытый билет в подключенном экземпляре.
Изменение существующего набора ответов на вопросы	Измените существующий набор ответов на вопросы из подключенного экземпляра.
Открытие билета (вопрос)	Откройте новый билет в подключенном экземпляре.
Открытие билета (отзыв)	Откройте новый запрос обратной связи типа в подключенном экземпляре.
Перевод (markdown friendly)	Перевод заданного текста при соблюдении синтаксиса Markdown диалекта COSMO Bot.
Переименование существующего раздела	Переименуйте существующий раздел из подключенного экземпляра.
Получение всех наборов ответов на вопросы	Получает все ответы из подключенного экземпляра.
Получение всех разделов	Возвращает все разделы из экземпляра подключенного бота.
Получение глобальных параметров	Возвращает глобальные параметры из подключенного экземпляра.
Получение открытых билетов	Возвращает все открытые билеты из подключенного экземпляра.
Получение раздела	Возвращает определенный раздел из подключенного экземпляра.
Получение экспертов по теме	Возвращает все эксперты из подключенного экземпляра.
Преобразование скрипта COSMO Bot	Запустите заданный текст с помощью средства синтаксического анализа скрипта COSMO Bot.
Создание теневой копии набора вопросов и ответов	Добавляет новую теневую копию для набора вопросов и ответов, указанных кратким описанием. Осторожный! Эти теневые копии удаляются при обновлении ответа. Поэтому рекомендуется автоматически вызывать это действие с помощью триггера "при обновлении набора вопросов и ответов".
Удаление набора ответов на вопрос	Удалите существующий набор ответов на вопросы из подключенного экземпляра.
Удаление эксперта из раздела	Бот удалит эксперта из предоставленного раздела. Если тема не указана, эксперт будет удален из всех тем.

Добавление нового набора ответов на вопросы

Идентификатор операции:

AddAnswer

Добавляет новый набор ответов на вопросы в подключенный экземпляр.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Тема	topic	True	string
Краткое описание	shortDescription	True	string
Вопросы	questions	True	array of string
Текст ответа	answerText	True	string
Электронная почта пользователя	userEmail		string

Добавление нового раздела

Идентификатор операции:

AddTopic

Добавляет новый раздел в подключенный экземпляр.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя раздела	name	True	string
Description	description	True	string
Экспертные сообщения электронной почты	expertEmails	True	array of string

Добавление эксперта в раздел

Идентификатор операции:

AddExpert

Бот добавит эксперта в указанный раздел.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Тема	topic	True	string
Эксперт по электронной почте	expertEmail	True	string

Задайте вопрос о COSMO Bot

Идентификатор операции:

AskQuestion

Бот будет выполнять поиск по базе знаний и возвращать ответ с лучшим совпадением. Также возвращает оценку.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Question	question	True	string
Пороговое значение оценки	scoreThreshold		integer	Минимальная оценка ответа для возврата.
Электронная почта пользователя	userEmail		string

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

Имя	Путь	Тип	Описание
Найденный ответ	foundAnswer	boolean	Найден ли COSMO Bot ответ, соответствующий вопросу.
Shadow-Answer	isSubAnswer	boolean	Указывает, является ли возвращенный ответ вложенным ответом.
Был вопрос переведен	isTranslated	boolean	Был ли переведен вопрос и возвращен ответ.
Ответ	answer	Answer
Балл	score	integer	Насколько уверен бот в том, что возвращенный ответ правильный.

Закрытие билета

Идентификатор операции:

CloseTicket

Закрывает открытый билет в подключенном экземпляре.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор билета	ticketId	True	string
Сообщение электронной почты пользователя, обрабатывающего билет	editorEmail	True	string
Комментарий, который будет отправлен пользователю	editorComment	True	string

Изменение существующего набора ответов на вопросы

Идентификатор операции:

EditAnswer

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Краткое описание существующего набора	shortDescription	True	string
Обновленный раздел	newTopic		string
Обновленное краткое описание	newShortDescription		string
Обновленные вопросы	newQuestions		array of string
Обновленный текст ответа	newAnswerText		string
Электронная почта пользователя	userEmail		string

Открытие билета (вопрос)

Идентификатор операции:

OpenTicketQuestion

Откройте новый билет в подключенном экземпляре.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Электронная почта пользователя	userEmail	True	string
Вопрос, заданный пользователем	queryText	True	string
Тема, к которой, скорее всего, относится этот вопрос	topic		string

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

Имя	Путь	Тип	Описание
Билет	ticket	Ticket

Открытие билета (отзыв)

Идентификатор операции:

OpenTicketFeedback

Откройте новый запрос обратной связи типа в подключенном экземпляре.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Электронная почта пользователя	userEmail	True	string
Вопрос, заданный пользователем	queryText	True	string
Краткое описание ответа	answerShortDescription	True	string
Отзывы о ответе	feedbackText	True	string

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

Имя	Путь	Тип	Описание
Билет	ticket	Ticket

Перевод (markdown friendly)

Идентификатор операции:

Translate

Перевод заданного текста при соблюдении синтаксиса Markdown диалекта COSMO Bot.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Целевой язык	targetLanguageCode	True	string	Код целевого языка (например, fr).
Текст	inputText	True	string	Текст для перевода.

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

Имя	Путь	Тип	Описание
Переведённый текст	outputText	string

Переименование существующего раздела

Идентификатор операции:

RenameTopic

Переименуйте существующий раздел из подключенного экземпляра.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя раздела	name	True	string	Имя существующего раздела, который необходимо переименовать.
Имя нового раздела	newName	True	string	Имя, в которое будет переименован раздел.

Получение всех наборов ответов на вопросы

Идентификатор операции:

GetAllAnswers

Получает все ответы из подключенного экземпляра.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Фильтрация по разделу (содержит)	filterByTopic		string	Фильтрация по разделу (содержит)
Фильтрация по краткому описанию (содержится)	filterByShortDescription		string	Фильтрация по краткому описанию (содержится)
Фильтр по тексту вопроса (содержит)	filterByQuestionText		string	Фильтр по тексту вопроса (содержит)
Фильтрация по тексту ответа (содержится)	filterByAnswerText		string	Фильтрация по тексту ответа (содержится)

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

Имя	Путь	Тип	Описание
Ответы	answers	array of Answer

Получение всех разделов

Идентификатор операции:

GetAllTopics

Возвращает все разделы из экземпляра подключенного бота.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Фильтрация по эксперту	filterByExpert		string	Фильтрация по эксперту

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

Имя	Путь	Тип	Описание
Темы	topics	array of string

Получение глобальных параметров

Идентификатор операции:

GetGlobalSettings

Возвращает глобальные параметры из подключенного экземпляра.

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

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

Получение открытых билетов

Идентификатор операции:

GetOpenTickets

Возвращает все открытые билеты из подключенного экземпляра.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Фильтрация по продолжительности открытия (минимум)	filterByHoursSinceOpened		integer	Получить билеты, которые были открыты дольше x часов.
Фильтрация по продолжительности открытия (максимальная)	filterByHoursSinceOpenedMax		integer	Получить билеты, которые были открыты менее чем в x часах.
Фильтрация по разделу	filterByTopic		string	Фильтрация по разделу
Фильтрация по эксперту	filterByExpertEmail		string	Фильтрация по эксперту

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

Имя	Путь	Тип	Описание
Билеты	tickets	array of Ticket

Получение раздела

Идентификатор операции:

GetTopic

Возвращает определенный раздел из подключенного экземпляра.

Параметры

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

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

Имя	Путь	Тип	Описание
Имя	topic.name	string
Description	topic.description	string

Получение экспертов по теме

Идентификатор операции:

GetExperts

Возвращает все эксперты из подключенного экземпляра.

Параметры

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

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

Имя	Путь	Тип	Описание
Эксперты	expertEmails	array of string

Преобразование скрипта COSMO Bot

Идентификатор операции:

ParseText

Запустите заданный текст с помощью средства синтаксического анализа скрипта COSMO Bot.

Параметры

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

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

Имя	Путь	Тип	Описание
Вывод текста	outputText	string	Проанализированный текст, возвращаемый анализатором скрипта COSMO Bot.

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

Идентификатор операции:

AddSubAnswer

Добавляет новую теневую копию для набора вопросов и ответов, указанных кратким описанием. Осторожный! Эти теневые копии удаляются при обновлении ответа. Поэтому рекомендуется автоматически вызывать это действие с помощью триггера "при обновлении набора вопросов и ответов".

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Краткое описание исходного ответа	shortDescription	True	string
Краткое описание теневого копирования	subShortDescription	True	string
Вопросы	subQuestions	True	array of string
Текст ответа	subAnswerText	True	string

Удаление набора ответов на вопрос

Идентификатор операции:

DeleteAnswer

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

Параметры

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

Удаление эксперта из раздела

Идентификатор операции:

RemoveExpert

Бот удалит эксперта из предоставленного раздела. Если тема не указана, эксперт будет удален из всех тем.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Эксперт по электронной почте	expertEmail	True	string
Тема	topic		string

Триггеры

Когда пользователь задает вопрос	Когда пользователь задает вопрос.
При обновлении раздела билета	При обновлении раздела существующего билета.
При разрешении билета	При разрешении существующего билета.
При создании или изменении набора ответов на вопрос	При создании или изменении набора ответов на вопрос.
При создании нового билета	При создании нового билета.
При создании нового набора ответов на вопросы	При создании нового набора ответов на вопросы.

Когда пользователь задает вопрос

Идентификатор операции:

OnAskedQuestion

Когда пользователь задает вопрос.

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

Имя	Путь	Тип	Описание
Электронная почта пользователя	userEmail	string
Вопрос, заданный пользователем	queryText	string
Найденный ответ	foundAnswer	boolean	Обнаружен ли COSMO Bot ответ, соответствующий вопросу пользователя.
Ответ	answer	Answer

При обновлении раздела билета

Идентификатор операции:

OnUpdatedTicketTopic

При обновлении раздела существующего билета.

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

Имя	Путь	Тип	Описание
Билет	ticket	Ticket

При разрешении билета

Идентификатор операции:

OnResolvedTicket

При разрешении существующего билета.

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

Имя	Путь	Тип	Описание
Билет	ticket	Ticket
Электронная почта редактора	editorEmail	string
Комментарий редактора	editorComment	string
Глубокая ссылка на исходный запрос	queryUrl	string

При создании или изменении набора ответов на вопрос

Идентификатор операции:

OnUpdateAnswer

При создании или изменении набора ответов на вопрос.

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

Имя	Путь	Тип	Описание
Ответ	answer	Answer

При создании нового билета

Идентификатор операции:

OnNewTicket

При создании нового билета.

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

Имя	Путь	Тип	Описание
Билет	ticket	Ticket

При создании нового набора ответов на вопросы

Идентификатор операции:

OnNewAnswer

При создании нового набора ответов на вопросы.

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

Имя	Путь	Тип	Описание
Ответ	answer	Answer

Определения

Ответ

Имя	Путь	Тип	Описание
Тема	topic	string
Краткое описание	shortDescription	string
Вопросы	questions	array of string
Текст ответа	answerText	string
Дата и время последнего изменения ответа	modifiedAt	date-time
Изменено пользователем	modifiedBy	string

Билет

Имя	Путь	Тип	Описание
Уникальный идентификатор билета	ticketId	string
Тема	topic	string
Глубокая ссылка для обработки билета	ticketUrl	string
Электронная почта запрашивающего средства	requesterEmail	string
Экспертные сообщения электронной почты	expertEmails	array of string
Вопрос, заданный пользователем	queryText	string
Отзывы, отправленные пользователем	feedbackText	string	Это пусто, если этот запрос не является отзывом.
Краткое описание ответа, полученного пользователем после того, как задать свой вопрос	answerShortDescription	string	Это пусто, если этот запрос не является отзывом.
Ответ на то, что пользователь получил после запроса своего вопроса	answerText	string	Это пусто, если этот запрос не является отзывом.
Дата и время создания билета	createdAt	date-time