Esta página foi traduzida pela API Cloud Translation.

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 atendam a esse limite sejam retornados como resultados. Esta página explica como especificar um limite de relevância para reduzir o número de documentos retornados nas 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 meio de 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ê descobrir que a pesquisa está retornando muitos documentos de relevância insuficiente para os usuários, defina o limite de relevância como alto para reduzir os resultados apenas aos mais relevantes. Se a configuração alta for muito restritiva, tente a configuração 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 armazenamentos de dados com os seguintes tipos de dados:

Dados do site com indexação avançada de sites
Dados não estruturados genéricos
Dados estruturados genéricos

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 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. Também é possível usar expressões de filtro para filtrar resultados com base em metadados (na indexação avançada de sites e em dados não estruturados com repositórios de dados de metadados) e valores de campo (em repositórios de dados estruturados).

Confira mais informações em:

Se você usar uma expressão de filtro e o filtro de relevância no nível do documento, a expressão de filtro 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 transferiu dados para o 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:

Observação:é possível pesquisar em um app usando o método engines.servingConfigs.search e em um repositório de dados usando o método dataStores.servingConfigs.search. Para o procedimento a seguir, o Google recomenda pesquisar usando o método engines.servingConfigs.search.

Encontre o ID do app. Se você já tiver o ID do app, pule para a próxima etapa.
1. No Console do Google Cloud, acesse a página Criador de agentes.
  
  Acessar "Apps".
2. Na página Apps, encontre o nome do app e confira o ID dele na coluna ID.

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

PROJECT_ID: o ID do seu projeto do Google Cloud.
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 | Vertex AI Agent Builder | Google Cloud",
      "title": "Check grounding | Vertex AI Agent Builder | Google Cloud"
    }
  }
}
],
"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.

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