Configurar as definições de campo

Nesta página, mostramos como configurar os campos do esquema para configurar um app para dados estruturados, dados não estruturados com metadados ou dados de sites com atributos personalizados e estruturados.

As configurações de campo ajudam a determinar como a Pesquisa do Agente usa os campos nos resultados. Use a guia Esquema no console doGoogle Cloud para definir as configurações de campo.

A configuração de campos está disponível apenas para apps com repositórios de dados que contêm dados estruturados ou não estruturados com metadados.

Configurações do campo

As configurações de campo a seguir estão disponíveis para muitos tipos de campo nos dados de pesquisa ou recomendações, mas não para todos os tipos de dados. Um esquema contém várias configurações de campo para campos individuais, e a próxima tabela contém configurações que podem ser aplicadas a um campo em um esquema. É altamente recomendável usar dados estruturados para estas configurações de campo:

Configuração Definição Finalidade Exemplo de caso de uso
Indexável

Definir campos como indexáveis permite operações como filtragem, otimização e atributos em campos estruturados em um documento.

Os campos do tipo Object não podem ser definidos como Indexable.

Marcar um campo como Indexable permite pesquisas mais rápidas.

Observação: marcar um campo como Indexable aumenta o tamanho do índice da Pesquisa e pode deixar a indexação mais lenta.

Em um repositório de dados de hotel, é possível definir um campo, como hotel_chain, como indexável. Isso permite aplicar operações de classificação, filtragem e otimização em hotel_chain. Por exemplo, você pode aplicar um filtro para que a pesquisa mostre apenas resultados da pesquisa que contenham a rede de hotéis filtrada.
Pesquisável

Os campos com maior probabilidade de estar relacionados a pesquisas são designados como Searchable. Um campo pode ser pesquisável sem ser indexável ou recuperável.

Somente campos com valores de texto podem ser marcados como pesquisáveis. Assim, um campo de preço numérico pode ser indexável (para filtragem ou facetas), mas não pode ser pesquisável como texto completo.

Definir um campo como Pesquisável melhora o recall desse campo em consultas de pesquisa, permitindo que os usuários encontrem conteúdo, como páginas da Web, consultando o texto nesses campos. Marcar um campo como pesquisável permite que a classificação seja aplicada. Consequentemente, marcar um número excessivo de campos como pesquisáveis pode afetar negativamente a precisão da pesquisa, saturando o algoritmo de classificação e retornando muitos resultados. Isso pode levar a resultados de pesquisa irrelevantes.

É possível aplicar uma ponderação relativa aos campos de pesquisa. No entanto, devido aos padrões robustos, isso raramente é necessário. Consulte os campos de pesquisa de peso abaixo.

O sistema de tíquetes de suporte de um provedor de acesso à Internet armazena cada tíquete como um documento estruturado. Se esses documentos tiverem campos de texto pesquisáveis, como issue_description ou resolution_notes, um agente de suporte poderá realizar uma consulta relacionada ao conteúdo desses campos, como como corrigir velocidades lentas da Internet após a redefinição do modem. O sistema vai mostrar os documentos que contêm qualquer um desses termos de pesquisa, incluindo modem, internet, velocidade, em um ou ambos os campos issue_description ou resolution_notes.

Correspondência de prefixo
(pré-lançamento)

Permite campos de texto de correspondência de prefixo usando o operador STARTS_WITH em expressões de filtro. Somente campos do tipo String ou String Array podem ser definidos como "Correspondência de prefixo".

Para mais informações, consulte Disponibilizar campos para correspondência parcial e de prefixo abaixo.

Definir um campo como correspondente de prefixo permite que o mecanismo de pesquisa corresponda a strings de consulta que são prefixos do valor do campo. Isso é particularmente útil para corresponder identificadores, caminhos ou códigos hierárquicos em que o início da string é conhecido. A correspondência de prefixo é limitada aos primeiros 12 caracteres do valor do campo normalizado e aumenta o tamanho do índice da Pesquisa. Não é possível definir mais de 10 campos como correspondentes de prefixo.

Você tem um campo, ticket_id, que usa um formato como <country-code><city-code><number>. Os exemplos incluem UKLON100, UKMAN100, UKMAN101 e USNY200. Para encontrar todos os ingressos de Manchester (Reino Unido), defina o campo ticket_id como correspondente ao prefixo e use o filtro ticket_id: STARTS_WITH("UKMAN"), que retorna UKMAN100 e UKMAN101.

Parcialmente correspondente
(pré-lançamento)

Permite a correspondência parcial de strings em campos de texto usando o operador CONTAINS em expressões de filtro. Somente campos do tipo String ou String Array podem ser definidos como parcialmente correspondentes.

Para mais informações, consulte Disponibilizar campos para correspondência parcial e de prefixo abaixo.

Definir um campo como parcialmente correspondente permite a correspondência baseada em token em um campo, permitindo que os usuários encontrem conteúdo quando apenas uma parte do valor do campo é conhecida. O mecanismo de pesquisa faz a correspondência entre os tokens de consulta e os tokens no valor do campo, independentemente da ordem. Observação: marcar um campo como parcialmente correspondente aumenta o tamanho do índice da Pesquisa. Não é possível definir mais de 10 campos como parcialmente correspondentes.

Você quer filtrar por regiões na Europa. Os nomes de region incluem Central Europe e Eastern Europe. Se o filtro for region: ANY("Europe"), você não vai receber correspondências. No entanto, se o campo region estiver definido como parcialmente correspondente, será possível filtrar com region: CONTAINS("Europe") e receber correspondências para Central Europe e Eastern Europe.

Compatível com pesquisa instantânea
(pré-lançamento)

Marca um campo de texto como utilizável pela pesquisa enquanto você digita: conforme o usuário digita, os documentos são retornados se o valor do campo contém um token que começa com o texto da consulta, e o conjunto de resultados é reclassificado a cada pressionamento de tecla.

Somente campos do tipo String ou String Array podem ser definidos como compatíveis com a pesquisa instantânea. Não é possível definir mais de três campos por esquema como compatíveis com a pesquisa durante a digitação.

Para mais informações, consulte Disponibilizar campos para pesquisa instantânea abaixo.

Definir um campo como saytCompatible permite que os usuários recebam um conjunto atualizado de documentos classificados a cada pressionamento de tecla, antes de terminarem de digitar uma consulta completa. Aplique essa configuração quando você espera que os usuários naveguem por uma lista de resultados atualizada enquanto digitam, por exemplo, pesquisas de catálogo ou navegação de cauda longa em que o usuário reconhece o resultado certo no meio da consulta em vez de digitar o termo completo. Isso é diferente do preenchimento automático, que sugere strings de consulta. A pesquisa instantânea retorna documentos classificados que correspondem à consulta parcial.

Em um repositório de dados de filmes, defina o campo title como saytCompatible. Quando um usuário digita b, os resultados da pesquisa incluem dinamicamente Batman Begins, Batman Returns e Bats, classificados de acordo com a consulta do usuário. Quando o usuário estende a consulta para bat, os mesmos três documentos permanecem no conjunto de resultados, reclassificados para o prefixo mais longo. Estender a consulta para batm descarta Bats porque o primeiro token do título não começa com batm. Assim, apenas Batman Begins e Batman Returns permanecem, reclassificados novamente.

Tabela dinâmica Oferece filtros sensíveis ao contexto para segmentar melhor as pesquisas dos usuários. Definir um campo como Dynamic Facetable permite que o sistema gere automaticamente filtros interativos (facetas) com base nos valores exclusivos presentes no campo. Definir um campo como Dynamic facetable permite que os usuários refinem dinamicamente os resultados da pesquisa selecionando categorias ou atributos derivados diretamente dos dados ingeridos, sem precisar predefinir manualmente todas as opções de filtro possíveis. Isso permite que o usuário restrinja a pesquisa a um conteúdo da Web altamente específico.
Use Dynamic Facetable com Searchable para conseguir resultados melhores, o que melhora o recall da pesquisa e a qualidade das facetas oferecidas ao usuário.
As páginas em uma base de conhecimento corporativa interna, como políticas de RH, são ingeridas com dados como department, document_type ou last_modified_date. Se esses campos forem marcados como dynamic facetable, uma pesquisa de funcionário por um termo como reembolso de despesas vai gerar dinamicamente filtros interativos com base nos resultados relevantes encontrados. Nesse caso, a interface da Web pode exibir aspectos para Departamento: Finanças, Viagens, Tipo de documento: Política, Perguntas frequentes ou Data da última modificação: este trimestre, ano passado.
Recuperável Quando uma consulta de pesquisa encontra conteúdo correspondente, o mecanismo de pesquisa pode extrair os valores dos campos recuperáveis para exibição ou uso no aplicativo, o que significa que as informações do documento original são exibidas como parte dos resultados da pesquisa. Os campos de chave (identificadores exclusivos para documentos) são configurados como recuperáveis. Os campos recuperáveis fornecem contexto de pesquisa ao distinguir os campos com valores que podem ser exibidos daqueles que devem ser usados apenas na lógica de pesquisa, mas com valores brutos que não devem ser mostrados ao usuário. Para uma pesquisa de produtos em um site de comerciante, product_id, name, price e um image_url são campos típicos que você quer definir como recuperáveis. Por outro lado, o internal_tracking_code pode ser indexado e filtrável apenas para fins administrativos, mas não recuperável em resultados de pesquisa públicos.
Completável Permite que o conteúdo de um campo seja usado para sugestões de consulta de pesquisa. Para mais informações, consulte Configurar o preenchimento automático.

Essa configuração permite que os valores desse campo sejam usados para fornecer sugestões de consulta em tempo real enquanto os usuários digitam. Esse recurso ajuda a direcionar os usuários para conteúdo relevante e acelera o processo de pesquisa. Alguns fatores, como o uso de filtragem de linguagem natural, podem afetar esse desempenho.

Se o campo completable estiver definido para product_name, brand e category, quando o usuário digitar Tech, as sugestões de preenchimento automático poderão mostrar:
  • TechCo (do campo brand)
  • TechCo UltraBook X1 (do campo product_name)
  • Tecnologia GameMaster Pro (outro produto do campo category)
Filtrável Permite que as recomendações usem um campo para filtrar os resultados recomendados, determinando quais resultados da pesquisa os usuários veem. Para informações sobre como filtrar recomendações, consulte Filtrar recomendações. Definir um campo como Filterable ajuda a personalizar as recomendações para os usuários. Os limites de filtragem se aplicam. Uma configuração de filtro por idioma e drama pode ser assim: language_code: ANY("en", "fr") OR categories: ANY("drama").

Diferenças entre as configurações usadas com frequência

Há diferenças importantes entre as configurações de campos indexáveis, pesquisáveis e recuperáveis. A tabela resume essas diferenças.

Recurso Indexável Pesquisável Recuperável
Função principal Disponibiliza o conteúdo do campo para o mecanismo de pesquisa Permite consultas de texto completo no conteúdo do campo Permite que o valor do campo seja retornado nos resultados da pesquisa
Análise O conteúdo é processado e colocado em um índice. Normalmente, passa por uma análise lexical extensa. O valor é armazenado como está para exibição.
Será que é...
...Pesquisável? Sim (geralmente é um pré-requisito) N/A Não necessariamente (pode ser recuperável sem ser pesquisável)
...Recuperável? Não necessariamente. Não necessariamente. N/A
...Filtrável/classificável/transformável em atributo? Sim (geralmente é um pré-requisito para esses também) Não diretamente. Esses são atributos separados, geralmente criados em um campo indexável. Não diretamente. Esses atributos se relacionam à forma como o campo é indexado e consultado, não apenas exibido.

Na prática, muitos campos que são cruciais para a experiência do usuário (como títulos, descrições e informações de identificação pessoal) geralmente são definidos como indexable, searchable e retrievable.

Limitações

As configurações de campo têm as seguintes limitações:

  • É possível configurar até 50 campos como indexáveis, pesquisáveis, recuperáveis ou com classificação dinâmica.
  • Para configurar um campo como dinamicamente facetável, ele precisa ser configurado como indexável.
  • Para mudar a configuração indexável, é necessário reindexar os dados, o que pode levar horas, especialmente para grandes repositórios de dados.

Se você estiver configurando campos de configuração para um app de pesquisa de mídia e quiser informações detalhadas sobre os campos no esquema, consulte Sobre documentos de mídia e repositórios de dados.

Atualizar as configurações de campo

Para atualizar as configurações de campo:

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

    Aplicativos de IA

  2. Clique no nome do app que você quer editar.

  3. Clique em Dados.

  4. Clique na guia Esquema. Essa guia mostra as configurações atuais do campo.

    A guia Esquema não vai aparecer se o repositório de dados tiver dados básicos de site ou dados não estruturados sem metadados.

  5. Clique em Editar.

  6. Selecione ou limpe as configurações de campo que você precisa atualizar. Algumas configurações de campo não são compatíveis. Por exemplo, os campos numéricos não podem ser definidos como Pesquisáveis.

  7. Clique em Salvar para aplicar as alterações.

Se você marcar um campo como pesquisável, poderá especificar um peso para indicar a importância relativa dele nos resultados da pesquisa. Na maioria das situações, não é necessário especificar pesos para campos individuais, porque os pesos padrão funcionam bem.

No entanto, ajustar as ponderações pode ser necessário em algumas situações, por exemplo:

  • Você está migrando dados de uma plataforma de pesquisa que já usa campos ponderados.

  • Quando os pesos padrão não fornecem resultados de pesquisa satisfatórios. Especificamente, isso pode acontecer quando você tem muitos campos de pesquisa e alguns são muito mais importantes do que outros.

    Talvez o resumo seja o campo mais importante para as pesquisas, então você quer priorizar esse texto.

    Ou o esquema tem um campo com palavras-chave altamente relevantes que são excelentes preditores para resultados da pesquisa, mas, como esse campo é muito mais curto do que outros, a influência dele é frequentemente ofuscada por campos mais longos. Aumentar o peso garante que ela tenha o impacto pretendido.

Níveis de peso

Os pesos são divididos nos seguintes níveis:

Importância do campo Explicação
Muito baixa Um valor baixo que o sistema ainda considera ao combinar pontuações de todos os campos. Se você quiser ainda menos peso para que o efeito seja insignificante, não marque o campo como pesquisável.
Baixa Um peso menor que o padrão.
Padrão O peso padrão para campos de pesquisa. Esse peso oferece um desempenho razoavelmente bom na maioria dos casos.
Alta Um peso que é visivelmente maior que o padrão.
Muito alto Um peso dominante. Normalmente, você reserva isso para, no máximo, um campo.

Atualização e reindexação de esquemas

Para adicionar pesos aos campos de pesquisa, é necessário atualizar o esquema e, em seguida, reindexar os dados no repositório de dados. A atualização do esquema leva horas, e não há um indicador confiável para informar quando a indexação é concluída. Por isso, é necessário superestimar o tempo de indexação.

Definir níveis de peso nos campos

A tarefa de definir níveis de peso para campos pode ser entediante, porque você deve fazer apenas pequenas alterações e analisar cuidadosamente os resultados da pesquisa para verificar se há consequências não intencionais. Após cada alteração, é necessário aguardar a conclusão da reindexação para avaliar o impacto da mudança.

Só é possível configurar a ponderação do campo de pesquisa pela API. Esse recurso não está disponível no console do Google Cloud .

Para definir pesos, é necessário atualizar o esquema do repositório de dados usando o método projects.locations.dataStores.schemas.patch da API.

  1. Se você ainda não tiver o esquema, siga as instruções para acessá-lo em Visualizar uma definição de esquema.

  2. Siga as instruções para atualizar o esquema de maneira programática. Adicione pesos a um ou mais campos de pesquisa, como nestes exemplos:

    "summary": {
       "type": "string",
       "searchable": true,
       "weight": "high"
     },
     "uri": {
       "type": "string",
       "searchable": true,
       "weight": "low"
     },
    

    Neste exemplo, o campo summary é definido com um peso maior que o normal, e o campo uri, com um peso menor. Se você quiser retornar um peso para o valor padrão, defina-o como default.

    Os valores permitidos para o parâmetro de peso são:

    • very_low
    • low
    • default
    • high
    • very_high
  3. Aguarde a conclusão da reindexação e teste o comportamento da pesquisa.

Disponibilizar campos para correspondência parcial e de prefixo (pré-lançamento)

Para campos do tipo string, é possível editar o esquema para disponibilizar os campos para correspondência de prefixo ou parcial. Isso permite usar STARTS_WITH ou CONTAINS em expressões de filtro.

Atualização e reindexação de esquemas

Para disponibilizar campos para correspondência de prefixo ou parcial, é necessário atualizar o esquema e reindexar os dados no repositório de dados. A atualização do esquema leva horas, e não há um indicador confiável para informar quando a indexação é concluída. Portanto, é necessário superestimar o tempo de indexação.

Atualizar o esquema para correspondência parcial e de prefixo

Para especificar campos como disponíveis para correspondência de prefixo ou parcial, é necessário atualizar o esquema do repositório de dados usando o método projects.locations.dataStores.schemas.patch da API.

  1. Se você ainda não tiver o esquema, siga as instruções para acessá-lo em Visualizar uma definição de esquema.

  2. Siga as instruções para atualizar o esquema de maneira programática. Defina os parâmetros de correspondência como true no esquema, como nestes exemplos:

    "zone": {
       "type": "string",
       "searchable": true,
       "prefixMatchable": true
     },
     "region": {
       "type": "string",
       "searchable": true,
       "partialMatchable": true
     },
     "model": {
       "type": "string",
       "searchable": true,
       "prefixMatchable": true,
       "partialMatchable": true
     },
    

    Neste exemplo, o campo zone está definido para ser correspondente ao prefixo. Até 12 caracteres, sem diferenciação de maiúsculas e minúsculas, podem ser usados na expressão de filtro para corresponder ao valor do campo. O campo region está definido para ser parcialmente correspondente.

  3. Aguarde a conclusão da reindexação.

Detalhes sobre a correspondência de prefixo

A correspondência de prefixo na Pesquisa de Agente permite filtrar resultados com base em se o valor de um campo começa com uma string específica. Esse recurso é viabilizado pelo operador STARTS_WITH e exige que o campo de texto de destino seja configurado como prefixMatchable no esquema.

Lógica de normalização e correspondência

Para otimizar o desempenho e garantir a consistência, o sistema aplica um processo de normalização específico ao valor do campo (durante a indexação) e à string de consulta (durante a pesquisa).

  1. Letras minúsculas: todos os caracteres são convertidos em letras minúsculas. Isso faz com que a correspondência não diferencie maiúsculas de minúsculas.

  2. Truncamento de 12 caracteres: o sistema considera apenas os primeiros 12 caracteres da string. Os caracteres além desse limite são ignorados para fins de correspondência de prefixo.

Como funciona

No momento da indexação, para um campo marcado como prefixMatchable, o sistema gera tokens de prefixo para os primeiros 12 caracteres. Para um valor como asia-south1-c, o índice armazena tokens para a, as, asi, asia, asia- e assim por diante, até o 12º caractere (asia-south1-).

No momento da consulta, a string fornecida ao operador STARTS_WITH também é convertida em minúsculas e truncada para 12 caracteres. Em seguida, a consulta é comparada com os tokens de prefixo armazenados.

Exemplos

Os exemplos a seguir demonstram como a normalização de 12 caracteres afeta os resultados da pesquisa:

  • Correspondências amplas: STARTS_WITH("A") corresponde a qualquer valor que comece com "a" (não diferencia maiúsculas de minúsculas), como asia, australia ou africa.

  • Prefixos parciais: STARTS_WITH("asia-south") corresponde a asia-south1-a e asia-southeast1-b porque ambos começam com a string de 10 caracteres especificada.

  • Comportamento de truncamento: como apenas os primeiros 12 caracteres são correspondidos, STARTS_WITH("asia-south1-a") corresponde a um valor de campo de asia-south1-c. Isso ocorre porque as duas strings são normalizadas para o mesmo prefixo de 12 caracteres: asia-south1-.

Detalhes sobre correspondência parcial

A correspondência parcial na Pesquisa de Agente permite filtrar resultados com base em se o valor de um campo contém palavras ou tokens específicos. Esse recurso é fornecido pelo operador CONTAINS e exige que o campo de texto de destino seja configurado como partialMatchable no esquema.

Lógica de normalização e tokenização

A Pesquisa de Agente normaliza e tokeniza o valor do campo (durante a indexação) e a string de consulta (durante a pesquisa):

  • Conversão para minúsculas: a Pesquisa de Agentes converte os caracteres em minúsculas. Isso faz com que a correspondência não diferencie maiúsculas de minúsculas.

  • Tokenização: a Pesquisa de Agente divide a string em tokens individuais (palavras) usando espaços e outros caracteres como delimitadores.

    • Delimitadores padrão: espaços e pontuações comuns atuam como delimitadores, incluindo hifens (-), barras (/), vírgulas (,), pontos (.), asteriscos (*), chaves ({ }), colchetes ([ ]), parênteses (( )) e apóstrofos (').

    • Não delimitadores: o "e" comercial (&) e o sublinhado (_) não funcionam como delimitadores. O sistema trata os caracteres unidos por esses símbolos como um único token.

    • Delimitador de e-mail (@): o símbolo @ funciona como um delimitador especial para ajudar a reconhecer endereços de e-mail. O sistema gera tokens para os componentes individuais e as formas combinadas. Por exemplo, ele tokeniza support+tier1@example.com para support, tier1, example, com, support+tier1@example.com e support@example.com.

Como funciona

No momento da indexação, para um campo marcado como partialMatchable, o sistema normaliza e tokeniza o valor do campo e armazena os tokens resultantes no índice. Por exemplo, ele tokeniza um valor de campo de 25-meter, outdoor, swimming pool para [25, meter, outdoor, swimming, pool].

No momento da consulta, a string fornecida ao operador CONTAINS passa pelo mesmo processo de normalização e tokenização. Em seguida, o mecanismo de pesquisa verifica se todos os tokens de consulta resultantes correspondem aos tokens armazenados para o campo. A ordem dos tokens não tem efeito.

Exemplos

Os exemplos a seguir demonstram como a tokenização afeta os resultados de correspondência parcial:

  • Correspondência básica de token: se o valor do campo for 25-meter, outdoor, swimming pool, um filtro de CONTAINS("Outdoor pool") será correspondente. O sistema tokeniza a consulta para [outdoor, pool], que existem nos tokens do campo.

  • Independência de ordem: um filtro de CONTAINS("pool outdoor") também corresponde ao valor de campo 25-meter, outdoor, swimming pool porque o sistema verifica a presença de cada token independentemente da ordem.

  • Correspondência de endereço de e-mail: se um campo armazenar o e-mail support+tier1@example.com, filtros como CONTAINS("support"), CONTAINS("example.com") ou CONTAINS("support@example.com") vão corresponder devido à tokenização especial do símbolo @.

Disponibilizar campos para o recurso "Pesquisar enquanto você digita" (pré-lançamento)

Para campos do tipo string, é possível editar o esquema para marcar os campos como saytCompatible. Quando um ou mais campos no esquema são saytCompatible e seu aplicativo ativa a pesquisa enquanto você digita na solicitação de pesquisa, a Pesquisa de Agente retorna documentos com campos saytCompatible que contêm um token que começa com o texto da consulta e reclassifica esses documentos a cada tecla pressionada.

Sobre a pesquisa enquanto você digita para mídia

A pesquisa durante a digitação é um recurso em disponibilidade geral para apps de música. Consulte Receber resultados de pesquisa instantânea para um app de música para conferir o campo de solicitação searchAsYouTypeSpec.condition somente para mídia.

A configuração do campo saytCompatible estende a pesquisa instantânea a qualquer app de pesquisa, permitindo que você marque os campos de esquema específicos para responder a consultas parciais. Os apps de mídia podem continuar usando searchAsYouTypeSpec.condition como antes. Os apps que não são de mídia precisam de campos saytCompatible no esquema.

Preenchimento automático e pesquisa enquanto você digita

A pesquisa instantânea é diferente do preenchimento automático:

  • O preenchimento automático prevê strings de consulta e é orientado pela configuração do campo completable.
  • A Search-as-you-type retorna documentos classificados e é impulsionada pela configuração do campo saytCompatible.

Os dois recursos podem ser usados de forma independente ou em conjunto, e não compartilham dados.

Limites

A criação de campos saytCompatible tem os seguintes limites:

  • Não é possível marcar mais de três campos por esquema como saytCompatible. Definir um quarto retorna um erro INVALID_ARGUMENT da API quando você corrige o esquema.
  • saytCompatible é válido apenas em campos do tipo string. Definir esse campo em number, integer, boolean, object ou datetime retorna um erro INVALID_ARGUMENT da API.
  • Somente os primeiros 12 tokens do valor de um campo são indexados, e cada token contribui com fragmentos de prefixo de até 10 caracteres. Valores mais longos ainda são indexados, mas a cauda não é acessível por um prefixo.

Atualização e reindexação de esquemas

Definir campos como saytCompatible exige uma atualização de esquema e a subsequente reindexação dos dados no repositório de dados. A atualização do esquema leva horas, e não há um indicador confiável para informar quando a indexação é concluída. Portanto, é necessário superestimar o tempo de indexação.

Atualizar o esquema para o recurso "Pesquisar enquanto você digita"

Para marcar campos como saytCompatible usando o método projects.locations.dataStores.schemas.patch, faça o seguinte:

  1. Se você ainda não tiver o esquema, siga as instruções para acessá-lo em Ver uma definição de esquema.

  2. Siga as instruções para atualizar o esquema de maneira programática. Defina saytCompatible como true nos campos que você quer ativar para o recurso, como neste exemplo:

    "title": {
       "type": "string",
       "retrievable": true,
       "saytCompatible": true
     },
     "channel_name": {
       "type": "string",
       "retrievable": true,
       "saytCompatible": true
     },
    

    Neste exemplo, os campos title e channel_name estão marcados como saytCompatible. Definir saytCompatible em um campo que não é do tipo string retorna um erro INVALID_ARGUMENT da API, assim como definir em mais de três campos no esquema.

  3. Aguarde a conclusão da reindexação.

Enviar uma solicitação de pesquisa enquanto você digita

Depois que a reindexação for concluída, ative o recurso "Pesquisar enquanto você digita" em cada solicitação de pesquisa enviando uma solicitação com searchAsYouTypeSpec no corpo. Os campos marcados como saytCompatible no esquema são consultados apenas quando searchAsYouTypeSpec é definido na solicitação. Assim, é possível manter a mesma configuração de exibição para consultas parciais e completas.

Para enviar uma solicitação de pesquisa enquanto você digita, faça o seguinte:

  1. Chame o método de pesquisa na configuração de veiculação, conforme descrito em Receber resultados da pesquisa.

  2. No corpo da solicitação, defina searchAsYouTypeSpec.condition como ENABLED. Isso ativa o recurso "Pesquisar enquanto você digita" na solicitação.

  3. Opcional: no mesmo searchAsYouTypeSpec, restrinja a pesquisa enquanto digita a um subconjunto dos campos saytCompatible do esquema, atribua a cada campo um peso relativo e defina um limite de pontuação mínima abaixo do qual os documentos são descartados. Todos os valores neste bloco são opcionais. Quando omitidos, os padrões são aplicados.

    • fields[i].key: um campo de esquema marcado como saytCompatible. A referência a um campo que não é saytCompatible não retorna nenhuma contribuição de pesquisa instantânea desse campo.
    • fields[i].weight: importância relativa do campo na pontuação de pesquisa ao digitar. O padrão é 1.0.
    • scoreThreshold: os documentos com pontuação de pesquisa ao digitar abaixo desse valor são excluídos. O padrão é não ter limite.
  4. Envie a solicitação. O exemplo a seguir mostra o formato de um searchAsYouTypeSpec que ativa a pesquisa enquanto você digita, define o escopo para dois campos com pesos diferentes e define uma pontuação mínima:

    "searchAsYouTypeSpec": {
      "condition": "ENABLED",
      "fields": [
        { "key": "title", "weight": 1.2 },
        { "key": "channel_name" }
      ],
      "scoreThreshold": 0.5
    }
    

Detalhes sobre a pesquisa durante a digitação

A pesquisa enquanto você digita na Pesquisa de Agente permite que os usuários recebam documentos classificados a cada pressionamento de tecla em campos marcados como saytCompatible no esquema.

Lógica de normalização e tokenização

A Pesquisa de Agente normaliza e tokeniza o valor do campo (durante a indexação) e o texto da consulta (durante a pesquisa):

  • Conversão para minúsculas: a Pesquisa de Agentes converte os caracteres em minúsculas. Isso faz com que a correspondência não diferencie maiúsculas de minúsculas.

  • Tokenização: a Pesquisa de Agente divide a string em tokens individuais (palavras) usando espaços e pontuação comum como delimitadores, correspondendo ao comportamento usado para correspondência parcial.

  • Limites por campo: apenas os primeiros 12 tokens do valor do campo são indexados para a pesquisa instantânea. Cada um desses tokens contribui com fragmentos de prefixo de até 10 caracteres.

Exemplo

Se o campo actor_name estiver marcado como saytCompatible e um documento tiver o valor Christian Bale, uma consulta de chr vai chegar ao documento pelo fragmento de prefixo de comprimento 3 do token christian, e estender a consulta para chris ainda vai corresponder ao fragmento de prefixo de comprimento 5. Uma consulta de bale também corresponde, pelo fragmento de prefixo de comprimento 4 do segundo token no valor do campo. As atualizações de classificação são feitas a cada tecla pressionada pelo usuário.

A seguir