Egain (Önizleme)
Bu bağlayıcı, Copilot'un eGain V3 API'sini güvenli bir şekilde çağırmasını sağlayarak müşteri etkileşimi verileri için sorunsuz tümleştirme sağlar. Kimlik doğrulama, veri alma ve eylem yürütmeyi destekler, iş akışlarını basitleştirir ve eGain hizmetlerinde gerçek zamanlı içgörüleri geliştirir.
Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:
| Hizmet | Class | Bölgeler |
|---|---|---|
| Copilot Studio | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Logic Apps | Standart | Aşağıdakiler dışında tüm Logic Apps bölgeleri : - Azure Kamu bölgeleri - Azure Çin bölgeleri - ABD Savunma Bakanlığı (DoD) |
| Power Apps | Premium | Aşağıdakiler dışında tüm Power Apps bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Power Automate | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| İletişim | |
|---|---|
| İsim | eGain Desteği |
| E-posta | support@egain.com |
| Bağlayıcı Meta Verileri | |
|---|---|
| Publisher | eGain Corporation |
| Web sitesi | http://egain.com/ |
| Gizlilik ilkesi | https://www.egain.com/privacy-policies |
| Kategoriler | AI; Maliye |
| Kaynak | pazar yeri |
| BrandColor | #FEF0FD |
Egain - Copilot Aracısı Kullanım Kılavuzu
Genel Bakış
Egain bağlayıcısı, iki farklı eGain örneği aracılığıyla güçlü bilgi yönetimi özellikleri sunan Microsoft Copilot Studio aracılarıyla sorunsuz bir şekilde tümleştirecek şekilde tasarlanmıştır. Bu bağlayıcı aracıların bilgi bankalarını aramasına, yapay zeka destekli yanıtlar oluşturmasına ve otomatik URL oluşturma ile doğru alıntılar sağlamasına olanak tanır.
Önkoşullar
Egain bağlayıcısını kullanmadan önce aşağıdaki önkoşullara sahip olduğunuzdan emin olun:
eGain Örneği Gereksinimleri: Rigel veya R21.x.x veya üzeri bir sürümde çalışan bir eGain örneğine sahip olmanız gerekir.
İstemci Uygulaması Yapılandırması: eGain örneğinizde, kullanmayı planladığınız eylemler için uygun izinlere sahip bir istemci uygulaması oluşturulmalıdır. İstemci uygulamasında aşağıdakiler olmalıdır:
- Bilgi bankası arama işlemleri için portal izinleri
- Üretken yapay zeka işlemleri için yapay zeka izinleri
İstemci uygulamaları oluşturma ve yapılandırma hakkında ayrıntılı bilgi için eGain İstemci Uygulaması belgelerine bakın.
Bilgi Portalı Kurulumu: İçerik arama ve almayı etkinleştirmek için eGain örneğinizde bir bilgi portalı önceden yapılandırılmalıdır. Portal, bilgi bankası işlemleri ve içerik yönetimi için temel görevi görür.
Bilgi portallarını ayarlama hakkında bilgi için eGain Portalları belgelerine bakın.
Aracı Yapılandırmaları
1. eGain Tanıtım Aracısı
-
API Konağı:
api.egain.cloud - Örnek URL'si: https://egainr21demo.egain.cloud
- Kimlik doğrulaması: Taşıyıcı belirteci kimlik doğrulaması ile etkinleştirilen güvenlik
-
Özel Konular:
-
eGain Arama: İşlemi kullanır
Kb-search -
Oluşturma: İşlemi kullanır
Generative-V3
-
eGain Arama: İşlemi kullanır
2. eGain Bağlayıcı Yardımcısı
-
API Konağı:
api.ai.egain.cloud - Örnek URL'si: https://ai.egain.cloud/s5fa
- Kimlik doğrulaması: Taşıyıcı belirteci kimlik doğrulaması ile etkinleştirilen güvenlik
-
Özel Konular:
-
Oluşturma: İşlemi kullanır
Generative-V3 -
eGainSearch: İşlemi kullanır
Search-V3
-
Oluşturma: İşlemi kullanır
Güvenlik ve Kimlik Doğrulaması
Önemli: Egain bağlayıcısının kendisi herhangi bir kimlik doğrulama yapılandırması gerektirmez. Ancak, eGain API'lerinin güvenliği sağlanır ve Copilot Studio aracılarınızın Güvenlik sekmesinde yapılandırılan genel OAuth 2.0 kimlik doğrulamasını destekler.
Her iki eGain örneğinde de tüm API çağrılarının doğru şekilde doğrulandığından emin olmak için güvenlik etkindir. Bağlayıcı aşağıdakileri otomatik olarak işler:
- OAuth 2.0 Desteği: Copilot Studio Güvenlik sekmesinde yapılandırılan genel OAuth 2.0 kimlik doğrulaması
-
Taşıyıcı Belirteci Kimlik Doğrulaması: Yoksa otomatik olarak ön ek ekler
Bearer - Üst Bilgi Yönetimi: Yetkilendirme üst bilgilerini düzgün yönetir
- Parametre Temizleme: eGain API'lerine iletmeden önce kimlik doğrulama parametrelerini kaldırır
- Hata İşleme: Kimlik doğrulama hatalarının düzgün işlenmesi
İşlemler ve Kullanım
İşlem 1: Search-V3
Tarafından kullanılır: eGain Bağlayıcı Yardımcısı (eGainSearch konusu)
Amaç: Gelişmiş sonuç işleme ve otomatik alıntı URL'si oluşturma ile eGain'in V3 arama API'sini kullanarak gelişmiş arama.
Yapılandırma:
-
API Konağı:
api.ai.egain.cloud -
Endpoint:
/search/v3 - Yöntem: POST
Örnek İstek:
{
"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 Yapılandırması:
$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
Örnek Yanıt:
{
"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?"
}
İşlem 2: Kb-search
Kullanılan: eGain Tanıtım Aracısı (eGain Arama konusu)
Amaç: Gelişmiş meta veri işleme ve otomatik URL oluşturma ile bilgi bankası makale araması.
Yapılandırma:
-
API Konağı:
api.egain.cloud -
Endpoint:
/search/kb - Yöntem: POST
Örnek İstek:
{
"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 Yapılandırması:
$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
Örnek Yanıt:
{
"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"
}
İşlem 3: Generative-V3
Tarafından kullanılır: Her iki aracı (Oluşturma konusu)
Amaç: Akıllı alıntı yönetimi, yinelenen algılama ve yapılandırılabilir filtreleme ile yapay zeka destekli yanıt oluşturma.
Yapılandırma:
-
eGain Tanıtım Aracısı:
api.egain.cloud -
eGain Bağlayıcı Yardımcısı:
api.ai.egain.cloud -
Endpoint:
/generative/v3 - Yöntem: POST
Örnek İstek:
{
"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 Yapılandırması:
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
Örnek Yanıt:
{
"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
}
Aracı Kurulumu ve Yapılandırması
eGain Tanıtım Aracısı Kurulumu
Özel Bağlayıcı Oluştur:
- OpenAPI tanımını içeri aktarma
- API ana bilgisayarını olarak ayarlama
api.egain.cloud - Taşıyıcı belirteci ile kimlik doğrulamayı yapılandırma
Özel Konuları Yapılandırma:
-
eGain Arama Konusu: İşlemle eşle
Kb-search -
Oluşturma Konusu: İşlemle
Generative-V3eşleme
-
eGain Arama Konusu: İşlemle eşle
Kimlik Doğrulama Kurulumu:
- eGain Tanıtım örneğinden Taşıyıcı belirteci alma
- Bağlayıcı kimlik doğrulaması ayarlarında yapılandırma
- Dağıtmadan önce bağlantıyı test etme
eGain Bağlayıcı Yardımcısı Kurulumu
Özel Bağlayıcı Oluştur:
- OpenAPI tanımını içeri aktarma
- API ana bilgisayarını olarak ayarlama
api.ai.egain.cloud - Taşıyıcı belirteci ile kimlik doğrulamayı yapılandırma
Özel Konuları Yapılandırma:
-
eGainSearch Konu Başlığı: İşlemle
Search-V3eşleme -
Oluşturma Konusu: İşlemle
Generative-V3eşleme
-
eGainSearch Konu Başlığı: İşlemle
Kimlik Doğrulama Kurulumu:
- eGain Bağlayıcı Yardımcısı örneğinden Taşıyıcı belirteci alma
- Bağlayıcı kimlik doğrulaması ayarlarında yapılandırma
- Dağıtmadan önce bağlantıyı test etme
Copilot Aracıları için En İyi Yöntemler
1. Konu Tasarımı
- Amaç Tanımayı Temizle: Her işlemin ne zaman kullanılacağını net bir şekilde belirlemek için konuları tasarlama
- Bağlam Tanıma: Uygun arama parametrelerini belirlemek için konuşma bağlamı kullanma
- Geri Dönüş İşleme: Sonuç bulunamadığında geri dönüş yanıtlarını uygulama
2. Yanıt İşleme
- Alıntı Tümleştirmesi: Zengin yanıtlar için otomatik URL oluşturmadan yararlanma
- İçerik Biçimlendirme: Tutarlı sunu için yapılandırılmış yanıt biçimini kullanın
- Hata İşleme: API hataları için düzgün hata işleme uygulama
3. Güvenlikle İlgili Dikkat Edilmesi Gerekenler
- Belirteç Yönetimi: Güvenli belirteç depolama ve döndürme uygulama
- Erişim Denetimi: Farklı kullanıcı rolleri için uygun erişim denetimlerini sağlayın
- Denetim Günlüğü: Güvenlik izleme için günlük API'leri çağrıları
4. Performans İyileştirme
- Önbelleğe alma: Sık erişilen içerik için uygun önbelleğe alma uygulama
- Hız Sınırlama: eGain API hız sınırlarını dikkate alma
- Yanıt Filtreleme: minScore ve maxReferences parametrelerini etkili bir şekilde kullanın
Sorun giderme
Yaygın Sorunlar
Kimlik Doğrulama Hataları:
- Taşıyıcı belirtecinin geçerli olduğunu ve süresinin dolmadığını doğrulayın
- API ana bilgisayar yapılandırmasının hedeflenen eGain örneğiyle eşleşir olup olmadığını denetleyin
- Bağlayıcı ayarlarında doğru belirteç biçimini sağlayın
Boş Sonuçlar:
- Arama sorgularının yeterince özel olduğunu doğrulayın
- Bilgi bankasında içerik olup olmadığını denetleyin
- Üretken yanıtlar için minScore ayarlarını gözden geçirin
URL Oluşturma Sorunları:
- baseUrl ve shortName parametrelerinin doğru yapılandırıldığından emin olun
- eGain örneği URL'lerinin erişilebilir olduğunu doğrulama
- Makale adlarında özel karakterler olup olmadığını denetleyin
Hata Ayıklama Adımları
- Tek Tek İşlemleri Test Etme: Her işlemi ayrı ayrı test etmek için Power Automate'i kullanın
- Yanıt Biçimini Denetle: Yanıt yapısının beklenen şemayla eşleştiklerini doğrulayın
- Kimlik Doğrulamayı Doğrulama: Belirteçlerin düzgün yapılandırıldığından emin olun
- Günlükleri Gözden Geçirme: Ayrıntılı hata bilgileri için bağlayıcı yürütme günlüklerini denetleyin
Gelişmiş Özellikler
Yinelenen Algılama
Bağlayıcı, başvuru kimliği ve ad birleşimlerine göre yinelenen alıntıları otomatik olarak kaldırır ve üretken yanıtlarda temiz başvuru listeleri sağlar.
Score-Based Filtreleme
Yanıt kalitesini ve uzunluğunu denetlemek için en düşük puan eşiklerini ve maksimum başvuru sayısını yapılandırın:
- minScore: Düşük ilgi düzeyi alıntılarını filtreleyin (varsayılan: 0,01)
- maxReferences: Başvuru sayısını sınırla (varsayılan: 10)
URL Özelleştirme
baseUrl ve shortName parametrelerini kullanarak özel URL oluşturma desteği:
- baseUrl: eGain örneği temel URL'niz
- shortName: İçerik erişimi için URL yolu kesimi
Destek ve Bakım
Düzenli Bakım
- Belirteç Döndürme: Kimlik doğrulama belirteçlerini düzenli olarak güncelleştirme
- API İzleme: API kullanımını ve performansını izleme
- İçerik Güncelleştirmeleri: Bilgi bankası içeriğini güncel tutma
Destek Kaynakları
- eGain Belgeleri: eGain'in resmi API belgelerine bakın
- Microsoft Copilot Studio: Microsoft bağlayıcısı sorun giderme kılavuzlarını kullanma
- Topluluk Desteği: Microsoft Power Platform topluluk kaynaklarını kullanma
Sürüm Geçmişi
- v1.0.0: Search-V3, Kb-search ve Generative-V3 işlemleriyle ilk sürüm
- Otomatik alıntı bağlama ve yinelenen algılama eklendi
- Yapılandırılabilir puan filtreleme ve başvuru sınırları uygulandı
- Düzgün kimlik doğrulaması işleme ile gelişmiş güvenlik
Bu belgeler, geliştiricilerin ve yöneticilerin Egain bağlayıcısını Microsoft Copilot Studio aracılarında etkili bir şekilde uygulamasına ve sürdürmesine yardımcı olmak için tasarlanmıştır.
Bağlantı oluşturma
Bağlayıcı aşağıdaki kimlik doğrulama türlerini destekler:
| Varsayılan | Bağlantı oluşturmak için parametreler. | Tüm bölgeler | Paylaşılamaz |
Temerrüt
Geçerli: Tüm bölgeler
Bağlantı oluşturmak için parametreler.
Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.
| İsim | Türü | Description | Gerekli |
|---|---|---|---|
| eGain API Konağı | String | Örnek türüne göre eGain API'sinin etki alanı | Doğru |
Azaltma Sınırları
| Name | Çağrılar | Yenileme Dönemi |
|---|---|---|
| Bağlantı başına API çağrıları | 100 | 60 saniye |
Eylemler
|
e |
Yalnızca 21.x.x.x sürümünde eGain yüklemesi için kullanılabilir |
| Kullanıcı sorgusu için en iyi arama sonuçlarını alma |
Kullanıcı sorgusu için en iyi arama sonuçlarını alın. 21.x.x.x sürümü için geçerli değildir |
| Veri kaynakları ve KB Portalı ile belirli bir kapsamın yanıtlarını alır |
Hizmet, belirli bir kapsam için bir dizi yanıt alır. Kapsam, belirli bir dil ve kişiselleştirme profili kimliğine sahip bir veri kaynakları koleksiyonu veya eGain KB Portalı'dır. |
eGain R21 için KB arama sonucunu döndürür
Yalnızca 21.x.x.x sürümünde eGain yüklemesi için kullanılabilir
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Portal Kimliği
|
portalId | True | string |
Portal tanımlayıcısı |
|
Query
|
q | True | string |
Arama sorgusu dizesi |
|
Language
|
$lang | True | string |
Arama için dil kodu |
|
Özellik
|
$attribute | string |
Arama sonuçları için öznitelik filtresi |
|
|
Sayfa Numarası
|
$pagenum | integer |
Sayfalandırma için sayfa numarası |
|
|
Sayfa Boyutu
|
$pagesize | integer |
Sayfa başına sonuç sayısı |
|
|
Kimlik Doğrulama Belirteci
|
authToken | True | string |
API erişimi için kimlik doğrulama belirteci |
|
Temel URL
|
baseUrl | True | string |
KM portalı için temel URL |
|
Kısa Ad
|
shortName | True | string |
KM portalı için kullanılan kısa ad |
|
Dili Kabul Et
|
Accept-language | True | string |
üst bilgi değerini Accept-Language |
|
Kabul etmek
|
Accept | True | string |
Üst bilgi değerini kabul et |
Kullanıcı sorgusu için en iyi arama sonuçlarını alma
Kullanıcı sorgusu için en iyi arama sonuçlarını alın. 21.x.x.x sürümü için geçerli değildir
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Portal Kimliği
|
portalId | True | string |
Portal tanımlayıcısı |
|
Dil Kodu
|
languageCode | True | string |
Arama için dil kodu |
|
Query
|
q | True | string |
Arama sorgusu dizesi |
|
Kişiselleştirme Profili Kimliği
|
personalizationProfileId | integer |
Kişiselleştirme profili tanımlayıcısı |
|
|
Kimlik Doğrulama Belirteci
|
authToken | True | string |
Yetkilendirme üst bilgisi olarak geçirilir |
|
Temel URL
|
baseUrl | True | string |
Bu, km portalının temel URL'sidir |
|
Kısa Ad
|
shortName | True | string |
KM portalının Kısa Adı |
|
Kabul etmek
|
Accept | string |
Üst bilgi değerini kabul et |
Veri kaynakları ve KB Portalı ile belirli bir kapsamın yanıtlarını alır
Hizmet, belirli bir kapsam için bir dizi yanıt alır. Kapsam, belirli bir dil ve kişiselleştirme profili kimliğine sahip bir veri kaynakları koleksiyonu veya eGain KB Portalı'dır.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Query
|
q | True | string |
Soru veya arama terimi |
|
Departman Kimliği
|
departmentId | integer |
Departman tanımlayıcısı |
|
|
Kullanıcı kimliği
|
userId | integer |
Kullanıcı tanımlayıcısı |
|
|
Portal Kimliği
|
portalId | True | integer |
Sonuçlar verilen KM portalından alınır |
|
Dil Kodu
|
languageCode | True | string |
Arama için dil kodu |
|
Kişiselleştirme Profili Kimliği
|
personalizationProfileId | integer |
Kişiselleştirme profili tanımlayıcısı |
|
|
Kimlik Doğrulama Belirteci
|
authToken | True | string |
eGain API'sine yetkilendirme için kullanılır |
|
Temel URL
|
baseUrl | True | string |
KM portalı için temel URL |
|
Kısa Ad
|
shortName | True | string |
KM portalı için kullanılan kısa ad |
|
Kabul etmek
|
Accept | string |
Üst bilgi değerini kabul et |