Esta página mostra como pré-visualizar recomendações através da Google Cloud consola e obter resultados de recomendações através da API. Consulte o separador REST para ver exemplos de chamadas de API que podem ajudar a integrar recomendações na sua app.
O procedimento que usa depende de ter dados de multimédia ou dados personalizados:
- Receba recomendações de multimédia
- Receba recomendações personalizadas para uma app com dados estruturados
Receba recomendações de conteúdo multimédia
Consola
Para usar a Google Cloud consola para pré-visualizar recomendações de multimédia, siga estes passos:
Na Google Cloud consola, aceda à página Aplicações de IA.
Clique no nome da app para a qual quer pré-visualizar recomendações.
Clique em Configurações > Preparação. Se Ready to query for Sim, a app está pronta para pré-visualização.
Clique em Pré-visualizar.
Clique no campo ID do documento. É apresentada uma lista de IDs de documentos.
Clique no ID do documento para o documento para o qual quer receber recomendações. Em alternativa, introduza um ID do documento no campo ID do documento.
Clique em Selecionar configuração de publicação e selecione a configuração de publicação a pré-visualizar.
Opcional: introduza o ID do visitante (também denominado ID do utilizador pseudonimizado) de um utilizador para o qual recolheu eventos do utilizador. Se deixar este campo em branco ou introduzir um ID de visitante inexistente, vai pré-visualizar as recomendações como um novo utilizador.
Clique em Receber recomendações. É apresentada uma lista de documentos recomendados.
Clique num documento para ver os respetivos detalhes.
REST
Para usar a API para receber recomendações de multimédia, use o método
servingConfigs.recommend
:
Encontre o ID do motor e o ID da configuração de publicação. Se já tiver o ID do motor e os IDs de configuração de publicação, avance para o passo 2.
Na Google Cloud consola, aceda à página Aplicações de IA.
Clique no nome da app.
No painel de navegação, clique em Configurações.
Se tiver apenas uma configuração de publicação, obtenha o ID da configuração de publicação apresentado no separador Publicação.
Se tiver várias configurações de publicação listadas no separador Publicação, encontre a configuração de publicação a partir da qual quer receber recomendações. O ID da configuração de publicação é o valor na coluna ID.
Clique no separador Formação. O ID do motor é o valor na linha ID da app.
Certifique-se de que a app está pronta para pré-visualização:
Na Google Cloud consola, aceda à página Aplicações de IA.
Clique no nome da app.
Clique em Configurações > Preparação. Se Ready to query for Sim, a app está pronta para pré-visualização.
Receba recomendações.
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ -d '{ "validateOnly": false, "userEvent": { "eventType": "view-item", "userPseudoId": "USER_PSEUDO_ID", "documents": [{ "id": "DOCUMENT_ID" }], "filter": "FILTER_STRING" } }' \ "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/servingConfigs/SERVING_CONFIG_ID:recommend"
Substitua o seguinte:
PROJECT_ID
: o ID do seu projeto.DATA_STORE_ID
: o ID do seu armazenamento de dados.DOCUMENT_ID
: o ID do documento para o qual quer pré-visualizar recomendações. Use o ID que usou para este documento no momento em que carregou os seus dados.USER_PSEUDO_ID
: uma string codificada em UTF-8 que funciona como um identificador pseudonimizado exclusivo que acompanha os utilizadores. Pode ter um comprimento máximo de 128 carateres. A Google recomenda vivamente a utilização deste campo porque melhora o desempenho do modelo e a qualidade da personalização. Pode usar um cookie HTTP para este campo, que identifica de forma exclusiva um visitante num único dispositivo. Seguem-se algumas considerações importantes:- Este identificador não se altera quando o visitante inicia ou termina sessão num Website.
- Este campo não pode ser definido com o mesmo identificador para vários utilizadores. Caso contrário, o mesmo ID do utilizador pode combinar os históricos de eventos de diferentes utilizadores e degradar a qualidade do modelo.
- Este campo não pode incluir informações de identificação pessoal (PII).
Para mais informações, consulte
userPseudoId
.SERVING_CONFIG_ID
: o ID da sua configuração de publicação.FILTER
: opcional. Um campo de texto que lhe permite filtrar um conjunto especificado de campos através da sintaxe de expressão de filtro. O valor predefinido é uma string vazia, o que significa que não é aplicado nenhum filtro. Para mais informações, consulte o artigo Filtre recomendações.
Deverá ver resultados semelhantes aos seguintes:
{ "results": [{"id": "sample-id-1"}, {"id": "sample-id-2"}], "attributionToken": "abc123" }
A Google recomenda associar tokens de atribuição, que incluímos em cada resposta de pesquisa e recomendação, a ações que um utilizador realiza em resposta a essas respostas de pesquisa e recomendações. Isto pode melhorar a qualidade das suas respostas de pesquisa e recomendações ao longo do tempo. Para tal, acrescente valores attributionToken
aos URLs de cada um dos links que apresenta no seu Website para respostas de pesquisa ou recomendações, por exemplo, https://www.example.com/54321/?rtoken=abc123
. Quando um utilizador clica num destes links, inclua o valor attributionToken
no evento do utilizador que regista.
Receba recomendações para uma app com dados estruturados personalizados
Consola
Para usar a Google Cloud consola para pré-visualizar recomendações personalizadas para a sua app estruturada, siga estes passos:
Na Google Cloud consola, aceda à página Aplicações de IA.
Clique no nome da app para a qual quer pré-visualizar recomendações.
Clique em Pré-visualizar.
Clique no campo ID do documento. É apresentada uma lista de IDs de documentos.
Clique no ID do documento para o documento para o qual quer receber recomendações. Em alternativa, introduza um ID do documento no campo ID do documento.
Clique em Receber recomendações. É apresentada uma lista de documentos recomendados.
Clique num documento para ver os respetivos detalhes.
REST
Para usar a API para receber recomendações personalizadas para uma app com dados estruturados,
use o método servingConfigs.recommend
:
Encontre o ID do motor. Se já tiver o ID do motor, avance para o passo 2.
Na Google Cloud consola, aceda à página Aplicações de IA.
Clique no nome da app.
Obtenha o ID do motor a partir do URL da Google Cloud consola. É o texto entre
engines/
e/data
. Por exemplo, se o URL contivergen-app-builder/engines/demo_1234567890123/data/records
Então, o ID do motor é
demo_1234567890123
.
Encontre o ID da loja de dados. Se já tiver o ID do armazenamento de dados, avance para o passo seguinte.
Na Google Cloud consola, aceda à página Aplicações de IA e, no menu de navegação, clique em Armazenamentos de dados.
Clique no nome do seu arquivo de dados.
Na página Dados da sua loja de dados, obtenha o ID da loja de dados.
Certifique-se de que o motor está pronto para a pré-visualização consultando o método
GetEngine
até que devolva"servingState":"ACTIVE"
. Nesse momento, o motor está pronto para pré-visualização.curl -X GET \ -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/ENGINE_ID
Substitua o seguinte:
PROJECT_ID
: o ID do seu projeto.ENGINE_ID
: o ID do seu motor.
Receba recomendações.
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -d '{ "userEvent": { "eventType":"view-item", "userPseudoId":"USER_PSEUDO_ID", "documents":[{"id":"DOCUMENT_ID"}]}}' \ "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/servingConfigs/SERVING_CONFIG_ID:recommend"
Substitua o seguinte:
PROJECT_ID
: o ID do seu projeto.DATA_STORE_ID
: o ID do seu armazenamento de dados.DOCUMENT_ID
: o ID do documento para o qual quer pré-visualizar recomendações. Use o ID que usou para este documento no momento em que carregou os seus dados.USER_PSEUDO_ID
: uma string codificada em UTF-8 que funciona como um identificador pseudonimizado exclusivo que acompanha os utilizadores. Pode ter um comprimento máximo de 128 carateres. A Google recomenda vivamente a utilização deste campo porque melhora o desempenho do modelo e a qualidade da personalização. Pode usar um cookie HTTP para este campo, que identifica de forma exclusiva um visitante num único dispositivo. Seguem-se algumas considerações importantes:- Este identificador não se altera quando o visitante inicia ou termina sessão num Website.
- Este campo não pode ser definido com o mesmo identificador para vários utilizadores. Caso contrário, o mesmo ID do utilizador pode combinar os históricos de eventos de diferentes utilizadores e degradar a qualidade do modelo.
- Este campo não pode incluir informações de identificação pessoal (PII).
Para mais informações, consulte
userPseudoId
.SERVING_CONFIG_ID
: o ID da sua configuração de publicação. O ID da configuração de publicação é igual ao ID do motor, por isso, use o ID do motor aqui.
C#
Para mais informações, consulte a documentação de referência da API C# de aplicações de IA.
Para se autenticar em aplicações de IA, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para um ambiente de desenvolvimento local.
Go
Para mais informações, consulte a documentação de referência da API Go de aplicações de IA.
Para se autenticar em aplicações de IA, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para um ambiente de desenvolvimento local.
Java
Para mais informações, consulte a documentação de referência da API Java de aplicações de IA.
Para se autenticar em aplicações de IA, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure 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 de aplicações de IA.
Para se autenticar em aplicações de IA, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para um ambiente de desenvolvimento local.
PHP
Para mais informações, consulte a documentação de referência da API PHP de aplicações de IA.
Para se autenticar em aplicações de IA, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para um ambiente de desenvolvimento local.
Python
Para mais informações, consulte a documentação de referência da API Python de aplicações de IA.
Para se autenticar em aplicações de IA, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para um ambiente de desenvolvimento local.
Ruby
Para mais informações, consulte a documentação de referência da API Ruby de aplicações de IA.
Para se autenticar em aplicações de IA, configure as Credenciais padrão da aplicação. Para mais informações, consulte o artigo Configure a autenticação para um ambiente de desenvolvimento local.