다음을 통해 공유


Egain(미리 보기)

이 커넥터를 사용하면 Copilot가 eGain V3 API를 안전하게 호출하여 고객 참여 데이터에 원활한 통합을 제공할 수 있습니다. 인증, 데이터 검색 및 작업 실행을 지원하여 워크플로를 간소화하고 eGain 서비스에서 실시간 인사이트를 향상합니다.

이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.

서비스 클래스 Regions
Copilot Studio Premium 다음을 제외한 모든 Power Automate 지역 :
     - 미국 정부(GCC)
     - 미국 정부(GCC High)
     - 21Vianet에서 운영하는 중국 클라우드
     - 미국 국방부(DoD)
논리 앱 스탠다드 다음을 제외한 모든 Logic Apps 지역 :
     - Azure Government 지역
     - Azure 중국 지역
     - 미국 국방부(DoD)
Power Apps Premium 다음을 제외한 모든 Power Apps 지역 :
     - 미국 정부(GCC)
     - 미국 정부(GCC High)
     - 21Vianet에서 운영하는 중국 클라우드
     - 미국 국방부(DoD)
Power Automate (파워 오토메이트) Premium 다음을 제외한 모든 Power Automate 지역 :
     - 미국 정부(GCC)
     - 미국 정부(GCC High)
     - 21Vianet에서 운영하는 중국 클라우드
     - 미국 국방부(DoD)
연락처
이름 eGain 지원
전자 메일 support@egain.com
커넥터 메타데이터
게시자 eGain Corporation
웹 사이트 http://egain.com/
개인 정보 보호 정책 https://www.egain.com/privacy-policies
카테고리 AI; 금융
출처 시장
BrandColor #FEF0FD

Egain - Copilot 에이전트 사용 가이드

개요

Egain 커넥터는 Microsoft Copilot Studio 에이전트와 원활하게 통합되도록 설계되었으며, 두 개의 고유한 eGain 인스턴스를 통해 강력한 지식 관리 기능을 제공합니다. 이 커넥터를 사용하면 에이전트가 기술 자료를 검색하고, AI 기반 응답을 생성하며, 자동 URL 생성을 통해 정확한 인용을 제공할 수 있습니다.

필수 조건

Egain 커넥터를 사용하기 전에 다음 필수 구성 요소가 있는지 확인합니다.

  1. eGain 인스턴스 요구 사항: EGain 인스턴스가 Rigel 또는 R21.x.x 버전 이상에서 실행되고 있어야 합니다.

  2. 클라이언트 애플리케이션 구성: 사용하려는 작업에 대한 적절한 권한이 있는 클라이언트 애플리케이션을 eGain 인스턴스에 만들어야 합니다. 클라이언트 애플리케이션에는 다음이 있어야 합니다.

    • 기술 자료 검색 작업에 대한 포털 권한
    • 생성 AI 작업에 대한 AI 권한

    클라이언트 애플리케이션을 만들고 구성하는 방법에 대한 자세한 내용은 eGain 클라이언트 애플리케이션 설명서를 참조하세요.

  3. 지식 포털 설정: 콘텐츠 검색 및 검색을 사용하도록 설정하려면 eGain 인스턴스에서 기술 포털을 미리 구성해야 합니다. 포털은 기술 자료 작업 및 콘텐츠 관리의 기초 역할을 합니다.

    기술 포털 설정에 대한 자세한 내용은 eGain Portals 설명서를 참조하세요.

에이전트 구성

1. eGain 데모 에이전트

  • API 호스트: api.egain.cloud
  • 인스턴스 URL: https://egainr21demo.egain.cloud
  • 인증: 전달자 토큰 인증을 사용하여 사용하도록 설정된 보안
  • 사용자 지정 항목:
    • eGain Search: 작업 사용 Kb-search
    • 생성: 작업 사용 Generative-V3

2. eGain Connector Assistant

  • API 호스트: api.ai.egain.cloud
  • 인스턴스 URL: https://ai.egain.cloud/s5fa
  • 인증: 전달자 토큰 인증을 사용하여 사용하도록 설정된 보안
  • 사용자 지정 항목:
    • 생성: 작업 사용 Generative-V3
    • eGainSearch: 작업 사용 Search-V3

보안 및 인증

중요: Egain 커넥터 자체에는 인증 구성이 필요하지 않습니다. 그러나 eGain API는 보호되며 Copilot Studio 에이전트의 보안 탭에 구성된 일반 OAuth 2.0 인증을 지원합니다.

두 eGain 인스턴스 모두 보안을 사용하도록 설정하여 모든 API 호출이 제대로 인증되도록 합니다. 커넥터는 다음을 자동으로 처리합니다.

  • OAuth 2.0 지원: Copilot Studio 보안 탭에 구성된 일반 OAuth 2.0 인증
  • 전달자 토큰 인증: 없는 경우 자동으로 접두사를 추가합니다 Bearer .
  • 헤더 관리: 권한 부여 헤더를 올바르게 관리합니다.
  • 매개 변수 삭제: eGain API로 전달하기 전에 인증 매개 변수를 제거합니다.
  • 오류 처리: 인증 실패의 정상적인 처리

작업 및 사용량

작업 1: Search-V3

사용: eGain Connector Assistant(eGainSearch 항목)

목적: 향상된 결과 처리 및 자동 인용 URL 생성과 함께 eGain의 V3 검색 API를 사용한 고급 검색

구성:

  • API 호스트: api.ai.egain.cloud
  • 엔드포인트:/search/v3
  • 메서드: POST

샘플 요청:

{
  "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 구성:

$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

샘플 응답:

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

사용: eGain 데모 에이전트(eGain Search 항목)

목적: 향상된 메타데이터 처리 및 자동 URL 생성을 사용하여 기술 자료 문서를 검색합니다.

구성:

  • API 호스트: api.egain.cloud
  • 엔드포인트:/search/kb
  • 메서드: POST

샘플 요청:

{
  "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 구성:

$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

샘플 응답:

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

작업 3: Generative-V3

사용: 두 에이전트(생성 항목)

목적: 지능형 인용 관리, 중복 검색 및 구성 가능한 필터링을 사용하여 AI 기반 응답 생성

구성:

  • eGain 데모 에이전트: api.egain.cloud
  • eGain 커넥터 도우미: api.ai.egain.cloud
  • 엔드포인트:/generative/v3
  • 메서드: POST

샘플 요청:

{
  "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 구성:

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

샘플 응답:

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

에이전트 설정 및 구성

eGain 데모 에이전트 설정

  1. 사용자 지정 커넥터 만들기:

    • OpenAPI 정의 가져오기
    • API 호스트를 로 설정 api.egain.cloud
    • 전달자 토큰을 사용하여 인증 구성
  2. 사용자 지정 토픽 구성:

    • eGain 검색 항목: 작업에 매핑 Kb-search
    • 생성 항목: 작업에 매핑 Generative-V3
  3. 인증 설정:

    • eGain Demo 인스턴스에서 전달자 토큰 가져오기
    • 커넥터 인증 설정에서 구성
    • 배포하기 전에 연결 테스트

eGain 커넥터 도우미 설정

  1. 사용자 지정 커넥터 만들기:

    • OpenAPI 정의 가져오기
    • API 호스트를 로 설정 api.ai.egain.cloud
    • 전달자 토큰을 사용하여 인증 구성
  2. 사용자 지정 토픽 구성:

    • eGainSearch 항목: 작업에 매핑 Search-V3
    • 생성 항목: 작업에 매핑 Generative-V3
  3. 인증 설정:

    • eGain Connector Assistant 인스턴스에서 전달자 토큰 가져오기
    • 커넥터 인증 설정에서 구성
    • 배포하기 전에 연결 테스트

코필로트 에이전트에 대한 모범 사례

1. 토픽 디자인

  • 의도 인식 지우기: 각 작업을 사용하는 시기를 명확하게 식별하는 디자인 항목
  • 컨텍스트 인식: 대화 컨텍스트를 사용하여 적절한 검색 매개 변수 확인
  • 대체 처리: 결과를 찾을 수 없는 경우 대체 응답 구현

2. 응답 처리

  • 인용 통합: 풍부한 응답에 대한 자동 URL 생성 활용
  • 콘텐츠 서식: 일관된 프레젠테이션을 위해 구조화된 응답 형식 사용
  • 오류 처리: API 오류에 대한 정상적인 오류 처리 구현

3. 보안 고려 사항

  • 토큰 관리: 보안 토큰 스토리지 및 회전 구현
  • 액세스 제어: 다른 사용자 역할에 대한 적절한 액세스 제어 확인
  • 감사 로깅: 보안 모니터링을 위한 로그 API 호출

4. 성능 최적화

  • 캐싱: 자주 액세스하는 콘텐츠에 적절한 캐싱 구현
  • 속도 제한: eGain API 속도 제한 준수
  • 응답 필터링: minScore 및 maxReferences 매개 변수를 효과적으로 사용

Troubleshooting

일반적인 문제

인증 오류:

  • 전달자 토큰이 유효하고 만료되지 않았는지 확인
  • API 호스트 구성이 의도한 eGain 인스턴스와 일치하는지 확인
  • 커넥터 설정에서 적절한 토큰 형식 확인

빈 결과:

  • 검색 쿼리가 충분히 구체적인지 확인
  • 기술 자료에 콘텐츠가 있는지 확인
  • 생성 응답에 대한 minScore 설정 검토

URL 생성 문제:

  • baseUrl 및 shortName 매개 변수가 올바르게 구성되었는지 확인
  • eGain 인스턴스 URL에 액세스할 수 있는지 확인
  • 아티클 이름에서 특수 문자 확인

디버깅 단계

  1. 개별 작업 테스트: Power Automate를 사용하여 각 작업을 개별적으로 테스트
  2. 응답 형식 확인: 응답 구조가 예상 스키마와 일치하는지 확인
  3. 인증 유효성 검사: 토큰이 제대로 구성되었는지 확인
  4. 로그 검토: 커넥터 실행 로그에서 자세한 오류 정보를 확인합니다.

고급 기능

중복 검색

커넥터는 참조 ID 및 이름 조합에 따라 중복 인용을 자동으로 제거하여 생성 응답에서 참조 목록을 정리합니다.

Score-Based 필터링

응답 품질 및 길이를 제어하도록 최소 점수 임계값 및 최대 참조 수를 구성합니다.

  • minScore: 관련성이 낮은 인용 필터링(기본값: 0.01)
  • maxReferences: 참조 수 제한(기본값: 10)

URL 사용자 지정

baseUrl 및 shortName 매개 변수를 사용하여 사용자 지정 URL 생성을 지원합니다.

  • baseUrl: eGain 인스턴스 기본 URL
  • shortName: 콘텐츠 액세스에 대한 URL 경로 세그먼트

지원 및 유지 관리

정기 유지 관리

  • 토큰 회전: 정기적으로 인증 토큰 업데이트
  • API 모니터링: API 사용량 및 성능 모니터링
  • 콘텐츠 업데이트: 기술 자료 콘텐츠를 최신 상태로 유지

지원 리소스

  • eGain 설명서: eGain의 공식 API 설명서를 참조하세요.
  • Microsoft Copilot Studio: Microsoft의 커넥터 문제 해결 가이드 사용
  • 커뮤니티 지원: Microsoft Power Platform 커뮤니티 리소스 활용

버전 기록

  • v1.0.0: Search-V3, Kb-search 및 Generative-V3 작업을 사용한 초기 릴리스
  • 자동 인용 연결 및 중복 검색 추가
  • 구성 가능한 점수 필터링 및 참조 제한 구현
  • 적절한 인증 처리로 보안 강화

이 설명서는 개발자와 관리자가 Microsoft Copilot Studio 에이전트에서 Egain 커넥터를 효과적으로 구현하고 유지 관리할 수 있도록 설계되었습니다.

연결을 만드는 중

커넥터는 다음 인증 유형을 지원합니다.

기본값 연결을 만들기 위한 매개 변수입니다. 모든 지역 공유할 수 없음

기본값

적용 가능: 모든 지역

연결을 만들기 위한 매개 변수입니다.

공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.

이름 유형 Description 필수
eGain API 호스트 문자열 인스턴스 유형에 따른 eGain API 도메인 진실

제한 한도

Name 호출 갱신 기간
연결당 API 호출 100 60초

동작

eGain R21에 대한 KB 검색 결과를 반환합니다.

릴리스 21.x.x.x에서 eGain 설치에만 사용할 수 있습니다.

데이터 원본 및 KB 포털을 사용하여 지정된 범위에 대한 답변을 검색합니다.

서비스는 지정된 범위에 대한 답변 집합을 검색합니다. 범위는 특정 언어 및 개인 설정 프로필 ID가 있는 데이터 원본 또는 eGain KB 포털의 컬렉션입니다.

사용자 쿼리에 대한 최상의 검색 결과 가져오기

사용자 쿼리에 대한 최상의 검색 결과를 가져옵니다. 릴리스 21.x.x.x에는 적용되지 않습니다.

eGain R21에 대한 KB 검색 결과를 반환합니다.

릴리스 21.x.x.x에서 eGain 설치에만 사용할 수 있습니다.

매개 변수

Name 필수 형식 Description
포털 ID
portalId True string

포털 식별자

Query
q True string

쿼리 문자열 검색

Language
$lang True string

검색에 대한 언어 코드

특성
$attribute string

검색 결과에 대한 특성 필터

페이지 번호
$pagenum integer

페이지 매김 페이지 번호

페이지 크기
$pagesize integer

페이지당 결과 수

인증 토큰
authToken True string

API 액세스에 대한 인증 토큰

기본 URL
baseUrl True string

KM 포털의 기본 URL

짧은 이름
shortName True string

KM 포털에 사용되는 짧은 이름

언어 수락
Accept-language True string

Accept-Language 헤더 값

수락
Accept True string

헤더 값 수락

데이터 원본 및 KB 포털을 사용하여 지정된 범위에 대한 답변을 검색합니다.

서비스는 지정된 범위에 대한 답변 집합을 검색합니다. 범위는 특정 언어 및 개인 설정 프로필 ID가 있는 데이터 원본 또는 eGain KB 포털의 컬렉션입니다.

매개 변수

Name 필수 형식 Description
Query
q True string

질문 또는 검색어

부서 ID
departmentId integer

부서 식별자

사용자 ID
userId integer

사용자 ID

포털 ID
portalId True integer

지정된 KM 포털에서 결과를 검색합니다.

언어 코드
languageCode True string

검색에 대한 언어 코드

개인 설정 프로필 ID
personalizationProfileId integer

개인 설정 프로필 식별자

인증 토큰
authToken True string

eGain API 권한 부여에 사용

기본 URL
baseUrl True string

KM 포털의 기본 URL

짧은 이름
shortName True string

KM 포털에 사용되는 짧은 이름

수락
Accept string

헤더 값 수락

사용자 쿼리에 대한 최상의 검색 결과 가져오기

사용자 쿼리에 대한 최상의 검색 결과를 가져옵니다. 릴리스 21.x.x.x에는 적용되지 않습니다.

매개 변수

Name 필수 형식 Description
포털 ID
portalId True string

포털 식별자

언어 코드
languageCode True string

검색에 대한 언어 코드

Query
q True string

쿼리 문자열 검색

개인 설정 프로필 ID
personalizationProfileId integer

개인 설정 프로필 식별자

인증 토큰
authToken True string

권한 부여 헤더로 전달됩니다.

기본 URL
baseUrl True string

km 포털의 기본 URL입니다.

짧은 이름
shortName True string

KM 포털의 짧은 이름

수락
Accept string

헤더 값 수락