Migrar da API Custom Search Site Restricted JSON

Se você usa a API JSON Custom Search Site Restricted do Mecanismo de Pesquisa Programável, é possível criar e implantar uma pesquisa restrita a sites com a qualidade do Google em minutos usando a Vertex AI para Pesquisa. Para implantar seu app, use o widget de pesquisa copiando o código do console Google Cloud diretamente em uma página da Web. Não é necessário programar. 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" em Receber resultados da pesquisa de um app com dados do site e o método servingConfigs.search na referência REST.

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

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 de preços dos aplicativos de IA.

Configurar a Vertex AI para Pesquisa

Para configurar a Vertex AI Search, siga estas etapas:

  1. No console Google Cloud , na página do seletor de projetos, selecione o projeto que você está usando para a API Custom Search Site Restricted JSON.

  2. Ative os aplicativos de IA.

Criar um app de pesquisa

Para criar um app de pesquisa, siga estas etapas:

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

    Aplicativos de IA

  2. Clique em Criar App.

  3. Na página Criar app, em Pesquisa no site com o Modo IA, 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 a opção Recursos avançados do LLM. Desativar essa opção oferece uma funcionalidade semelhante à API Custom Search Site Restricted JSON do Mecanismo de Pesquisa Programável. Desative essa opção se não precisar do resumo ou da pesquisa com acompanhamento. Para mais informações, consulte Recursos avançados do LLM.

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

  7. No campo Nome externo da sua empresa ou organização, insira o nome comum da sua 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. Desativar essa opção oferece 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 ou pesquisa com acompanhamento, ou se não for proprietário dos domínios especificados. Para mais informações, consulte Indexação avançada de sites.

  12. No painel Especificar padrões de URL para indexar, no campo Sites a incluir, 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 Search: 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 em aplicativos de IA. Adicione o papel Usuário do Discovery Engine ou Leitor do Discovery Engine à conta de serviço.

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

Implantar o app de pesquisa (chave de API)

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

  1. Crie a chave de API:

    1. No Google Cloud console, 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 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 passam o URL referenciador.

      • 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 de aplicativos de IA em https://discoveryengine.googleapis.com/*.

  2. Implante o app de pesquisa usando a API. Consulte Receber resultados da pesquisa de um app com dados do site (chave de API) e o método servingConfigs.searchLite na referência 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 faz a autenticação usando uma chave de API. 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ê escolher a autenticação pelo OAuth 2.0, use os métodos search e answer para consultar seu site. Além disso, você pode implantar seu app de pesquisa usando o widget de pesquisa sem código.

A tabela a seguir lista as diferenças entre o uso do método searchLite com autenticação de chave de API e os métodos search e answer com 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 da pesquisa ✔ ✔
Pesquisar sites públicos ✔ ✔

Próximas etapas