Egain (Vorschau)

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung	Class	Regions
Copilot Studio	Premium	Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:      - US Government (GCC)      - US Government (GCC High)      - China Cloud betrieben von 21Vianet      - US Department of Defense (DoD)
Logik-Apps	Norm	Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:      – Azure Government-Regionen      - Azure China-Regionen      - US Department of Defense (DoD)
Power Apps	Premium	Alle Power Apps-Regionen mit Ausnahme der folgenden:      - US Government (GCC)      - US Government (GCC High)      - China Cloud betrieben von 21Vianet      - US Department of Defense (DoD)
Power Automate	Premium	Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:      - US Government (GCC)      - US Government (GCC High)      - China Cloud betrieben von 21Vianet      - US Department of Defense (DoD)

Kontakt
Name	eGain Support
Email	support@egain.com

Connectormetadaten
Herausgeber	eGain Corporation
Webseite	http://egain.com/
Datenschutzrichtlinie	https://www.egain.com/privacy-policies
Kategorien	Künstliche Intelligenz; Finanzieren
Quelle	Marktplatz
BrandColor	#FEF0FD

Egain - Copilot Agent Usage Guide

Überblick

Der Egain-Connector wurde entwickelt, um nahtlos in Microsoft Copilot Studio-Agents integriert zu werden und bietet leistungsstarke Wissensverwaltungsfunktionen über zwei unterschiedliche eGain-Instanzen. Dieser Connector ermöglicht Es Agents, Wissensdatenbanken zu durchsuchen, KI-gestützte Antworten zu generieren und präzise Zitate mit automatischer URL-Generierung bereitzustellen.

Voraussetzungen

Stellen Sie vor der Verwendung des Egain-Connectors sicher, dass Sie die folgenden Voraussetzungen erfüllt haben:

1. eGain Instance Requirements: You need to have an eGain instance running on Rigel or R21.x.x version or higher.

2. Clientanwendungskonfiguration: Eine Clientanwendung muss in Ihrer eGain-Instanz mit den entsprechenden Berechtigungen für die aktionen erstellt werden, die Sie verwenden möchten. Die Clientanwendung sollte folgendes haben:

   • Portalberechtigungen für Knowledge Base-Suchvorgänge
   • KI-Berechtigungen für generative KI-Vorgänge

   Ausführliche Informationen zum Erstellen und Konfigurieren von Clientanwendungen finden Sie in der Dokumentation zur eGain-Clientanwendung.

3. Knowledge Portal Setup: Ein Wissensportal muss in Ihrer eGain-Instanz vorkonfiguriert werden, um die Inhaltssuche und den Abruf zu ermöglichen. Das Portal dient als Grundlage für Knowledge Base-Operationen und Content Management.

   Informationen zum Einrichten von Wissensportalen finden Sie in der Dokumentation zu eGain Portals.

Agentkonfigurationen

1. eGain Demo Agent

• API-Host: api.egain.cloud
• Instanz-URL: https://egainr21demo.egain.cloud
• Authentifizierung: Sicherheit mit Bearertokenauthentifizierung aktiviert
• Benutzerdefinierte Themen:
  • eGain Search: Verwendet Kb-search Den Vorgang
  • Generativ: Verwendet Generative-V3 den Vorgang

2. eGain Connector Assistant

• API-Host: api.ai.egain.cloud
• Instanz-URL: https://ai.egain.cloud/s5fa
• Authentifizierung: Sicherheit mit Bearertokenauthentifizierung aktiviert
• Benutzerdefinierte Themen:
  • Generativ: Verwendet Generative-V3 den Vorgang
  • eGainSearch: Verwendet Search-V3 den Vorgang

Sicherheit und Authentifizierung

Wichtig: Der Egain-Connector selbst erfordert keine Authentifizierungskonfiguration. Die eGain-APIs sind jedoch gesichert und unterstützen die generische OAuth 2.0-Authentifizierung, die auf der Registerkarte "Sicherheit" Ihrer Copilot Studio-Agents konfiguriert ist.

Beide eGain-Instanzen verfügen über eine aktivierte Sicherheit, um sicherzustellen, dass alle API-Aufrufe ordnungsgemäß authentifiziert sind. Der Verbinder übernimmt automatisch Folgendes:

• OAuth 2.0-Unterstützung: Generische OAuth 2.0-Authentifizierung, die auf der Registerkarte "Sicherheit" von Copilot Studio konfiguriert ist
• Bearertokenauthentifizierung: Fügt automatisch präfix hinzu Bearer , wenn sie nicht vorhanden ist.
• Headerverwaltung: Ordnungsgemäß verwaltet Autorisierungsheader
• Parameterbereinigung: Entfernt Authentifizierungsparameter vor der Weiterleitung an eGain-APIs
• Fehlerbehandlung: Ordnungsgemäße Behandlung von Authentifizierungsfehlern

Vorgänge und Nutzung

Vorgang 1: Search-V3

Verwendet von: eGain Connector Assistant (eGainSearch-Thema)

Zweck: Erweiterte Suche mithilfe der V3-Such-API von eGain mit erweiterter Ergebnisverarbeitung und automatischer Generierung von Zitat-URL.

Konfiguration:

• API-Host: api.ai.egain.cloud
• Endpunkt:/search/v3
• Methode: POST

Beispielanforderung:

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

Beispielantwort:

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

Vorgang 2: Kb-Suche

Verwendet von: eGain Demo Agent (eGain Search Topic)

Zweck: Suche nach Knowledge Base-Artikeln mit erweiterter Metadatenverarbeitung und automatischer URL-Generierung.

Konfiguration:

• API-Host: api.egain.cloud
• Endpunkt:/search/kb
• Methode: POST

Beispielanforderung:

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

Beispielantwort:

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

Vorgang 3: Generative-V3

Verwendet von: Beide Agents (generatives Thema)

Zweck: KI-gestützte Reaktionsgenerierung mit intelligenter Zitatverwaltung, Duplikaterkennung und konfigurierbarer Filterung.

Konfiguration:

• eGain Demo Agent: api.egain.cloud
• eGain Connector Assistant: api.ai.egain.cloud
• Endpunkt:/generative/v3
• Methode: POST

Beispielanforderung:

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

Beispielantwort:

{
  "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-Setup und -Konfiguration

eGain Demo Agent Setup

1. Benutzerdefinierten Connector erstellen:

   • OpenAPI-Definition importieren
   • Festlegen des API-Hosts auf api.egain.cloud
   • Konfigurieren der Authentifizierung mit Bearer-Token

2. Konfigurieren von benutzerdefinierten Themen:

   • eGain-Suchthema: Zuordnung zum Kb-search Vorgang
   • Generatives Thema: Zuordnung zum Generative-V3 Vorgang

3. Authentifizierungseinrichtung:

   • Abrufen des Bearertokens aus der eGain Demo-Instanz
   • Konfigurieren in Connectorauthentifizierungseinstellungen
   • Testen der Verbindung vor der Bereitstellung

eGain Connector Assistant Setup

1. Benutzerdefinierten Connector erstellen:

   • OpenAPI-Definition importieren
   • Festlegen des API-Hosts auf api.ai.egain.cloud
   • Konfigurieren der Authentifizierung mit Bearer-Token

2. Konfigurieren von benutzerdefinierten Themen:

   • eGainSearch-Thema: Vorgang zuordnen Search-V3
   • Generatives Thema: Zuordnung zum Generative-V3 Vorgang

3. Authentifizierungseinrichtung:

   • Abrufen des Bearertokens von der eGain Connector Assistant-Instanz
   • Konfigurieren in Connectorauthentifizierungseinstellungen
   • Testen der Verbindung vor der Bereitstellung

Bewährte Methoden für Copilot-Agents

1. Themenentwurf

• Clear Intent Recognition: Design topics to clear identify when to use each operation
• Kontextbewusstsein: Verwenden des Unterhaltungskontexts, um geeignete Suchparameter zu ermitteln
• Fallbackbehandlung: Implementieren von Fallbackantworten, wenn keine Ergebnisse gefunden werden

2. Antwortverarbeitung

• Zitatintegration: Nutzen der automatischen URL-Generierung für umfangreiche Antworten
• Inhaltsformatierung: Verwenden des strukturierten Antwortformats für eine konsistente Präsentation
• Fehlerbehandlung: Implementieren der ordnungsgemäßen Fehlerbehandlung für API-Fehler

3. Sicherheitsaspekte

• Tokenverwaltung: Implementieren von sicherem Tokenspeicher und -drehung
• Zugriffssteuerung: Sicherstellen der ordnungsgemäßen Zugriffssteuerung für unterschiedliche Benutzerrollen
• Überwachungsprotokollierung: Protokoll-API-Aufrufe für die Sicherheitsüberwachung

4. Leistungsoptimierung

• Zwischenspeichern: Implementieren einer geeigneten Zwischenspeicherung für häufig aufgerufene Inhalte
• Rate Limiting: Respektieren von eGain-API-Ratenlimits
• Antwortfilterung: Verwenden sie die Parameter "minScore" und "maxReferences" effektiv.

Problembehandlung

Häufige Probleme

Authentifizierungsfehler:

• Überprüfen, ob bearertoken gültig und nicht abgelaufen ist
• Überprüfen der API-Hostkonfiguration mit der beabsichtigten eGain-Instanz
• Sicherstellen des richtigen Tokenformats in den Connectoreinstellungen

Leere Ergebnisse:

• Überprüfen, ob Suchabfragen spezifisch genug sind
• Überprüfen, ob Inhalte in der Wissensdatenbank vorhanden sind
• Überprüfen der minScore-Einstellungen für generative Antworten

Probleme bei der URL-Generierung:

• Stellen Sie sicher, dass baseUrl- und shortName-Parameter korrekt konfiguriert sind.
• Überprüfen, ob auf eGain-Instanz-URLs zugegriffen werden kann
• Suchen nach Sonderzeichen in Artikelnamen

Debuggingschritte

1. Testen einzelner Vorgänge: Verwenden von Power Automate, um jeden Vorgang separat zu testen
2. Antwortformat überprüfen: Überprüfen, ob die Antwortstruktur mit dem erwarteten Schema übereinstimmt
3. Überprüfen der Authentifizierung: Sicherstellen, dass Token ordnungsgemäß konfiguriert sind
4. Überprüfungsprotokolle: Überprüfen der Ausführungsprotokolle des Connectors auf detaillierte Fehlerinformationen

Erweiterte Funktionen

Duplikaterkennung

Der Connector entfernt automatisch doppelte Zitate basierend auf Bezugs-ID- und Namenskombinationen, wodurch saubere Referenzlisten in generativen Antworten sichergestellt werden.

Score-Based Filterung

Konfigurieren Sie Mindestbewertungsschwellenwerte und maximale Referenzanzahlen, um die Antwortqualität und -länge zu steuern:

• minScore: Herausfiltern von Zitaten mit niedriger Relevanz (Standard: 0.01)
• maxReferences: Maximale Anzahl von Verweisen (Standard: 10)

URL-Anpassung

Unterstützung für die benutzerdefinierte URL-Konstruktion mit baseUrl- und ShortName-Parametern:

• baseUrl: Ihre eGain-Instanz-Basis-URL
• shortName: URL-Pfadsegment für den Inhaltszugriff

Support und Wartung

Regelmäßige Wartung

• Tokenrotation: Authentifizierungstoken werden regelmäßig aktualisiert
• API-Überwachung: Überwachen der API-Nutzung und -Leistung
• Inhaltsupdates: Aktualisieren von Knowledge Base-Inhalten auf dem aktuellen Stand

Supportressourcen

• eGain-Dokumentation: Weitere Informationen finden Sie in der offiziellen API-Dokumentation von eGain
• Microsoft Copilot Studio: Verwenden der Microsoft Connector-Anleitungen zur Problembehandlung
• Communitysupport: Nutzen von Microsoft Power Platform-Communityressourcen

Versionsverlauf

• v1.0.0: Erste Version mit Search-V3-, Kb-Search- und Generative-V3-Vorgängen
• Automatische Zitatverknüpfung und Duplikaterkennung hinzugefügt
• Implementierte konfigurierbare Bewertungsfilterungs- und Referenzgrenzwerte
• Verbesserte Sicherheit mit ordnungsgemäßer Authentifizierungsbehandlung

---

Diese Dokumentation soll Entwicklern und Administratoren helfen, den Egain-Connector in Microsoft Copilot Studio-Agents effektiv zu implementieren und zu verwalten.

Eine Verbindung wird erstellt

Der Connector unterstützt die folgenden Authentifizierungstypen:

Vorgabe	Parameter zum Erstellen einer Verbindung.	Alle Regionen	Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name	Typ	Description	Erforderlich
eGain-API-Host	Schnur	Domäne der eGain-API basierend auf dem Instanztyp	Richtig

Drosselungsgrenzwerte

Name	Aufrufe	Verlängerungszeitraum
API-Aufrufe pro Verbindung	100	60 Sekunden

Aktionen

Abrufen der besten Suchergebnisse für eine Benutzerabfrage	Rufen Sie die besten Suchergebnisse für eine Benutzerabfrage ab. Es gilt nicht für Version 21.x.x.x.x.
Gibt das KB-Suchergebnis für eGain R21 zurück.	Es ist nur für die eGain-Installation auf Version 21.x.x.x.x verfügbar.
Ruft Antworten für einen bestimmten Bereich mit Datenquellen und KB-Portal ab.	Der Dienst ruft eine Reihe von Antworten für einen bestimmten Bereich ab. Ein Bereich ist eine Sammlung von Datenquellen oder ein eGain KB-Portal mit einer bestimmten Sprach- und Personalisierungsprofil-ID.

Abrufen der besten Suchergebnisse für eine Benutzerabfrage

Gibt das KB-Suchergebnis für eGain R21 zurück.

Ruft Antworten für einen bestimmten Bereich mit Datenquellen und KB-Portal ab.