Nesta página, mostramos como visualizar os resultados da pesquisa usando o console do Google Cloud e resultados da pesquisa usando a API.
Além disso, em vez de criar um widget de pesquisa para adicionar à sua página da Web, faça chamadas de API e integre essas chamadas ao seu servidor ou aplicativo. Esta página inclui exemplos de código para criar consultas de pesquisa usando as bibliotecas de cliente gRPC com uma conta de serviço.
O resumo da pesquisa varia de acordo com o modelo
Se você gerar resumos de pesquisa para suas consultas, poderá notar que os resumos são diferentes entre os resultados do console e os da API. Se você ver isto, o motivo provável é que o console está usando um modelo LLM diferente da API. Os exemplos de curl e de código nesta página usam o modelo LLM estável.
Para mudar ou conferir o modelo de LLM usado na página Prévia da interface, acesse a página Configurações > guia Interface do app.
Para chamadas de método, para usar um modelo LLM diferente do modelo estável, consulte Especificar o modelo de resumo.
Conseguir resultados de pesquisa para um app com dados do site
Console
Usar o console do Google Cloud para visualizar os resultados da pesquisa de um app com site dados, siga estas etapas:
No Console do Google Cloud, acesse a página Criador de agentes.
Clique no nome do app que você quer editar.
Clique em Visualização.
Abra a página Visualização no console.
Opcional: se você conectou vários repositórios de dados ao app, mas quer resultados apenas de um repositório específico, selecione o repositório de dados de onde quer receber os resultados.
Digite uma consulta de pesquisa.
- Se você tiver ativado o preenchimento automático, verá uma lista de opções sugestões abaixo da barra de pesquisa enquanto você digita.
Clique em Enter para enviar a consulta.
- Uma lista de resultados da pesquisa vai aparecer abaixo da barra de pesquisa.
- Cada resultado contém um título, um snippet e um URL.
- Quando você clica em um resultado, o URL correspondente é aberto.
Clique na seta abaixo da lista de resultados para carregar a próxima página.
REST
Para usar a API para receber resultados da pesquisa de um app com dados de sites, faça o seguinte:
use o método engines.servingConfigs.search
:
Encontre o ID do app. Se você já tiver o ID do app, pule para a próxima etapa.
No Console do Google Cloud, acesse a página Criador de agentes.
Na página Apps, encontre o nome do app e confira o ID dele na coluna ID.
Receber resultados de pesquisa.
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/servingConfigs/default_search:search" \ -d '{ "servingConfig": "projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search", "query": "QUERY", "pageSize": "PAGE_SIZE", "offset": "OFFSET", "orderBy": "ORDER_BY", "params": {"user_country_code": "USER_COUNTRY_CODE", "searchType": "SEARCH_TYPE"}, "filter": "FILTER", "boostSpec": "BOOST_SPEC", "contentSearchSpec": { "searchResultMode": "RESULT_MODE" }, "dataStoreSpec": {"DATA_STORE_SPEC"} }'
- PROJECT_ID: o ID do seu projeto do Google Cloud.
- APP_ID: o ID do app Vertex AI para Pesquisa que você o que você quer consultar.
- QUERY: o texto da consulta a ser pesquisada.
PAGE_SIZE: o número de resultados retornados pela pesquisa. O tamanho máximo permitido da página depende do tipo de dados. Tamanhos de página acima do são convertidos para o valor máximo.
- Sites com indexação básica: padrão
10
, máximo25
- Sites com indexação avançada: padrão
25
, máximo50
- Outros:
50
padrão, máximo de100
- Sites com indexação básica: padrão
OFFSET: o índice inicial dos resultados. O valor padrão é 0.
Por exemplo, se o deslocamento for 2, o tamanho da página for 10 e houver 15 resultados para retornar, os resultados de 2 a 12 serão retornados na primeira página.
ORDER_BY: a ordem em que os resultados são organizados. O para classificar devem ter uma interpretação numérica, por exemplo, como preço ou data.
USER_COUNTRY_CODE: o local do usuário. Essa chave-valor é a única entrada compatível para o campo de mapa
params
. O valor padrão está vazio. Para valores aceitáveis, consulte Códigos de país na documentação de referência da API JSON do Mecanismo de Pesquisa Programável.SEARCH_TYPE: o tipo de pesquisa a ser realizada. O valor padrão é 0 para a pesquisa de documentos. O outro valor aceito é 1 para a pesquisa de imagens.
FILTER: um campo de texto para filtrar sua pesquisa usando um expressão de filtro. O valor padrão é uma string vazia. Para mais informações sobre como usar o campo
filter
, consulte Filtrar site pesquisa.BOOST_SPEC: opcional. Uma especificação para aumentar ou ocultar documentos. Valores:
BOOST
: um número de ponto flutuante entre -1 e 1. Quando o valor é negativo, os resultados são rebaixados (eles aparecem mais abaixo nos resultados). Quando o valor é positivo, os resultados são promovidos (eles aparecem mais acima nos resultados).CONDITION
: uma expressão de filtro de texto para selecionar os documentos em que o aumento é aplicado. O filtro precisa avaliar como um valor booleano. Para saber mais sobre a otimização da pesquisa estruturada, consulte Otimizar os resultados da pesquisa.
RESULT_MODE: determina se os resultados da pesquisa serão retornados. como documentos completos ou em partes. Para receber blocos, o armazenamento de dados precisa ter o agrupamento de documentos ativado. Os valores aceitos são
documents
echunks
. Quando a divisão está ativada em um repositório de dados, o padrão o valor échunks
. Caso contrário, o padrão serádocuments
. Para informações sobre a fragmentação de documentos, consulte Analisar e fragmentar documentos. Esse campo está em pré-lançamento público. Para usá-lo, mudev1
parav1alpha
no comando curl.DATA_STORE_SPEC: filtra um repositório de dados específico para pesquisa. Use
dataStoreSpec
se o app de pesquisa estiver conectado a vários repositórios de dados, mas você quiser resultados de um repositório específico.
C#
Para mais informações, consulte a documentação de referência da API C# do Vertex AI Agent Builder.
Para autenticar no Vertex AI Agent Builder, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Java
Para mais informações, consulte a API Vertex AI Agent Builder Java documentação de referência.
Para autenticar no Vertex AI Agent Builder, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Node.js
Para mais informações, consulte a documentação de referência da API Node.js do Vertex AI Agent Builder.
Para autenticar no Vertex AI Agent Builder, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
PHP
Para mais informações, consulte a documentação de referência da API PHP do Vertex AI Agent Builder.
Para autenticar no Vertex AI Agent Builder, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Python
Para mais informações, consulte a API Vertex AI Agent Builder Python documentação de referência.
Para autenticar no Vertex AI Agent Builder, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Ruby
Para mais informações, consulte a API Vertex AI Agent Builder Ruby documentação de referência.
Para autenticar no Vertex AI Agent Builder, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Receber resultados de pesquisa para um app com dados estruturados ou não estruturados
É possível visualizar os resultados da pesquisa no console do Google Cloud ou acessá-los usando a API.
Console
Para usar o console do Google Cloud para visualizar os resultados da pesquisa de um app com dados estruturados ou não estruturados, siga estas etapas:
- Abra a página Visualização no console.
- Digite uma consulta de pesquisa.
- Se você ativou o preenchimento automático na etapa 1, uma lista de sugestões de preenchimento automático vai aparecer abaixo da barra de pesquisa conforme você digita.
- (Opcional) Se você conectou vários repositórios de dados ao seu app, mas quer resultados somente de um repositório de dados específico, selecione o repositório de dados para obter resultados.
- Clique em Enter para enviar a consulta.
- Uma lista de resultados da pesquisa vai aparecer abaixo da barra de pesquisa.
- Se nenhum mapeamento de atributo for definido na página Configurações, cada resultado da pesquisa vai aparecer como uma lista de nomes e valores de atributos brutos.
- Se algum mapeamento de atributo tiver sido salvo em Configurações os resultados da pesquisa exibirão as mesmas imagens que você vê na Visualização da página Configurações.
- Se algumas facetas tiverem sido especificadas na página Configurações, elas serão mostradas da mesma forma.
- Clique na seta abaixo da lista de resultados para carregar a próxima página.
REST
Para usar a API e receber resultados de pesquisa para um app com dados estruturados ou não estruturados, use o método engines.servingConfigs.search
:
Encontre o ID do app. Se você já tiver o ID do app, pule para a próxima etapa.
No Console do Google Cloud, acesse a página Criador de agentes.
Na página Apps, encontre o nome do app e confira o ID dele na coluna ID.
Receber resultados de pesquisa.
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/servingConfigs/default_search:search" \ -d '{ "query": "QUERY", "userPseudoId": "USER_PSEUDO_ID", "pageSize": "PAGE_SIZE", "offset": "OFFSET", "orderBy": "ORDER_BY", "filter": "FILTER", "boostSpec": "BOOST_SPEC", "facetSpec": "FACET_SPEC", "queryExpansionSpec": "QUERY_EXPANSION_SPEC", "spellCorrectionSpec": "SPELL_CORRECTION_SPEC", "contentSearchSpec": "CONTENT_SEARCH_SPEC", "dataStoreSpec": {"DATA_STORE_SPEC"}, }'
- PROJECT_ID: o ID do seu projeto do Google Cloud.
- APP_ID: o ID do app Vertex AI para Pesquisa que você o que você quer consultar.
- QUERY: o texto da consulta a ser pesquisada.
- USER_PSEUDO_ID: opcional. É um identificador pseudônimo para rastrear um visitante de pesquisa. O Google recomenda o uso desse campo, que melhora a performance do modelo e a qualidade da personalização. Você pode usar um cookie HTTP para esse campo, que identifica de forma exclusiva um visitante em um único dispositivo. Esse identificador não muda quando o visitante faz login ou sai de um site. Não defina esse campo como o mesmo identificador para vários usuários. Isso combinaria os históricos de eventos deles e degradaria a qualidade do modelo. Não inclua informações de identificação pessoal (PII) neste campo.
PAGE_SIZE: o número de resultados retornados pela pesquisa. O tamanho máximo permitido da página depende do tipo de dados. Tamanhos de página acima do são convertidos para o valor máximo.
- Sites com indexação básica: padrão
10
, máximo25
- Sites com indexação avançada: padrão
25
, máximo50
- Outros:
50
padrão, máximo de100
- Sites com indexação básica: padrão
OFFSET: opcional. O índice inicial dos resultados. O valor padrão é 0.
Por exemplo, se o deslocamento for 2, o tamanho da página será 10, e há 15 resultados para retornar, os resultados de 2 a 11 são retornados na primeira página.
ORDER_BY: opcional. A ordem em que os resultados são organizados.
FILTER: opcional. Um campo de texto para filtrar sua pesquisa usando uma expressão de filtro. O valor padrão é uma string vazia, que significa que nenhum filtro é aplicado.
Exemplo:
color: ANY("red", "blue") AND score: IN(*, 100.0e)
Para mais informações, consulte Filtrar pesquisas estruturadas ou não estruturadas dados.
BOOST_SPEC: opcional. Uma especificação para aumentar ou ocultar documentos. Valores:
BOOST
: um número de ponto flutuante entre -1 e 1. Quando o valor for negativos, os resultados são rebaixados (aparecem mais abaixo na resultados. Quando o valor é positivo, os resultados são promovidos (eles aparecem mais acima nos resultados).CONDITION
: uma expressão de filtro de texto para selecionar os documentos em que o aumento é aplicado. O filtro precisa ser avaliado como um valor booleano.
Para saber mais sobre o aumento da pesquisa estruturada, consulte Aumentar os resultados da pesquisa.
FACET_SPEC: opcional. Uma especificação de atributo a ser executada facetada.
QUERY_EXPANSION_SPEC: opcional. Uma especificação para determinar em que condições a expansão da consulta deve ocorrer. O padrão é
DISABLED
.SPELL_CORRECTION_SPEC: opcional. Uma especificação para determinar em quais condições a correção ortográfica precisa ocorrer. O padrão é
AUTO
.CONTENT_SEARCH_SPEC: opcional. Para receber snippets, respostas extrativas, segmentos extrativos e resumos de pesquisa. Para apenas para dados não estruturados. Veja mais informações em:
DATA_STORE_SPEC: filtra um repositório de dados específico para pesquisa. Isso pode ser usado se o app de pesquisa estiver conectado a vários repositórios de dados.
Como visualizar os resultados da pesquisa guiada na resposta da pesquisa:
Os resultados da pesquisa guiada são retornados com respostas para pesquisas e pesquisa não estruturada. O resultado da pesquisa guiada contém uma lista de pares de chave-valor de atributos extraídos com base nos documentos de resultados da pesquisa. Isso permite que os usuários refinem os resultados da pesquisa usando algumas chaves de atributos e valores como filtros.
Neste exemplo de resposta, a cor verde foi usada para refinar os resultados da pesquisa emitir uma nova solicitação de pesquisa com o campo de filtro especificado como
_gs.color: ANY("green")
:{ "guidedSearchResult": { "refinementAttributes": [ { "attributeKey": "_gs.color", "attributeValue" : "green" }, { "attributeKey": "_gs.category", "attributeValue" : "shoe" } ] } }
C#
Para mais informações, consulte a documentação de referência da API C# do Vertex AI Agent Builder.
Para autenticar no Vertex AI Agent Builder, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Java
Para mais informações, consulte a API Vertex AI Agent Builder Java documentação de referência.
Para autenticar no Vertex AI Agent Builder, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Node.js
Para mais informações, consulte a documentação de referência da API Node.js do Vertex AI Agent Builder.
Para autenticar no Vertex AI Agent Builder, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
PHP
Para mais informações, consulte a API Vertex AI Agent Builder PHP documentação de referência.
Para autenticar no Vertex AI Agent Builder, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Python
Para mais informações, consulte a documentação de referência da API Python do Vertex AI Agent Builder.
Para autenticar no Vertex AI Agent Builder, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Ruby
Para mais informações, consulte a API Vertex AI Agent Builder Ruby documentação de referência.
Para autenticar no Vertex AI Agent Builder, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Receber resultados da pesquisa enquanto você digita para um app de música
Para pesquisa de mídia, a Vertex AI Agent Builder oferece dois tipos de comportamento de pesquisa:
O usuário digita a consulta de pesquisa e pressiona Enter. Esse é o padrão e é o mesmo comportamento da pesquisa no widget e da pesquisa por elementos que não sejam de mídia (genéricos) apps. Consulte Receber resultados de pesquisa para um app com dados estruturados ou não estruturados.
Um novo resultado de pesquisa é retornado após cada letra inserida pelo usuário. Isso é chamado de pesquisa enquanto você digita e é particularmente útil para usuários que estão o usuário digitam consultas de pesquisa por meio de interfaces mais estranhas, como controle remoto de uma televisão.
Para receber os resultados da pesquisa enquanto você digita para um app de música:
Console
Para usar o console do Google Cloud e ativar a pesquisa conforme você digita em um app de widget:
No Console do Google Cloud, acesse a página Criador de agentes.
Clique no nome do app de pesquisa de mídia que você quer usar para a pesquisa conforme digita.
Clique em Configurations.
Clique na guia UI.
Clique no botão Ativar pesquisa enquanto você digita.
No painel Visualização, comece a digitar uma consulta.
Os resultados da pesquisa são atualizados após cada tecla pressionada.
Para manter a configuração de pesquisa conforme você digita, clique em Salvar e publicar.
REST
Use o método dataStores.servingConfigs.search
para receber
resultados de pesquisa de um app de mídia:
Encontre o ID do app. Se você já tiver o ID do app, pule para a próxima etapa.
No Console do Google Cloud, acesse a página Criador de agentes.
Na página Apps, localize o nome do seu app e acesse o ID dele na a coluna ID;
Execute o comando curl a seguir para receber resultados de pesquisa conforme você digita.
Todos os campos, exceto
contentSearchSpec
, podem ser usados com o camposearchAsYouTypeSpec
. Para maior clareza, os campos opcionais foram omitidos do comando curl. Para os campos opcionais, consulte Receber resultados da pesquisa para um app com dados estruturados ou não estruturados.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/servingConfigs/default_search:search" \ -d '{ "query": "QUERY", "searchAsYouTypeSpec": {"condition": "ENABLED"} }'
- PROJECT_ID: o ID do seu projeto do Google Cloud.
- APP_ID: o ID do app Vertex AI para Pesquisa que você o que você quer consultar.
- QUERY: o texto da consulta a ser pesquisada.
Clique para conferir um exemplo de comando curl.
curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" "https://discoveryengine.googleapis.com/v1/projects/12345/locations/global/collections/default_collection/engines/my-app_4321/servingConfigs/default_search:search" -d '{ "query": "midsummer night", "searchAsYouTypeSpec": {"condition": "ENABLED"} }'