Migrar da API Custom Search Site Restricted JSON

Se você usa a API Custom Search Site Restricted JSON do Mecanismo de Pesquisa Programável, é possível criar e implantar pesquisas restritas a sites com a qualidade do Google em minutos usando a Pesquisa da Vertex AI. Para implantar seu app, use o widget de pesquisa copiando o código do console do Google Cloud diretamente para uma página da Web, sem precisar de programação. Ou você pode implementar uma implantação de API para controlar a aparência da funcionalidade de pesquisa no seu site. Para mais informações sobre como usar a API, consulte a guia REST de Receber resultados de pesquisa para um app com dados do site e o método servingConfigs.search na referência REST.

Além dos snippets curtos padrão que a Vertex AI para Pesquisa retorna com os resultados da pesquisa, é possível adicionar recursos avançados à pesquisa. Isso inclui resumos gerados de resultados de pesquisa, pesquisa com acompanhamento para pesquisa com base no contexto que permite perguntas adicionais e respostas extraídas para texto extraído retornado com cada resultado de pesquisa. Para ter esses recursos avançados na pesquisa da Web, é necessário fazer a verificação de domínio e incorrer em custos de indexação adicionais.

Também é possível filtrar ou ordenar os resultados da pesquisa e aplicar controles de promoção para mostrar um link como resultado promovido.

Para mais informações, consulte a página Preços do Vertex AI Agent Builder.

Configurar a Vertex AI para Pesquisa

Para configurar a Pesquisa Vertex AI, siga estas etapas:

  1. No console do Google Cloud, na página do seletor de projetos, selecione o projeto que você tem usado para a API JSON restrita do site de pesquisa personalizada.

  2. Ative o Vertex AI Agent Builder.

Criar um app de pesquisa

Para criar um app de pesquisa, siga estas etapas:

  1. No Console do Google Cloud, acesse a página Criador de agentes.

    Agent Builder.

  2. Clique em Criar App.

  3. Na página Criar app, em Pesquisar no site, clique em Criar.

  4. Verifique se a opção Recursos da edição Enterprise está ativada. Isso é necessário para a pesquisa no site. Para mais informações, consulte Recursos da edição Enterprise.

  5. Desative os Recursos avançados do LLM. Desative essa opção para ter uma funcionalidade semelhante à API Custom Search Site Restricted JSON do Mecanismo de Pesquisa Programável. Desative essa opção se você não precisar de resumo de pesquisa ou pesquisa com acompanhamentos. Para mais informações, consulte Recursos avançados de LLM.

  6. No campo Nome do app, insira um nome para o app.

  7. No campo Nome externo da sua empresa ou organização, insira o nome comum da empresa ou organização.

  8. Selecione global (Global) como o local do app e clique em Continuar.

  9. Na página Repositórios de dados, clique em Criar repositório de dados.

  10. No painel Selecionar uma fonte de dados, escolha Conteúdo do site.

  11. Desative a Indexação avançada de sites. Desative essa opção para ter uma funcionalidade semelhante à API Custom Search Site Restricted JSON do Mecanismo de Pesquisa Programável. Desative essa opção se você não precisar de resumo de pesquisa ou pesquisa com acompanhamentos ou se não for o proprietário dos domínios especificados. Para mais informações, consulte Indexação de sites avançada.

  12. No painel Especificar padrões de URL para indexação, no campo Sites a serem incluídos, insira os padrões de URL dos sites que você quer pesquisar e clique em Continuar.

  13. No painel Configurar seu repositório de dados, insira um nome de exibição para o repositório e clique em Criar.

  14. Na página Repositórios de dados, selecione o novo repositório e clique em Criar.

Implantar o app de pesquisa

Decida como você planeja autenticar seu app de pesquisa da Vertex AI usando o OAuth 2.0 ou uma chave de API. Para informações sobre as vantagens e desvantagens de cada método, consulte Sobre a autenticação.

Implantar o app de pesquisa (OAuth 2.0)

Para implantar o app de pesquisa usando a autenticação OAuth 2.0, siga estas etapas:

  1. Para configurar o OAuth 2.0, consulte No Google Cloud em Autenticar no Vertex AI Agent Builder. Adicione o papel de Usuário do Discovery Engine ou de Visualizador do Discovery Engine à conta de serviço.

  2. Implante o app de pesquisa de uma das seguintes maneiras:

Implantar o app de pesquisa (chave de API)

Para implantar o app de pesquisa usando uma chave de API para autenticação, siga estas etapas:

  1. Crie a chave de API:

    1. No Console do Google Cloud, acesse a página Credenciais.

      Credenciais

    2. Se você ainda não estiver no seu projeto, selecione-o na lista de projetos na parte de cima da página do console do Google Cloud.

    3. Clique em Criar credenciais e, em seguida, selecione Chave de API. Não adicione restrições de referenciador. Algumas configurações de privacidade do usuário não transmitem o URL de referência.

      • Anote a chave de API gerada, que será usada ao chamar o método searchLite.

    4. Para reforçar a segurança, adicione uma restrição HTTP à sua chave de API para restringir o acesso ao serviço Vertex AI Agent Builder em https://discoveryengine.googleapis.com/*.

  2. Implante o app de pesquisa usando a API. Consulte Receber resultados de pesquisa para um app com dados do site (chave de API) e o método servingConfigs.searchLite na referência do REST. Para ordenar os resultados das suas consultas de pesquisa na Web, consulte Ordenar resultados da pesquisa na Web.

Sobre a autenticação

A API Custom Search Site Restricted JSON do Mecanismo de Pesquisa Programável é autenticada usando uma chave de API. No entanto, com algumas exceções, a Vertex AI para Pesquisa exige o OAuth 2.0. Se você quiser continuar usando uma chave de API para autenticação, use o método searchLite em chamadas de API.

Se você optar por fazer a autenticação pelo OAuth 2.0, use o método search e o método answer para consultar seu site. Além disso, é possível implantar seu app de pesquisa pelo widget de pesquisa sem código.

A tabela a seguir lista as diferenças entre o uso do método searchLite com a autenticação de chave de API e os métodos search e answer com a autenticação OAuth 2.0.

Recurso/métodos Método searchLite Método search
Authentication Chave de API OAuth 2.0
Widget da Pesquisa disponível ✘ ✔
Resumos de pesquisa ✔ ✔
Pesquisar sites públicos ✔ ✔

Próximas etapas