Les développeurs peuvent utiliser l'API Conversational Analytics, qui est accessible via geminidataanalytics.googleapis.com
, pour créer une interface de chat ou un agent de données optimisés par l'intelligence artificielle (IA). Ces outils répondent aux questions sur les données structurées dans BigQuery, Looker et Looker Studio en utilisant le langage naturel. L'API Conversational Analytics vous permet de fournir à votre agent de données des informations et des données sur l'entreprise ("contexte"), ainsi qu'un accès à des outils tels que SQL, Python et des bibliothèques de visualisation. Les réponses de l'agent sont présentées à l'utilisateur et peuvent être journalisées par l'application cliente afin de créer une expérience de chat de données qui soit fluide et auditable.
Découvrez comment et quand Gemini pour Google Cloud utilise vos données.
Premiers pas avec l'API Conversational Analytics
Pour commencer à utiliser l'API Conversational Analytics, vous pouvez d'abord consulter la documentation sur l'architecture et les concepts clés pour comprendre comment les agents traitent les requêtes, les workflows pour les créateurs et les utilisateurs d'agents, les modes de conversation et les rôles Identity and Access Management (IAM). Ensuite, pour commencer à créer des agents de données, vous pouvez choisir entre une expérience guidée avec les notebooks Colaboratory ou une approche autonome en suivant les étapes de la section Configuration et prérequis.
Notebooks Colaboratory interactifs
Pour suivre un guide par étapes et interactif vous permettant de configurer votre environnement, créer un agent de données et exécuter des appels d'API, accédez aux notebooks Colaboratory suivants :
- Notebook Colaboratory HTTP de l'API Conversational Analytics
- Notebook Colaboratory du SDK de l'API Conversational Analytics
Configuration et prérequis
Avant d'utiliser l'API ou les exemples, effectuez les étapes suivantes :
- Activer l'API Conversational Analytics : décrit les conditions préalables à l'activation de l'API Conversational Analytics.
- Attribuer des rôles et des autorisations IAM pour l'API Conversational Analytics : décrit les rôles IAM prédéfinis pour gérer l'accès aux agents de données.
- S'authentifier et se connecter à une source de données avec l'API Conversational Analytics : fournit des instructions pour s'authentifier auprès de l'API et configurer des connexions à vos données BigQuery, Looker et Looker Studio.
Créer un agent de données avec lequel interagir
Une fois que vous avez effectué les étapes précédentes, utilisez l'API Conversational Analytics pour créer un agent de données et interagir avec lui en procédant comme suit :
- Créer un agent de données à l'aide de HTTP : fournit un exemple complet de la création d'un agent de données avec lequel interagir à l'aide de requêtes HTTP directes avec Python.
- Créer un agent de données à l'aide du SDK Python : fournit un exemple complet de la création d'un agent de données avec lequel interagir à l'aide du SDK Python.
- Rédiger des instructions système efficaces : découvrez comment structurer le contenu YAML du paramètre
system_instruction
pour guider le comportement de l'agent et améliorer la justesse des réponses. Vous pouvez également consulter des exemples d'instructions système dans les sources de données BigQuery et Looker. - Afficher une réponse d'agent de l'API Conversational Analytics sous forme de visualisation : illustre le traitement des spécifications de graphique à partir des réponses de l'API et leur affichage sous forme de visualisations à l'aide du SDK Python et de la bibliothèque Vega-Altair.
Bonnes pratiques
- Gérer les coûts BigQuery pour vos agents : découvrez comment surveiller et gérer les coûts BigQuery pour vos agents de l'API Conversational Analytics en définissant des limites de dépenses au niveau des projets, des utilisateurs et des requêtes.
Principales opérations d'API
L'API fournit les principaux points de terminaison suivants pour gérer les agents de données et les conversations :
Opération | Méthode HTTP | Point de terminaison | Description |
---|---|---|---|
Créer un agent | POST |
/v1beta/projects/*/locations/*/dataAgents |
Crée un agent de données. |
Obtenir un agent | GET |
/v1beta/projects/*/locations/*/dataAgents/* |
Récupère les détails d'un agent de données spécifique. |
Obtenir une stratégie Identity and Access Management | POST |
/v1beta/projects/*/locations/*/dataAgents/*:getIamPolicy |
Obtient les autorisations Identity and Access Management attribuées à chaque utilisateur pour un agent de données spécifique. Les utilisateurs disposant du rôle de propriétaire d'agent de données peuvent appeler ce point de terminaison pour consulter la stratégie Identity and Access Management de l'agent de données avant d'utiliser le point de terminaison setIAMpolicy pour partager un agent de données avec d'autres utilisateurs. |
Définir une stratégie Identity and Access Management | POST |
/v1beta/projects/*/locations/*/dataAgents/*:setIamPolicy |
Définit la stratégie Identity and Access Management pour un agent de données spécifique. Les utilisateurs disposant du rôle de propriétaire d'agent de données doivent appeler ce point de terminaison pour partager un agent de données avec d'autres utilisateurs, ce qui met à jour leurs autorisations Identity and Access Management. |
Mettre à jour un agent | PATCH |
/v1beta/projects/*/locations/*/dataAgents/* |
Modifie un agent de données existant. |
Lister des agents | GET |
/v1beta/projects/*/locations/*/dataAgents |
Liste les agents de données disponibles dans un projet. |
Supprimer un agent | DELETE |
/v1beta/projects/*/locations/*/dataAgents/* |
Supprime un agent de données. |
Créer une conversation | POST |
/v1beta/projects/*/locations/*/conversations |
Démarre une nouvelle conversation persistante. |
Discuter en utilisant une référence à une conversation | POST |
/v1beta/projects/*/locations/*:chat |
Poursuit une conversation avec état en envoyant un message de chat qui fait référence à une conversation existante et au contexte de l'agent associé. Pour les conversations multitours, Google Cloud stocke et gère l'historique de la conversation. |
Discuter en utilisant une référence à un agent de données | POST |
/v1beta/projects/*/locations/*:chat |
Envoie un message de chat sans état qui se réfère à un agent de données enregistré pour le contexte. Pour les conversations multitours, votre application doit gérer et fournir l'historique de la conversation à chaque requête. |
Discuter en utilisant le contexte intégré | POST |
/v1beta/projects/*/locations/*:chat |
Envoie un message de chat sans état en fournissant tout le contexte directement dans la requête, sans utiliser d'agent de données enregistré. Pour les conversations multitours, votre application doit gérer et fournir l'historique de la conversation à chaque requête. |
Obtenir une conversation | GET |
/v1beta/projects/*/locations/*/conversations/* |
Récupère les détails d'une conversation spécifique. |
Lister les conversations | GET |
/v1beta/projects/*/locations/*/conversations |
Liste les conversations d'un projet spécifique. |
Lister les messages d'une conversation | GET |
/v1beta/projects/*/locations/*/conversations/*/messages |
Liste les messages d'une conversation spécifique. |
Envoyer des commentaires
Utilisez les liens suivants pour signaler un bug ou demander une fonctionnalité.
Envoyer des commentaires
Utilisez les liens suivants pour signaler un bug ou demander une fonctionnalité.
Autres ressources
- Documentation de référence de l'API Conversational Analytics : fournit des descriptions détaillées des méthodes, des points de terminaison et des définitions de type pour les structures des requêtes et des réponses.
- Résoudre les problèmes liés aux erreurs de l'API Conversational Analytics : résolvez les problèmes courants liés aux erreurs de l'API Conversational Analytics.