Egain (Preview)

Tento konektor umožňuje službě Copilot bezpečně volat rozhraní API eGain V3 a poskytuje bezproblémovou integraci dat o zapojení zákazníků. Podporuje ověřování, načítání dat a provádění akcí, zjednodušuje pracovní postupy a vylepšuje přehledy v reálném čase napříč službami eGain.

Tento konektor je dostupný v následujících produktech a oblastech:

Service	Class	Regions
Copilot Studio	Premium	Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD)
Logic Apps	Standard	Všechny oblasti Logic Apps s výjimkou následujících: – Oblasti Azure Government – Oblasti Azure China - Ministerstvo obrany USA (DoD)
Power Apps	Premium	Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD)
Power Automate	Premium	Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD)

Kontakt
Název	Podpora eGain
Email	support@egain.com

Metadata konektoru
Vydavatel	eGain Corporation
Internetová stránka	http://egain.com/
Zásady ochrany osobních údajů	https://www.egain.com/privacy-policies
Kategorie	Umělá inteligence; Finance
Zdroj	marketplace
BrandColor	#FEF0FD

Egain – Průvodce používáním agenta Copilot

Přehled

Konektor Egain je navržený tak, aby se bezproblémově integrovali s agenty Microsoft Copilot Studio a poskytuje výkonné funkce správy znalostí prostřednictvím dvou různých instancí eGain. Tento konektor umožňuje agentům prohledávat znalostní báze, generovat odpovědi založené na umělé inteligenci a poskytovat přesné citace pomocí automatického generování adres URL.

Požadavky

Před použitím konektoru Egain se ujistěte, že máte splněné následující požadavky:

Požadavky na instanci eGain: Musíte mít instanci eGain spuštěnou na Rigelu nebo R21.x.x nebo vyšší.
Konfigurace klientské aplikace: Klientská aplikace musí být vytvořena v instanci eGain s příslušnými oprávněními pro akce, které plánujete použít. Klientská aplikace by měla mít:
- Oprávnění portálu pro operace vyhledávání ve znalostní bázi
- Oprávnění AI pro operace generující umělé inteligence
Podrobné informace o vytváření a konfiguraci klientských aplikací najdete v dokumentaci k klientské aplikaci eGain.
Nastavení portálu Knowledge Portal: Pro povolení vyhledávání a načítání obsahu musí být v instanci eGain předem nakonfigurovaný portál znalostí. Portál slouží jako základ pro operace znalostní báze a správu obsahu.

Informace o nastavení portálů znalostí najdete v dokumentaci k portálům eGain.

Konfigurace agenta

1. eGain Demo Agent

Hostitel rozhraní API: api.egain.cloud
Adresa URL instance: https://egainr21demo.egain.cloud
Ověřování: Zabezpečení povoleno s ověřováním nosným tokenem
Vlastní témata:
- eGain Search: Používá Kb-search operaci
- Generování: Použití Generative-V3 operace

2. Pomocník pro konektor eGain

Hostitel rozhraní API: api.ai.egain.cloud
Adresa URL instance: https://ai.egain.cloud/s5fa
Ověřování: Zabezpečení povoleno s ověřováním nosným tokenem
Vlastní témata:
- Generování: Použití Generative-V3 operace
- eGainSearch: Použití Search-V3 operace

Zabezpečení a ověřování

Důležité: Samotný konektor Egain nevyžaduje žádnou konfiguraci ověřování. Rozhraní API eGain jsou však zabezpečená a podporují obecné ověřování OAuth 2.0, které je nakonfigurované na kartě Zabezpečení agentů copilot studia.

Obě instance eGain mají povolené zabezpečení a zajišťují správné ověření všech volání rozhraní API. Konektor automaticky zpracovává:

Podpora OAuth 2.0: Obecné ověřování OAuth 2.0 nakonfigurované na kartě Zabezpečení copilot Studia
Ověřování nosné tokeny: Automaticky přidá Bearer předponu, pokud není k dispozici.
Správa hlaviček: Správně spravuje autorizační hlavičky
Sanitizace parametrů: Před předáním do rozhraní API eGain odebere parametry ověřování.
Zpracování chyb: Řádné zpracování chyb ověřování

Operace a využití

Operace 1: Search-V3

Používá se: Pomocník pro konektory eGain (téma eGainSearch)

Účel: Rozšířené vyhledávání pomocí rozhraní API vyhledávání v3 od společnosti eGain s vylepšeným zpracováním výsledků a automatickou generováním adres URL citace.

Konfigurace:

Hostitel rozhraní API: api.ai.egain.cloud
Koncový bod:/search/v3
Metoda: POST

Ukázkový požadavek:

{
  "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"
}

Konfigurace copilot Studia:

$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

Ukázková odpověď:

{
  "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?"
}

Operace 2: Hledání kB

Používá se: eGain Demo Agent (téma hledání eGain)

Účel: Vyhledávání článků znalostní báze Knowledge Base s vylepšeným zpracováním metadat a automatickým generováním adres URL.

Konfigurace:

Hostitel rozhraní API: api.egain.cloud
Koncový bod:/search/kb
Metoda: POST

Ukázkový požadavek:

{
  "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"
}

Konfigurace copilot Studia:

$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

Ukázková odpověď:

{
  "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"
}

Operace 3: Generative-V3

Používá: Oba agenti (téma Generování)

Účel: Generování odpovědí využívajících AI s inteligentní správou citací, detekcí duplicit a konfigurovatelným filtrováním

Konfigurace:

eGain Demo Agent: api.egain.cloud
Pomocník pro konektor eGain: api.ai.egain.cloud
Koncový bod:/generative/v3
Metoda: POST

Ukázkový požadavek:

{
  "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"
}

Konfigurace copilot Studia:

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

Ukázková odpověď:

{
  "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
}

Nastavení a konfigurace agenta

Instalace agenta eGain Demo

Vytvoření vlastního konektoru:
- Import definice OpenAPI
- Nastavení hostitele rozhraní API na api.egain.cloud
- Konfigurace ověřování pomocí nosné tokeny
Konfigurace vlastních témat:
- Téma hledání eGain: Mapování na Kb-search operaci
- Téma generování: Mapování na Generative-V3 operaci
Nastavení ověřování:
- Získání nosný token z instance eGain Demo
- Konfigurace v nastavení ověřování konektoru
- Testování připojení před nasazením

Nastavení Pomocníka s konektorem eGain

Vytvoření vlastního konektoru:
- Import definice OpenAPI
- Nastavení hostitele rozhraní API na api.ai.egain.cloud
- Konfigurace ověřování pomocí nosné tokeny
Konfigurace vlastních témat:
- Téma eGainSearch: Mapování na Search-V3 operaci
- Téma generování: Mapování na Generative-V3 operaci
Nastavení ověřování:
- Získání nosný token z instance pomocníka s konektorem eGain
- Konfigurace v nastavení ověřování konektoru
- Testování připojení před nasazením

Osvědčené postupy pro agenty Copilot

1. Návrh tématu

Jasné rozpoznávání záměru: Témata návrhu, která jasně identifikují, kdy se mají jednotlivé operace používat
Rozpoznávání kontextu: Určení vhodných parametrů hledání pomocí kontextu konverzace
Zpracování náhradních akcí: Implementace náhradních odpovědí, pokud se nenašly žádné výsledky

2. Zpracování odpovědí

Integrace citace: Využití automatického generování adres URL pro bohaté odpovědi
Formátování obsahu: Použití formátu strukturované odpovědi pro konzistentní prezentaci
Zpracování chyb: Implementace odkladu zpracování chyb pro selhání rozhraní API

3. Aspekty zabezpečení

Správa tokenů: Implementace zabezpečeného úložiště a obměně tokenů
Řízení přístupu: Zajištění správných řízení přístupu pro různé role uživatelů
Protokolování auditu: Volání rozhraní API protokolu pro monitorování zabezpečení

4. Optimalizace výkonu

Ukládání do mezipaměti: Implementace vhodné mezipaměti pro často přístupný obsah
Omezování rychlosti: Dodržování limitů rychlosti rozhraní API eGain
Filtrování odpovědí: Efektivní použití parametrů minScore a maxReferences

Řešení problémů

Běžné problémy

Chyby ověřování:

Ověřte platnost nosného tokenu a nevypršela jeho platnost.
Kontrola konfigurace hostitele rozhraní API odpovídá zamýšlené instanci eGain.
Zajištění správného formátu tokenu v nastavení konektoru

Prázdné výsledky:

Ověřte, že vyhledávací dotazy jsou dostatečně specifické.
Kontrola, jestli ve znalostní bázi existuje obsah
Kontrola nastavení minScore pro generování odpovědí

Problémy s generováním adres URL:

Ujistěte se, že jsou správně nakonfigurované parametry baseUrl a shortName.
Ověření přístupnosti adres URL instancí eGain
Kontrola speciálních znaků v názvech článků

Kroky ladění

Testování jednotlivých operací: Použití Power Automate k otestování jednotlivých operací samostatně
Kontrola formátu odpovědi: Ověření struktury odpovědi odpovídá očekávanému schématu
Ověření ověřování: Ujistěte se, že jsou tokeny správně nakonfigurované.
Kontrola protokolů: Podrobné informace o chybách najdete v protokolech spuštění konektoru.

Pokročilé funkce

Detekce duplicit

Konektor automaticky odebere duplicitní citace založené na kombinacích ID odkazu a názvů a zajišťuje čisté seznamy odkazů v generačních odpovědích.

Filtrování Score-Based

Nakonfigurujte minimální prahové hodnoty skóre a maximální počet odkazů pro řízení kvality a délky odezvy:

minScore: Odfiltrujte citace s nízkou důležitostí (výchozí hodnota: 0,01)
maxReferences: Limit počtu odkazů (výchozí hodnota: 10)

Přizpůsobení adresy URL

Podpora vytváření vlastních adres URL pomocí parametrů baseUrl a shortName:

baseUrl: Základní adresa URL vaší instance eGain
shortName: Segment cesty url pro přístup k obsahu

Podpora a údržba

Pravidelná údržba

Obměny tokenů: Pravidelné aktualizace ověřovacích tokenů
Monitorování rozhraní API: Monitorování využití a výkonu rozhraní API
Aktualizace obsahu: Udržování aktuálního obsahu znalostní báze

Zdroje podpory

Dokumentace k eGain: Projděte si oficiální dokumentaci k rozhraní API od společnosti eGain.
Microsoft Copilot Studio: Použití průvodců odstraňováním potíží s konektory Microsoftu
Podpora komunity: Využití komunitních zdrojů microsoft Power Platform

Historie verzí

v1.0.0: Počáteční verze s operacemi Search-V3, Kb-search a Generative-V3
Přidání automatického propojení citací a detekce duplicit
Implementovali jsme konfigurovatelné limity filtrování skóre a odkazů.
Vylepšené zabezpečení s využitím správného zpracování ověřování

Tato dokumentace je navržená tak, aby vývojářům a správcům pomohla efektivně implementovat a udržovat konektor Egain v agentech microsoft Copilot Studio.

Vytvoření připojení

Konektor podporuje následující typy ověřování:


výchozí	Parametry pro vytvoření připojení	Všechny oblasti	Nesdílitelné

Výchozí

Použitelné: Všechny oblasti

Parametry pro vytvoření připojení

Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.

Název	Typ	Description	Povinné
Hostitel rozhraní API eGain	řetězec	Doména rozhraní API eGain na základě typu instance	Pravdivé

Limity omezování

Name	Volání	Období obnovení
Volání rozhraní API na připojení	100	60 sekund

Akce

Načte odpovědi pro daný obor pomocí zdrojů dat a portálu KB Portal.	Služba načte sadu odpovědí pro daný obor. Obor je kolekce zdrojů dat nebo portál kb eGain s konkrétním jazykem a ID profilu přizpůsobení.
Vrátí výsledek hledání kb pro eGain R21.	Je k dispozici pouze pro instalaci eGain ve verzi 21.x.x.x.
Získání nejlepších výsledků hledání pro dotaz uživatele	Získejte nejlepší výsledky hledání pro dotaz uživatele. Neplatí pro verzi 21.x.x.x.x.

Načte odpovědi pro daný obor pomocí zdrojů dat a portálu KB Portal.

ID operace:: Generative-V3

Služba načte sadu odpovědí pro daný obor. Obor je kolekce zdrojů dat nebo portál kb eGain s konkrétním jazykem a ID profilu přizpůsobení.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Query	q	True	string	Dotaz nebo hledaný termín
ID oddělení	departmentId		integer	Identifikátor oddělení
ID uživatele	userId		integer	Identifikátor uživatele
ID portálu	portalId	True	integer	Výsledky se načtou z daného portálu KM.
Kód jazyka	languageCode	True	string	Kód jazyka pro vyhledávání
ID profilu přizpůsobení	personalizationProfileId		integer	Identifikátor profilu přizpůsobení
Ověřovací token	authToken	True	string	Používá se k autorizaci k rozhraní API eGain.
Základní adresa URL	baseUrl	True	string	Základní adresa URL portálu KM
Krátký název	shortName	True	string	Krátký název použitý pro portál KM
Přijmout	Accept		string	Přijmout hodnotu záhlaví

Vrátí výsledek hledání kb pro eGain R21.

ID operace:: Kb-search

Je k dispozici pouze pro instalaci eGain ve verzi 21.x.x.x.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID portálu	portalId	True	string	Identifikátor portálu
Query	q	True	string	Řetězec vyhledávacího dotazu
Jazyk	$lang	True	string	Kód jazyka pro vyhledávání
Vlastnost	$attribute		string	Filtr atributů pro výsledky hledání
Číslo stránky	$pagenum		integer	Číslo stránky pro stránkování
Velikost stránky	$pagesize		integer	Počet výsledků na stránku
Ověřovací token	authToken	True	string	Ověřovací token pro přístup k rozhraní API
Základní adresa URL	baseUrl	True	string	Základní adresa URL portálu KM
Krátký název	shortName	True	string	Krátký název použitý pro portál KM
Přijmout jazyk	Accept-language	True	string	hodnota záhlaví Accept-Language
Přijmout	Accept	True	string	Přijmout hodnotu záhlaví

Získání nejlepších výsledků hledání pro dotaz uživatele

ID operace:: Search-V3

Získejte nejlepší výsledky hledání pro dotaz uživatele. Neplatí pro verzi 21.x.x.x.x.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID portálu	portalId	True	string	Identifikátor portálu
Kód jazyka	languageCode	True	string	Kód jazyka pro vyhledávání
Query	q	True	string	Řetězec vyhledávacího dotazu
ID profilu přizpůsobení	personalizationProfileId		integer	Identifikátor profilu přizpůsobení
Ověřovací token	authToken	True	string	Předá se jako autorizační hlavička.
Základní adresa URL	baseUrl	True	string	Toto je základní adresa URL portálu Km.
Krátký název	shortName	True	string	Krátký název portálu KM
Přijmout	Accept		string	Přijmout hodnotu záhlaví

Sdílet prostřednictvím

Egain (Preview)

Egain – Průvodce používáním agenta Copilot

Přehled

Požadavky

Konfigurace agenta

1. eGain Demo Agent

2. Pomocník pro konektor eGain

Zabezpečení a ověřování

Operace a využití

Operace 1: Search-V3

Operace 2: Hledání kB

Operace 3: Generative-V3

Nastavení a konfigurace agenta

Instalace agenta eGain Demo

Nastavení Pomocníka s konektorem eGain

Osvědčené postupy pro agenty Copilot

1. Návrh tématu

2. Zpracování odpovědí

3. Aspekty zabezpečení

4. Optimalizace výkonu

Řešení problémů

Běžné problémy

Kroky ladění

Pokročilé funkce

Detekce duplicit

Filtrování Score-Based

Přizpůsobení adresy URL

Podpora a údržba

Pravidelná údržba

Zdroje podpory

Historie verzí

Vytvoření připojení

Výchozí

Limity omezování

Akce

Načte odpovědi pro daný obor pomocí zdrojů dat a portálu KB Portal.

Parametry

Vrátí výsledek hledání kb pro eGain R21.

Parametry

Získání nejlepších výsledků hledání pro dotaz uživatele

Parametry