Egain (préversion)

Ce connecteur permet à Copilot d’appeler en toute sécurité l’API eGain V3, fournissant une intégration transparente pour les données d’engagement client. Il prend en charge l’authentification, la récupération des données et l’exécution d’actions, ce qui simplifie les flux de travail et améliore les insights en temps réel dans les services eGain.

Ce connecteur est disponible dans les produits et régions suivants :

Service	classe	Régions
Copilot Studio	Premium	Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD)
Applications logiques	Norme	Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD)
Power Apps	Premium	Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD)
Power Automate	Premium	Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD)

Contact
Nom	Prise en charge eGain
Messagerie électronique	support@egain.com

Métadonnées du connecteur
Éditeur	eGain Corporation
Website	http://egain.com/
Politique de confidentialité	https://www.egain.com/privacy-policies
Catégories	IA; Finance
Origine	Place de marché
BrandColor	#FEF0FD

Egain - Guide d’utilisation de l’agent Copilot

Aperçu

Le connecteur Egain est conçu pour s’intégrer en toute transparence à des agents Microsoft Copilot Studio, offrant de puissantes fonctionnalités de gestion des connaissances par le biais de deux instances eGain distinctes. Ce connecteur permet aux agents de rechercher dans des bases de connaissances, de générer des réponses basées sur l’IA et de fournir des citations précises avec la génération automatique d’URL.

Prerequisites

Avant d’utiliser le connecteur Egain, vérifiez que vous disposez des conditions préalables suivantes :

Configuration requise pour l’instance eGain : vous devez disposer d’une instance eGain s’exécutant sur Rigel ou R21.x.x version ou ultérieure.
Configuration de l’application cliente : une application cliente doit être créée dans votre instance eGain avec les autorisations appropriées pour les actions que vous envisagez d’utiliser. L’application cliente doit avoir :
- Autorisations du portail pour les opérations de recherche de base de connaissances
- Autorisations d’IA pour les opérations d’IA génératives
Pour plus d’informations sur la création et la configuration d’applications clientes, reportez-vous à la documentation relative à l’application cliente eGain.
Configuration du portail de connaissances : un portail de connaissances doit être préconfiguré dans votre instance eGain pour activer la recherche et la récupération de contenu. Le portail sert de base pour les opérations de base de connaissances et la gestion du contenu.

Pour plus d’informations sur la configuration des portails de connaissances, reportez-vous à la documentation eGain Portals.

Configurations de l’agent

1. Agent de démonstration eGain

Hôte d’API : api.egain.cloud
URL de l’instance : https://egainr21demo.egain.cloud
Authentification : Sécurité activée avec l’authentification par jeton du porteur
Rubriques personnalisées :
- Recherche eGain : utilise l’opération Kb-search
- Générative : utilise l’opération Generative-V3

2. Assistant Connecteur eGain

Hôte d’API : api.ai.egain.cloud
URL de l’instance : https://ai.egain.cloud/s5fa
Authentification : Sécurité activée avec l’authentification par jeton du porteur
Rubriques personnalisées :
- Générative : utilise l’opération Generative-V3
- eGainSearch : Utilise l’opération Search-V3

Sécurité et authentification

Important : le connecteur Egain lui-même ne nécessite aucune configuration d’authentification. Toutefois, les API eGain sont sécurisées et prennent en charge l’authentification OAuth 2.0 générique, qui est configurée dans l’onglet Sécurité de vos agents Copilot Studio.

Les deux instances eGain ont la sécurité activée, ce qui garantit que tous les appels d’API sont correctement authentifiés. Le connecteur gère automatiquement :

Prise en charge d’OAuth 2.0 : Authentification OAuth 2.0 générique configurée dans l’onglet Sécurité de Copilot Studio
Authentification par jeton du porteur : ajoute Bearer automatiquement le préfixe s’il n’est pas présent
Gestion des en-têtes : gère correctement les en-têtes d’autorisation
Nettoyage des paramètres : supprime les paramètres d’authentification avant de transférer vers les API eGain
Gestion des erreurs : gestion normale des échecs d’authentification

Opérations et utilisation

Opération 1 : Search-V3

Utilisé par : Assistant connecteur eGain (rubrique eGainSearch)

Objectif : recherche avancée à l’aide de l’API de recherche V3 d’eGain avec traitement amélioré des résultats et génération automatique d’URL de citation.

Configuration :

Hôte d’API : api.ai.egain.cloud
Point de terminaison :/search/v3
Méthode : POST

Exemple de requête :

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

Configuration de Copilot Studio :

$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

Exemple de réponse :

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

Opération 2 : Kb-search

Utilisé par : agent de démonstration eGain (rubrique recherche eGain)

Objectif : recherche d’articles de la base de connaissances avec traitement amélioré des métadonnées et génération automatique d’URL.

Configuration :

Hôte d’API : api.egain.cloud
Point de terminaison :/search/kb
Méthode : POST

Exemple de requête :

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

Configuration de Copilot Studio :

$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

Exemple de réponse :

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

Opération 3 : Generative-V3

Utilisé par : Les deux agents (rubrique Générative)

Objectif : génération de réponse optimisée par l’IA avec gestion intelligente des citations, détection en double et filtrage configurable.

Configuration :

Agent de démonstration eGain : api.egain.cloud
Assistant Connecteur eGain : api.ai.egain.cloud
Point de terminaison :/generative/v3
Méthode : POST

Exemple de requête :

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

Configuration de Copilot Studio :

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

Exemple de réponse :

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

Configuration et configuration de l’agent

Configuration de l’agent de démonstration eGain

Créer un connecteur personnalisé :
- Importer la définition OpenAPI
- Définir l’hôte d’API sur api.egain.cloud
- Configurer l’authentification avec le jeton du porteur
Configurer des rubriques personnalisées :
- Rubrique de recherche eGain : Mapper à l’opération Kb-search
- Rubrique Générative : Mapper à l’opération Generative-V3
Configuration de l’authentification :
- Obtenir le jeton du porteur à partir de l’instance de démonstration eGain
- Configurer dans les paramètres d’authentification du connecteur
- Tester la connexion avant le déploiement

Configuration de l’Assistant Connecteur eGain

Créer un connecteur personnalisé :
- Importer la définition OpenAPI
- Définir l’hôte d’API sur api.ai.egain.cloud
- Configurer l’authentification avec le jeton du porteur
Configurer des rubriques personnalisées :
- Rubrique eGainSearch : Mapper à l’opération Search-V3
- Rubrique Générative : Mapper à l’opération Generative-V3
Configuration de l’authentification :
- Obtenir le jeton du porteur à partir de l’instance de l’Assistant Connecteur eGain
- Configurer dans les paramètres d’authentification du connecteur
- Tester la connexion avant le déploiement

Meilleures pratiques pour les agents Copilot

1. Conception de rubriques

Reconnaissance de l’intention claire : rubriques de conception pour identifier clairement quand utiliser chaque opération
Sensibilisation au contexte : utiliser le contexte de conversation pour déterminer les paramètres de recherche appropriés
Gestion de secours : Implémenter des réponses de secours quand aucun résultat n’est trouvé

2. Traitement des réponses

Intégration de citation : tirer parti de la génération automatique d’URL pour les réponses enrichies
Mise en forme du contenu : utiliser le format de réponse structurée pour une présentation cohérente
Gestion des erreurs : Implémenter une gestion des erreurs normale pour les échecs d’API

3. Considérations relatives à la sécurité

Gestion des jetons : implémenter le stockage et la rotation sécurisés des jetons
Contrôle d’accès : vérifier les contrôles d’accès appropriés pour différents rôles d’utilisateur
Journalisation de l’audit : appels d’API de journalisation pour la surveillance de la sécurité

4. Optimisation des performances

Mise en cache : implémenter la mise en cache appropriée pour le contenu fréquemment consulté
Limitation du débit : respecter les limites de débit d’API eGain
Filtrage de réponse : utiliser efficacement les paramètres minScore et maxReferences

Résolution des problèmes

Problèmes courants

Erreurs d’authentification :

Vérifier que le jeton du porteur est valide et n’a pas expiré
Vérifier la configuration de l’hôte d’API correspond à l’instance eGain prévue
Vérifier le format de jeton approprié dans les paramètres du connecteur

Résultats vides :

Vérifier que les requêtes de recherche sont suffisamment spécifiques
Vérifier si le contenu existe dans la base de connaissances
Passer en revue les paramètres minScore pour les réponses génératives

Problèmes de génération d’URL :

Vérifiez que les paramètres baseUrl et shortName sont correctement configurés
Vérifier que les URL d’instance eGain sont accessibles
Rechercher des caractères spéciaux dans les noms d’articles

Étapes de débogage

Tester les opérations individuelles : utiliser Power Automate pour tester chaque opération séparément
Vérifier le format de réponse : vérifier que la structure de réponse correspond au schéma attendu
Valider l’authentification : vérifiez que les jetons sont correctement configurés
Examiner les journaux : vérifier les journaux d’exécution du connecteur pour obtenir des informations détaillées sur les erreurs

Fonctionnalités avancées

Détection des doublons

Le connecteur supprime automatiquement les citations en double basées sur des combinaisons d’ID de référence et de noms, ce qui garantit des listes de référence propres dans les réponses génératives.

filtrage Score-Based

Configurez les seuils de score minimal et le nombre maximal de références pour contrôler la qualité et la longueur de la réponse :

minScore : Filtrer les citations à faible pertinence (valeur par défaut : 0,01)
maxReferences : Nombre maximal de références (valeur par défaut : 10)

Personnalisation de l’URL

Prise en charge de la construction d’URL personnalisée à l’aide de paramètres baseUrl et shortName :

baseUrl : URL de base de votre instance eGain
shortName : segment de chemin d’URL pour l’accès au contenu

Support et maintenance

Maintenance régulière

Rotation des jetons : Mettez régulièrement à jour les jetons d’authentification
Surveillance des API : Surveiller l’utilisation et les performances des API
Mises à jour de contenu : Maintenir le contenu de la base de connaissances actuel

Ressources de support

Documentation eGain : reportez-vous à la documentation officielle de l’API eGain
Microsoft Copilot Studio : Utiliser les guides de résolution des problèmes liés au connecteur Microsoft
Support de la communauté : Tirer parti des ressources de la communauté Microsoft Power Platform

Historique des versions

v1.0.0 : version initiale avec les opérations Search-V3, Kb-search et Generative-V3
Ajout de la liaison automatique de citations et de la détection en double
Implémentation du filtrage de score configurable et des limites de référence
Sécurité renforcée avec une gestion appropriée de l’authentification

Cette documentation est conçue pour aider les développeurs et les administrateurs à implémenter et à gérer efficacement le connecteur Egain dans les agents Microsoft Copilot Studio.

Création d’une connexion

Le connecteur prend en charge les types d’authentification suivants :


Par défaut	Paramètres de création de connexion.	Toutes les régions	Non partageable

Faire défaut

Applicable : Toutes les régions

Paramètres de création de connexion.

Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.

Nom	Type	Descriptif	Obligatoire
Hôte de l’API eGain	ficelle	Domaine de l’API eGain en fonction du type d’instance	Vrai

Limitations

Nom	Appels	Période de renouvellement
Appels d’API par connexion	100	60 secondes

Actions

Obtenir les meilleurs résultats de recherche pour une requête utilisateur	Obtenez les meilleurs résultats de recherche pour une requête utilisateur. Il n’est pas applicable à la version 21.x.x.x.x
Retourne le résultat de recherche de la base de connaissances pour eGain R21	Il est disponible uniquement pour l’installation d’eGain à la version 21.x.x.x
Récupère des réponses pour une étendue donnée avec des sources de données et le portail de la base de connaissances	Le service récupère un ensemble de réponses pour une étendue donnée. Une étendue est une collection de sources de données ou d’un portail eGain KB avec un id de profil de personnalisation et de langage spécifique.

Obtenir les meilleurs résultats de recherche pour une requête utilisateur

ID d’opération :: Search-V3

Obtenez les meilleurs résultats de recherche pour une requête utilisateur. Il n’est pas applicable à la version 21.x.x.x.x

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du portail	portalId	True	string	Identificateur du portail
Code de langue	languageCode	True	string	Code de langue pour la recherche
Query	q	True	string	Chaîne de requête de recherche
ID de profil de personnalisation	personalizationProfileId		integer	Identificateur de profil de personnalisation
Jeton d’authentification	authToken	True	string	Il est passé en tant qu’en-tête d’autorisation
URL de base	baseUrl	True	string	Il s’agit de l’URL de base pour le portail km
Nom court	shortName	True	string	Nom court du portail KM
Accepter	Accept		string	Accepter la valeur d’en-tête

Retourne le résultat de recherche de la base de connaissances pour eGain R21

ID d’opération :: Kb-search

Il est disponible uniquement pour l’installation d’eGain à la version 21.x.x.x

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du portail	portalId	True	string	Identificateur du portail
Query	q	True	string	Chaîne de requête de recherche
Language	$lang	True	string	Code de langue pour la recherche
Caractéristique	$attribute		string	Filtre d’attribut pour les résultats de recherche
Numéro de page	$pagenum		integer	Numéro de page pour la pagination
Taille de page	$pagesize		integer	Nombre de résultats par page
Jeton d’authentification	authToken	True	string	Jeton d’authentification pour l’accès aux API
URL de base	baseUrl	True	string	URL de base pour le portail KM
Nom court	shortName	True	string	Nom court utilisé pour le portail KM
Accepter la langue	Accept-language	True	string	valeur d’en-tête Accept-Language
Accepter	Accept	True	string	Accepter la valeur d’en-tête

Récupère des réponses pour une étendue donnée avec des sources de données et le portail de la base de connaissances

ID d’opération :: Generative-V3

Le service récupère un ensemble de réponses pour une étendue donnée. Une étendue est une collection de sources de données ou d’un portail eGain KB avec un id de profil de personnalisation et de langage spécifique.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Query	q	True	string	Question ou terme de recherche
ID de service	departmentId		integer	Identificateur de service
ID d’utilisateur	userId		integer	Identificateur de l’utilisateur
ID du portail	portalId	True	integer	Les résultats sont récupérés à partir du portail KM donné
Code de langue	languageCode	True	string	Code de langue pour la recherche
ID de profil de personnalisation	personalizationProfileId		integer	Identificateur de profil de personnalisation
Jeton d’authentification	authToken	True	string	Utilisé pour l’autorisation pour l’API eGain
URL de base	baseUrl	True	string	URL de base pour le portail KM
Nom court	shortName	True	string	Nom court utilisé pour le portail KM
Accepter	Accept		string	Accepter la valeur d’en-tête

Partager via

Egain (préversion)

Egain - Guide d’utilisation de l’agent Copilot

Aperçu

Prerequisites

Configurations de l’agent

1. Agent de démonstration eGain

2. Assistant Connecteur eGain

Sécurité et authentification

Opérations et utilisation

Opération 1 : Search-V3

Opération 2 : Kb-search

Opération 3 : Generative-V3

Configuration et configuration de l’agent

Configuration de l’agent de démonstration eGain

Configuration de l’Assistant Connecteur eGain

Meilleures pratiques pour les agents Copilot

1. Conception de rubriques

2. Traitement des réponses

3. Considérations relatives à la sécurité

4. Optimisation des performances

Résolution des problèmes

Problèmes courants

Étapes de débogage

Fonctionnalités avancées

Détection des doublons

filtrage Score-Based

Personnalisation de l’URL

Support et maintenance

Maintenance régulière

Ressources de support

Historique des versions

Création d’une connexion

Faire défaut

Limitations

Actions

Obtenir les meilleurs résultats de recherche pour une requête utilisateur

Paramètres

Retourne le résultat de recherche de la base de connaissances pour eGain R21

Paramètres

Récupère des réponses pour une étendue donnée avec des sources de données et le portail de la base de connaissances

Paramètres