Configurar o preenchimento automático avançado

Esta página descreve o recurso avançado de preenchimento automático da Pesquisa da Vertex AI.

Assim como o preenchimento automático básico, o avançado gera sugestões de consulta com base nos primeiros caracteres inseridos.

Antes de ler esta página, conheça o preenchimento automático básico da Vertex AI Search. Consulte Configurar o preenchimento automático.

Principais recursos do preenchimento automático avançado

Os principais recursos do preenchimento automático avançado que o diferenciam do básico são os seguintes:

  • Pesquisa combinada:o preenchimento automático avançado pode ser usado com apps de pesquisa combinada, que são apps de pesquisa genérica conectados a mais de um repositório de dados.

  • Controle de acesso:o preenchimento automático avançado respeita os controles de acesso. Os controles de acesso também são chamados de ACLs, listas de controle de acesso. O preenchimento automático avançado só sugere pesquisas relacionadas a documentos aos quais o usuário tem acesso. Para informações sobre o controle de acesso, consulte Usar o controle de acesso à fonte de dados.

  • Aumento de idioma:o preenchimento automático avançado pode ser definido para aumentar as sugestões em um ou mais idiomas. Por exemplo, se o idioma do navegador for holandês, as sugestões de preenchimento automático nesta língua podem ser otimizadas. Para mais informações, consulte Enviar uma solicitação de preenchimento automático com um impulso de idioma.

  • Diferentes tipos de sugestões:com o preenchimento automático avançado, em vez de sugestões de consulta de preenchimento automático regulares, é possível especificar diferentes tipos de sugestões:

Antes de começar

Revise e, se quiser, edite as configurações de preenchimento automático do app. Consulte Atualizar as configurações de preenchimento automático.

Particularmente ao testar, para repositórios de dados menores, recomendamos definir Ativar preenchimento automático como Agora. Isso acontece porque pequenos repositórios de dados podem não conter dados suficientes para oferecer sugestões precisas.

Enviar solicitações de preenchimento automático

Confira a seguir como enviar solicitações de preenchimento automático avançado usando o método completionConfig.completeQuery.

REST

Para enviar uma solicitação de preenchimento automático usando a API, 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 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.

  2. Chame o método completionConfig.completeQuery.

    curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/completionConfig:completeQuery" \
-d '{
      "query":"QUERY_STRING"
    }'

    • PROJECT_ID: o ID do seu projeto do Google Cloud.

    • APP_ID: o ID do app da Vertex AI para Pesquisa.

    • QUERY_STRING: a entrada de typeahead usada para buscar sugestões.

Enviar uma solicitação de preenchimento automático com um aumento de idioma

É possível aumentar ou diminuir as sugestões de preenchimento automático de acordo com o código do idioma. Por exemplo, é possível aumentar ou diminuir a probabilidade de exibição das sugestões de preenchimento automático em alguns idiomas.

O valor de otimização precisa estar entre -1 e 1. Definir um número negativo "esconde" as sugestões de preenchimento automático nesse idioma, e um número positivo aumenta o idioma.

Use tags de idioma de duas letras definidas pelo BCP 47, por exemplo, en, fr, hi e zh.

REST

Para enviar uma solicitação de preenchimento automático que inclua um valor de aumento de idioma, 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 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.

  2. Chame o método completionConfig.completeQuery.

    curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/completionConfig:completeQuery" \
-d '{
      "query":"QUERY_STRING",
      "boostSpec": {
         "conditionBoostSpecs": [{
           "condition": "(langCode: ANY(LANG_CODE))",
           "boost": BOOST_VALUE
         }]
      }
    }'

    • PROJECT_ID: o ID do seu projeto do Google Cloud.

    • APP_ID: o ID do app da Vertex AI para Pesquisa.

    • QUERY_STRING: a entrada de typeahead usada para buscar sugestões.

    • LANG_CODE: o código de duas letras de um ou mais idiomas, com aspas de escape. Por exemplo, \"fr\", \"es\" para aplicar o valor do aumento ao espanhol e ao francês.

    • BOOST_VALUE: um número de ponto flutuante entre -1 e 1. Quando o valor é negativo, as sugestões automáticas no idioma são rebaixadas (elas aparecem mais abaixo na lista de sugestões). Quando o valor é positivo, as sugestões são promovidas (elas aparecem mais acima na lista).

Enviar uma solicitação de preenchimento automático e retornar sugestões ricas

O preenchimento automático avançado retorna conteúdo (documentos) em que os títulos contêm palavras que começam com a consulta.

Além do título do documento, a solicitação de preenchimento automático retorna source_type e entity_type e, se disponível, as propriedades principais: uri, create_time e update_time. É possível visualizar e editar os mapeamentos de propriedades-chave na guia Esquema da página do repositório de dados.

Como em todas as sugestões avançadas de preenchimento automático, as ACLs são respeitadas para todos os documentos sugeridos.

Exemplo

Um funcionário está consultando o site da intranet da empresa em busca de informações técnicas sobre permissões de acesso.

O funcionário começa a digitar tec, e os seguintes documentos podem ser retornados: Data technicians handbook, Access technology guide e Techniques for troubleshooting access issues.

Com as sugestões avançadas, você pode mostrar as seguintes informações sobre cada um desses documentos sugeridos: o título (title), um link para o documento (uri), a última atualização (update_time) e a origem (source_type), por exemplo, se o documento foi encontrado no Confluence Cloud ou no Slack. Saber quando um documento foi atualizado e a origem dele ajuda o funcionário a escolher qual documento consultar primeiro.

Limitações

O preenchimento automático avançado só se aplica a conectores de terceiros e apenas a determinados armazenamentos de dados de entidade para esses conectores. A tabela a seguir mostra quais entidades são compatíveis com quais conectores.

Conector de terceiros Entidades compatíveis
Box Arquivo
Confluence Cloud Página Espaço
Dropbox Arquivo
Jira Cloud Problema Espaço
OneDrive Arquivo
Salesforce Conta Lead Oportunidade
ServiceNow Incidente Conhecimento
SharePoint Online Anexo Evento Arquivo Página
Slack Mensagem

Procedimento

Para enviar uma solicitação de preenchimento automático que retorna uma sugestão completa, siga estas etapas:

REST

  1. 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.

  2. Chame o método completionConfig.completeQuery.

    
curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/completionConfig:completeQuery" \
-d '{
      "query":"QUERY_STRING",
      "suggestionTypes": ["CONTENT"]
    }'

    • PROJECT_ID: o ID do seu projeto do Google Cloud.

    • APP_ID: o ID do app da Vertex AI para Pesquisa.

    • QUERY_STRING: a entrada de typeahead usada para buscar sugestões.

Enviar uma solicitação de preenchimento automático e retornar consultas recentes

Retorna como sugestões uma lista das consultas mais recentes do usuário que correspondem ao prefixo da consulta na solicitação.

As sugestões de consulta correspondentes são listadas da mais recente para a mais antiga. Para usar a pesquisa recente, o pseudoID do usuário precisa ser fornecido.

Exemplo

Um funcionário está consultando o site da intranet da empresa para saber como tirar férias. O funcionário realizou as seguintes consultas, listadas da mais recente para a mais antiga:

PTO, Vacation blackout periods, How much vacation time do I have?, Time off, Vacation policy, covering a vacant position during absences e Can I take unpaid time off?.

Agora, em resposta ao funcionário que digita vac na caixa de pesquisa, as sugestões de preenchimento automático serão as seguintes:

  • Vacation blackout periods
  • How much vacation time do I have?
  • Vacation policy
  • Covering a vacant position during absences

Procedimento

Para enviar uma solicitação de preenchimento automático que retorne as consultas mais recentes do usuário, siga estas etapas:

REST

  1. 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.

  2. Chame o método completionConfig.completeQuery.

    
curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/completionConfig:completeQuery" \
-d '{
      "query":"QUERY_STRING",
      "suggestionTypes": ["RECENT_SEARCH"],
      "userPseudoId": "USER_PSEUDO_ID"
    }'

    • PROJECT_ID: o ID do seu projeto do Google Cloud.

    • APP_ID: o ID do app da Vertex AI para Pesquisa.

    • QUERY_STRING: a entrada de typeahead usada para buscar sugestões.

    • USER_PSEUDO_ID: um identificador pseudônimo do usuário. Você pode usar um cookie HTTP para esse campo, que identifica com exclusividade um visitante em um único dispositivo. Não defina esse campo como o mesmo identificador para vários usuários. Isso vai combinar os históricos de consulta. Não inclua informações de identificação pessoal (PII) neste campo.

Usar uma lista de bloqueio de preenchimento automático

É possível usar uma lista de bloqueios para evitar que termos específicos apareçam como sugestões de preenchimento automático.

Embora o preenchimento automático avançado esteja no nível do app, as listas de bloqueio estão no nível do repositório de dados. Isso é importante se o app for de pesquisa combinada. Crie uma lista de bloqueio para cada repositório de dados conectado ao app.

Para informações sobre como criar e usar listas de bloqueio, consulte Usar uma lista de bloqueio de preenchimento automático.