Questa è la documentazione di Recommendations AI, Retail Search e la nuova console di Retail.

Eseguire la migrazione dalla versione beta all'API Retail

Recommendations AI ora utilizza l'API Retail. Questa pagina spiega le modifiche introdotte e le best practice per la migrazione durante il passaggio dalla versione v1beta1 dell'API Recommendations Engine (endpoint di servizio https://recommendationengine.googleapis.com) all'API Retail in disponibilità generale (endpoint di servizio https://retail.googleapis.com).

L'API Recommendations Engine e il relativo set di documentazione rimangono disponibili, ma non verranno più aggiornati.

Questo documento è valido solo se hai iniziato a utilizzare Recommendations AI quando era in versione beta.

Best practice

  • Invia traffico solo convalida prima della migrazione completa.
  • La migrazione incrementale del traffico è meglio di eseguire tutti i passaggi contemporaneamente. Se possibile, esegui la migrazione graduale del traffico da v1beta1 a v2.
  • Se esegui servizi in aree geografiche diverse, è meglio eseguire la migrazione di una alla volta per evitare interruzioni globali.

Modifiche alla documentazione

Questo set di documentazione riguarda l'API Retail disponibile a livello generale.

La documentazione beta impostata per l'API Recommendations Engine e il relativo set di documenti rimangono disponibili, ma non verranno più aggiornate. Di seguito puoi trovare la documentazione beta:

Modifiche alla console

La console Retail sostituisce la Console Consigli.

La console per la vendita al dettaglio è disponibile pubblicamente a partire dal 20 gennaio 2022. Se utilizzi la Console Recommendations, ti consigliamo di accedere ai tuoi progetti Recommendations AI dalla console del retail.

Per una spiegazione dei cambiamenti di funzionalità e terminologia nella console Retail rispetto alla console Consigli, consulta Passare alla console Retail.

Configurazioni e posizionamenti di pubblicazione

L'API Retail introduce configurazioni di pubblicazione, che sostituiscono il concetto di posizionamenti utilizzati dall'API Recommendations Engine.

Le configurazioni di pubblicazione sono disponibili a partire da Recommendations AI v2 e Retail Search v2alpha, utilizzando l'API Retail.

La risorsa servingConfig è disponibile nelle versioni v2beta e v2alpha dell'API Retail. Puoi utilizzare questa risorsa per creare, visualizzare, modificare e rimuovere le configurazioni di pubblicazione.

Se hai posizionamenti esistenti o ne crei di nuovi, l'API Retail crea automaticamente una configurazione di pubblicazione associata a ogni posizionamento. La creazione di una configurazione della pubblicazione non crea un posizionamento corrispondente.

Se elimini una configurazione di pubblicazione, viene eliminato il posizionamento corrispondente. Se elimini un posizionamento, viene eliminata anche la configurazione di pubblicazione corrispondente.

Le configurazioni di pubblicazione consentono di modificare le opzioni di diversità e re-ranking del prezzo e fare in modo che vengano applicate quasi in tempo reale. Con i posizionamenti, la diversità e le impostazioni dei prezzi possono essere modificate solo dal modello di suggerimento a cui rimanda il posizionamento.

I posizionamenti sono ancora supportati, ma è consigliabile utilizzare configurazioni di pubblicazione.

Per ulteriori informazioni sull'utilizzo delle configurazioni di pubblicazione, consulta Configurazioni di pubblicazione e Creazione delle configurazioni di pubblicazione.

Percorsi REST e RPC

Sono state apportate molte modifiche ai percorsi REST e RPC. Assicurati di esaminare la documentazione dell'API Retail per verificare di aver chiamato correttamente l'API Retail.

Tutti i percorsi ora utilizzano retail.googleapis.com invece di recommendationengine.googleapis.com.

Ad esempio:

API v1beta1 Recommendations Engine:

GET https://recommendationengine.googleapis.com/v1beta1/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/operations/OPERATION_ID

API v2 Retail:

GET https://retail.googleapis.com/v2/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/operations/OPERATION_ID

Alcuni metodi e risorse sono stati rinominati, rimossi o aggiunti di recente. La tabella riportata di seguito mette a confronto le risorse v1beta1 e v2 con i relativi metodi associati.

Ad esempio, la risorsa v1beta1 catalogs.catalogItems equivale alla risorsa v2 catalogs.branches.products. Il metodo list, disponibile in catalogs.catalogItems per v1beta1, non è disponibile per catalogs.branches.products in v2, pertanto è indicato come Rimosso.

Tieni presente che i link alle risorse v1beta1 rimandano alla documentazione dell'API per v1beta1.

Risorsa v1beta1 Metodo Risorsa v2 Metodo
catalogs list catalogs list
patch patch
N/A catalogs.branches.operations get
catalogs.catalogItems create catalogs.branches.products create
delete delete
get get
import import
list Rimosso
patch patch
catalogs.operations get catalogs.operations get
list list
catalogs.eventStores.operations get Rimosso
list
catalogs.eventStores.placements predict catalogs.placements predict
catalogs.eventStores.predictionApiKeyRegistrations create Rimosso
delete
list
catalogs.eventStores.userEvents collect catalogs.userEvents collect
import import
list Rimosso
purge purge
rejoin rejoin
write write
N/A operations get
list

Modifiche IAM

Sono state introdotte le seguenti modifiche ai ruoli e alle autorizzazioni di Gestione di identità e accessi (IAM) per la vendita al dettaglio:

  • Retail utilizza autorizzazioni e ruoli IAM nello spazio dei nomi retail anziché nello spazio dei nomi automlrecommendations utilizzato da Recommendations Engine v1beta1.
  • Il ruolo Admin Viewer è stato rimosso.
  • Le autorizzazioni per apiKeys sono state rimosse perché il metodo predict non richiede più una propria chiave API.

Cataloghi degli schemi di eventi e utenti

Gli schemi per gli eventi catalogo e utente sono cambiati nell'API Retail.