Questa pagina mostra come visualizzare l'anteprima dei consigli utilizzando la console Google Cloud e come ottenere i risultati dei consigli utilizzando l'API. Consulta la scheda REST per esempi di chiamate API che possono aiutarti a integrare i consigli nella tua app.
La procedura che utilizzi dipende dal tipo di consigli che vuoi ricevere e dal tipo di datastore a cui è collegata la tua app di consigli:
- Ricevere consigli sui contenuti multimediali
- Ricevere consigli generici per un'app con dati strutturati
- Ricevere consigli generici per un'app con dati non strutturati
- Ricevere consigli generici per un'app con i dati di un sito web
Ricevere consigli sui contenuti multimediali
Console
Per utilizzare la console Google Cloud per visualizzare l'anteprima dei consigli sui contenuti multimediali, segui questi passaggi:
Nella console Google Cloud, vai alla pagina Agent Builder.
Fai clic sul nome dell'app per cui vuoi visualizzare l'anteprima dei consigli.
Fai clic su Configurazioni > Addestramento. Se Pronto per le query è OK, l'app è pronta per l'anteprima.
Fai clic su Anteprima.
Fai clic sul campo ID documento. Viene visualizzato un elenco di ID documento.
Fai clic sull'ID del documento per il quale vuoi ricevere suggerimenti. In alternativa, inserisci un ID documento nel campo ID documento.
Fai clic su Seleziona configurazione di pubblicazione e seleziona la configurazione di pubblicazione di cui vuoi visualizzare l'anteprima.
(Facoltativo) Inserisci l'ID visitatore (chiamato anche pseudo ID utente) di un utente per cui hai raccolto gli eventi utente. Se lasci vuoto questo campo o inserisci un ID visitatore inesistente, vedrai l'anteprima dei consigli come nuovo utente.
Fai clic su Ricevi suggerimenti. Viene visualizzato un elenco di documenti suggeriti.
Fai clic su un documento per visualizzarne i dettagli.
REST
Per utilizzare l'API per ricevere consigli sui contenuti multimediali, utilizza il metodo
servingConfigs.recommend
:
Trova l'ID motore e l'ID configurazione di pubblicazione. Se hai già l'ID motore e gli ID configurazione di pubblicazione, vai al passaggio 2.
Nella console Google Cloud, vai alla pagina Agent Builder.
Fai clic sul nome dell'app.
Nel riquadro di navigazione, fai clic su Configurazioni.
Se hai solo la configurazione di pubblicazione creata automaticamente quando hai creato l'app, l'ID configurazione di pubblicazione e l'ID motore sono uguali. Vai al passaggio successivo.
Se nella scheda Configurazioni di pubblicazione sono elencate più configurazioni di pubblicazione, individua quella da cui vuoi ricevere i consigli. L'ID configurazione di pubblicazione è il valore nella colonna ID.
Se hai eliminato la configurazione di pubblicazione creata automaticamente quando hai creato l'app e al momento hai una sola configurazione di pubblicazione creata manualmente, vai alla pagina Anteprima e fai clic su Seleziona configurazione di pubblicazione per visualizzare l'ID configurazione di pubblicazione.
Fai clic sulla scheda Addestramento. L'ID motore è il valore nella riga ID app.
Assicurati che l'app sia pronta per l'anteprima:
Nella console Google Cloud, vai alla pagina Agent Builder.
Fai clic sul nome dell'app.
Fai clic su Configurazioni > Addestramento. Se Pronta per le query è OK, l'app è pronta per l'anteprima.
Ricevere consigli.
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"
- PROJECT_ID: l'ID del progetto.
- DATA_STORE_ID: l'ID del tuo datastore.
- DOCUMENT_ID: l'ID del documento per il quale vuoi visualizzare l'anteprima dei consigli. Utilizza l'ID che hai utilizzato per questo documento al momento dell'importazione dei dati.
- USER_PSEUDO_ID: un identificatore pseudonimo dell'utente. Puoi utilizzare un cookie HTTP per questo campo, che identifica in modo univoco un visitatore su un singolo dispositivo. Non impostare questo campo sullo stesso identificatore per più utenti, poiché questo combinerebbe le relative cronologie degli eventi e peggiorerebbe la qualità del modello. Non includere informazioni che consentono l'identificazione personale (PII) in questo campo.
- SERVING_CONFIG_ID: l'ID della configurazione di pubblicazione.
- FILTER: facoltativo. Un campo di testo che consente di filtrare in base a un insieme specificato di campi utilizzando la sintassi dell'espressione di filtro. Il valore predefinito è una stringa vuota, il che significa che non viene applicato alcun filtro. Per ulteriori informazioni, consulta Filtrare i consigli.
Dovresti visualizzare risultati simili ai seguenti:
{ "results": [{"id": "sample-id-1"}, {"id": "sample-id-2"}], "attributionToken": "abc123" }
Google consiglia di associare i token di attribuzione, che includiamo in ogni risposta e consiglio di ricerca, alle azioni intraprese da un utente in risposta a queste risposte e a questi consigli. In questo modo, nel tempo, puoi migliorare la qualità delle risposte e dei consigli di ricerca. A questo scopo, aggiungi i valori attributionToken
agli URL di ciascuno dei link visualizzati sul tuo sito web per le risposte o i consigli di ricerca, ad esempio https://www.example.com/54321/?rtoken=abc123
. Quando un utente fa clic su uno di questi
link, includi il valore attributionToken
nell'evento utente registrato.
Ricevere consigli generici per un'app con dati strutturati
Console
Per utilizzare la console Google Cloud per visualizzare l'anteprima di consigli generici per la tua app strutturata:
Nella console Google Cloud, vai alla pagina Agent Builder.
Fai clic sul nome dell'app per cui vuoi visualizzare l'anteprima dei consigli.
Fai clic su Anteprima.
Fai clic sul campo ID documento. Viene visualizzato un elenco di ID documento.
Fai clic sull'ID del documento per il quale vuoi ricevere suggerimenti. In alternativa, inserisci un ID documento nel campo ID documento.
Fai clic su Ricevi suggerimenti. Viene visualizzato un elenco di documenti suggeriti.
Fai clic su un documento per visualizzarne i dettagli.
REST
Per utilizzare l'API per ricevere consigli generici per un'app con dati strutturati,
utilizza il metodo servingConfigs.recommend
:
Trova l'ID motore. Se hai già l'ID motore, vai al passaggio 2.
Nella console Google Cloud, vai alla pagina Agent Builder.
Fai clic sul nome dell'app.
Recupera l'ID motore dall'URL della console Google Cloud. Si tratta del testo tra
engines/
e/data
. Ad esempio, se l'URL contienegen-app-builder/engines/demo_1234567890123/data/records
l'ID motore è
demo_1234567890123
.
Trova l'ID del tuo datastore. Se hai già l'ID del tuo datastore, vai al passaggio successivo.
Nella console Google Cloud, vai alla pagina Agent Builder e nel menu di navigazione fai clic su Data Store.
Fai clic sul nome del tuo datastore.
Nella pagina Dati del tuo datastore, ottieni l'ID datastore.
Assicurati che il motore sia pronto per l'anteprima eseguendo il polling del metodo
GetEngine
finché non restituisce"servingState":"ACTIVE"
. A questo punto, il motore è pronto per l'anteprima.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
- PROJECT_ID: l'ID del progetto.
- ENGINE_ID: l'ID del tuo motore.
Ricevere consigli.
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"
- PROJECT_ID: l'ID del progetto.
- DATA_STORE_ID: l'ID del tuo datastore.
- DOCUMENT_ID: l'ID del documento per il quale vuoi visualizzare l'anteprima dei consigli. Utilizza l'ID che hai utilizzato per questo documento al momento dell'importazione dei dati.
- USER_PSEUDO_ID: un identificatore pseudonimo dell'utente. Puoi utilizzare un cookie HTTP per questo campo, che identifica in modo univoco un visitatore su un singolo dispositivo. Non impostare questo campo sullo stesso identificatore per più utenti, poiché questo combinerebbe le relative cronologie degli eventi e peggiorerebbe la qualità del modello. Non includere informazioni che consentono l'identificazione personale (PII) in questo campo.
- SERVING_CONFIG_ID: l'ID della configurazione di pubblicazione. Il tuo ID configurazione di pubblicazione è uguale al tuo ID motore, quindi utilizza l'ID motore qui.
C#
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API C# Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Go
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Go Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Java
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Java Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Node.js Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
PHP
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API PHP Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Python
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Python Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Ruby
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Ruby Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Ricevere consigli generici per un'app con dati non strutturati
Console
Per utilizzare la console Google Cloud per visualizzare l'anteprima dei consigli generici, segui questi passaggi:
Nella console Google Cloud, vai alla pagina Agent Builder.
Fai clic sul nome dell'app per cui vuoi visualizzare l'anteprima dei consigli.
Fai clic su Anteprima.
Fai clic sul campo URI. Viene visualizzato un elenco di URI.
Fai clic sull'URI del documento per il quale vuoi ricevere suggerimenti. In alternativa, inserisci un URI nel campo URI.
Fai clic su Ricevi suggerimenti. Viene visualizzato un elenco di URI per i documenti consigliati.
Fai clic su un URI per visualizzare il documento.
REST
Per utilizzare l'API per ricevere consigli generici per un'app con dati non strutturati, segui questi passaggi:
Trova l'ID motore. Se hai già l'ID motore, vai al passaggio 2.
Nella console Google Cloud, vai alla pagina Agent Builder.
Fai clic sul nome dell'app.
Recupera l'ID motore dall'URL della console Google Cloud. Si tratta del testo tra
engines/
e/data
. Ad esempio, se l'URL contienegen-app-builder/engines/demo_1234567890123/data/records
l'ID motore è
demo_1234567890123
.
Trova l'ID del tuo datastore. Se hai già l'ID del tuo datastore, vai al passaggio successivo.
Nella console Google Cloud, vai alla pagina Agent Builder e nel menu di navigazione fai clic su Data Store.
Fai clic sul nome del tuo datastore.
Nella pagina Dati del tuo datastore, ottieni l'ID datastore.
Assicurati che il motore sia pronto per l'anteprima eseguendo il polling del metodo
GetEngine
finché non restituisce"servingState":"ACTIVE"
. A questo punto, il motore è pronto per l'anteprima.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
- PROJECT_ID: l'ID del progetto.
- ENGINE_ID: l'ID del tuo motore.
Ricevere consigli.
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"
- PROJECT_ID: l'ID del progetto.
- DATA_STORE_ID: l'ID dello datastore associato al tuo motore.
- DOCUMENT_ID: l'ID del documento per il quale vuoi visualizzare l'anteprima dei consigli. Utilizza l'ID documento che hai fornito al momento dell'importazione dei dati.
- USER_PSEUDO_ID: un identificatore pseudonimo dell'utente. Puoi utilizzare un cookie HTTP per questo campo, che identifica in modo univoco un visitatore su un singolo dispositivo. Non impostare questo campo sullo stesso identificatore per più utenti, poiché questo combinerebbe le relative cronologie degli eventi e peggiorerebbe la qualità del modello. Non includere informazioni che consentono l'identificazione personale (PII) in questo campo.
- SERVING_CONFIG_ID: l'ID della configurazione di pubblicazione. Il tuo ID configurazione di pubblicazione è uguale al tuo ID motore, quindi utilizza l'ID motore qui.
C#
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API C# Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Go
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Go Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Java
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Java Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Node.js Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
PHP
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API PHP Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Python
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Python Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Ruby
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Ruby Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Ricevere consigli generici per un'app con dati di un sito web
Console
Per utilizzare la console Google Cloud per visualizzare l'anteprima di consigli generici per la tua app website, segui questi passaggi:
Nella console Google Cloud, vai alla pagina Agent Builder.
Fai clic sul nome dell'app per cui vuoi visualizzare l'anteprima dei consigli.
Nel menu di navigazione, fai clic su Anteprima.
Fai clic sul campo URI. Viene visualizzato un elenco di URL dal tuo sito web.
Fai clic sull'URL della pagina web per la quale desideri suggerimenti. In alternativa, inserisci un URL del tuo sito web nel campo URL.
Fai clic su Ricevi suggerimenti. Viene visualizzato un elenco di URL per le pagine web suggerite.
Fai clic su un URL per visualizzare la pagina web.
REST
Per utilizzare l'API per ricevere consigli generici per un'app con dati del sito web,
utilizza il metodo servingConfigs.recommend
:
Trova l'ID motore. Se hai già l'ID motore, vai al passaggio 2.
Nella console Google Cloud, vai alla pagina Agent Builder.
Fai clic sul nome dell'app.
Recupera l'ID motore dall'URL della console Google Cloud. Si tratta del testo tra
engines/
e/data
. Ad esempio, se l'URL contienegen-app-builder/engines/demo_1234567890123/data/records
l'ID motore è
demo_1234567890123
.
Trova l'ID del tuo datastore. Se hai già l'ID del tuo datastore, vai al passaggio successivo.
Nella console Google Cloud, vai alla pagina Agent Builder e nel menu di navigazione fai clic su Data Store.
Fai clic sul nome del tuo datastore.
Nella pagina Dati del tuo datastore, ottieni l'ID datastore.
Assicurati che il motore sia pronto per l'anteprima eseguendo il polling del metodo
GetEngine
finché non restituisce"servingState":"ACTIVE"
. A questo punto, il motore è pronto per l'anteprima.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
- PROJECT_ID: l'ID del progetto.
- ENGINE_ID: l'ID del tuo motore.
Ricevere consigli.
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":[{"uri":"WEBSITE_URL"}]}}' \ "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/servingConfigs/SERVING_CONFIG_ID:recommend"
- PROJECT_ID: l'ID del progetto.
- DATA_STORE_ID: l'ID del tuo datastore.
- WEBSITE_URL: l'URL del sito web per cui vuoi visualizzare l'anteprima dei consigli.
- USER_PSEUDO_ID: un identificatore pseudonimo dell'utente. Puoi utilizzare un cookie HTTP per questo campo, che identifica in modo univoco un visitatore su un singolo dispositivo. Non impostare questo campo sullo stesso identificatore per più utenti, in quanto ciò combinerebbe le relative cronologie degli eventi e peggiorerebbe la qualità del modello. Non includere informazioni che consentono l'identificazione personale (PII) in questo campo.
- SERVING_CONFIG_ID: l'ID della configurazione di pubblicazione. L'ID configurazione pubblicazione è uguale all'ID motore, quindi utilizza l'ID motore qui.
C#
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API C# Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Go
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Go Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Java
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Java Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Node.js Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
PHP
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API PHP Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Python
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Python Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Ruby
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Ruby Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.