Zendesk 연계 검색에 대한 정보

헬프 센터 연계 검색을 사용하면 최종 사용자들이 헬프 센터 외부에 있는 헬프 센터 검색 결과의 콘텐츠를 볼 수 있습니다. 즉, 최종 사용자가 헬프 센터에서 검색할 때 검색 결과가 헬프 센터 문서 또는 커뮤니티 게시물에만 국한되지 않습니다. 연계 검색은 예를 들어 외부 지식창고, 학습 관리 소프트웨어, 블로그 및 웹사이트의 페이지까지 검색 범위를 확장할 수 있습니다. 최종 사용자는 유형별(예: 블로그 게시물별)로 검색을 필터링할 수도 있습니다.

다음 방법 중 하나를 사용하여 헬프 센터에서 연계 검색을 구현할 수 있습니다.

• 연계 검색 API - 외부 콘텐츠의 레코드를 Zendesk 검색 인덱스에 수집할 수 있는 REST API. 이 방법을 사용하려면 개발자가 외부 콘텐츠를 호스팅하는 사이트를 헬프 센터와 연동하기 위해 미들웨어 레이어를 빌드하여 유지 관리해야 합니다.
• 검색 크롤러 - Guide의 검색 설정에서 구성할 수 있는 검색 크롤러를 사용하면 개발자 리소스 없이도 헬프 센터에서 연계 검색을 구현할 수 있습니다. 헬프 센터 검색 설정에서 여러 크롤러를 설정하여 같은 웹사이트나 다른 웹사이트의 서로 다른 콘텐츠를 크롤링하고 인덱싱할 수 있습니다.

API와 크롤러를 동시에 사용할 수 있습니다. 하지만 API를 통해 소스나 유형을 삭제하면 삭제된 소스나 유형의 레코드를 만들거나 업데이트하는 모든 크롤러가 작동을 중지합니다.

이 문서에서 다루는 주제는 다음과 같습니다.

• 검색 크롤러 작동 방식
• 연계 검색 API 작동 방식
• 외부 콘텐츠 소스 및 유형
• 연계 검색의 알려진 제한

검색 크롤러 작동 방식

하나 이상의 검색 크롤러를 설정하여 헬프 센터에서 검색을 수행하는 사용자들에게 제공하려는 외부 콘텐츠를 크롤링하고 인덱싱할 수 있습니다. 크롤링하려는 외부 사이트에 검색 크롤러를 위한 페이지를 나열하는 사이트맵이 있어야 합니다. 또한 크롤링하려는 페이지가 인증되지 않는 공개 페이지여야 합니다. 인증된 콘텐츠를 헬프 센터 검색에 추가하려면 외부 콘텐츠 API를 사용해야 합니다.

크롤러가 구성되면 12~24시간마다 한 번씩 실행되어 설정 중 지정한 사이트맵의 페이지를 방문하여 그러한 소스의 콘텐츠를 헬프 센터 검색 인덱스에 수집합니다. 검색 크롤러는 아코디언 등 UI 요소에 의해 콘텐츠가 숨겨져 있더라도 초기 페이지 로드 시 페이지 소스에 있는 콘텐츠를 인덱싱합니다. 단, 크롤러는 JavaScript를 실행하지 않으므로 JavaScript로 렌더링되는 콘텐츠 또는 초기 페이지 로드 후 동적으로 렌더링되는 기타 콘텐츠를 크롤링하지 않습니다. 또한 크롤러는 방문하는 페이지의 링크를 크롤링하지 않고 사용하도록 구성된 사이트맵의 페이지만 방문합니다.

여러 크롤러를 설정하여 같은 웹사이트나 다른 웹사이트의 서로 다른 콘텐츠를 크롤링하고 인덱싱할 수 있습니다. 검색 크롤러 설정하기를 참조하세요.

사용자가 검색을 수행할 때 크롤러가 발견하는 관련 외부 콘텐츠에 순위가 매겨져 검색 결과 페이지에 제시됩니다. 여기에서 사용자는 결과를 필터링하고 링크를 클릭하여 다른 브라우저 탭에서 외부 콘텐츠 링크를 볼 수 있습니다. 필터에 대한 자세한 내용은 최종 사용자를 위한 헬프 센터 가이드를 참조하세요.

참고: 모든 관련 법규 및 관련 웹사이트의 이용 약관을 준수하여 헬프 센터 검색 크롤러를 사용해야 합니다. 그러한 사이트맵과 연결된 도메인을 소유하는 사이트맵만 추가해야 합니다. 헬프 센터 검색 크롤러를 사용하면 크롤러에 추가된 모든 사이트맵에 대한 도메인을 소유하며 그러한 웹사이트를 크롤링할 수 있는 권한이 있음을 확인하는 것입니다.

연계 검색 API 작동 방식

Zendesk는 개발자가 외부 콘텐츠 레코드를 헬프 센터 검색 인덱스에 수집하기 위해 사용자 지정 연동 서비스를 빌드할 수 있는 REST API를 제공합니다. 검색을 위한 외부 콘텐츠를 수집하려면 개발자가 외부 콘텐츠를 호스팅하는 애플리케이션을 외부 콘텐츠 API와 통합해야 합니다.

API가 구성된 후에는 외부 콘텐츠 레코드를 수집하여 헬프 센터 검색 인덱스에 추가합니다. 그러면 사용자 검색 쿼리에 응답할 때 헬프 센터 검색 엔진에서 인덱싱된 레코드를 사용할 수 있습니다.

자세한 내용은 Zendesk 연계 검색 외부 콘텐츠 API 설정하기를 참조하세요.

외부 콘텐츠 소스 및 유형

사용하는 설정 방법에 관계없이 연계 검색으로 수집되는 각 콘텐츠 레코드는 최종 사용자가 검색 결과를 필터링하는 데 사용되는 콘텐츠 소스 및 콘텐츠 유형과 연결됩니다. 검색 필터 편집을 참조하세요.

연계 검색 API를 사용하거나 Guide에서 검색 크롤러를 설정할 때 소스와 유형을 정의할 수 있습니다. API를 사용하여 소스와 유형을 정의하면 검색 크롤러 설정 중에 그러한 소스와 유형을 선택할 수 있습니다. 마찬가지로 검색 크롤러를 설정할 때 콘텐츠 소스와 유형을 만들면 external_content_type 및 external_content_source API에 반영됩니다. Zendesk 연계 검색 API 참고자료를 참조하세요.

외부 콘텐츠 소스를 포함하거나 제외하도록 검색 결과를 구성할 수 있습니다. 헬프 센터 검색에 외부 콘텐츠가 포함되면 검색 필터가 소스 및 유형 이름별로 콘텐츠를 그룹화하여 사용자들이 원하는 정보를 더 쉽게 찾을 수 있도록 합니다. “소스”는 출처(예를 들어 블로그)별로 콘텐츠를 그룹화하고 “유형”은 콘텐츠 종류(예를 들어 개발자 문서)별로 콘텐츠를 그룹화합니다.

소스와 유형을 만들 때 외부 콘텐츠 소스 및 유형에 대한 유용한 그룹화와 이름을 고려하세요. 최종 사용자들이 헬프 센터에서 검색하는 콘텐츠를 쉽게 필터링하여 찾는 데 도움이 됩니다. 검색 필터 편집을 참조하세요.

연계 검색의 알려진 제한

현재 연계 검색에 대해 알려진 모든 제한 사항은 다음과 같습니다.

• 외부 콘텐츠 검색 결과는 헬프 센터 검색, 컨텍스트 패널의 지식 섹션 및 통합 검색 API 응답에 나타납니다. 바로 검색이나 Article Search API와 같은 다른 Guide 검색 기반 인터페이스에는 나타나지 않습니다.