Configurar o preenchimento automático avançado

Esta página descreve o recurso de preenchimento automático avançado do Gemini Enterprise.

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 do Gemini Enterprise. 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 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 sugere apenas consultas de pesquisa relacionadas a documentos aos quais o pesquisador tem acesso. Para informações sobre controle de acesso, consulte Identidade e permissões.

• Otimização de idioma: o preenchimento automático avançado pode ser configurado para otimizar sugestões em um ou mais idiomas. Por exemplo, se o idioma do navegador for holandês, as sugestões de preenchimento automático nesse idioma poderão ser priorizadas. Para mais informações, consulte Enviar uma solicitação de preenchimento automático com um aumento 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 que você quer diferentes tipos de sugestões:

  • Sugestões avançadas: como sugestões de preenchimento automático, os usuários recebem informações sobre documentos em que os títulos correspondem ao prefixo das letras digitadas. Para mais informações, consulte Enviar uma solicitação de preenchimento automático e retornar sugestões avançadas.

  • Consultas recentes: como sugestões de preenchimento automático, os usuários recebem as consultas recentes que correspondem ao prefixo das letras digitadas. Para mais informações, consulte Enviar uma solicitação de preenchimento automático e retornar consultas recentes.

Antes de começar

Antes de começar a usar o preenchimento automático avançado, faça o seguinte:

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

• Para repositórios de dados menores, defina Ativar preenchimento automático como Agora. Recomendamos isso porque os repositórios de dados pequenos podem não conter dados suficientes para fornecer sugestões precisas.

• Se os repositórios de dados tiverem informações de identificação pessoal (PII) ou se você usar o histórico de pesquisa ou o modelo de sugestões de consulta de eventos do usuário, consulte Proteger contra vazamentos de PII e configure as proteções de prevenção contra perda de dados (DLP) que podem ser necessárias para evitar vazamentos de PII.

• Se você planeja usar sugestões de pesquisa recentes (RECENT_SEARCH), registre os eventos de usuário de pesquisa. O Gemini Enterprise não preenche automaticamente o índice da Pesquisa recente quando as pesquisas são realizadas usando o método SearchService.Search. Para retornar consultas recentes, é necessário registrar eventos de usuário de pesquisa usando o método userEvents.write. Consulte Antes de começar para consultas recentes.

Enviar solicitações de preenchimento automático

Veja 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 Google Cloud , acesse a página Gemini Enterprise.

      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/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/completionConfig:completeQuery" \
   -d '{
         "query":"QUERY_STRING"
       }'
   

   Substitua:

   • PROJECT_ID: ID do projeto.

   • APP_ID: o ID do app.

   • QUERY_STRING: a entrada de digitação antecipada usada para buscar sugestões.

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

É possível impulsionar ou ocultar sugestões de preenchimento automático de acordo com o código do idioma. Por exemplo, tornar as sugestões de preenchimento automático em alguns idiomas mais ou menos propensas a aparecer.

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

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 otimização 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 Google Cloud , acesse a página Gemini Enterprise.

      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/v1/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
            }]
         }
       }'
   
   

   Substitua:

   • PROJECT_ID: ID do projeto.

   • APP_ID: o ID do app.

   • QUERY_STRING: a entrada de digitação antecipada usada para buscar sugestões.

   • LANG_CODE: o código de duas letras para um ou mais idiomas, entre aspas com escape. Por exemplo, \"fr\", \"es\" para aplicar o valor de otimização 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 (aparecem mais acima na lista).

   Exemplo de comando

   curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   "https://discoveryengine.googleapis.com/v1/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/completionConfig:completeQuery" \
   -d '{
        "query": "hol",
        "boostSpec": {
           "conditionBoostSpecs": [{
             "condition": "(langCode: ANY(\"es\", \"fr\"))",
             "boost": 0.75 }, {
             "condition": "(langCode: ANY(\"en\"))",
             "boost": -1
           }]
         }
       }'
    

   Neste exemplo, as sugestões de preenchimento automático para a consulta Co são promovidas (colocadas em uma posição mais alta na lista de sugestões automáticas) se estiverem em francês ou espanhol e rebaixadas (colocadas em uma posição mais baixa na lista de sugestões automáticas) se estiverem em inglês.

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

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 o source_type e o entity_type e, se disponíveis, as propriedades principais: uri, create_time e update_time. É possível conferir e editar os mapeamentos de propriedades principais na guia Esquema da página do repositório de dados.

Como acontece com todas as sugestões de preenchimento automático avançadas, 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, para cada um desses documentos sugeridos, é possível exibir as seguintes informações sobre o documento:

• o título do documento (title), um link para o documento (uri)

• quando foi atualizado pela última vez (update_time)

• A origem (source_type), por exemplo, se o documento foi encontrado no Confluence Cloud ou no Slack.

Saber quando um documento foi atualizado e qual é a fonte dele ajuda o funcionário a escolher qual documento consultar primeiro.

Limitações

O preenchimento automático avançado se aplica apenas a conectores de terceiros e a determinados repositórios de dados de entidade para esses conectores de terceiros. 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	Space
Dropbox	Arquivo
Jira Cloud	Problema	Space
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 retorne uma sugestão avançada, 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 Google Cloud , acesse a página Gemini Enterprise.

      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/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/completionConfig:completeQuery" \
   -d '{
         "query":"QUERY_STRING",
         "suggestionTypes": ["CONTENT"]
       }'
   
   

   Substitua:

   • PROJECT_ID: ID do projeto.

   • APP_ID: o ID do app.

   • QUERY_STRING: a entrada de digitação antecipada usada para buscar sugestões.

   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/v1/projects/1234/locations/global/collections/default_collection/engines/my_app/completionConfig:completeQuery" \
   - d {
         "query": "C",
         "suggestionTypes": ["CONTENT"]
       }'
   
   {
     "contentSuggestions": [{
       "suggestion": "critical crash in payment module",
       "document": {
         "name": "projects/1234/locations/global/collections/default_collection/dataStores/my_data_store/branches/0/documents/10000",
         "derivedStructData": {
           "title": "Critical Crash in Payment Module",
           "uri": "https://cymballabs.atlassian.net/browse/CPT-1",
           "source_type": "jira",
           "entity_type": "issue"
         }
       },
       "dataStore": "projects/1234/locations/global/collections/default_collection/dataStores/my_data_store"
     }]
   }
   
   

Observação: se você especificar suggestionTypes como CONTENT, todos os parâmetros boostSpec, queryModel ou includeTailSuggestions no comando curl serão ignorados.

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, é necessário fornecer o pseudoID do usuário.

Importante: o Gemini Enterprise não registra automaticamente as consultas de pesquisa executadas usando o método SearchService.Search no histórico da Pesquisa recente de um usuário. Para retornar consultas recentes, é necessário registrar eventos de pesquisa do usuário. Para mais detalhes, consulte Antes de começar.

Antes de começar

Antes de recuperar consultas recentes com o preenchimento automático, é necessário registrar as pesquisas do usuário como eventos de pesquisa chamando o método userEvents.write.

Se os eventos de pesquisa do usuário não forem gravados, as solicitações para completionConfig.completeQuery com suggestionTypes: ["RECENT_SEARCH"] vão retornar uma lista vazia de sugestões ({}).

Para registrar um evento de usuário de pesquisa, envie uma solicitação POST ao método userEvents.write com os seguintes valores:

• eventType: defina como "search"
• userPseudoId: definido como o identificador pseudonimizado exclusivo do usuário.
• engine: defina como o nome do recurso do seu mecanismo.
• searchInfo.searchQuery: definido como a string de consulta de pesquisa inserida pelo usuário.

curl -X POST \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" \
  "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/userEvents:write" \
  -d '{
        "eventType": "search",
        "userPseudoId": "USER_PSEUDO_ID",
        "engine": "projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID",
        "searchInfo": {
          "searchQuery": "SEARCH_QUERY"
        }
      }'

Substitua:

• PROJECT_ID: ID do projeto.
• LOCATION: o local do app ou repositório de dados (por exemplo, global ou us).
• APP_ID: o ID do app.
• USER_PSEUDO_ID: um identificador pseudonimizado do usuário. Ele precisa corresponder ao userPseudoId transmitido nas solicitações completionConfig.completeQuery subsequentes.
• SEARCH_QUERY: a string de consulta pesquisada pelo usuário.

Para mais informações, consulte Registrar eventos de usuário em tempo real com o método userEvents.write.

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 seriam 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 Google Cloud , acesse a página Gemini Enterprise.

      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/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/completionConfig:completeQuery" \
   -d '{
         "query":"QUERY_STRING",
         "suggestionTypes": ["RECENT_SEARCH"],
         "userPseudoId": "USER_PSEUDO_ID"
       }'
   
   

   Substitua:

   • PROJECT_ID: ID do projeto.

   • APP_ID: o ID do app.

   • QUERY_STRING: a entrada de digitação antecipada usada para buscar sugestões.

   • USER_PSEUDO_ID: um identificador pseudonimizado do usuário. Você pode usar um cookie HTTP para esse campo, que identifica exclusivamente um visitante em um único dispositivo. Não defina esse campo com o mesmo identificador para vários usuários. Isso combinaria os históricos de consultas. Não inclua informações de identificação pessoal (PII) nesse campo.

   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/v1/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/completionConfig:completeQuery" \
   -d '{
         "query": "hol",
         "suggestionTypes": ["RECENT_SEARCH"],
         "userPseudoId": "test_user"
       }'
   
   {
     "recentSearchSuggestions": [
       {
         "suggestion": "holiday readiness",
         "recentSearchTime": "2025-05-19T18:27:07.261698Z"
       },
       {
         "suggestion": "holiday freeze",
         "recentSearchTime": "2025-05-19T18:25:45.744021Z"
       },
       {
         "suggestion": "holiday",
         "recentSearchTime": "2025-05-19T18:20:08.916884Z"
       }
     ]
   }
   

Observação: se você especificar suggestionTypes como RECENT_SEARCH, todos os parâmetros boostSpec, queryModel ou includeTailSuggestions no comando curl serão ignorados.

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 mista. Crie uma lista de bloqueio para cada repositório de dados conectado ao app.

Para saber como criar e usar listas de bloqueio, consulte Usar uma lista de bloqueio de preenchimento automático.

Usar uma lista importada de sugestões de preenchimento automático

É possível fornecer sua própria lista de sugestões de preenchimento automático em vez de usar as sugestões geradas por um modelo de dados de preenchimento automático.

Para saber como importar uma lista, consulte Usar uma lista importada de sugestões de preenchimento automático.