Egain (wersja zapoznawcza)

Ten łącznik umożliwia aplikacji Copilot bezpieczne wywoływanie interfejsu API eGain V3, zapewniając bezproblemową integrację danych zaangażowania klientów. Obsługuje uwierzytelnianie, pobieranie danych i wykonywanie akcji, upraszczając przepływy pracy i zwiększając szczegółowe informacje w czasie rzeczywistym w usługach eGain.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa	Class	Regions
Copilot Studio	Premium	Wszystkie regiony usługi Power Automate z wyjątkiem następujących:      - Rząd USA (GCC)      - Rząd USA (GCC High)      - China Cloud obsługiwane przez firmę 21Vianet      - Departament Obrony USA (DoD)
Logic Apps	Standard	Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:      — Regiony platformy Azure Government      — Regiony platformy Azure (Chiny)      - Departament Obrony USA (DoD)
Power Apps	Premium	Wszystkie regiony usługi Power Apps z wyjątkiem następujących:      - Rząd USA (GCC)      - Rząd USA (GCC High)      - China Cloud obsługiwane przez firmę 21Vianet      - Departament Obrony USA (DoD)
Power Automate - narzędzie do automatyzacji procesów	Premium	Wszystkie regiony usługi Power Automate z wyjątkiem następujących:      - Rząd USA (GCC)      - Rząd USA (GCC High)      - China Cloud obsługiwane przez firmę 21Vianet      - Departament Obrony USA (DoD)

Kontakt
Name	Obsługa usługi eGain
Email	support@egain.com

Metadane łącznika
Publisher	eGain Corporation
Witryna internetowa	http://egain.com/
Zasady ochrony prywatności	https://www.egain.com/privacy-policies
Kategorie	AI; Finanse
Źródło	platforma handlowa
BrandColor	#FEF0FD

Egain — Przewodnik użycia agenta Copilot

Przegląd

Łącznik Egain został zaprojektowany tak, aby bezproblemowo integrować się z agentami programu Microsoft Copilot Studio, zapewniając zaawansowane możliwości zarządzania wiedzą za pomocą dwóch odrębnych wystąpień eGain. Ten łącznik umożliwia agentom wyszukiwanie baz wiedzy, generowanie odpowiedzi opartych na sztucznej inteligencji i dostarczanie dokładnych cytatów z automatycznym generowaniem adresów URL.

Wymagania wstępne

Przed rozpoczęciem korzystania z łącznika Egain upewnij się, że zostały spełnione następujące wymagania wstępne:

1. Wymagania dotyczące wystąpienia eGain: musisz mieć wystąpienie eGain uruchomione w wersji Rigel lub R21.x.x lub nowszej.

2. Konfiguracja aplikacji klienckiej: aplikacja kliencka musi zostać utworzona w wystąpieniu eGain z odpowiednimi uprawnieniami dla akcji, które mają być używane. Aplikacja kliencka powinna mieć:

   • Uprawnienia portalu dla operacji wyszukiwania bazy wiedzy
   • Uprawnienia sztucznej inteligencji do generowania operacji sztucznej inteligencji

   Aby uzyskać szczegółowe informacje na temat tworzenia i konfigurowania aplikacji klienckich, zapoznaj się z dokumentacją aplikacji klienckiej eGain.

3. Konfiguracja portalu wiedzy: portal wiedzy musi być wstępnie skonfigurowany w wystąpieniu eGain, aby umożliwić wyszukiwanie i pobieranie zawartości. Portal służy jako podstawa operacji bazy wiedzy i zarządzania zawartością.

   Aby uzyskać informacje na temat konfigurowania portali wiedzy, zapoznaj się z dokumentacją dotyczącą portali eGain.

Konfiguracje agenta

1. Agent demonstracyjny eGain

• Host interfejsu API: api.egain.cloud
• Adres URL wystąpienia: https://egainr21demo.egain.cloud
• Uwierzytelnianie: zabezpieczenia włączone z uwierzytelnianiem tokenu elementu nośnego
• Tematy niestandardowe:
  • wyszukiwanie eGain: używa Kb-search operacji
  • Generowanie: używa Generative-V3 operacji

2. Asystent łącznika eGain

• Host interfejsu API: api.ai.egain.cloud
• Adres URL wystąpienia: https://ai.egain.cloud/s5fa
• Uwierzytelnianie: zabezpieczenia włączone z uwierzytelnianiem tokenu elementu nośnego
• Tematy niestandardowe:
  • Generowanie: używa Generative-V3 operacji
  • eGainSearch: używa Search-V3 operacji

Zabezpieczenia i uwierzytelnianie

Ważne: sam łącznik Egain nie wymaga żadnej konfiguracji uwierzytelniania. Jednak interfejsy API eGain są zabezpieczone i obsługują ogólne uwierzytelnianie OAuth 2.0, które jest skonfigurowane na karcie Zabezpieczenia agentów copilot Studio.

Oba wystąpienia eGain mają włączone zabezpieczenia, upewniając się, że wszystkie wywołania interfejsu API są prawidłowo uwierzytelniane. Łącznik automatycznie obsługuje:

• Obsługa protokołu OAuth 2.0: ogólne uwierzytelnianie OAuth 2.0 skonfigurowane na karcie Zabezpieczenia programu Copilot Studio
• Uwierzytelnianie tokenu elementu nośnego: automatycznie dodaje Bearer prefiks, jeśli nie istnieje
• Zarządzanie nagłówkami: Prawidłowo zarządza nagłówkami autoryzacji
• Oczyszczanie parametrów: usuwa parametry uwierzytelniania przed przekazaniem do interfejsów API eGain
• Obsługa błędów: bezproblemowa obsługa błędów uwierzytelniania

Operacje i użycie

Operacja 1: Search-V3

Używane przez: eGain Connector Assistant (temat eGainSearch)

Cel: Wyszukiwanie zaawansowane przy użyciu interfejsu API wyszukiwania w wersji 3 eGain z rozszerzonym przetwarzaniem wyników i automatycznym generowaniem adresów URL cytatów.

Konfiguracja:

• Host interfejsu API: api.ai.egain.cloud
• Punkt końcowy:/search/v3
• , metoda: POST

Przykładowe żądanie:

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

Konfiguracja programu 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

Przykładowa odpowiedź:

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

Operacja 2. Wyszukiwanie w kb

Używane przez: eGain Demo Agent (temat eGain Search)

Cel: wyszukiwanie artykułów bazy wiedzy z rozszerzonym przetwarzaniem metadanych i automatycznym generowaniem adresów URL.

Konfiguracja:

• Host interfejsu API: api.egain.cloud
• Punkt końcowy:/search/kb
• , metoda: POST

Przykładowe żądanie:

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

Konfiguracja programu 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

Przykładowa odpowiedź:

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

Operacja 3. Generative-V3

Używane przez: Oba agenty (temat generowania)

Cel: generowanie odpowiedzi opartej na sztucznej inteligencji z inteligentnym zarządzaniem cytatami, wykrywaniem duplikatów i konfigurowalnym filtrowaniem.

Konfiguracja:

• Agent demonstracyjny eGain: api.egain.cloud
• Asystent łącznika eGain: api.ai.egain.cloud
• Punkt końcowy:/generative/v3
• , metoda: POST

Przykładowe żądanie:

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

Konfiguracja programu 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

Przykładowa odpowiedź:

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

Instalacja i konfiguracja agenta

Konfiguracja agenta demonstracyjnego eGain

1. Utwórz łącznik niestandardowy:

   • Importuj definicję OpenAPI
   • Ustaw hosta interfejsu API na wartość api.egain.cloud
   • Konfigurowanie uwierzytelniania przy użyciu tokenu elementu nośnego

2. Konfigurowanie tematów niestandardowych:

   • Temat wyszukiwania eGain: Mapuj na Kb-search operację
   • Temat generowania: Mapuj na Generative-V3 operację

3. Konfiguracja uwierzytelniania:

   • Uzyskiwanie tokenu elementu nośnego z wystąpienia pokazu eGain
   • Konfigurowanie w ustawieniach uwierzytelniania łącznika
   • Testowanie połączenia przed wdrożeniem

Konfiguracja Asystenta łącznika eGain

1. Utwórz łącznik niestandardowy:

   • Importuj definicję OpenAPI
   • Ustaw hosta interfejsu API na wartość api.ai.egain.cloud
   • Konfigurowanie uwierzytelniania przy użyciu tokenu elementu nośnego

2. Konfigurowanie tematów niestandardowych:

   • Temat eGainSearch: Mapuj na Search-V3 operację
   • Temat generowania: Mapuj na Generative-V3 operację

3. Konfiguracja uwierzytelniania:

   • Uzyskiwanie tokenu elementu nośnego z wystąpienia asystenta łącznika eGain
   • Konfigurowanie w ustawieniach uwierzytelniania łącznika
   • Testowanie połączenia przed wdrożeniem

Najlepsze rozwiązania dotyczące agentów Copilot

1. Projektowanie tematów

• Wyczyść rozpoznawanie intencji: Tematy projektowania, aby wyraźnie określić, kiedy używać każdej operacji
• Rozpoznawanie kontekstu: użyj kontekstu konwersacji, aby określić odpowiednie parametry wyszukiwania
• Obsługa rezerwowa: implementowanie odpowiedzi rezerwowych, gdy nie znaleziono wyników

2. Przetwarzanie odpowiedzi

• Integracja cytatów: wykorzystanie automatycznego generowania adresów URL w celu uzyskania rozbudowanych odpowiedzi
• Formatowanie zawartości: użyj formatu odpowiedzi ustrukturyzowanej do spójnej prezentacji
• Obsługa błędów: Implementowanie bezproblemowej obsługi błędów dla błędów interfejsu API

3. Zagadnienia dotyczące zabezpieczeń

• Zarządzanie tokenami: implementowanie bezpiecznego magazynu i rotacji tokenów
• Kontrola dostępu: Zapewnianie odpowiednich kontroli dostępu dla różnych ról użytkowników
• Rejestrowanie inspekcji: wywołania interfejsu API dzienników na potrzeby monitorowania zabezpieczeń

4. Optymalizacja wydajności

• Buforowanie: implementowanie odpowiedniego buforowania dla często używanej zawartości
• Ograniczanie szybkości: Przestrzegaj limitów szybkości interfejsu API eGain
• Filtrowanie odpowiedzi: efektywne używanie parametrów minScore i maxReferences

Rozwiązywanie problemów

Typowe problemy

Błędy uwierzytelniania:

• Sprawdź, czy token elementu nośnego jest prawidłowy i nie wygasł
• Sprawdzanie, czy konfiguracja hosta interfejsu API jest zgodna z zamierzonym wystąpieniem eGain
• Upewnij się, że odpowiedni format tokenu w ustawieniach łącznika

Puste wyniki:

• Sprawdź, czy zapytania wyszukiwania są wystarczająco szczegółowe
• Sprawdzanie, czy zawartość istnieje w bazie wiedzy
• Przejrzyj ustawienia minScore dla odpowiedzi generowania

Problemy z generowaniem adresów URL:

• Upewnij się, że parametry baseUrl i shortName są poprawnie skonfigurowane
• Sprawdź, czy adresy URL wystąpień eGain są dostępne
• Sprawdzanie znaków specjalnych w nazwach artykułów

Kroki debugowania

1. Testowanie poszczególnych operacji: testowanie poszczególnych operacji przy użyciu usługi Power Automate
2. Sprawdzanie formatu odpowiedzi: Sprawdzanie, czy struktura odpowiedzi jest zgodna z oczekiwanym schematem
3. Weryfikowanie uwierzytelniania: upewnij się, że tokeny są prawidłowo skonfigurowane
4. Przejrzyj dzienniki: Sprawdź dzienniki wykonywania łącznika, aby uzyskać szczegółowe informacje o błędzie

Funkcje zaawansowane

Wykrywanie duplikatów

Łącznik automatycznie usuwa zduplikowane cytaty na podstawie kombinacji identyfikatora odwołania i nazwy, zapewniając czyste listy odwołań w odpowiedziach generacyjnych.

filtrowanie Score-Based

Skonfiguruj minimalne progi oceny i maksymalne liczby odwołań, aby kontrolować jakość i długość odpowiedzi:

• minScore: Odfiltruj cytaty o niskiej istotności (ustawienie domyślne: 0,01)
• maxReferences: Limit liczby odwołań (wartość domyślna: 10)

Dostosowywanie adresu URL

Obsługa niestandardowej konstrukcji adresu URL przy użyciu parametrów baseUrl i shortName:

• baseUrl: podstawowy adres URL wystąpienia eGain
• shortName: segment ścieżki adresu URL na potrzeby dostępu do zawartości

Pomoc techniczna i konserwacja

Regularna konserwacja

• Rotacja tokenów: regularnie aktualizuj tokeny uwierzytelniania
• Monitorowanie interfejsu API: monitorowanie użycia i wydajności interfejsu API
• Aktualizacje zawartości: utrzymywanie bieżącej zawartości bazy wiedzy

Zasoby pomocy technicznej

• Dokumentacja usługi eGain: zapoznaj się z oficjalną dokumentacją interfejsu API usługi eGain
• Microsoft Copilot Studio: Korzystanie z przewodników rozwiązywania problemów z łącznikiem firmy Microsoft
• Pomoc techniczna społeczności: korzystanie z zasobów społeczności platformy Microsoft Power Platform

Historia wersji

• Wersja 1.0.0: początkowa wersja z operacjami Search-V3, Kb-search i Generative-V3
• Dodano automatyczne łączenie cytatów i wykrywanie duplikatów
• Zaimplementowano konfigurowalne filtrowanie wyników i limity odwołań
• Zwiększone zabezpieczenia z odpowiednią obsługą uwierzytelniania

---

Ta dokumentacja została zaprojektowana w celu ułatwienia deweloperom i administratorom efektywnego implementowania łącznika Egain w agencie programu Microsoft Copilot Studio.

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:

Wartość domyślna	Parametry tworzenia połączenia.	Wszystkie regiony	Nie można udostępniać

Domyślny

Dotyczy: wszystkie regiony

Parametry tworzenia połączenia.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Name	Typ	Description	Wymagane
Host interfejsu API eGain	ciąg	Domena interfejsu API eGain na podstawie typu wystąpienia	Prawda

Limity ograniczania

Nazwa	Wywołania	Okres odnowienia
Wywołania interfejsu API na połączenie	100	60 sekund

Akcje

Pobiera odpowiedzi dla danego zakresu za pomocą źródeł danych i portalu BAZY wiedzy	Usługa pobierze zestaw odpowiedzi dla danego zakresu. Zakres to kolekcja źródeł danych lub portalu bazy wiedzy eGain z określonym identyfikatorem języka i profilu personalizacji.
Uzyskiwanie najlepszych wyników wyszukiwania dla zapytania użytkownika	Uzyskaj najlepsze wyniki wyszukiwania dla zapytania użytkownika. Nie dotyczy wersji 21.x.x.x
Zwraca wynik wyszukiwania bazy wiedzy dla eGain R21	Jest dostępna tylko w przypadku instalacji eGain w wersji 21.x.x.x

Pobiera odpowiedzi dla danego zakresu za pomocą źródeł danych i portalu BAZY wiedzy

Identyfikator operacji:

Generative-V3

Usługa pobierze zestaw odpowiedzi dla danego zakresu. Zakres to kolekcja źródeł danych lub portalu bazy wiedzy eGain z określonym identyfikatorem języka i profilu personalizacji.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Query	q	True	string	Pytanie lub wyszukiwany termin
Identyfikator działu	departmentId		integer	Identyfikator działu
Identyfikator użytkownika	userId		integer	Identyfikator użytkownika
Identyfikator portalu	portalId	True	integer	Wyniki są pobierane z danego portalu KM
Kod języka	languageCode	True	string	Kod języka wyszukiwania
Identyfikator profilu personalizacji	personalizationProfileId		integer	Identyfikator profilu personalizacji
Token uwierzytelniania	authToken	True	string	Używany do autoryzacji do interfejsu API eGain
Podstawowy adres URL	baseUrl	True	string	Podstawowy adres URL portalu km
Krótka nazwa	shortName	True	string	Krótka nazwa używana dla portalu KM
Akceptuj	Accept		string	Zaakceptuj wartość nagłówka

Uzyskiwanie najlepszych wyników wyszukiwania dla zapytania użytkownika

Identyfikator operacji:

Search-V3

Uzyskaj najlepsze wyniki wyszukiwania dla zapytania użytkownika. Nie dotyczy wersji 21.x.x.x

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator portalu	portalId	True	string	Identyfikator portalu
Kod języka	languageCode	True	string	Kod języka wyszukiwania
Query	q	True	string	Ciąg zapytania wyszukiwania
Identyfikator profilu personalizacji	personalizationProfileId		integer	Identyfikator profilu personalizacji
Token uwierzytelniania	authToken	True	string	Jest przekazywany jako nagłówek autoryzacji
Podstawowy adres URL	baseUrl	True	string	Jest to podstawowy adres URL portalu km
Krótka nazwa	shortName	True	string	Krótka nazwa portalu km
Akceptuj	Accept		string	Zaakceptuj wartość nagłówka

Zwraca wynik wyszukiwania bazy wiedzy dla eGain R21

Identyfikator operacji:

Kb-search

Jest dostępna tylko w przypadku instalacji eGain w wersji 21.x.x.x

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator portalu	portalId	True	string	Identyfikator portalu
Query	q	True	string	Ciąg zapytania wyszukiwania
Język	$lang	True	string	Kod języka wyszukiwania
Attribute	$attribute		string	Filtr atrybutów dla wyników wyszukiwania
Numer strony	$pagenum		integer	Numer strony na potrzeby stronicowania
Rozmiar strony	$pagesize		integer	Liczba wyników na stronę
Token uwierzytelniania	authToken	True	string	Token uwierzytelniania na potrzeby dostępu do interfejsu API
Podstawowy adres URL	baseUrl	True	string	Podstawowy adres URL portalu km
Krótka nazwa	shortName	True	string	Krótka nazwa używana dla portalu KM
Zaakceptuj język	Accept-language	True	string	Accept-Language wartość nagłówka
Akceptuj	Accept	True	string	Zaakceptuj wartość nagłówka