Egain (preview)

Met deze connector kan Copilot de eGain V3-API veilig aanroepen, waardoor naadloze integratie mogelijk is voor klantbetrokkenheidsgegevens. Het biedt ondersteuning voor verificatie, het ophalen van gegevens en het uitvoeren van acties, het vereenvoudigen van werkstromen en het verbeteren van realtime inzichten in eGain-services.

Deze connector is beschikbaar in de volgende producten en regio's:

Dienst	Class	Regions
Copilot Studio	Premium	Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD)
Logic Apps-	Standaard	Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD)
Power Apps	Premium	Alle Power Apps-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD)
Power Automate	Premium	Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD)

Contactpersoon
Naam	Ondersteuning voor eGain
E-mailen	support@egain.com

Connector-metagegevens
Uitgever	eGain Corporation
Webpagina	http://egain.com/
Privacybeleid	https://www.egain.com/privacy-policies
Categorieën	AI; Financieren
Bron	marktplaats
BrandColor	#FEF0FD

Egain - Gebruikshandleiding voor Copilot-agent

Overzicht

De Egain-connector is ontworpen om naadloos te integreren met Microsoft Copilot Studio-agents en biedt krachtige mogelijkheden voor kennisbeheer via twee afzonderlijke eGain-exemplaren. Met deze connector kunnen agents zoeken in knowledge bases, AI-antwoorden genereren en nauwkeurige bronvermeldingen genereren met automatische URL-generatie.

Vereiste voorwaarden

Zorg ervoor dat u aan de volgende vereisten voldoet voordat u de Egain-connector gebruikt:

Vereisten voor eGain-exemplaren: u moet een eGain-exemplaar hebben dat wordt uitgevoerd op Rigel- of R21.x.x-versie of hoger.
Clienttoepassingsconfiguratie: er moet een clienttoepassing worden gemaakt in uw eGain-exemplaar met de juiste machtigingen voor de acties die u wilt gebruiken. De clienttoepassing moet het volgende hebben:
- Portalmachtigingen voor zoekbewerkingen in knowledge base
- AI-machtigingen voor generatieve AI-bewerkingen
Raadpleeg de documentatie van de eGain-clienttoepassing voor gedetailleerde informatie over het maken en configureren van clienttoepassingen.
Installatie van knowledge portal: een kennisportal moet vooraf zijn geconfigureerd in uw eGain-exemplaar om inhoud zoeken en ophalen in te schakelen. De portal fungeert als de basis voor knowledge base-bewerkingen en inhoudsbeheer.

Raadpleeg de documentatie voor eGain Portals voor informatie over het instellen van kennisportals.

Agentconfiguraties

1. eGain Demo Agent

API-host: api.egain.cloud
Exemplaar-URL: https://egainr21demo.egain.cloud
Verificatie: Beveiliging ingeschakeld met Bearer-tokenverificatie
Aangepaste onderwerpen:
- eGain Search: Gebruikt Kb-search bewerking
- Generatieve: gebruikt Generative-V3 bewerking

2. eGain Connector Assistant

API-host: api.ai.egain.cloud
Exemplaar-URL: https://ai.egain.cloud/s5fa
Verificatie: Beveiliging ingeschakeld met Bearer-tokenverificatie
Aangepaste onderwerpen:
- Generatieve: gebruikt Generative-V3 bewerking
- eGainSearch: bewerking gebruikt Search-V3

Beveiliging en verificatie

Belangrijk: De Egain-connector zelf vereist geen verificatieconfiguratie. De eGain-API's zijn echter beveiligd en ondersteunen algemene OAuth 2.0-verificatie, die is geconfigureerd op het tabblad Beveiliging van uw Copilot Studio-agents.

Beide eGain-exemplaren hebben beveiliging ingeschakeld, zodat alle API-aanroepen correct worden geverifieerd. De connector verwerkt het volgende automatisch:

Ondersteuning voor OAuth 2.0: Algemene OAuth 2.0-verificatie geconfigureerd op het tabblad Copilot Studio Security
Bearer-tokenverificatie: automatisch voorvoegsel toevoegen Bearer als dit niet aanwezig is
Headerbeheer: Autorisatieheaders op de juiste manier beheren
Parameter opschonen: hiermee verwijdert u verificatieparameters voordat u doorstuurt naar eGain-API's
Foutafhandeling: Probleemloze verwerking van verificatiefouten

Bewerkingen en gebruik

Bewerking 1: Search-V3

Gebruikt door: eGain Connector Assistant (eGainSearch-onderwerp)

Doel: Geavanceerd zoeken met behulp van de V3-zoek-API van eGain met verbeterde verwerking van resultaten en het automatisch genereren van bronvermeldings-URL's.

Configuratie:

API-host: api.ai.egain.cloud
Eindpunt:/search/v3
methode: POST

Voorbeeldaanvraag:

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

$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

Voorbeeldantwoord:

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

Bewerking 2: Kb-search

Gebruikt door: eGain Demo Agent (eGain Search-onderwerp)

Doel: Zoeken in Knowledge Base-artikelen met verbeterde verwerking van metagegevens en het automatisch genereren van URL's.

Configuratie:

API-host: api.egain.cloud
Eindpunt:/search/kb
methode: POST

Voorbeeldaanvraag:

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

$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

Voorbeeldantwoord:

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

Bewerking 3: Generative-V3

Gebruikt door: Beide agents (Generatief onderwerp)

Doel: door AI aangedreven responsgeneratie met intelligent bronvermeldingsbeheer, dubbele detectie en configureerbare filtering.

Configuratie:

eGain Demo Agent: api.egain.cloud
eGain Connector Assistant: api.ai.egain.cloud
Eindpunt:/generative/v3
methode: POST

Voorbeeldaanvraag:

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

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

Voorbeeldantwoord:

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

Agent instellen en configureren

eGain Demo Agent instellen

Aangepaste connector maken:
- De OpenAPI-definitie importeren
- API-host instellen op api.egain.cloud
- Verificatie configureren met Bearer-token
Aangepaste onderwerpen configureren:
- eGain-zoekonderwerp: toewijzen aan Kb-search bewerking
- Generatief onderwerp: toewijzen aan Generative-V3 bewerking
Verificatie-instelling:
- Bearer-token verkrijgen van eGain Demo-exemplaar
- Configureren in connectorverificatie-instellingen
- Verbinding testen voordat u implementeert

Configuratie van eGain Connector Assistant

Aangepaste connector maken:
- De OpenAPI-definitie importeren
- API-host instellen op api.ai.egain.cloud
- Verificatie configureren met Bearer-token
Aangepaste onderwerpen configureren:
- eGainSearch-onderwerp: Toewijzen aan Search-V3 bewerking
- Generatief onderwerp: toewijzen aan Generative-V3 bewerking
Verificatie-instelling:
- Bearer-token verkrijgen van het eGain Connector Assistant-exemplaar
- Configureren in connectorverificatie-instellingen
- Verbinding testen voordat u implementeert

Aanbevolen procedures voor Copilot-agents

1. Onderwerpontwerp

Intentieherkenning wissen: ontwerponderwerpen om duidelijk te bepalen wanneer elke bewerking moet worden gebruikt
Contextbewustzijn: gesprekscontext gebruiken om de juiste zoekparameters te bepalen
Terugvalafhandeling: terugvalreacties implementeren wanneer er geen resultaten worden gevonden

2. Reactieverwerking

Bronvermeldingsintegratie: gebruik de automatische URL-generatie voor uitgebreide antwoorden
Inhoudsopmaak: de gestructureerde antwoordindeling gebruiken voor een consistente presentatie
Foutafhandeling: Foutafhandeling implementeren voor foutafhandeling voor API-fouten

3. Beveiligingsoverwegingen

Tokenbeheer: veilige tokenopslag en -rotatie implementeren
Toegangsbeheer: zorg voor de juiste toegangsbeheer voor verschillende gebruikersrollen
Auditlogboekregistratie: API-aanroepen voor logboekregistratie voor beveiligingsbewaking

4. Optimalisatie van prestaties

Caching: de juiste caching implementeren voor veelgebruikte inhoud
Snelheidsbeperking: Respecteer frequentielimieten voor eGain-API
Antwoordfiltering: minScore en maxReferences-parameters effectief gebruiken

Probleemoplossingsproces

Veelvoorkomende problemen

Verificatiefouten:

Controleer of het Bearer-token geldig is en niet is verlopen
Controleer of de CONFIGURATIE van de API-host overeenkomt met het beoogde eGain-exemplaar
De juiste tokenindeling in connectorinstellingen garanderen

Lege resultaten:

Controleren of zoekquery's specifiek genoeg zijn
Controleren of er inhoud bestaat in de Knowledge Base
MinScore-instellingen voor generatieve reacties controleren

Problemen met het genereren van URL's:

Zorg ervoor dat de parameters baseUrl en shortName correct zijn geconfigureerd
Controleren of URL's van eGain-exemplaren toegankelijk zijn
Controleren op speciale tekens in artikelnamen

Stappen voor foutopsporing

Afzonderlijke bewerkingen testen: Power Automate gebruiken om elke bewerking afzonderlijk te testen
Antwoordindeling controleren: controleren of de antwoordstructuur overeenkomt met het verwachte schema
Verificatie valideren: zorg ervoor dat tokens correct zijn geconfigureerd
Logboeken controleren: De uitvoeringslogboeken van de connector controleren op gedetailleerde foutinformatie

Geavanceerde functies

Dubbele detectie

De connector verwijdert automatisch dubbele bronvermeldingen op basis van referentie-id's en naamcombinaties, waardoor schone referentielijsten in generatieve reacties worden gegarandeerd.

Score-Based filteren

Configureer minimumscoredrempels en maximale referentieaantallen om de kwaliteit en lengte van de respons te bepalen:

minScore: Bronvermeldingen met lage relevantie filteren (standaard: 0,01)
maxReferences: Het aantal verwijzingen beperken (standaard: 10)

URL-aanpassing

Ondersteuning voor aangepaste URL-constructie met behulp van baseUrl- en shortName-parameters:

baseUrl: basis-URL van uw eGain-exemplaar
shortName: URL-padsegment voor toegang tot inhoud

Ondersteuning en onderhoud

Regelmatig onderhoud

Tokenrotatie: verificatietokens regelmatig bijwerken
API-bewaking: API-gebruik en -prestaties bewaken
Inhoudsupdates: Inhoud van knowledge base actueel houden

Ondersteuningsbronnen

eGain-documentatie: Raadpleeg de officiële API-documentatie van eGain
Microsoft Copilot Studio: de handleidingen voor het oplossen van problemen met microsoft-connectors gebruiken
Communityondersteuning: gebruikmaken van communitybronnen van Microsoft Power Platform

Versiegeschiedenis

v1.0.0: Eerste release met Search-V3, Kb-search en Generative-V3 bewerkingen
Automatische bronvermeldingskoppeling en dubbele detectie toegevoegd
Configureerbare scorefilters en referentielimieten geïmplementeerd
Verbeterde beveiliging met de juiste verificatieafhandeling

Deze documentatie is ontworpen om ontwikkelaars en beheerders te helpen de Egain-connector effectief te implementeren en te onderhouden in Microsoft Copilot Studio-agents.

Een verbinding maken

De connector ondersteunt de volgende verificatietypen:


standaard	Parameters voor het maken van verbinding.	Alle regio's	Niet deelbaar

Verstek

Van toepassing: Alle regio's

Parameters voor het maken van verbinding.

Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.

Naam	Typologie	Description	Verplicht
eGain-API-host	touw	Domein van eGain-API op basis van exemplaartype	Klopt

Beperkingslimieten

Name	Aanroepen	Verlengingsperiode
API-aanroepen per verbinding	100	60 seconden

Acties

De beste zoekresultaten voor een gebruikersquery ophalen	Haal de beste zoekresultaten op voor een gebruikersquery. Het is niet van toepassing op release 21.x.x.x
Hiermee worden antwoorden opgehaald voor een bepaald bereik met gegevensbronnen en KB-portal	De service haalt een set antwoorden voor een bepaald bereik op. Een bereik is een verzameling gegevensbronnen of een eGain KB-portal met een specifieke taal- en persoonlijke profiel-id.
Hiermee wordt KB-zoekresultaat voor eGain R21 geretourneerd	Het is alleen beschikbaar voor eGain-installatie op release 21.x.x.x.x

De beste zoekresultaten voor een gebruikersquery ophalen

Bewerkings-id:: Search-V3

Haal de beste zoekresultaten op voor een gebruikersquery. Het is niet van toepassing op release 21.x.x.x

Parameters

Name	Sleutel	Vereist	Type	Description
Portal-id	portalId	True	string	De portal-id
Taalcode	languageCode	True	string	Taalcode voor de zoekopdracht
Query	q	True	string	Zoekquerytekenreeks
Persoonlijke profiel-id	personalizationProfileId		integer	Personalisatieprofiel-id
Verificatietoken	authToken	True	string	Het wordt doorgegeven als autorisatieheader
Basis-URL	baseUrl	True	string	Dit is de basis-URL voor km-portal
Korte naam	shortName	True	string	Korte naam voor de KM-portal
Accepteren	Accept		string	Koptekstwaarde accepteren

Hiermee worden antwoorden opgehaald voor een bepaald bereik met gegevensbronnen en KB-portal

Bewerkings-id:: Generative-V3

De service haalt een set antwoorden voor een bepaald bereik op. Een bereik is een verzameling gegevensbronnen of een eGain KB-portal met een specifieke taal- en persoonlijke profiel-id.

Parameters

Name	Sleutel	Vereist	Type	Description
Query	q	True	string	Vraag of zoekterm
Afdelings-id	departmentId		integer	Afdelings-id
Gebruikers-ID	userId		integer	Gebruikers-id
Portal-id	portalId	True	integer	Resultaten worden opgehaald uit de opgegeven KM-portal
Taalcode	languageCode	True	string	Taalcode voor de zoekopdracht
Persoonlijke profiel-id	personalizationProfileId		integer	Personalisatieprofiel-id
Verificatietoken	authToken	True	string	Wordt gebruikt voor autorisatie voor eGain-API
Basis-URL	baseUrl	True	string	Basis-URL voor KM-portal
Korte naam	shortName	True	string	Korte naam die wordt gebruikt voor km-portal
Accepteren	Accept		string	Koptekstwaarde accepteren

Hiermee wordt KB-zoekresultaat voor eGain R21 geretourneerd

Bewerkings-id:: Kb-search

Het is alleen beschikbaar voor eGain-installatie op release 21.x.x.x.x

Parameters

Name	Sleutel	Vereist	Type	Description
Portal-id	portalId	True	string	De portal-id
Query	q	True	string	Zoekquerytekenreeks
Language	$lang	True	string	Taalcode voor de zoekopdracht
Attribute	$attribute		string	Kenmerkfilter voor zoekresultaten
Paginanummer	$pagenum		integer	Paginanummer voor paginering
Paginaformaat	$pagesize		integer	Aantal resultaten per pagina
Verificatietoken	authToken	True	string	Verificatietoken voor API-toegang
Basis-URL	baseUrl	True	string	Basis-URL voor KM-portal
Korte naam	shortName	True	string	Korte naam die wordt gebruikt voor km-portal
Taal accepteren	Accept-language	True	string	Accept-Language koptekstwaarde
Accepteren	Accept	True	string	Koptekstwaarde accepteren

Delen via

Egain (preview)

Egain - Gebruikshandleiding voor Copilot-agent

Overzicht

Vereiste voorwaarden

Agentconfiguraties

1. eGain Demo Agent

2. eGain Connector Assistant

Beveiliging en verificatie

Bewerkingen en gebruik

Bewerking 1: Search-V3

Bewerking 2: Kb-search

Bewerking 3: Generative-V3

Agent instellen en configureren

eGain Demo Agent instellen

Configuratie van eGain Connector Assistant

Aanbevolen procedures voor Copilot-agents

1. Onderwerpontwerp

2. Reactieverwerking

3. Beveiligingsoverwegingen

4. Optimalisatie van prestaties

Probleemoplossingsproces

Veelvoorkomende problemen

Stappen voor foutopsporing

Geavanceerde functies

Dubbele detectie

Score-Based filteren

URL-aanpassing

Ondersteuning en onderhoud

Regelmatig onderhoud

Ondersteuningsbronnen

Versiegeschiedenis

Een verbinding maken

Verstek

Beperkingslimieten

Acties

De beste zoekresultaten voor een gebruikersquery ophalen

Parameters

Hiermee worden antwoorden opgehaald voor een bepaald bereik met gegevensbronnen en KB-portal

Parameters

Hiermee wordt KB-zoekresultaat voor eGain R21 geretourneerd

Parameters