Egain (versión preliminar)

Este conector está disponible en los siguientes productos y regiones:

Service	Class	Regions
Copilot Studio	Premium	Todas las regiones de Power Automate excepto las siguientes:      - Gobierno de EE. UU. (GCC)      - Gobierno de EE. UU. (GCC High)      - China Cloud operado por 21Vianet      - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas	Estándar	Todas las regiones de Logic Apps excepto las siguientes:      - Regiones de Azure Government      - Regiones de Azure China      - Departamento de Defensa de EE. UU. (DoD)
Power Apps	Premium	Todas las regiones de Power Apps excepto las siguientes:      - Gobierno de EE. UU. (GCC)      - Gobierno de EE. UU. (GCC High)      - China Cloud operado por 21Vianet      - Departamento de Defensa de EE. UU. (DoD)
Power Automate	Premium	Todas las regiones de Power Automate excepto las siguientes:      - Gobierno de EE. UU. (GCC)      - Gobierno de EE. UU. (GCC High)      - China Cloud operado por 21Vianet      - Departamento de Defensa de EE. UU. (DoD)

Contacto
Nombre	Compatibilidad con eGain
Correo Electrónico	support@egain.com

Metadatos del conector
Publicador	eGain Corporation
Sitio web	http://egain.com/
Directiva de privacidad	https://www.egain.com/privacy-policies
Categorías	IA; Finanzas
Fuente	mercado
BrandColor	#FEF0FD

Egain- Guía de uso del agente de Copilot

Información general

El conector Egain está diseñado para integrarse sin problemas con los agentes de Microsoft Copilot Studio, lo que proporciona funcionalidades eficaces de administración de conocimientos a través de dos instancias distintas de eGain. Este conector permite a los agentes buscar bases de conocimiento, generar respuestas basadas en inteligencia artificial y proporcionar citas precisas con generación automática de direcciones URL.

Prerrequisitos

Antes de usar el conector Egain, asegúrese de que tiene los siguientes requisitos previos:

1. Requisitos de instancia de eGain: debe tener una instancia de eGain que se ejecute en la versión Rigel o R21.x.x o posterior.

2. Configuración de la aplicación cliente: se debe crear una aplicación cliente en la instancia de eGain con los permisos adecuados para las acciones que planea usar. La aplicación cliente debe tener:

   • Permisos del portal para las operaciones de búsqueda de la base de conocimiento
   • Permisos de IA para operaciones de IA generativas

   Para obtener información detallada sobre cómo crear y configurar aplicaciones cliente, consulte la documentación de la aplicación cliente de eGain.

3. Configuración del Portal de conocimiento: un portal de conocimiento debe estar preconfigurado en la instancia de eGain para habilitar la búsqueda y recuperación de contenido. El portal sirve como base para las operaciones de la base de conocimiento y la administración de contenido.

   Para obtener información sobre cómo configurar portales de conocimiento, consulte la documentación de eGain Portals.

Configuraciones del agente

1. Agente de demostración de eGain

• Host de API: api.egain.cloud
• Dirección URL de instancia: https://egainr21demo.egain.cloud
• Autenticación: seguridad habilitada con autenticación de token de portador
• Temas personalizados:
  • Búsqueda de eGain: usa Kb-search la operación
  • Generative: usa Generative-V3 la operación

2. Asistente para conectores de eGain

• Host de API: api.ai.egain.cloud
• Dirección URL de instancia: https://ai.egain.cloud/s5fa
• Autenticación: seguridad habilitada con autenticación de token de portador
• Temas personalizados:
  • Generative: usa Generative-V3 la operación
  • eGainSearch: usa Search-V3 la operación

Seguridad y autenticación

Importante: El propio conector Egain no requiere ninguna configuración de autenticación. Sin embargo, las API de eGain están protegidas y admiten la autenticación genérica de OAuth 2.0, que se configura en la pestaña Seguridad de los agentes de Copilot Studio.

Ambas instancias de eGain tienen habilitada la seguridad, lo que garantiza que todas las llamadas API se autentiquen correctamente. El conector controla automáticamente:

• Compatibilidad con OAuth 2.0: autenticación genérica de OAuth 2.0 configurada en la pestaña Seguridad de Copilot Studio
• Autenticación de token de portador: agrega Bearer automáticamente el prefijo si no está presente
• Administración de encabezados: administra correctamente los encabezados de autorización
• Saneamiento de parámetros: quita los parámetros de autenticación antes de reenviar a las API de eGain
• Control de errores: control con gracia de errores de autenticación

Operaciones y uso

Operación 1: Search-V3

Usado por: Asistente para conectores de eGain (tema eGainSearch)

Propósito: búsqueda avanzada mediante la API de búsqueda V3 de eGain con procesamiento mejorado de resultados y generación automática de direcciones URL de cita.

Configuración:

• Host de API: api.ai.egain.cloud
• Punto de conexión:/search/v3
• Método : POST

Solicitud de ejemplo:

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

Configuración 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

Respuesta de ejemplo:

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

Operación 2: Kb-search

Usado por: Agente de demostración de eGain (tema eGain Search)

Propósito: búsqueda de artículos de Knowledge Base con procesamiento mejorado de metadatos y generación automática de direcciones URL.

Configuración:

• Host de API: api.egain.cloud
• Punto de conexión:/search/kb
• Método : POST

Solicitud de ejemplo:

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

Configuración 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

Respuesta de ejemplo:

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

Operación 3: Generative-V3

Usado por: Ambos agentes (tema generativo)

Propósito: generación de respuestas con tecnología de inteligencia artificial con administración inteligente de citas, detección de duplicados y filtrado configurable.

Configuración:

• Agente de demostración de eGain: api.egain.cloud
• Asistente para conectores de eGain: api.ai.egain.cloud
• Punto de conexión:/generative/v3
• Método : POST

Solicitud de ejemplo:

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

Configuración 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

Respuesta de ejemplo:

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

Configuración y configuración del agente

Configuración del agente de demostración de eGain

1. Creación de un conector personalizado:

   • Importar la definición de OpenAPI
   • Establecimiento del host de API en api.egain.cloud
   • Configuración de la autenticación con token de portador

2. Configurar temas personalizados:

   • Tema de búsqueda de eGain: Asignación a Kb-search la operación
   • Tema generativo: Asignación a la Generative-V3 operación

3. Configuración de autenticación:

   • Obtención del token de portador de la instancia de demostración de eGain
   • Configuración en los valores de autenticación del conector
   • Prueba de la conexión antes de la implementación

Configuración del Asistente para conectores de eGain

1. Creación de un conector personalizado:

   • Importar la definición de OpenAPI
   • Establecimiento del host de API en api.ai.egain.cloud
   • Configuración de la autenticación con token de portador

2. Configurar temas personalizados:

   • Tema de eGainSearch: Asignación a Search-V3 la operación
   • Tema generativo: Asignación a la Generative-V3 operación

3. Configuración de autenticación:

   • Obtención del token de portador de la instancia del Asistente para conectores de eGain
   • Configuración en los valores de autenticación del conector
   • Prueba de la conexión antes de la implementación

Procedimientos recomendados para agentes de Copilot

1. Diseño de temas

• Reconocimiento de intenciones claras: diseñar temas para identificar claramente cuándo usar cada operación
• Reconocimiento del contexto: usar el contexto de conversación para determinar los parámetros de búsqueda adecuados
• Control de reserva: implementación de respuestas de reserva cuando no se encuentra ningún resultado

2. Procesamiento de respuesta

• Integración de citas: aproveche la generación automática de direcciones URL para respuestas enriquecidas.
• Formato de contenido: use el formato de respuesta estructurado para una presentación coherente.
• Control de errores: Implementación del control de errores con gracia para errores de API

3. Consideraciones de seguridad

• Administración de tokens: implementación de almacenamiento y rotación de tokens seguros
• Control de acceso: garantizar los controles de acceso adecuados para distintos roles de usuario
• Registro de auditoría: llamadas api de registro para la supervisión de seguridad

4. Optimización del rendimiento

• Almacenamiento en caché: implementar el almacenamiento en caché adecuado para el contenido al que se accede con frecuencia
• Limitación de velocidad: respetar los límites de velocidad de la API de eGain
• Filtrado de respuestas: use los parámetros minScore y maxReferences de forma eficaz

Solución de problemas

Problemas comunes

Errores de autenticación:

• Comprobación de que el token de portador es válido y no ha expirado
• Comprobación de la configuración del host de API coincide con la instancia de eGain prevista
• Asegúrese de que el formato de token adecuado en la configuración del conector

Resultados vacíos:

• Comprobación de que las consultas de búsqueda son lo suficientemente específicas
• Comprobación de si el contenido existe en la base de conocimiento
• Revise la configuración de minScore para obtener respuestas generativas.

Problemas de generación de direcciones URL:

• Asegúrese de que los parámetros baseUrl y shortName estén configurados correctamente.
• Comprobación de que las direcciones URL de la instancia de eGain son accesibles
• Buscar caracteres especiales en nombres de artículo

Pasos de depuración

1. Probar operaciones individuales: use Power Automate para probar cada operación por separado
2. Comprobar el formato de respuesta: comprobar que la estructura de respuesta coincide con el esquema esperado
3. Validar autenticación: asegúrese de que los tokens están configurados correctamente
4. Revisión de registros: comprobación de los registros de ejecución del conector para obtener información detallada sobre errores

Características avanzadas

Detección de duplicados

El conector quita automáticamente las citas duplicadas basadas en combinaciones de identificador de referencia y nombre, lo que garantiza listas de referencia limpias en respuestas generativas.

Filtrado de Score-Based

Configure umbrales de puntuación mínima y recuentos máximos de referencias para controlar la calidad y la longitud de la respuesta:

• minScore: Filtre las citas de baja relevancia (valor predeterminado: 0.01)
• maxReferences: límite del número de referencias (valor predeterminado: 10)

Personalización de direcciones URL

Compatibilidad con la construcción de direcciones URL personalizadas mediante parámetros baseUrl y shortName:

• baseUrl: dirección URL base de la instancia de eGain
• shortName: segmento de ruta de acceso url para el acceso a contenido

Soporte técnico y mantenimiento

Mantenimiento normal

• Rotación de tokens: actualización periódica de tokens de autenticación
• Supervisión de API: Supervisión del uso y el rendimiento de la API
• Actualizaciones de contenido: mantener el contenido actual de la base de conocimiento

Recursos de soporte técnico

• Documentación de eGain: Consulte la documentación oficial de la API de eGain.
• Microsoft Copilot Studio: Uso de las guías de solución de problemas del conector de Microsoft
• Soporte técnico de la comunidad: Aprovechar los recursos de la comunidad de Microsoft Power Platform

Historial de versiones

• v1.0.0: versión inicial con operaciones Search-V3, Kb-search y Generative-V3
• Se ha agregado la vinculación automática de citas y la detección de duplicados.
• Se han implementado límites de referencia y filtrado de puntuación configurables
• Seguridad mejorada con control de autenticación adecuado

---

Esta documentación está diseñada para ayudar a los desarrolladores y administradores a implementar y mantener eficazmente el conector Egain en los agentes de Microsoft Copilot Studio.

Creación de una conexión

El conector admite los siguientes tipos de autenticación:

Predeterminado	Parámetros para crear una conexión.	Todas las regiones	No se puede compartir

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Nombre	Tipo	Description	Obligatorio
Host de api de eGain	cuerda / cadena	Dominio de eGain API basado en el tipo de instancia	Cierto

Limitaciones

Nombre	Llamadas	Período de renovación
Llamadas API por conexión	100	60 segundos

Acciones

Devuelve el resultado de la búsqueda de KB para eGain R21	Solo está disponible para la instalación de eGain en la versión 21.x.x.x.x
Obtención de los mejores resultados de búsqueda para una consulta de usuario	Obtenga los mejores resultados de búsqueda para una consulta de usuario. No es aplicable a la versión 21.x.x.x.x
Recupera respuestas para un ámbito determinado con orígenes de datos y el portal de KB.	El servicio recuperará un conjunto de respuestas para un ámbito determinado. Un ámbito es una colección de orígenes de datos o un portal de kb de eGain con un idioma específico y un identificador de perfil de personalización.

Devuelve el resultado de la búsqueda de KB para eGain R21

Obtención de los mejores resultados de búsqueda para una consulta de usuario

Recupera respuestas para un ámbito determinado con orígenes de datos y el portal de KB.