Configurar o preenchimento automático avançado

Experimental

Esse recurso está sujeito aos "Termos de ofertas pré-GA" na seção "Termos de Serviço gerais" dos Termos específicos de serviço. Os recursos pré-GA estão disponíveis "no estado em que se encontram" e podem ter suporte limitado. Para mais informações, consulte as descrições da fase de lançamento.

Importante: o preenchimento automático avançado está disponível para alguns clientes do Google Cloud. Para saber mais ou se inscrever para usar esse recurso, entre em contato com seu representante de vendas do Google Cloud.

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 distinguem do preenchimento automático básico preenchimento automático são as 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. (Acesso controles 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 controle de acesso, consulte Usar dados controle de acesso de origem.

• Otimização de idioma:o preenchimento automático avançado pode ser configurado para otimizar as sugestões em uma ou mais sugestões. idiomas. Por exemplo, se o idioma do navegador for holandês, o preenchimento automático sugestões nesse idioma poderiam ser aprimoradas. 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:

  • Sugestões avançadas: assim como as sugestões de preenchimento automático, os usuários recebem informações sobre documentos em que o prefixo dos títulos corresponde às letras que eles digitam. 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 informações recentes consultas que têm o prefixo correspondente às letras digitadas. Para mais informações, consulte Enviar uma solicitação de preenchimento automático e retornar campos recentes comuns.

Enviar solicitações de preenchimento automático

Veja a seguir como enviar solicitações de preenchimento automático avançado usando o 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, localize o nome do seu app e acesse o ID dele na a coluna ID;

2. Chame o métodocompletionConfig.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 Vertex AI para Pesquisa.

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

Enviar uma solicitação de preenchimento automático com otimização 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 da otimização precisa estar entre -1 e 1. Definir um número negativo "buries" sugestões de preenchimento automático nesse idioma e um número positivo aumenta a idioma de destino.

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, localize o nome do seu app e acesse o ID dele na a coluna ID;

2. Chame o métodocompletionConfig.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 Vertex AI para Pesquisa.

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

   • LANG_CODE: o código de duas letras para um ou mais idiomas; em aspas com 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 for positiva, as sugestões são promovidas (elas 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": { "text": "Co"}
        "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 otimizado (colocado mais acima na lista de sugestões automáticas) se estiver em francês ou espanhol e enterrado (colocado na parte inferior da lista de sugestões automáticas) se estejam 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 entity_type e, se disponíveis, as principais propriedades: 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 detalhadas, é possível mostrar as seguintes informações sobre cada um desses documentos sugeridos: o título (title), um link para o documento (uri), a data da última atualização (update_time) e a origem (source_type), por exemplo, se o documento foi encontrado no Confluence Cloud ou no Slack. Saber como um documento foi atualizado recentemente e a fonte dele ajuda os o funcionário vai escolher qual documento analisar primeiro.

Limitações

O preenchimento automático avançado só se aplica a conectores de terceiros e apenas a alguns e armazenamentos 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 (em inglês)	Página	Espaço
Dropbox	Arquivo
Jira Cloud	Problema	Espaço
OneDrive	Arquivo
Salesforce	Conta	Lead	Oportunidade
ServiceNow	Incidente	Conhecimento
Sharepoint Online (em inglês)	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étodocompletionConfig.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 Vertex AI para Pesquisa.

   • QUERY_STRING: a entrada de typeahead 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/v1beta/projects/my-project-123/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/123456/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/123456/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, o pseudoID do usuário precisa ser fornecido.

Exemplo

Um funcionário está consultando o site da intranet da empresa dele para conseguir informações sobre tirando férias. O funcionário executou as seguintes consultas, listadas em do mais recente para o mais antigo:

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étodocompletionConfig.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 Vertex AI para Pesquisa.

   • QUERY_STRING: a entrada de autopreenchimento 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 exclusivamente um visitante em um único dispositivo. Não defina este campo como o mesmo identificador para vários usuários. Isso vai combinar os históricos de consulta. O que não fazer incluir informações de identificação pessoal (PII) neste 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/v1beta/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/completionConfig:completeQuery"
   - d '{
         "query": "C",
         "suggestionTypes": ["RECENT_SEARCH"],
         "userPseudoId: "test_user"
       }
   
   {
     "contentSuggestions": [{
       "suggestion": "critical crash in payment module",
       "document": {
         "name": "projects/123456/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/123456/locations/global/collections/default_collection/dataStores/my-data-store"
     }]
   }
   

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 armazenamento de dados. Isso é significativo quando seu aplicativo é um aplicativo 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 um preenchimento automático à lista de bloqueio.