Gli sviluppatori possono utilizzare l'API Conversational Analytics, a cui si accede tramite geminidataanalytics.googleapis.com
, per creare un'interfaccia di chat o un agente di dati basato sull'intelligenza artificiale (AI) che risponde a domande sui dati strutturati in BigQuery, Looker e Looker Studio utilizzando il linguaggio naturale. Con l'API Conversational Analytics, fornisci all'agente dati informazioni e dati aziendali ("contesto"), nonché l'accesso a strumenti come SQL, Python e librerie di visualizzazione. Queste risposte dell'agente vengono presentate all'utente e possono essere registrate dall'applicazione client, creando un'esperienza di chat con i dati fluida e verificabile.
Scopri come e quando Gemini per Google Cloud utilizza i tuoi dati.
Inizia a utilizzare l'API Conversational Analytics
Per iniziare a utilizzare l'API Conversational Analytics, puoi prima consultare la documentazione relativa all'architettura e ai concetti chiave per capire come gli agenti elaborano le richieste, i flussi di lavoro per i creatori e gli utenti degli agenti, le modalità di conversazione e i ruoli di Identity and Access Management (IAM). Per iniziare a creare agenti di dati, puoi scegliere tra un'esperienza guidata con i notebook Colaboratory o un approccio autonomo seguendo i passaggi descritti in Configurazione e prerequisiti.
Notebook interattivi di Colaboratory
Per una guida interattiva passo passo alla configurazione dell'ambiente, alla creazione di un agente dati e all'esecuzione di chiamate API, consulta i seguenti blocchi note Colaboratory:
- Notebook HTTP Colaboratory dell'API Conversational Analytics
- Notebook Colaboratory dell'SDK dell'API Conversational Analytics
Configurazione e prerequisiti
Prima di utilizzare l'API o gli esempi, completa i seguenti passaggi:
- Abilitare l'API Conversational Analytics: descrive i prerequisiti per abilitare l'API Conversational Analytics.
- Concedi ruoli e autorizzazioni IAM per l'API Conversational Analytics: descrive i ruoli IAM predefiniti per la gestione dell'accesso agli agenti di dati.
- Autenticarsi e connettersi a un'origine dati con l'API Conversational Analytics: fornisce istruzioni per l'autenticazione all'API e la configurazione delle connessioni ai dati di BigQuery, Looker e Looker Studio.
Creare e interagire con un agente di dati
Dopo aver completato i passaggi precedenti, utilizza l'API Conversational Analytics per creare un agente di dati e interagire con lui seguendo questi passaggi:
- Crea un agente dati utilizzando HTTP: fornisce un esempio completo di creazione e interazione con un agente dati utilizzando richieste HTTP dirette con Python.
- Crea un data agent utilizzando l'SDK Python: fornisce un esempio completo di creazione e interazione con un data agent utilizzando l'SDK Python.
- Scrivere istruzioni di sistema efficaci: scopri come strutturare i contenuti YAML per il parametro
system_instruction
per guidare il comportamento dell'agente e migliorare l'accuratezza delle risposte. Puoi anche visualizzare esempi di istruzioni di sistema nelle origini dati BigQuery e nelle origini dati Looker. - Visualizzare la risposta di un agente dell'API Conversational Analytics come visualizzazione: fornisce un esempio di elaborazione delle specifiche del grafico dalle risposte dell'API e di rendering come visualizzazioni utilizzando l'SDK Python e la libreria Vega-Altair.
Best practice
- Gestisci i costi di BigQuery per i tuoi agenti: scopri come monitorare e gestire i costi di BigQuery per gli agenti dell'API Conversational Analytics impostando limiti di spesa a livello di progetto, utente e query.
Operazioni API chiave
L'API fornisce i seguenti endpoint principali per la gestione degli agenti di dati e delle conversazioni:
Operazione | Metodo HTTP | Endpoint | Descrizione |
---|---|---|---|
Crea un agente | POST |
/v1beta/projects/*/locations/*/dataAgents |
Crea un nuovo agente dati. |
Recuperare un agente | GET |
/v1beta/projects/*/locations/*/dataAgents/* |
Recupera i dettagli di un agente di dati specifico. |
Recupera criterio Identity and Access Management | POST |
/v1beta/projects/*/locations/*/dataAgents/*:getIamPolicy |
Recupera le autorizzazioni di Identity and Access Management assegnate a ciascun utente per un agente dati specifico. Gli utenti con il ruolo Proprietario agente dati possono chiamare questo endpoint per visualizzare il criterio di Identity and Access Management dell'agente dati prima di utilizzare l'endpoint setIAMpolicy per condividere un agente dati con altri utenti. |
Imposta il criterio Identity and Access Management | POST |
/v1beta/projects/*/locations/*/dataAgents/*:setIamPolicy |
Imposta il criterio Identity and Access Management per un agente dati specifico. Gli utenti con un ruolo di proprietario dell'agente dati devono chiamare questo endpoint per condividere un agente dati con altri utenti, il che aggiorna effettivamente le autorizzazioni di Identity and Access Management di questi utenti. |
Aggiornare un agente | PATCH |
/v1beta/projects/*/locations/*/dataAgents/* |
Modifica un agente dati esistente. |
Elenca agenti | GET |
/v1beta/projects/*/locations/*/dataAgents |
Elenca gli agenti dati disponibili in un progetto. |
Elenco degli agenti accessibili | GET |
/v1beta/projects/*/locations/*/dataAgents:listaccessible |
Elenca gli agenti dati accessibili in un progetto. Un agente dati è considerato accessibile se l'utente che richiama questa API dispone dell'autorizzazione get per l'agente. Puoi utilizzare il campo creator_filter per gestire gli agenti restituiti da questo metodo:
|
Eliminare un agente | DELETE |
/v1beta/projects/*/locations/*/dataAgents/* |
Rimuove un agente di dati. |
Creare una conversazione | POST |
/v1beta/projects/*/locations/*/conversations |
Avvia una nuova conversazione persistente. |
Chattare utilizzando un riferimento alla conversazione | POST |
/v1beta/projects/*/locations/*:chat |
Continua una conversazione stateful inviando un messaggio di chat che fa riferimento a una conversazione esistente e al relativo contesto dell'agente. Per le conversazioni multi-turno, Google Cloud memorizza e gestisce la cronologia della conversazione. |
Chattare utilizzando un riferimento dell'agente di dati | POST |
/v1beta/projects/*/locations/*:chat |
Invia un messaggio di chat stateless che fa riferimento a un agente di dati salvato per il contesto. Per le conversazioni multi-turno, la tua applicazione deve gestire e fornire la cronologia della conversazione a ogni richiesta. |
Chattare utilizzando il contesto in linea | POST |
/v1beta/projects/*/locations/*:chat |
Invia un messaggio di chat stateless fornendo tutto il contesto direttamente nella richiesta, senza utilizzare un agente di dati salvato. Per le conversazioni multi-turno, la tua applicazione deve gestire e fornire la cronologia della conversazione a ogni richiesta. |
Recuperare una conversazione | GET |
/v1beta/projects/*/locations/*/conversations/* |
Recupera i dettagli di una conversazione specifica. |
Elenca conversazioni | GET |
/v1beta/projects/*/locations/*/conversations |
Elenca le conversazioni in un progetto specifico. |
Elencare i messaggi in una conversazione | GET |
/v1beta/projects/*/locations/*/conversations/*/messages |
Elenca i messaggi all'interno di una conversazione specifica. |
Invia feedback
Utilizza i seguenti link per segnalare un bug o richiedere una funzionalità.
Risorse aggiuntive
- Documentazione di riferimento dell'API Conversational Analytics: fornisce descrizioni dettagliate di metodi, endpoint e definizioni dei tipi per le strutture di richiesta e risposta.
- Risoluzione dei problemi relativi agli errori dell'API Conversation Analytics: risolvi i problemi comuni relativi all'API Conversation Analytics.