Sobre a pesquisa agrupada do Zendesk

A pesquisa agrupada na central de ajuda permite que os usuários finais vejam conteúdo externo nos resultados da pesquisa de sua central de ajuda. Isso significa que, quando um usuário final fizer uma pesquisa em sua central de ajuda, os resultados de pesquisa não ficam limitados apenas aos artigos dela e às publicações da comunidade. A pesquisa agrupada pode estender sua pesquisa para, por exemplo, bases de conhecimento externas, software de gerenciamento de aprendizagem, blogs e páginas de seu website. Seus usuários finais também podem filtrar a pesquisa por tipo (ex.: por publicações do blog).

Você pode usar qualquer método a seguir para implementar a pesquisa agrupada em sua central de ajuda:

• A API de pesquisa agrupada – a REST API que permite incorporar registros de conteúdo externo aos índices de pesquisa do Zendesk. Os desenvolvedores devem criar e manter uma camada de middleware para integrar o site que hospeda o conteúdo externo à central de ajuda.
• Rastreador de pesquisa – pode ser definido nas Configurações de pesquisa do Guide e permite a implementação da pesquisa agrupada na central de ajuda sem recursos de desenvolvedor. É possível definir vários rastreadores nas configurações de pesquisa da central de ajuda para monitoramento e indexação de conteúdos diversos no mesmo website ou em websites diferentes.

Você pode usar a API e o rastreador de forma simultânea. No entanto, se você apagar uma origem ou tipo pela API, o rastreador que estiver criando ou atualizando registros para a origem ou o tipo apagados vai parar de funcionar.

Este artigo abrange os seguintes tópicos:

• Como o rastreador de pesquisa funciona
• Como funciona a API de pesquisa agrupada
• Origens e tipos de conteúdo externo
• Limitações conhecidas da pesquisa agrupada

Como o rastreador de pesquisa funciona

Você pode configurar um ou mais rastreadores de pesquisa para rastrear e indexar conteúdo externo que você deseja disponibilizar para os usuários que fazem pesquisa em sua central de ajuda. Para rastrear sites externos, eles devem ter um mapa do site que lista as páginas para o rastreador de pesquisa. Depois de configurados, os rastreadores funcionam a cada 12-24 horas, visitando as páginas do mapa do site especificadas durante a configuração e incorporando o conteúdo dessas origens aos índices de pesquisa da central de ajuda.

Os rastreadores de pesquisa indexam conteúdo da origem da página, no carregamento inicial, mesmo se ele estiver oculto por um elemento da interface de usuário, como um acordeão. No entanto, como rastreadores não executam JavaScript, eles não rastreiam conteúdo renderizado por JavaScript ou renderizado de forma dinâmica após o carregamento da página inicial. Os rastreadores também não rastreiam links das páginas visitadas; eles apenas visitam as páginas do mapa do site que foram configurados para usar.

Você pode configurar vários rastreadores para indexação e rastreamento de conteúdos diferentes no mesmo website ou em websites diferentes. Consulte Configuração do rastreador de pesquisa.

Quando os usuários fazem uma pesquisa, o conteúdo externo descoberto pelo rastreador é classificado e exibido na página de resultados da pesquisa, onde os usuários conseguem filtrar os resultados e clicar nos links para visualizar o conteúdo externo em outra aba do navegador. Para obter mais informações, consulte o Guia da central de ajuda para usuários finais.

Observação: você é responsável por usar o rastreador de pesquisa da central de ajuda de acordo com as leis, os termos e as condições aplicáveis dos websites. Você só deve adicionar mapas do site onde você detiver o domínio associado a tais mapas. Ao usar o rastreador de pesquisa da central de ajuda, você confirma que detém os domínios de todos os mapas do site adicionados ao rastreador e que tem o direito de rastrear tais websites.

Como funciona a API de pesquisa agrupada

O Zendesk fornece uma REST API para que os desenvolvedores criem integrações personalizadas para incorporação de registros de conteúdo externo aos índices de pesquisa da central de ajuda. Para incorporar o conteúdo externo à pesquisa, os desenvolvedores devem integrar o aplicativo que hospeda o conteúdo externo com a API do conteúdo externo.

Depois de configurada, a API incorpora os registros do conteúdo externo e os adiciona nos índices de pesquisa da central de ajuda. Registros indexados podem ser disponibilizados para o mecanismo de pesquisa da central de ajuda ao responder às consultas de pesquisa do usuário.

Para obter mais informações, consulte Configuração da API de pesquisa agrupada do Zendesk para conteúdo externo

Origens e tipos de conteúdo externo

Independentemente do método de configuração usado, cada registro de conteúdo incorporado por pesquisa agrupada fica associado a uma origem e a um tipo de conteúdo, que os usuários finais usam para filtrar os resultados da pesquisa. Consulte Edição de filtros de pesquisa.

Você pode definir origens e tipos usando a API de pesquisa agrupada ou ao configurar o rastreador de pesquisa no Guide. Se você definir origens e tipos pela API, eles poderão ser selecionados durante a configuração do rastreador de pesquisa. Da mesma forma, se você criar uma origem e um tipo de conteúdo ao configurar o rastreador de pesquisa, eles serão refletidos nas APIs external_content_type e external_content_source. Consulte Referência da API Federated Search do Zendesk.

Você pode configurar seus resultados de pesquisa para que eles incluam ou não origens de conteúdo externas. Quando o conteúdo externo é incluído na pesquisa da central de ajuda, os filtros de pesquisa agrupam conteúdo por nomes de origem e tipo, o que facilita para os usuários encontrarem a informação que procuram. A "origem" agrupa o conteúdo por ponto de origem (ex.: blog) e o "tipo" agrupa o conteúdo pela categoria do conteúdo em si (por exemplo, documentação para desenvolvedores).

Use agrupamentos e nomes práticos para origens e tipos de conteúdo externo ao criá-los, pois isso ajuda os usuários finais a filtrarem e localizarem com facilidade o conteúdo que procuram em sua central de ajuda. Consulte Edição de filtros de pesquisa.

Limitações conhecidas da pesquisa agrupada

No momento, apresentamos as seguintes limitações conhecidas da pesquisa agrupada:

• Os resultados da pesquisa de conteúdo externo são exibidos nas pesquisas da central de ajuda, na seção de conhecimento do painel de contexto e nas respostas da API de pesquisa unificada. Eles não são exibidos em outras interfaces do Guide que utilizam pesquisa, como a pesquisa instantânea e a API de pesquisa de artigos.