Entwickler können die Conversational Analytics API verwenden, auf die über geminidataanalytics.googleapis.com
zugegriffen wird, um eine auf künstlicher Intelligenz (KI) basierende Chat-Oberfläche oder einen KI-Datenagenten zu erstellen, der Fragen zu strukturierten Daten in BigQuery, Looker und Looker Studio in natürlicher Sprache beantwortet. Mit der Conversational Analytics API stellen Sie Ihrem KI-Datenagenten Informationen und Daten zum Unternehmen („Kontext“) sowie Zugriff auf Tools wie SQL-, Python- und Visualisierungsbibliotheken zur Verfügung. Die Antworten des KI-Agenten werden dem Nutzer präsentiert und können von der Clientanwendung protokolliert werden, wodurch ein nahtloser Chat mit prüfbaren Daten entsteht.
Wie und wann Gemini für Google Cloud Ihre Daten verwendet
Erste Schritte mit der Conversational Analytics API
Wenn Sie Ihre Umgebung einrichten und mit der Entwicklung und Interaktion mit KI-Datenagenten mithilfe der Conversational Analytics API beginnen möchten, können Sie entweder den geführten Abläufen in den Colaboratory-Notebooks oder eigenständig den Schritten unter Einrichtung und Voraussetzungen folgen.
Interaktive Colaboratory-Notebooks
Eine interaktive, detaillierte Anleitung zum Einrichten Ihrer Umgebung, zum Erstellen eines KI-Datenagenten und zum Ausführen von API-Aufrufen finden Sie in den folgenden Colaboratory-Notebooks:
- Colaboratory-Notebook für die Conversational Analytics API mit HTTP
- Colaboratory-Notebook für das Conversational Analytics API SDK
Einrichtung und Voraussetzungen
Führen Sie die folgenden Schritte aus, bevor Sie die API oder die Beispiele verwenden:
- Conversational Analytics API aktivieren: Hier werden die Voraussetzungen für die Aktivierung der Conversational Analytics API beschrieben.
- IAM-Rollen und -Berechtigungen für die Conversational Analytics API zuweisen: Hier werden die vordefinierten IAM-Rollen zum Verwalten des Zugriffs auf KI-Datenagenten beschrieben.
- Bei der Conversational Analytics API authentifizieren und eine Verbindung zu einer Datenquelle herstellen: Hier finden Sie eine Anleitung zur Authentifizierung bei der API und zum Konfigurieren von Verbindungen zu Ihren BigQuery-, Looker- und Looker Studio-Daten.
KI-Datenagenten erstellen und mit einem KI-Datenagenten interagieren
Nachdem Sie die vorherigen Schritte ausgeführt haben, können Sie mit der Conversational Analytics API einen KI-Datenagenten erstellen und mit dem KI-Datenagenten interagieren. Gehen Sie dazu so vor:
- KI-Datenagenten mit HTTP erstellen: Hier finden Sie ein vollständiges Beispiel für das Erstellen und Interagieren mit einem KI-Datenagenten mithilfe direkter HTTP-Anfragen mit Python.
- KI-Datenagenten mit dem Python SDK erstellen: Hier finden Sie ein vollständiges Beispiel für das Erstellen und Interagieren mit einem KI-Datenagenten mit dem Python SDK.
- Effektive Systemanweisungen schreiben: Hier erfahren Sie, wie Sie den YAML-Inhalt für den Parameter
system_instruction
strukturieren, um das Verhalten des Agenten zu steuern und die Genauigkeit der Antworten zu verbessern. - Eine Antwort eines Conversational Analytics API-Agenten als Visualisierung rendern: Hier finden Sie ein Beispiel für die Verarbeitung von Diagrammspezifikationen aus API-Antworten und das Rendern als Visualisierungen mit dem Python SDK und der Vega-Altair-Bibliothek.
Wichtige API-Vorgänge
Die API bietet die folgenden Kernendpunkte zum Verwalten von KI-Datenagenten und Unterhaltungen:
Vorgang | HTTP-Methode | Endpunkt | Beschreibung |
---|---|---|---|
KI-Agenten erstellen | POST |
/v1alpha/projects/*/locations/*/dataAgents |
Erstellt einen neuen KI-Datenagenten. |
KI-Agenten abrufen | GET |
/v1alpha/projects/*/locations/*/dataAgents/* |
Ruft Details zu einem bestimmten KI-Datenagenten ab. |
KI-Agenten aktualisieren | PATCH |
/v1alpha/projects/*/locations/*/dataAgents/* |
Ändert einen vorhandenen KI-Datenagenten. |
KI-Agenten auflisten | GET |
/v1alpha/projects/*/locations/*/dataAgents |
Listet die verfügbaren KI-Datenagenten in einem Projekt auf. |
KI-Agenten löschen | DELETE |
/v1alpha/projects/*/locations/*/dataAgents/* |
Entfernt einen KI-Datenagenten. |
Unterhaltung erstellen | POST |
/v1alpha/projects/*/locations/*/conversations |
Startet eine neue, dauerhafte Unterhaltung. |
Mit Unterhaltungsverweis chatten | POST |
/v1alpha/projects/*/locations/*:chat |
Setzt eine zustandsorientierte Unterhaltung fort, indem eine Chatnachricht gesendet wird, die auf eine vorhandene Unterhaltung und den zugehörigen KI-Agentenkontext verweist. Bei Multi-Turn-Unterhaltungen speichert und verwaltet Google Cloud den Unterhaltungsverlauf. |
Mit KI-Datenagentenverweis chatten | POST |
/v1alpha/projects/*/locations/*:chat |
Sendet eine zustandslose Chatnachricht, die zur Kontextualisierung auf einen gespeicherten KI-Datenagenten verweist. Bei Multi-Turn-Unterhaltungen muss Ihre Anwendung den Unterhaltungsverlauf verwalten und bei jeder Anfrage bereitstellen. |
Mit Inline-Kontext chatten | POST |
/v1alpha/projects/*/locations/*:chat |
Sendet eine zustandslose Chatnachricht, indem der gesamte Kontext direkt in der Anfrage angegeben wird, ohne einen gespeicherten KI-Datenagenten zu verwenden. Bei Multi-Turn-Unterhaltungen muss Ihre Anwendung den Unterhaltungsverlauf verwalten und bei jeder Anfrage bereitstellen. |
Unterhaltung abrufen | GET |
/v1alpha/projects/*/locations/*/conversations/* |
Ruft Details zu einer bestimmten Unterhaltung ab. |
Unterhaltungen auflisten | GET |
/v1alpha/projects/*/locations/*/conversations |
Listet die Unterhaltungen in einem bestimmten Projekt auf. |
Nachrichten in einer Unterhaltung auflisten | GET |
/v1alpha/projects/*/locations/*/conversations/*/messages |
Listet Nachrichten in einer bestimmten Unterhaltung auf. |
Weitere Informationen
- Referenzdokumentation zur Conversational Analytics API: Hier finden Sie detaillierte Beschreibungen von Methoden, Endpunkten und Typdefinitionen für Anfrage- und Antwortstrukturen.