Egain (előzetes verzió)

Ez az összekötő lehetővé teszi, hogy a Copilot biztonságosan meghívja az eGain V3 API-t, és zökkenőmentes integrációt biztosítson az ügyfelek előjegyzési adataihoz. Támogatja a hitelesítést, az adatok lekérését és a műveletek végrehajtását, leegyszerűsíti a munkafolyamatokat, és növeli a valós idejű elemzéseket az eGain-szolgáltatásokban.

Ez az összekötő a következő termékekben és régiókban érhető el:

Service	Class	Régiók
Copilot Studio	prémium	Az összes Power Automate-régió, kivéve a következőket: - USA kormánya (GCC) - Amerikai kormány (GCC High) - A 21Vianet által üzemeltetett China Cloud - Amerikai Védelmi Minisztérium (DoD)
Logikai alkalmazások	Standard	Az összes Logic Apps-régió , kivéve a következőket: - Azure Government-régiók - Azure China-régiók - Amerikai Védelmi Minisztérium (DoD)
Power Alkalmazások	prémium	Az összes Power Apps-régió , kivéve a következőket: - USA kormánya (GCC) - Amerikai kormány (GCC High) - A 21Vianet által üzemeltetett China Cloud - Amerikai Védelmi Minisztérium (DoD)
Power Automate	prémium	Az összes Power Automate-régió, kivéve a következőket: - USA kormánya (GCC) - Amerikai kormány (GCC High) - A 21Vianet által üzemeltetett China Cloud - Amerikai Védelmi Minisztérium (DoD)

Érintkezés
Név	eGain-támogatás
Email	support@egain.com

Összekötő metaadatai
Kiadó	eGain Corporation
Webhely	http://egain.com/
Adatvédelmi irányelvek	https://www.egain.com/privacy-policies
Kategóriák	AI; Pénzügy
Forrás	piactér
BrandColor	#FEF0FD

Egain – Copilot-ügynök használati útmutatója

Áttekintés

Az Egain-összekötőt úgy tervezték, hogy zökkenőmentesen integrálható legyen a Microsoft Copilot Studio-ügynökökkel, és hatékony tudáskezelési képességeket biztosít két különálló eGain-példányon keresztül. Ez az összekötő lehetővé teszi az ügynökök számára a tudásbázisok keresését, az AI-alapú válaszok létrehozását és a pontos idézetek automatikus URL-generálását.

Előfeltételek

Az Egain-összekötő használata előtt győződjön meg arról, hogy a következő előfeltételek teljesülnek:

eGain-példányokra vonatkozó követelmények: Rigel vagy R21.x.x vagy újabb verziójú eGain-példányt kell futtatnia.
Ügyfélalkalmazás konfigurálása: Létre kell hozni egy ügyfélalkalmazást az eGain-példányban a használni kívánt műveletekhez megfelelő engedélyekkel. Az ügyfélalkalmazásnak a következőnek kell lennie:
- Portálengedélyek tudásbáziskeresési műveletekhez
- AI-engedélyek generatív AI-műveletekhez
Az ügyfélalkalmazások létrehozásával és konfigurálásával kapcsolatos részletes információkért tekintse meg az eGain ügyfélalkalmazás dokumentációját.
Tudásbázisportál beállítása: A tartalomkeresés és -lekérés engedélyezéséhez előre konfigurálnia kell egy tudásbázisportált az eGain-példányban. A portál a tudásbázis műveleteinek és a tartalomkezelésnek az alapja.

A tudásportálok beállításával kapcsolatos információkért tekintse meg az eGain Portalok dokumentációját.

Ügynökkonfigurációk

1. eGain demo ügynök

API-gazdagép: api.egain.cloud
Példány URL-címe: https://egainr21demo.egain.cloud
Hitelesítés: A tulajdonosi jogkivonat-hitelesítéssel engedélyezett biztonság
Egyéni témakörök:
- eGain Search: Művelet használata Kb-search
- Generatív: Művelet használata Generative-V3

2. eGain Connector Assistant

API-gazdagép: api.ai.egain.cloud
Példány URL-címe: https://ai.egain.cloud/s5fa
Hitelesítés: A tulajdonosi jogkivonat-hitelesítéssel engedélyezett biztonság
Egyéni témakörök:
- Generatív: Művelet használata Generative-V3
- eGainSearch: Művelet használata Search-V3

Biztonság és hitelesítés

Fontos: Maga az Egain-összekötő nem igényel hitelesítési konfigurációt. Az eGain API-k azonban védettek, és támogatják az általános OAuth 2.0-hitelesítést, amely a Copilot Studio-ügynökök Biztonság lapján van konfigurálva.

Mindkét eGain-példány rendelkezik engedélyezett biztonsággal, biztosítva, hogy minden API-hívás megfelelően hitelesítve legyen. Az összekötő automatikusan kezeli a következőt:

OAuth 2.0-támogatás: A Copilot Studio Security lapon konfigurált általános OAuth 2.0-hitelesítés
Tulajdonosi jogkivonat hitelesítése: Automatikusan hozzáadja az Bearer előtagot, ha nincs jelen
Fejléckezelés: Az engedélyezési fejlécek megfelelő kezelése
Paraméter tisztítása: Eltávolítja a hitelesítési paramétereket, mielőtt továbbítana az eGain API-knak
Hibakezelés: A hitelesítési hibák türelmes kezelése

Műveletek és használat

1. művelet: Search-V3

Használja: eGain Connector Assistant (eGainSearch témakör)

Cél: Irányított keresés az eGain V3 keresési API-jával, továbbfejlesztett eredményfeldolgozással és automatikus idézet URL-cím generálással.

Konfiguráció:

API-gazdagép: api.ai.egain.cloud
Végpont:/search/v3
Metódus: POST

Mintakérés:

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

A Copilot Studio konfigurációja:

$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

Mintaválasz:

{
  "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. művelet: Kb-search

Használt: eGain Demo Agent (eGain Search témakör)

Cél: Tudásbáziscikk-keresés továbbfejlesztett metaadatok feldolgozásával és automatikus URL-generálással.

Konfiguráció:

API-gazdagép: api.egain.cloud
Végpont:/search/kb
Metódus: POST

Mintakérés:

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

A Copilot Studio konfigurációja:

$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

Mintaválasz:

{
  "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. művelet: Generative-V3

Használt: Mindkét ügynök (Generatív témakör)

Cél: AI-alapú válaszlétrehozás intelligens idézetkezeléssel, duplikált észleléssel és konfigurálható szűréssel.

Konfiguráció:

eGain demo ügynök: api.egain.cloud
eGain Connector Assistant: api.ai.egain.cloud
Végpont:/generative/v3
Metódus: POST

Mintakérés:

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

A Copilot Studio konfigurációja:

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

Mintaválasz:

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

Ügynök beállítása és konfigurálása

eGain Demo Agent beállítása

Egyéni összekötő létrehozása:
- A definíció importálása OpenAPI
- API-gazdagép beállítása api.egain.cloud
- Hitelesítés konfigurálása Tulajdonosi jogkivonattal
Egyéni témakörök konfigurálása:
- eGain search topic: Map to Kb-search operation
- Generatív témakör: Leképezés működésre Generative-V3
Hitelesítés beállítása:
- Tulajdonosi jogkivonat beszerzése az eGain Demo-példányból
- Konfigurálás az összekötő hitelesítési beállításaiban
- A kapcsolat tesztelése üzembe helyezés előtt

Az eGain Connector Assistant beállítása

Egyéni összekötő létrehozása:
- A definíció importálása OpenAPI
- API-gazdagép beállítása api.ai.egain.cloud
- Hitelesítés konfigurálása Tulajdonosi jogkivonattal
Egyéni témakörök konfigurálása:
- eGainSearch témakör: Térkép a működéshez Search-V3
- Generatív témakör: Leképezés működésre Generative-V3
Hitelesítés beállítása:
- Tulajdonosi jogkivonat beszerzése az eGain Connector Assistant-példányból
- Konfigurálás az összekötő hitelesítési beállításaiban
- A kapcsolat tesztelése üzembe helyezés előtt

Ajánlott eljárások a Copilot-ügynökökhöz

1. Tématervezés

Szándékfelismerés törlése: Tervezési témakörök az egyes műveletek használatának egyértelmű azonosításához
Környezettudatosság: Beszélgetési környezet használata a megfelelő keresési paraméterek meghatározásához
Tartalékkezelés: Tartalék válaszok implementálása, ha nem található eredmény

2. Válaszfeldolgozás

Idézetintegráció: Használja ki az automatikus URL-generálást a gazdag válaszokhoz
Tartalomformázás: A strukturált válaszformátum használata konzisztens bemutatóhoz
Hibakezelés: Az API-hibák kecses hibakezelésének megvalósítása

3. Biztonsági szempontok

Jogkivonat-kezelés: Biztonságos jogkivonat-tárolás és -forgatás megvalósítása
Hozzáférés-vezérlés: A különböző felhasználói szerepkörök megfelelő hozzáférés-vezérlésének biztosítása
Naplózás naplózása: Naplózási API-hívások biztonsági monitorozáshoz

4. Teljesítményoptimalizálás

Gyorsítótárazás: A gyakran használt tartalom megfelelő gyorsítótárazásának megvalósítása
Sebességkorlátozás: Az eGain API sebességkorlátjainak tiszteletben tartása
Válaszszűrés: A minScore és a maxReferences paraméterek hatékony használata

Hibaelhárítás

Gyakori problémák

Hitelesítési hibák:

Ellenőrizze, hogy a Tulajdonos jogkivonata érvényes-e, és nem járt-e le
Ellenőrizze, hogy az API-gazdagép konfigurációja megfelel-e a kívánt eGain-példánynak
A megfelelő tokenformátum biztosítása az összekötő beállításaiban

Üres találatok:

Ellenőrizze, hogy a keresési lekérdezések elég specifikusak-e
Ellenőrizze, hogy létezik-e tartalom a tudásbázisban
A minScore-beállítások áttekintése a generatív válaszokhoz

URL-létrehozási problémák:

Győződjön meg arról, hogy a baseUrl és a shortName paraméterek megfelelően vannak konfigurálva
Ellenőrizze, hogy az eGain-példány URL-címei elérhetők-e
Speciális karakterek keresése a cikknevekben

Hibakeresési lépések

Egyéni műveletek tesztelése: Az egyes műveletek külön tesztelése a Power Automate használatával
Válaszformátum ellenőrzése: Ellenőrizze, hogy a válaszszerkezet megfelel-e a várt sémának
Hitelesítés ellenőrzése: Győződjön meg arról, hogy a jogkivonatok megfelelően vannak konfigurálva
Naplók áttekintése: Ellenőrizze az összekötő végrehajtási naplóit a részletes hibainformációkért

Speciális funkciók

Duplikált észlelés

Az összekötő automatikusan eltávolítja a hivatkozásazonosító és a névkombinációk alapján ismétlődő idézeteket, így tiszta referencialistákat biztosít a generatív válaszokban.

Score-Based szűrés

A minimális pontszám küszöbértékeinek és maximális hivatkozási számának konfigurálása a válaszminőség és a hossz szabályozásához:

minScore: Az alacsony relevanciájú idézetek kiszűrése (alapértelmezett: 0,01)
maxReferences: Hivatkozási korlát (alapértelmezett: 10)

URL-testreszabás

Egyéni URL-építés támogatása baseUrl és shortName paraméterekkel:

baseUrl: Az eGain-példány alap URL-címe
shortName: URL-elérési út szegmens tartalomhozzáféréshez

Támogatás és karbantartás

Rendszeres karbantartás

Token rotálása: A hitelesítési jogkivonatok rendszeres frissítése
API Monitorozás: AZ API használatának és teljesítményének monitorozása
Tartalomfrissítések: A tudásbázis tartalmának naprakészen tartása

Támogatási erőforrások

eGain-dokumentáció: Tekintse meg az eGain hivatalos API-dokumentációját
Microsoft Copilot Studio: A Microsoft összekötőjének hibaelhárítási útmutatóinak használata
Közösségi támogatás: A Microsoft Power Platform közösségi erőforrásainak kihasználása

Verzióelőzmények

1.0.0-s verzió: Kezdeti kiadás Search-V3, Kb-search és Generative-V3 műveletekkel
Automatikus idézet-csatolás és duplikálásészlelés hozzáadása
Konfigurálható pontszámszűrés és referenciakorlátok implementálása
Fokozott biztonság a megfelelő hitelesítés kezelésével

Ez a dokumentáció segít a fejlesztőknek és rendszergazdáknak az Egain-összekötő hatékony implementálásában és karbantartásában a Microsoft Copilot Studio-ügynökökben.

Kapcsolat létrehozása

Az összekötő a következő hitelesítési típusokat támogatja:


Alapértelmezett	A kapcsolat létrehozásának paraméterei.	Minden régió	Nem osztható meg

Alapértelmezett

Alkalmazható: Minden régió

A kapcsolat létrehozásának paraméterei.

Ez nem megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a rendszer kérni fogja, hogy hozzon létre új kapcsolatot.

Név	Típus	Description	Kötelező
eGain API-gazdagép	karakterlánc	Az eGain API tartománya példánytípus alapján	True

Szabályozási korlátok

Name	Hívások	Megújítási időszak
API-hívások kapcsolatonként	100	60 másodperc

Műveletek

Az eGain R21 kb. keresési eredményét adja vissza	Ez csak a 21.x.x.x.x kiadásban elérhető eGain-telepítéshez érhető el
Egy adott hatókörre vonatkozó válaszokat kér le adatforrásokkal és TUDÁSBÁZIS-portállal	A szolgáltatás egy adott hatókörre vonatkozó válaszokat fog lekérni. A hatókör adatforrások gyűjteménye vagy egy eGain KB-portál egy adott nyelvvel és személyre szabási profilazonosítóval.
Felhasználói lekérdezés legjobb keresési eredményeinek lekérése	A felhasználói lekérdezések legjobb keresési eredményeinek lekérése. Nem alkalmazható a 21.x.x.x.x kiadásra

Az eGain R21 kb. keresési eredményét adja vissza

Műveletazonosító:: Kb-search

Ez csak a 21.x.x.x.x kiadásban elérhető eGain-telepítéshez érhető el

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Portál azonosítója	portalId	True	string	A portál azonosítója
Query	q	True	string	Keresési lekérdezési sztring
Nyelv	$lang	True	string	A keresés nyelvkódja
Attribute	$attribute		string	Attribútumszűrő a keresési eredményekhez
Oldalszám	$pagenum		integer	Oldalszám a lapozáshoz
Oldalméret	$pagesize		integer	Találatok száma oldalanként
Hitelesítési jogkivonat	authToken	True	string	Hitelesítési jogkivonat API-hozzáféréshez
Alap URL-cím	baseUrl	True	string	A KM-portál alap URL-címe
Rövid név	shortName	True	string	A KM-portálhoz használt rövid név
Nyelv elfogadása	Accept-language	True	string	Accept-Language fejlécérték
Elfogadás	Accept	True	string	Fejlécérték elfogadása

Egy adott hatókörre vonatkozó válaszokat kér le adatforrásokkal és TUDÁSBÁZIS-portállal

Műveletazonosító:: Generative-V3

A szolgáltatás egy adott hatókörre vonatkozó válaszokat fog lekérni. A hatókör adatforrások gyűjteménye vagy egy eGain KB-portál egy adott nyelvvel és személyre szabási profilazonosítóval.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Query	q	True	string	Kérdés vagy keresési kifejezés
Részlegazonosító	departmentId		integer	Részlegazonosító
Felhasználói azonosító	userId		integer	Felhasználói azonosító
Portál azonosítója	portalId	True	integer	Az eredmények lekérése a megadott KM-portálról történik
Nyelvi kód	languageCode	True	string	A keresés nyelvkódja
Személyre szabási profil azonosítója	personalizationProfileId		integer	Személyre szabási profil azonosítója
Hitelesítési jogkivonat	authToken	True	string	Az eGain API engedélyezéséhez használatos
Alap URL-cím	baseUrl	True	string	A KM-portál alap URL-címe
Rövid név	shortName	True	string	A KM-portálhoz használt rövid név
Elfogadás	Accept		string	Fejlécérték elfogadása

Felhasználói lekérdezés legjobb keresési eredményeinek lekérése

Műveletazonosító:: Search-V3

A felhasználói lekérdezések legjobb keresési eredményeinek lekérése. Nem alkalmazható a 21.x.x.x.x kiadásra

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Portál azonosítója	portalId	True	string	A portál azonosítója
Nyelvi kód	languageCode	True	string	A keresés nyelvkódja
Query	q	True	string	Keresési lekérdezési sztring
Személyre szabási profil azonosítója	personalizationProfileId		integer	Személyre szabási profil azonosítója
Hitelesítési jogkivonat	authToken	True	string	Engedélyezési fejlécként van átadva
Alap URL-cím	baseUrl	True	string	Ez a km-portál alap URL-címe
Rövid név	shortName	True	string	A KM-portál rövid neve
Elfogadás	Accept		string	Fejlécérték elfogadása

Megosztás:

Egain (előzetes verzió)

Egain – Copilot-ügynök használati útmutatója

Áttekintés

Előfeltételek

Ügynökkonfigurációk

1. eGain demo ügynök

2. eGain Connector Assistant

Biztonság és hitelesítés

Műveletek és használat

1. művelet: Search-V3

2. művelet: Kb-search

3. művelet: Generative-V3

Ügynök beállítása és konfigurálása

eGain Demo Agent beállítása

Az eGain Connector Assistant beállítása

Ajánlott eljárások a Copilot-ügynökökhöz

1. Tématervezés

2. Válaszfeldolgozás

3. Biztonsági szempontok

4. Teljesítményoptimalizálás

Hibaelhárítás

Gyakori problémák

Hibakeresési lépések

Speciális funkciók

Duplikált észlelés

Score-Based szűrés

URL-testreszabás

Támogatás és karbantartás

Rendszeres karbantartás

Támogatási erőforrások

Verzióelőzmények

Kapcsolat létrehozása

Alapértelmezett

Szabályozási korlátok

Műveletek

Az eGain R21 kb. keresési eredményét adja vissza

Paraméterek

Egy adott hatókörre vonatkozó válaszokat kér le adatforrásokkal és TUDÁSBÁZIS-portállal

Paraméterek

Felhasználói lekérdezés legjobb keresési eredményeinek lekérése

Paraméterek