Egain (förhandsversion)

Med den här anslutningsappen kan Copilot anropa eGain V3-API:et på ett säkert sätt, vilket ger sömlös integrering för kundengagemangsdata. Den stöder autentisering, datahämtning och åtgärdskörning, förenkla arbetsflöden och förbättra insikter i realtid i eGain-tjänster.

Den här anslutningsappen är tillgänglig i följande produkter och regioner:

Tjänster	Class	Regioner
Copilot Studio	Premie	Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD)
Logiska appar	Norm	Alla Logic Apps-regioner utom följande: – Azure Government-regioner – Regioner i Azure Kina - US Department of Defense (DoD)
Power Apps	Premie	Alla Power Apps-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD)
Power Automate	Premie	Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD)

Kontakt
Namn	eGain-support
E-postmeddelande	support@egain.com

Metadata för anslutningsprogram
Utgivare	eGain Corporation
Webbplats	http://egain.com/
Sekretesspolicy	https://www.egain.com/privacy-policies
Kategorier	Artificiell intelligens; Finans
Källa	marknadsplats
BrandColor	#FEF0FD

Egain – Användningsguide för Copilot-agent

Översikt

Egain-anslutningsappen är utformad för att integreras sömlöst med Microsoft Copilot Studio-agenter, vilket ger kraftfulla funktioner för kunskapshantering via två distinkta eGain-instanser. Med den här anslutningsappen kan agenter söka i kunskapsbaser, generera AI-baserade svar och tillhandahålla korrekta citat med automatisk URL-generering.

Förutsättningar

Kontrollera att du har följande förutsättningar på plats innan du använder Egain-anslutningsappen:

eGain-instanskrav: Du måste ha en eGain-instans som körs på Rigel- eller R21.x.x-versionen eller senare.
Konfiguration av klientprogram: Ett klientprogram måste skapas i din eGain-instans med rätt behörighet för de åtgärder som du planerar att använda. Klientprogrammet ska ha:
- Portalbehörigheter för kunskapsbassökningsåtgärder
- AI-behörigheter för generativa AI-åtgärder
Detaljerad information om hur du skapar och konfigurerar klientprogram finns i dokumentationen för eGain-klientprogram.
Installation av kunskapsportalen: En kunskapsportal måste vara förkonfigurerad i din eGain-instans för att aktivera innehållssökning och hämtning. Portalen fungerar som grund för kunskapsbasåtgärder och innehållshantering.

Information om hur du konfigurerar kunskapsportaler finns i dokumentationen om eGain-portaler.

Agentkonfigurationer

1. eGain Demo Agent

API-värd: api.egain.cloud
Instans-URL: https://egainr21demo.egain.cloud
Autentisering: Säkerhet aktiverad med autentisering med ägartoken
Anpassade ämnen:
- eGain-sökning: Använder Kb-search åtgärden
- Generativ: Använder Generative-V3 åtgärden

2. eGain Connector Assistant

API-värd: api.ai.egain.cloud
Instans-URL: https://ai.egain.cloud/s5fa
Autentisering: Säkerhet aktiverad med autentisering med ägartoken
Anpassade ämnen:
- Generativ: Använder Generative-V3 åtgärden
- eGainSearch: Använder Search-V3 åtgärden

Säkerhet och autentisering

Viktigt: Egain-anslutningsappen kräver ingen autentiseringskonfiguration. EGain-API:erna är dock skyddade och stöder allmän OAuth 2.0-autentisering, som är konfigurerad på fliken Säkerhet för dina Copilot Studio-agenter.

Båda eGain-instanserna har säkerhet aktiverat, vilket säkerställer att alla API-anrop autentiseras korrekt. Anslutningsappen hanterar automatiskt:

OAuth 2.0-stöd: Allmän OAuth 2.0-autentisering konfigurerad på fliken Säkerhet i Copilot Studio
Ägartokenautentisering: Lägger automatiskt till Bearer prefix om det inte finns
Rubrikhantering: Hanterar auktoriseringshuvuden korrekt
Parametersanering: Tar bort autentiseringsparametrar innan de vidarebefordras till eGain-API:er
Felhantering: Korrekt hantering av autentiseringsfel

Åtgärder och användning

Åtgärd 1: Search-V3

Används av: eGain Connector Assistant (eGainSearch-ämne)

Syfte: Avancerad sökning med eGains V3-sök-API med förbättrad resultatbearbetning och automatisk källhänvisnings-URL-generering.

Konfiguration:

API-värd: api.ai.egain.cloud
Slutpunkt:/search/v3
Metod: POST

Exempelbegäran:

{
  "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-konfiguration:

$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

Exempelsvar:

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

Åtgärd 2: Kb-search

Används av: eGain Demo Agent (eGain Search-ämne)

Syfte: Artikelsökning i kunskapsbasen med förbättrad metadatabearbetning och automatisk URL-generering.

Konfiguration:

API-värd: api.egain.cloud
Slutpunkt:/search/kb
Metod: POST

Exempelbegäran:

{
  "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-konfiguration:

$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

Exempelsvar:

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

Åtgärd 3: Generative-V3

Används av: Båda agenterna (Generativt ämne)

Syfte: AI-baserad svarsgenerering med intelligent källhänvisningshantering, duplicerad identifiering och konfigurerbar filtrering.

Konfiguration:

eGain Demo Agent: api.egain.cloud
eGain Connector Assistant: api.ai.egain.cloud
Slutpunkt:/generative/v3
Metod: POST

Exempelbegäran:

{
  "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-konfiguration:

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

Exempelsvar:

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

Konfiguration och konfiguration av agent

Installation av eGain Demo Agent

Skapa anpassad anslutningsapp:
- Importera OpenAPI-definitionen
- Ange API-värd till api.egain.cloud
- Konfigurera autentisering med ägartoken
Konfigurera anpassade ämnen:
- eGain-sökämne: Mappa till Kb-search åtgärd
- Generativt ämne: Mappa till Generative-V3 åtgärd
Autentiseringskonfiguration:
- Hämta ägartoken från eGain Demo-instansen
- Konfigurera i autentiseringsinställningar för anslutningsprogram
- Testa anslutningen innan du distribuerar

Installation av eGain Connector Assistant

Skapa anpassad anslutningsapp:
- Importera OpenAPI-definitionen
- Ange API-värd till api.ai.egain.cloud
- Konfigurera autentisering med ägartoken
Konfigurera anpassade ämnen:
- eGainSearch-ämne: Mappa till Search-V3 åtgärd
- Generativt ämne: Mappa till Generative-V3 åtgärd
Autentiseringskonfiguration:
- Hämta ägartoken från eGain Connector Assistant-instansen
- Konfigurera i autentiseringsinställningar för anslutningsprogram
- Testa anslutningen innan du distribuerar

Metodtips för Copilot-agenter

1. Ämnesdesign

Rensa avsiktsigenkänning: Designa ämnen för att tydligt identifiera när varje åtgärd ska användas
Kontextmedvetenhet: Använd konversationskontext för att fastställa lämpliga sökparametrar
Återställningshantering: Implementera återställningssvar när inga resultat hittas

2. Svarsbearbetning

Källhänvisningsintegrering: Utnyttja den automatiska URL-genereringen för omfattande svar
Innehållsformatering: Använd det strukturerade svarsformatet för konsekvent presentation
Felhantering: Implementera korrekt felhantering för API-fel

3. Säkerhetsöverväganden

Tokenhantering: Implementera lagring och rotation av säker token
Åtkomstkontroll: Se till att det finns rätt åtkomstkontroller för olika användarroller
Granskningsloggning: Log API anropar för säkerhetsövervakning

4. Prestandaoptimering

Cachelagring: Implementera lämplig cachelagring för innehåll som används ofta
Hastighetsbegränsning: Respektera hastighetsbegränsningar för eGain API
Svarsfiltrering: Använd parametrarna minScore och maxReferences effektivt

Felsökning

Vanliga problem

Autentiseringsfel:

Kontrollera att ägartoken är giltig och inte har upphört att gälla
Kontrollera att API-värdkonfigurationen matchar den avsedda eGain-instansen
Se till att tokenformatet är korrekt i anslutningsinställningarna

Tomma resultat:

Kontrollera att sökfrågorna är tillräckligt specifika
Kontrollera om innehållet finns i kunskapsbasen
Granska minScore-inställningar för generativa svar

Problem med URL-generering:

Kontrollera att parametrarna baseUrl och shortName är korrekt konfigurerade
Kontrollera att eGain-instans-URL:er är tillgängliga
Sök efter specialtecken i artikelnamn

Felsökningssteg

Testa enskilda åtgärder: Använd Power Automate för att testa varje åtgärd separat
Kontrollera svarsformat: Kontrollera att svarsstrukturen matchar förväntat schema
Verifiera autentisering: Kontrollera att token är korrekt konfigurerade
Granska loggar: Kontrollera anslutningsappens körningsloggar för detaljerad felinformation

Avancerade funktioner

Dubblettidentifiering

Anslutningsappen tar automatiskt bort dubbla citat baserat på referens-ID och namnkombinationer, vilket säkerställer rena referenslistor i generativa svar.

Score-Based filtrering

Konfigurera tröskelvärden för lägsta poäng och maximalt antal referenser för att kontrollera svarskvalitet och svarslängd:

minScore: Filtrera bort citat med låg relevans (standard: 0,01)
maxReferences: Begränsa antalet referenser (standard: 10)

URL-anpassning

Stöd för anpassad URL-konstruktion med hjälp av parametrarna baseUrl och shortName:

baseUrl: Din eGain-instansbas-URL
shortName: URL-sökvägssegment för innehållsåtkomst

Support och underhåll

Regelbundet underhåll

Tokenrotation: Uppdatera regelbundet autentiseringstoken
API-övervakning: Övervaka API-användning och prestanda
Innehållsuppdateringar: Håll kunskapsbasinnehållet aktuellt

Supportresurser

eGain-dokumentation: Se eGains officiella API-dokumentation
Microsoft Copilot Studio: Använda Microsofts felsökningsguider för anslutningsprogram
Community-support: Utnyttja Microsoft Power Platform-communityresurser

Versionshistorik

v1.0.0: Första versionen med Search-V3, Kb-search och Generative-V3 åtgärder
Automatisk källhänvisning har lagts till och dubbletidentifiering har lagts till
Implementerad konfigurerbar poängfiltrering och referensgränser
Förbättrad säkerhet med korrekt autentiseringshantering

Den här dokumentationen är utformad för att hjälpa utvecklare och administratörer att effektivt implementera och underhålla Egain-anslutningsappen i Microsoft Copilot Studio-agenter.

Skapa en anslutning

Anslutningsappen stöder följande autentiseringstyper:


Standardinställning	Parametrar för att skapa anslutning.	Alla regioner	Går inte att dela

Standard

Tillämpligt: Alla regioner

Parametrar för att skapa anslutning.

Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.

Namn	Typ	Description	Krävs
eGain API-värd	snöre	Domän för eGain-API baserat på instanstyp	Sann

Begränsningsgränser

Name	Anrop	Förnyelseperiod
API-anrop per anslutning	100	60 sekunder

Åtgärder

Få bästa sökresultat för en användarfråga	Få bästa sökresultat för en användarfråga. Det är inte tillämpligt för version 21.x.x.x
Hämtar svar för ett visst omfång med datakällor och KB-portalen	Tjänsten hämtar en uppsättning svar för ett visst omfång. Ett omfång är en samling datakällor eller en eGain KB-portal med ett specifikt språk- och personanpassningsprofil-ID.
Returnerar KB-sökresultat för eGain R21	Det är bara tillgängligt för eGain-installation på version 21.x.x.x

Få bästa sökresultat för en användarfråga

Åtgärds-ID:: Search-V3

Få bästa sökresultat för en användarfråga. Det är inte tillämpligt för version 21.x.x.x

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Portal-ID	portalId	True	string	Portalidentifieraren
Språkkod	languageCode	True	string	Språkkod för sökningen
Query	q	True	string	Sökfrågesträng
Personanpassningsprofil-ID	personalizationProfileId		integer	Personanpassningsprofilidentifierare
Autentiseringstoken	authToken	True	string	Det skickas som auktoriseringshuvud
Bas-webbadress	baseUrl	True	string	Det här är bas-URL:en för km-portalen
Kort namn	shortName	True	string	Kort namn för KM-portalen
Godkänn	Accept		string	Acceptera rubrikvärde

Hämtar svar för ett visst omfång med datakällor och KB-portalen

Åtgärds-ID:: Generative-V3

Tjänsten hämtar en uppsättning svar för ett visst omfång. Ett omfång är en samling datakällor eller en eGain KB-portal med ett specifikt språk- och personanpassningsprofil-ID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Query	q	True	string	Fråga eller sökord
Avdelnings-ID	departmentId		integer	Avdelningsidentifierare
Användar-ID	userId		integer	Användaridentifierare
Portal-ID	portalId	True	integer	Resultaten hämtas från den angivna KM-portalen
Språkkod	languageCode	True	string	Språkkod för sökningen
Personanpassningsprofil-ID	personalizationProfileId		integer	Personanpassningsprofilidentifierare
Autentiseringstoken	authToken	True	string	Används för auktorisering till eGain-API
Bas-webbadress	baseUrl	True	string	Bas-URL för KM-portalen
Kort namn	shortName	True	string	Kort namn som används för KM-portalen
Godkänn	Accept		string	Acceptera rubrikvärde

Returnerar KB-sökresultat för eGain R21

Åtgärds-ID:: Kb-search

Det är bara tillgängligt för eGain-installation på version 21.x.x.x

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Portal-ID	portalId	True	string	Portalidentifieraren
Query	q	True	string	Sökfrågesträng
Language	$lang	True	string	Språkkod för sökningen
Attribute	$attribute		string	Attributfilter för sökresultat
Sidnummer	$pagenum		integer	Sidnummer för sidnumrering
Sidstorlek	$pagesize		integer	Antal resultat per sida
Autentiseringstoken	authToken	True	string	Autentiseringstoken för API-åtkomst
Bas-webbadress	baseUrl	True	string	Bas-URL för KM-portalen
Kort namn	shortName	True	string	Kort namn som används för KM-portalen
Acceptera språk	Accept-language	True	string	Accept-Language rubrikvärde
Godkänn	Accept	True	string	Acceptera rubrikvärde

Dela via

Egain (förhandsversion)

Egain – Användningsguide för Copilot-agent

Översikt

Förutsättningar

Agentkonfigurationer

1. eGain Demo Agent

2. eGain Connector Assistant

Säkerhet och autentisering

Åtgärder och användning

Åtgärd 1: Search-V3

Åtgärd 2: Kb-search

Åtgärd 3: Generative-V3

Konfiguration och konfiguration av agent

Installation av eGain Demo Agent

Installation av eGain Connector Assistant

Metodtips för Copilot-agenter

1. Ämnesdesign

2. Svarsbearbetning

3. Säkerhetsöverväganden

4. Prestandaoptimering

Felsökning

Vanliga problem

Felsökningssteg

Avancerade funktioner

Dubblettidentifiering

Score-Based filtrering

URL-anpassning

Support och underhåll

Regelbundet underhåll

Supportresurser

Versionshistorik

Skapa en anslutning

Standard

Begränsningsgränser

Åtgärder

Få bästa sökresultat för en användarfråga

Parametrar

Hämtar svar för ett visst omfång med datakällor och KB-portalen

Parametrar

Returnerar KB-sökresultat för eGain R21

Parametrar