Filtrar a pesquisa do site

Nesta página, explicamos como filtrar consultas de pesquisa para um app de pesquisa com dados do site.

Antes de começar

Confira se você criou um app e um repositório de dados e se ingeriu dados do site no repositório. Para mais informações, consulte Criar um app de pesquisa.

Sobre as expressões de filtro

Use expressões de filtro para criar filtros de pesquisa do site. A forma de criar filtros varia dependendo se você ativou a indexação avançada de sites. Consulte uma das seções a seguir, dependendo se você tem a pesquisa básica ou a indexação avançada de sites:

Expressões de filtro para pesquisa básica no site

Esta seção explica o comportamento das expressões de filtro com a pesquisa básica de sites (a indexação avançada de sites está desativada).

Sintaxe para pesquisa básica no site

O Extended Backus–Naur form (em inglês) a seguir resume a sintaxe da expressão de filtro para criar um filtro de pesquisa de site quando você tem a pesquisa básica de site. As aspas duplas depois dos dois-pontos em um filtro são aplicadas de forma estrita.

    # A single expression or multiple expressions that are joined by "AND".
  filter = expression, { "AND", expression };
  expression =
    # A simple expression applying to a text url string.
    | filter_key, ":", \"text_value\"
  filter_key = (cr | highRange | lowRange | fileType | lr | rights | siteSearch);
  text_value = string value to filter on;

Campos disponíveis para a pesquisa básica no site

Estes são os campos disponíveis para filtrar a pesquisa no site quando você tem a pesquisa básica:

  • cr (string) Restringe os resultados da pesquisa a documentos de um país específico. Para uma lista de valores compatíveis, consulte Valores de coleção de países.

  • highRange (string) Especifica o limite superior do intervalo de pesquisa. Se um documento contiver um número, ele precisará ser igual ou menor que o valor de highRange para ser incluído na resposta. Especifique highRange e lowRange para criar uma consulta de pesquisa dentro do intervalo desses parâmetros.

  • lowRange (string) Especifica o limite inferior do intervalo de pesquisa. Se um documento contiver um número, ele precisará ser igual ou maior que o valor de lowRange para ser incluído na resposta. Especifique lowRange e highRange para criar uma consulta de pesquisa dentro do intervalo desses parâmetros.

  • fileType (string): restringe os resultados da pesquisa a documentos com uma extensão especificada. Para uma lista de tipos de arquivo compatíveis, consulte Tipos de arquivo indexáveis pelo Google.

  • lr (string): restringe os resultados da pesquisa a documentos escritos em um idioma especificado. Para uma lista de idiomas compatíveis, consulte Parâmetros de consulta (lr).

  • rights (string) Filtra os resultados da pesquisa com base no licenciamento. Para valores aceitos, consulte Parâmetros de consulta (direitos).

  • siteSearch (string) Especifica um padrão de URL para as páginas da Web em que sua consulta deve pesquisar.

Exemplos de pesquisa básica no site

Confira alguns exemplos de filtros para pesquisa básica de sites:

  • {"filter": "cr:\"countryUS\" AND siteSearch:\"https://example.com/example_domain\""}

    Filtra documentos que são: (1) dos EUA e (2) do domínio https://example.com/example_domain.

  • {"filter": "fileType:\".pdf\" AND lr:\"lang_en\""}

    Filtra documentos que são: (1) arquivos PDF e (2) em inglês.

  • {"filter": "rights:\"cc_publicdomain\""}

    Filtra documentos que estão em domínio público.

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

Esta seção explica o comportamento da expressão de filtro com a indexação avançada de sites (que está ativada).

Campos disponíveis para indexação avançada de sites

Com a indexação avançada de sites, é possível filtrar a pesquisa no seu site usando estes campos:

  • siteSearch (string): um padrão de URL para as páginas da Web em que sua consulta deve pesquisar.
  • Nomes de tag meta e de atributos do PageMap: dados estruturados das suas páginas da Web que podem ser adicionados ao esquema do repositório de dados para tornar os campos pesquisáveis, recuperáveis e indexáveis. Para mais informações, consulte Usar dados estruturados para indexação avançada de sites.

Sintaxe para indexação avançada de sites

O Extended Backus–Naur form (em inglês) a seguir resume a sintaxe de expressão de filtro para criar um filtro de pesquisa de site quando você tem indexação avançada de sites. As aspas duplas depois dos dois-pontos em um filtro são aplicadas de forma estrita.

Ao filtrar por siteSearch, a sintaxe EBNF é:

    # A single expression or multiple expressions that are joined by "OR".
  filter = expression, { "OR", expression };
    # Expressions can be prefixed with "-" or "NOT" to express a negation.
  expression = [ "-" | "NOT " ],
    # A simple expression applying to a text url string.
    | filter_key, ":", \"url_string\"
  filter_key = siteSearch;
  url_string = double quoted string representing a URL;

Ao filtrar nomes de tags meta e de atributos PageMap, a sintaxe EBNF é:

    # A single expression or multiple expressions that are joined by "OR".
  filter = expression, { "OR", expression };
    # Expressions can be prefixed with "-" or "NOT" to express a negation.
  expression = [ "-" | "NOT " ],
   # Function "ANY" returns true if the field exactly matches any of the literals.
    | text_field, ":", "ANY", "(", literal, { ",", literal }, ")"
  literal = double quoted string;
  # text_field corresponds to the meta tag or PageMap Attribute name, for example, category
  text_field = text field;

Exemplos de indexação avançada de sites

Confira alguns exemplos de filtros para indexação avançada de sites com siteSearch:

  • {"filter": "siteSearch:\"https://example.com/example_domain\""}

    Filtra documentos que estão no domínio https://example.com/example_domain. Por exemplo, https://example.com/example_domain/index.html.

  • {"filter": "siteSearch:\"https://example.com/subdomains/*\""}

    Filtra documentos que estão em qualquer domínio correspondente a https://example.com/subdomains/*. Por exemplo, https://example.com/subdomains/example_subdomain_page.

  • {"filter": "siteSearch:\"https://altostrat.com/subdomain/pages/*\" OR siteSearch:\"http://cymbalgroup.com/pages/*\""}

    Filtra documentos que estão em qualquer domínio que corresponda ao primeiro ou segundo padrão de URL. Por exemplo, https://altostrat.com/subdomain/pages/title_page, https://cymbalgroup.com/subdomain/pages/title_page ou https://altostrat.com/subdomain/pages/INFO.

Confira alguns exemplos de filtragem por meta ou nome do atributo PageMap:

  • {"filter": "product: ANY(\"networking\",\"compute\")"}

    Filtra documentos que contêm a tag meta ou o atributo PageMap chamado product, com o valor networking ou compute.

  • {"filter": "NOT product: ANY(\"storage\")"}

    Filtra documentos que não contêm a tag meta ou o nome do atributo PageMap product com o valor storage.

Para mais informações sobre nomes de tags meta e nomes de atributos PageMap usados para indexação, consulte Exemplo de caso de uso para tags meta e Exemplo de caso de uso para PageMaps.

Para filtrar uma pesquisa de site, 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 uma pesquisa de site, use o campo filter 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/v1/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",
"filter": "FILTER"
}'

    Substitua: