Filtrar pesquisas por relevância no nível do documento

Ao pesquisar no app da Vertex AI para Pesquisa, é possível aplicar um limite de relevância para que apenas os documentos que atendem a esse limite sejam retornados como resultados. Nesta página, explicamos como especificar um limiar de relevância para reduzir o número de documentos retornados em consultas.

Sobre a filtragem por relevância no nível do documento

Cada documento retornado por uma consulta de pesquisa recebe um nível de relevância, que indica a relevância do documento retornado para a consulta. Ao fazer uma consulta por uma chamada de API, é possível definir um limite de relevância. Definir um limite de relevância alto pode reduzir o número de documentos retornados por uma consulta.

Por exemplo, se você perceber que a pesquisa está retornando muitos documentos de relevância insuficiente para seus usuários, defina o limite de relevância como "alto" para restringir os resultados apenas aos mais relevantes. Se a configuração alta for muito restritiva, tente a média.

Tipos de dados e apps compatíveis com o filtro de relevância no nível do documento

O filtro de relevância no nível do documento pode ser aplicado a repositórios de dados com os seguintes tipos de dados:

• Dados de sites com indexação avançada de sites
• Dados não estruturados personalizados
• Dados estruturados personalizados

O filtro de relevância no nível do documento não funciona para repositórios de dados com indexação básica de sites, dados de mídia ou dados de saúde.

Além disso, o filtro de relevância no nível do documento não pode ser usado com apps de pesquisa combinada. Os apps de pesquisa combinada são conectados a vários repositórios de dados.

Outros tipos de filtros

O filtro de relevância no nível do documento não é a única maneira de filtrar os dados retornados pelas consultas. Você também pode usar expressões de filtro para filtrar resultados com base em metadados (na indexação avançada de sites e repositórios de dados não estruturados com metadados) e valores de campos (em repositórios de dados estruturados).

Confira mais informações em:

• Expressões de filtro com indexação avançada de sites

• Filtrar a pesquisa personalizada por dados estruturados ou não estruturados

Se você usar uma expressão de filtro e o filtro de relevância no nível do documento, a expressão será aplicada primeiro aos resultados e, em seguida, o filtro de relevância no nível do documento.

Antes de começar

Verifique se você criou um app e um repositório de dados e se ingeriu dados no repositório. Para mais informações, consulte Criar um app de pesquisa. Consulte também Tipos de dados e apps compatíveis com o filtro de relevância no nível do documento.

Pesquisar e filtrar resultados por relevância no nível do documento

Para filtrar por relevância, siga estas etapas:

1. Encontre o ID do app. Se você já tiver o ID do app, pule para a próxima etapa.

   1. No console Google Cloud , acesse a página Aplicativos de IA.

      Acessar "Apps".

   2. Na página Apps, encontre o nome do app e confira o ID dele na coluna ID.

2. Para filtrar a pesquisa por relevância no nível do documento, use o campo relevanceThreshold com o método engines.servingConfigs.search.

   curl -X POST -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
   -H "Content-Type: application/json" \
   "https://discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search:search" \
   -d '{
    "servingConfig": "projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search",
   "query": "QUERY",
   "relevanceThreshold": "RELEVANCE_THRESHOLD"
   }'
   

   Substitua:

   • PROJECT_ID: o ID do seu Google Cloud projeto.
   • APP_ID: o ID do app da Vertex AI para Pesquisa que você quer consultar.
   • QUERY: o texto da consulta a ser pesquisado.
   • RELEVANCE_THRESHOLD: um dos seguintes: HIGH, MEDIUM, LOW, LOWEST.

   Exemplo de comando e resultado

   curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)"
   -H "Content-Type: application/json" \
   "https://discoveryengine.googleapis.com/v1alpha/projects/my-project-123/locations/global/collections/default_collection/engines/my-search-app/servingConfigs/default_search:search" \
   -d '{
   "servingConfig": "projects/my-project-123/locations/global/collections/default_collection/engines/my-search-app/servingConfigs/default_search",
   "query": "What is the check grounding API",
   "relevanceThreshold": "HIGH"
   }'
   
   {
   "results": [
   {
     "id": "a082e70352c073a4443502477255bd2a",
     "document": {
       "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/branches/0/documents/a082e70352c073a4443502477255bd2a",
       "id": "a082e70352c073a4443502477255bd2a",
       "derivedStructData": {
         "displayLink": "cloud.google.com",
         "link": "https://cloud.google.com/generative-ai-app-builder/docs/check-grounding",
         "htmlTitle": "Check grounding",
         "title": "Check grounding"
       }
     }
   }
   ],
   "totalSize": 1,
   "attributionToken": "f_B-CgwIidzwswYQyue15gESJDY2N2M1NmJkLTAwMDAtMjk3Ni1iMGI4LTg4M2QyNGZmNTZhOCIHR0VORVJJQypAjr6dFavEii3b7Ygt3o-aIoCymiLC8J4Vo4CXIra3jC3Usp0V24-aIt7tiC3n7YgtrsSKLeTtiC2DspoixsvzFw",
   "guidedSearchResult": {},
   "summary": {}
   }
   

   Aqui, o limite de relevância está definido como "alto", então apenas os resultados mais relevantes são retornados. Neste exemplo, apenas um documento foi considerado altamente relevante.

3. Teste várias consultas com diferentes limites para determinar as melhores configurações de limite para seus dados e aplicativo.