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

Этот соединитель позволяет Copilot безопасно вызывать API eGain версии 3, обеспечивая простую интеграцию с данными об взаимодействии с клиентами. Она поддерживает проверку подлинности, извлечение данных и выполнение действий, упрощение рабочих процессов и повышение аналитических сведений в режиме реального времени в службах eGain.

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

Услуга	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)

Контакт
Имя	Поддержка eGain
Адрес электронной почты	support@egain.com

Метаданные соединителя
Publisher	eGain Corporation
Website	http://egain.com/
Политика конфиденциальности	https://www.egain.com/privacy-policies
Категории	Искусственный интеллект; Финансировать
Исходный материал	рынок
BrandColor	#FEF0FD

Egain — руководство по использованию агента Copilot

Обзор

Соединитель Egain предназначен для эффективной интеграции с агентами Microsoft Copilot Studio, предоставляя мощные возможности управления знаниями с помощью двух отдельных экземпляров eGain. Этот соединитель позволяет агентам выполнять поиск баз знаний, создавать ответы на основе ИИ и предоставлять точные ссылки с автоматическим созданием URL-адресов.

Предпосылки

Прежде чем использовать соединитель Egain, убедитесь, что у вас есть следующие предварительные требования:

Требования к экземпляру eGain: у вас должен быть экземпляр eGain, работающий в Rigel или R21.x.x.x или более поздней версии.
Конфигурация клиентского приложения. Клиентское приложение должно быть создано в экземпляре eGain с соответствующими разрешениями для действий, которые вы планируете использовать. Клиентское приложение должно иметь следующее:
- Разрешения портала для операций поиска базы знаний
- Разрешения искусственного интеллекта для операций создания ИИ
Подробные сведения о создании и настройке клиентских приложений см. в документации по клиентскому приложению eGain.
Настройка портала знаний. Портал знаний должен быть предварительно настроен в экземпляре eGain, чтобы включить поиск контента и получение. Портал служит основой для операций базы знаний и управления содержимым.

Сведения о настройке порталов знаний см. в документации по eGain Portals.

Конфигурации агента

1. Демонстрационный агент eGain

Узел API: api.egain.cloud
URL-адрес экземпляра: https://egainr21demo.egain.cloud
Проверка подлинности: включена безопасность с проверкой подлинности маркера носителя
Пользовательские разделы:
- Поиск eGain: использует Kb-search операцию
- Создание: использует Generative-V3 операцию

2. Помощник по соединителю eGain

Узел API: api.ai.egain.cloud
URL-адрес экземпляра: https://ai.egain.cloud/s5fa
Проверка подлинности: включена безопасность с проверкой подлинности маркера носителя
Пользовательские разделы:
- Создание: использует Generative-V3 операцию
- eGainSearch: использует Search-V3 операцию

Безопасность и проверка подлинности

Важно: сам соединитель Egain не требует какой-либо конфигурации проверки подлинности. Однако API eGain защищены и поддерживают универсальную проверку подлинности OAuth 2.0, настроенную на вкладке "Безопасность" агентов Copilot Studio.

Оба экземпляра eGain включены в систему безопасности, обеспечивая правильную проверку подлинности всех вызовов API. Соединитель автоматически обрабатывает следующее:

Поддержка OAuth 2.0: универсальная проверка подлинности OAuth 2.0, настроенная на вкладке "Безопасность Copilot Studio"
Проверка подлинности маркера носителя: автоматически добавляет Bearer префикс, если он отсутствует
Управление заголовками: правильно управляет заголовками авторизации
Санитизация параметров: удаляет параметры проверки подлинности перед пересылкой в API eGain
Обработка ошибок: правильная обработка сбоев проверки подлинности

Операции и использование

Операция 1: Search-V3

Используется: помощник по соединителю eGain (раздел eGainSearch)

Назначение. Расширенный поиск с помощью API поиска eGain версии 3 с улучшенной обработкой результатов и автоматическим созданием URL-адреса ссылки.

Конфигурация:

Узел API: api.ai.egain.cloud
Конечная точка:/search/v3
Метод : POST

Пример запроса:

{
  "q": "How to reset password for user accounts?",
  "baseUrl": "https://ai.egain.cloud/s5fa/kb/ebank,
  "shortName": "content",
  "authToken": "your-bearer-token-here",
  "$attribute": "snippet",
  "$lang": "en-us",
  "$pagenum": 1,
  "$pagesize": 10,
  "Accept": "application/json",
  "Accept-language": "en-us",
  "portalId": "202400000001000"
}

Конфигурация Copilot Studio:

$attribute: snippet
$lang: en-us
$pagenum: 1
$pagesize: 10
Accept: application/json
Accept-language: en-us
authToken: =System.User.AccessToken
baseUrl: https://ai.egain.cloud/s5fa/kb/ebank
portalId: "202400000001000"
query: =Topic.Var1_SearchQuestion
shortName: content

Пример ответа:

{
  "results": [
    {
      "alternateId": "KB-12345",
      "title": "Password Reset Procedures",
      "url": "https://ai.egain.cloud/s5fa/kb/ebank/content/KB-12345/Password-Reset-Procedures",
      "snippet": "To reset a user password, follow these steps...",
      "relevanceScore": 0.95,
      "lastModifiedDate": "2024-01-15T10:30:00Z"
    },
    {
      "alternateId": "KB-12346",
      "title": "Account Security Guidelines",
      "url": "https://ai.egain.cloud/s5fa/kb/ebank/content/KB-12346/Account-Security-Guidelines",
      "snippet": "Best practices for maintaining account security...",
      "relevanceScore": 0.87,
      "lastModifiedDate": "2024-01-10T14:20:00Z"
    }
  ],
  "totalCount": 2,
  "query": "How to reset password for user accounts?"
}

Операция 2. Kb-search

Используется: агент демонстрации eGain (раздел поиска eGain)

Назначение: поиск статьи базы знаний с улучшенной обработкой метаданных и автоматическим созданием URL-адресов.

Конфигурация:

Узел API: api.egain.cloud
Конечная точка:/search/kb
Метод : POST

Пример запроса:

{
  "q": "troubleshooting network connectivity issues",
  "baseUrl": "https://egainr21demo.egain.cloud/kb",
  "shortName": "ebank",
  "authToken": "your-bearer-token-here",
  "$attribute": "snippet",
  "$lang": "en-us",
  "$pagenum": 1,
  "$pagesize": 10,
  "Accept": "application/json",
  "Accept-language": "en-us",
  "portalId": "202200000001170"
}

Конфигурация Copilot Studio:

$attribute: snippet
$lang: en-us
$pagenum: 1
$pagesize: 10
Accept: application/json
Accept-language: en-us
authToken: =System.User.AccessToken
baseUrl: https://egainr21demo.egain.cloud/kb
portalId: "202200000001170"
q: =Topic.Var1_SearchQuestion
shortName: ebank

Пример ответа:

{
  "article": [
    {
      "id": "202200000021450",
      "name": "Network Troubleshooting Guide",
      "url": "https://egainr21demo.egain.cloud/kb/content/202200000021450/Network-Troubleshooting-Guide",
      "snippet": "Common network connectivity issues and their solutions...",
      "createdDate": "2022-11-11T14:21:48Z",
      "lastModifiedDate": "2023-10-02T16:46:58Z",
      "hasAttachments": false
    },
    {
      "id": "202200000019399",
      "name": "WiFi Connection Problems",
      "url": "https://egainr21demo.egain.cloud/kb/content/202200000019399/WiFi-Connection-Problems",
      "snippet": "Step-by-step guide to resolve WiFi connectivity issues...",
      "createdDate": "2022-09-28T22:24:43Z",
      "lastModifiedDate": "2025-08-07T15:22:02Z",
      "hasAttachments": true
    }
  ],
  "isSpellingCorrected": false,
  "paginationInfo": {
    "count": 15,
    "pagenum": 1,
    "pagesize": 10
  },
  "query": "troubleshooting network connectivity issues"
}

Операция 3: Generative-V3

Используется: оба агента (генерированный раздел)

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

Конфигурация:

Агент демонстрации eGain: api.egain.cloud
Помощник по соединителю eGain: api.ai.egain.cloud
Конечная точка:/generative/v3
Метод : POST

Пример запроса:

{
  "q": "What are the steps to configure a new user account with proper security settings?",
  "baseUrl": "https://egainr21demo.egain.cloud/kb",
  "shortName": "ebank",
  "minScore": 0.3,
  "maxReferences": 5,
  "authToken": "your-bearer-token-here",
  "Accept": "application/json",
  "languageCode": "en-us",
  "portalId": "202200000001170"
}

Конфигурация Copilot Studio:

Accept: application/json
authToken: =System.User.AccessToken
baseUrl: https://egainr21demo.egain.cloud/kb
languageCode: en-us
portalId: 202200000001170
q: =Topic.Var1_UserQuestion
shortName: ebank
minScore: 0.3
maxReferences: 5

Пример ответа:

{
  "Content": "To configure a new user account with proper security settings, follow these comprehensive steps:\n\n**1. Account Creation**\n- Create the user account in the system [1]\n- Set up initial login credentials [2]\n- Configure basic profile information [3]\n\n**2. Security Configuration**\n- Enable two-factor authentication [4]\n- Set password complexity requirements [5]\n- Configure access permissions based on role [6]\n\n**3. Verification and Testing**\n- Test login functionality [7]\n- Verify security settings are active [8]\n- Conduct security audit [9]\n\n**References:**\n1. [User Account Setup Guide](https://egainr21demo.egain.cloud/kb/ebank/content/USR-001/User-Account-Setup-Guide)\n2. [Login Credentials Management](https://egainr21demo.egain.cloud/kb/ebank/content/USR-002/Login-Credentials-Management)\n3. [Profile Configuration](https://egainr21demo.egain.cloud/kb/ebank/content/USR-003/Profile-Configuration)\n4. [Two-Factor Authentication Setup](https://egainr21demo.egain.cloud/kb/ebank/content/SEC-001/Two-Factor-Authentication-Setup)\n5. [Password Policy Configuration](https://egainr21demo.egain.cloud/kb/ebank/content/SEC-002/Password-Policy-Configuration)",
  "Sources": [
    {
      "Id": "1",
      "Name": "User Account Setup Guide",
      "Url": "https://egainr21demo.egain.cloud/kb/ebank/content/USR-001/User-Account-Setup-Guide",
      "Score": 0.95
    },
    {
      "Id": "2",
      "Name": "Login Credentials Management",
      "Url": "https://egainr21demo.egain.cloud/kb/ebank/content/USR-002/Login-Credentials-Management",
      "Score": 0.92
    },
    {
      "Id": "3",
      "Name": "Profile Configuration",
      "Url": "https://egainr21demo.egain.cloud/kb/ebank/content/USR-003/Profile-Configuration",
      "Score": 0.88
    }
  ],
  "Score": 0.92,
  "ReferenceCount": 9
}

Настройка и настройка агента

Настройка демонстрационного агента eGain

Создание настраиваемого соединителя:
- Импорт определения OpenAPI
- Задайте для узла API значение api.egain.cloud
- Настройка проверки подлинности с помощью маркера носителя
Настройка настраиваемых разделов:
- Раздел поиска eGain: сопоставление с операцией Kb-search
- Создание раздела: сопоставление с операцией Generative-V3
Настройка проверки подлинности:
- Получение маркера носителя из демонстрационного экземпляра eGain
- Настройка параметров проверки подлинности соединителя
- Тестирование подключения перед развертыванием

Настройка помощника по соединителю eGain

Создание настраиваемого соединителя:
- Импорт определения OpenAPI
- Задайте для узла API значение api.ai.egain.cloud
- Настройка проверки подлинности с помощью маркера носителя
Настройка настраиваемых разделов:
- Раздел eGainSearch: сопоставление с операцией Search-V3
- Создание раздела: сопоставление с операцией Generative-V3
Настройка проверки подлинности:
- Получение маркера носителя из экземпляра помощника по соединителю eGain
- Настройка параметров проверки подлинности соединителя
- Тестирование подключения перед развертыванием

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

Распространенные проблемы

Ошибки проверки подлинности:

Проверка допустимости маркера носителя и не истекает
Проверка конфигурации узла API соответствует предполагаемому экземпляру eGain
Убедитесь, что правильный формат маркера в параметрах соединителя

Пустые результаты:

Убедитесь, что поисковые запросы достаточно конкретные
Проверка наличия содержимого в базе знаний
Просмотр параметров minScore для создания ответов

Проблемы с созданием URL-адресов:

Убедитесь, что параметры baseUrl и shortName настроены правильно
Проверка доступности URL-адресов экземпляра eGain
Проверка специальных символов в именах статей

Шаги отладки

Тестирование отдельных операций. Использование Power Automate для тестирования каждой операции отдельно
Проверка формата ответа: проверка структуры ответа соответствует ожидаемой схеме
Проверка подлинности. Убедитесь, что маркеры настроены правильно
Просмотр журналов. Проверьте журналы выполнения соединителя для получения подробных сведений об ошибках

Дополнительные функции

Обнаружение повторяющихся данных

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

Фильтрация Score-Based

Настройте минимальные пороговые значения оценки и максимальное количество ссылок для контроля качества ответа и длины:

minScore: фильтрация ссылок с низкой релевантностью (по умолчанию: 0.01)
maxReferences: ограничение количества ссылок (по умолчанию: 10)

Настройка URL-адреса

Поддержка создания пользовательского URL-адреса с помощью параметров baseUrl и shortName:

baseUrl: базовый URL-адрес экземпляра eGain
shortName: сегмент URL-пути для доступа к содержимому

Поддержка и обслуживание

Регулярное обслуживание

Смена маркеров: регулярно обновляйте маркеры проверки подлинности
Мониторинг API: мониторинг использования и производительности API
Обновления содержимого: сохранение текущего содержимого базы знаний

Ресурсы поддержки

Документация по eGain: см. официальную документацию по API eGain
Microsoft Copilot Studio: использование руководств по устранению неполадок соединителя Майкрософт
Поддержка сообщества. Использование ресурсов сообщества Microsoft Power Platform

Журнал версий

версии 1.0.0: начальный выпуск с помощью операций Поиска-V3, Kb-search и Generative-V3
Добавлена автоматическая привязка ссылок и обнаружение дубликата
Реализованы настраиваемые ограничения фильтрации показателей и ссылок
Улучшенная безопасность с правильной обработкой проверки подлинности

Эта документация предназначена для эффективной реализации и обслуживания соединителя Egain в агентах Microsoft Copilot Studio.

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

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


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

По умолчанию

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

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

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

Имя	Тип	Description	Обязательно
Узел API eGain	струна	Домен API eGain на основе типа экземпляра	True

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

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

Действия

Возвращает результат поиска базы знаний для eGain R21	Он доступен только для установки eGain в выпуске 21.x.x.x.x.x.
Извлекает ответы на данную область с источниками данных и порталом базы знаний	Служба получит набор ответов для заданной области. Область — это коллекция источников данных или портала базы знаний eGain с определенным идентификатором языка и профиля персонализации.
Получение лучших результатов поиска для запроса пользователя	Получите лучшие результаты поиска для запроса пользователя. Оно неприменимо для выпуска 21.x.x.x.x.

Возвращает результат поиска базы знаний для eGain R21

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

Он доступен только для установки eGain в выпуске 21.x.x.x.x.x.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор портала	portalId	True	string	Идентификатор портала
Query	q	True	string	Строка запроса поиска
Language	$lang	True	string	Языковой код для поиска
Свойство	$attribute		string	Фильтр атрибутов для результатов поиска
Номер страницы	$pagenum		integer	Номер страницы для разбиения на страницы
Размер страницы	$pagesize		integer	Количество результатов на странице
Маркер проверки подлинности	authToken	True	string	Маркер проверки подлинности для доступа к API
Базовый URL-адрес	baseUrl	True	string	Базовый URL-адрес для портала KM
Короткое имя	shortName	True	string	Короткое имя, используемое для портала KM
Принять язык	Accept-language	True	string	значение заголовка Accept-Language
Принять	Accept	True	string	Принять значение заголовка

Извлекает ответы на данную область с источниками данных и порталом базы знаний

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

Служба получит набор ответов для заданной области. Область — это коллекция источников данных или портала базы знаний eGain с определенным идентификатором языка и профиля персонализации.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Query	q	True	string	Вопрос или поисковый термин
Идентификатор отдела	departmentId		integer	Идентификатор отдела
Идентификатор пользователя	userId		integer	Идентификатор пользователя
Идентификатор портала	portalId	True	integer	Результаты извлекаются с заданного портала KM
Код языка	languageCode	True	string	Языковой код для поиска
Идентификатор профиля персонализации	personalizationProfileId		integer	Идентификатор профиля персонализации
Маркер проверки подлинности	authToken	True	string	Используется для авторизации в API eGain
Базовый URL-адрес	baseUrl	True	string	Базовый URL-адрес для портала KM
Короткое имя	shortName	True	string	Короткое имя, используемое для портала KM
Принять	Accept		string	Принять значение заголовка

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

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

Получите лучшие результаты поиска для запроса пользователя. Оно неприменимо для выпуска 21.x.x.x.x.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор портала	portalId	True	string	Идентификатор портала
Код языка	languageCode	True	string	Языковой код для поиска
Query	q	True	string	Строка запроса поиска
Идентификатор профиля персонализации	personalizationProfileId		integer	Идентификатор профиля персонализации
Маркер проверки подлинности	authToken	True	string	Он передается в качестве заголовка авторизации
Базовый URL-адрес	baseUrl	True	string	Это базовый URL-адрес портала km
Короткое имя	shortName	True	string	Короткое имя портала KM
Принять	Accept		string	Принять значение заголовка

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

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

Egain — руководство по использованию агента Copilot

Обзор

Предпосылки

Конфигурации агента

1. Демонстрационный агент eGain

2. Помощник по соединителю eGain

Безопасность и проверка подлинности

Операции и использование

Операция 1: Search-V3

Операция 2. Kb-search

Операция 3: Generative-V3

Настройка и настройка агента

Настройка демонстрационного агента eGain

Настройка помощника по соединителю eGain

Рекомендации по агентам Copilot

1. Конструктор разделов

2. Обработка ответов

3. Вопросы безопасности

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

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

Распространенные проблемы

Шаги отладки

Дополнительные функции

Обнаружение повторяющихся данных

Фильтрация Score-Based

Настройка URL-адреса

Поддержка и обслуживание

Регулярное обслуживание

Ресурсы поддержки

Журнал версий

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

По умолчанию

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

Действия

Возвращает результат поиска базы знаний для eGain R21

Параметры

Извлекает ответы на данную область с источниками данных и порталом базы знаний

Параметры

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

Параметры