Migrar da API Custom Search Site Restricted JSON

Se você usa a API Custom Search Site Restricted JSON do Mecanismo de Pesquisa Programável, pode criar e implantar uma pesquisa restrita a sites com a qualidade do Google em minutos usando a Pesquisa do agente. Para implantar seu app, você pode usar o widget de pesquisa copiando o código do Google Cloud console 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 de Receber resultados de pesquisa para um app com dados do site e o servingConfigs.search método na referência REST.

Além dos snippets curtos padrão que a Pesquisa do agente retorna com os resultados da pesquisa, você pode adicionar recursos avançados à pesquisa. Isso inclui resumos gerados de resultados da pesquisa, pesquisa com acompanhamentos para pesquisa contextual que permite perguntas complementares, e respostas extrativas para texto extraído retornado com cada resultado da pesquisa. Para receber esses recursos avançados para sua pesquisa na Web, é necessário verificar o domínio e incorrer em custos adicionais de indexação.

Você também pode filtrar ou classificar seus resultados da pesquisa e aplicar controles de promoção para exibir um link como um resultado promovido.

Para mais informações, consulte a página de preços da Pesquisa do agente.

Configurar a Pesquisa do agente

Para configurar a Pesquisa do agente, siga estas etapas:

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

  2. Ative a Pesquisa do agente.

Criar um app de pesquisa

Para criar um app de pesquisa, siga estas etapas:

  1. No Google Cloud console, 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 de sites. Para mais informações, consulte Recursos da edição Enterprise.

  5. Desative a opção Respostas generativas. Ao desativar essa opção, você terá uma funcionalidade semelhante à API Custom Search Site Restricted JSON do Mecanismo de Pesquisa Programável. Desative essa opção se não precisar de resumo ou pesquisa com acompanhamentos. Para mais informações, consulte Respostas generativas.

  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 Indexação avançada de sites. Ao desativar essa opção, você terá uma funcionalidade semelhante à API Custom Search Site Restricted JSON do Mecanismo de Pesquisa Programável. Desative essa opção se não precisar de resumo ou pesquisa com acompanhamentos 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 armazenamento de dados e clique em Criar.

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

Implantar o app de pesquisa

Decida como você planeja autenticar seu app de pesquisa da Pesquisa do agente: 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 seu 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 na Pesquisa do agente. Adicione o papel de Discovery Engine usuário ou de Discovery Engine leitor à 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, na lista de projetos na parte de cima de a Google Cloud página do console, selecione seu projeto.

    3. Clique em Criar credenciais e selecione Chave de API. Não adicione restrições de referenciador. Algumas configurações de privacidade do usuário não transmitem 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 da Pesquisa do agente em https://discoveryengine.googleapis.com/*.

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

Sobre a autenticação

A API Custom Search Site Restricted JSON do Mecanismo de Pesquisa Programável autentica usando uma chave de API. Já a Pesquisa do agente, com algumas exceções, exige o OAuth 2.0. Se você quiser continuar usando uma chave de API para autenticação, será necessário usar o searchLite método por chamadas de API.

Se você escolher autenticar pelo OAuth 2.0, será necessário usar o search método e o answer método para consultar seu site. Além disso, você pode 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 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
Autenticação Chave de API OAuth 2.0
Widget da Pesquisa disponível ✘ ✔
Resumos de pesquisa ✔ ✔
Pesquisar sites públicos ✔ ✔

Próximas etapas