Entwickler können über geminidataanalytics.googleapis.com
auf die Conversational Analytics API zugreifen, um eine KI-basierte Chat-Oberfläche oder einen Daten-Agent zu erstellen, der Fragen zu strukturierten Daten in BigQuery, Looker und Looker Studio in natürlicher Sprache beantwortet.
Auf dieser Seite wird beschrieben, wie Sie sich bei der Conversational Analytics API authentifizieren und Verbindungen zu Ihren Daten in Looker, BigQuery und Looker Studio konfigurieren. Dazu können Sie entweder direkte HTTP-Anfragen oder das SDK verwenden. Für die Conversational Analytics API werden standardmäßige Google Cloud Authentifizierungsmethoden verwendet.
Hinweise
Bevor Sie sich bei der Conversational Analytics API authentifizieren und Verbindungen zu Ihren Daten konfigurieren können, müssen Sie die Voraussetzungen erfüllen und die erforderlichen APIs für Ihr Google Cloud Projekt aktivieren, wie unter Conversational Analytics API aktivieren beschrieben.
Bei der Conversational Analytics API authentifizieren
In diesem Abschnitt wird beschrieben, wie Sie sich über geminidataanalytics.googleapis.com
bei der Conversational Analytics API authentifizieren, indem Sie HTTP- und Python-Methoden verwenden, um die erforderlichen Autorisierungstokens abzurufen.
HTTP-Curl
Mit dem folgenden curl
-Beispielbefehl wird eine Anfrage an die Conversational Analytics API gesendet. Der Befehl gcloud auth print-identity-token
stellt ein Zugriffstoken bereit, das für die Autorisierung verwendet wird. Ersetzen Sie im Codebeispiel
curl -H "Authorization: Bearer $(gcloud auth print-identity-token)" \
https://geminidataanalytics.googleapis.com/
HTTP mit Python
Der folgende Python-Beispielcode zeigt, wie Sie mit der Google Cloud CLI und Python ein Zugriffstoken für die HTTP-Authentifizierung abrufen.
billing_project = 'YOUR_BILLING_PROJECT'
access_token = !gcloud auth application-default print-access-token
url = f"https://geminidataanalytics.googleapis.com/v1alpha/projects/{billing_project}:method"
headers = {"Authorization": f'Bearer {access_token[0]}'}
Ersetzen Sie die Beispielwerte so:
- YOUR_BILLING_PROJECT: Die ID Ihres Abrechnungsprojekts, in dem die erforderlichen APIs aktiviert sind.
- method: Der Ressourcenpfad für den Zielendpunkt. Beispiel:
- Verwenden Sie zum Erstellen eines Daten-Agents die Methode
POST
und den Ressourcenpfad/v1alpha/projects/{billing_project}/locations/global/dataAgents
. - Verwenden Sie die Methode
GET
und den Ressourcenpfad/v1alpha/projects/{billing_project}/locations/global/dataAgents
, um vorhandene Daten-Agents aufzulisten.
- Verwenden Sie zum Erstellen eines Daten-Agents die Methode
Python SDK
Das folgende Python-Codebeispiel zeigt, wie Sie Ihr Google-Konto für den Zugriff auf die Conversational Analytics API in Colaboratory authentifizieren:
from google.colab import auth
auth.authenticate_user()
Mit der Conversational Analytics API eine Verbindung zu Looker herstellen
Wenn Sie mit der Conversational Analytics API eine Verbindung zu Looker herstellen möchten, müssen Sie die folgenden Informationen angeben:
- Die URL Ihrer Looker-Instanz
- Das LookML-Modell und das Looker-Explore, die Sie als Datenquelle verwenden möchten
Sie können dann entweder Looker API-Schlüssel (Client-ID und Clientschlüssel) oder ein Zugriffstoken für die Authentifizierung verwenden.
Authentifizierung mit Looker-API-Schlüsseln
In diesem Abschnitt wird beschrieben, wie Sie die API-Schlüssel generieren und die Conversational Analytics API so konfigurieren, dass sie eine Verbindung zu Looker herstellt. Dazu können Sie entweder direkte HTTP-Anfragen oder das SDK verwenden.
Um eine Verbindung zu einer Looker-Instanz herzustellen, benötigen Sie gültige Looker API-Schlüssel, die von Looker erstellt werden und aus einer Client-ID und einem Client Secret bestehen. Looker verwendet diese Schlüssel, um Anfragen an die Looker API zu autorisieren.
Weitere Informationen zum Generieren neuer Looker API-Schlüssel finden Sie unter Administratoreinstellungen – Nutzer. Weitere Informationen zu Authentifizierungsmethoden und zur Verwaltung von Looker API-Schlüsseln finden Sie unter Looker API-Authentifizierung.
HTTP mit Python
Nachdem Sie die API-Schlüssel (Client-ID und Secret) generiert haben, können Sie die Conversational Analytics API so konfigurieren, dass sie über direkte HTTP-Anfragen eine Verbindung zu Looker herstellt. Im folgenden Beispielcode sehen Sie, wie Sie die Details Ihrer Looker-Datenquelle und Ihre API-Schlüssel im Text Ihrer HTTP-Anfrage angeben.
looker_credentials = {
"oauth": {
"secret": {
"client_id": "your_looker_client_id",
"client_secret": "your_looker_client_secret",
}
}
}
looker_data_source = {
"looker": {
"explore_references": {
"looker_instance_uri": "https://your_company.looker.com",
"lookml_model": "your_model",
"explore": "your_explore",
}
}
}
Ersetzen Sie die Beispielwerte so:
- your_looker_client_id: Die Client-ID Ihres generierten Looker API-Schlüssels
- your_looker_client_secret: Das Client-Secret Ihres generierten Looker-API-Schlüssels
- https://your_company.looker.com: Die vollständige URL Ihrer Looker-Instanz
- your_model: Der Name des LookML-Modells, das Sie verwenden möchten
- your_explore: Der Name des Explores im angegebenen Modell, das Sie verwenden möchten.
Python SDK
Nachdem Sie die API-Schlüssel (Client-ID und Secret) generiert haben, können Sie die Conversational Analytics API so konfigurieren, dass sie über Python eine Verbindung zu Looker herstellt. Im folgenden Python-Beispielcode wird gezeigt, wie Sie die Details Ihrer Looker-Datenquelle und Ihre API-Schlüssel für die Conversational Analytics API angeben.
looker_client_id = "YOUR-LOOKER-CLIENT-ID" # @param {type:"string"}
looker_client_secret = "YOUR-LOOKER-CLIENT-SECRET" # @param {type:"string"}
looker_instance_uri = "YOUR-LOOKER-INSTANCE-URI" # @param {type:"string"}
lookml_model = "YOUR-LOOKER-MODEL" # @param {type:"string"}
explore = "YOUR-LOOKER-EXPLORE" # @param {type:"string"}
# Looker data source
looker_explore_reference = geminidataanalytics.LookerExploreReference()
looker_explore_reference.looker_instance_uri = looker_instance_uri
looker_explore_reference.lookml_model = lookml_model
looker_explore_reference.explore = explore
credentials = geminidataanalytics.Credentials()
credentials.oauth.secret.client_id = looker_client_id
credentials.oauth.secret.client_secret = looker_client_secret
# Connect to your data source
datasource_references = geminidataanalytics.DatasourceReferences()
datasource_references.looker.explore_references = [looker_explore_reference]
Ersetzen Sie die Beispielwerte so:
- YOUR-LOOKER-CLIENT-ID: Die Client-ID Ihres generierten Looker API-Schlüssels
- YOUR-LOOKER-CLIENT-SECRET: Das Client-Secret Ihres generierten Looker-API-Schlüssels
- YOUR-LOOKER-INSTANCE-URI: Die vollständige URL Ihrer Looker-Instanz
- YOUR-LOOKER-MODEL: Der Name des Looker-Modells, das Sie verwenden möchten
- YOUR-LOOKER-EXPLORE: Der Name des Looker-Explores, das Sie verwenden möchten
Authentifizierung mit einem Zugriffstoken
In diesem Abschnitt wird beschrieben, wie Sie die Conversational Analytics API konfigurieren, um mit einem Zugriffstoken eine Verbindung zu Looker herzustellen.
Um eine Verbindung zu einer Looker-Instanz herzustellen, benötigen Sie einen gültigen OAuth2-access_token
-Wert, der durch eine erfolgreiche Anfrage an den Looker API-Endpunkt login
erstellt wird.
Weitere Informationen zum Generieren eines Zugriffstokens finden Sie unter Looker API-Authentifizierung und Clientanmeldedaten zum Abrufen eines Autorisierungstokens präsentieren.
HTTP mit Python
Das folgende Beispiel zeigt, wie Sie die Details Ihrer Looker-Datenquelle und Ihr Zugriffstoken im Text Ihrer HTTP-Anfrage angeben.
looker_credentials = {
"oauth": {
"token": {
"access_token": "YOUR-TOKEN",
}
}
}
looker_data_source = {
"looker": {
"explore_references": {
"looker_instance_uri": "https://your_company.looker.com",
"lookml_model": "your_model",
"explore": "your_explore",
}
}
}
Ersetzen Sie die Beispielwerte so:
- YOUR-TOKEN: Der
access_token
-Wert, den Sie zur Authentifizierung bei Looker generieren. - https://your_company.looker.com: Die vollständige URL Ihrer Looker-Instanz
- your_model: Der Name des LookML-Modells, das Sie verwenden möchten
- your_explore: Der Name des Explores im angegebenen Modell, das Sie verwenden möchten.
Python SDK
Im folgenden Python-Beispielcode wird veranschaulicht, wie Sie die Details Ihrer Looker-Datenquelle und Ihr Zugriffstoken definieren, um sich mit dem Python SDK zu authentifizieren.
looker_access_token = "YOUR-TOKEN"
looker_instance_uri = "YOUR-LOOKER-INSTANCE-URI"
lookml_model = "YOUR-LOOKER-MODEL"
explore = "YOUR-LOOKER-EXPLORE"
# Looker data source
looker_explore_reference = geminidataanalytics.LookerExploreReference()
looker_explore_reference.looker_instance_uri = looker_instance_uri
looker_explore_reference.lookml_model = lookml_model
looker_explore_reference.explore = explore
credentials = geminidataanalytics.Credentials()
credentials.oauth.token.access_token = looker_access_token
# Connect to your data source
datasource_references = geminidataanalytics.DatasourceReferences()
datasource_references.looker.explore_references = [looker_explore_reference]
Ersetzen Sie die Beispielwerte so:
- YOUR-TOKEN: Der
access_token
-Wert, den Sie zur Authentifizierung bei Looker verwenden - YOUR-LOOKER-INSTANCE-URI: Die vollständige URL Ihrer Looker-Instanz
- YOUR-LOOKER-MODEL: Der Name des Looker-Modells, das Sie verwenden möchten
- YOUR-LOOKER-EXPLORE: Der Name des Looker-Explores, das Sie verwenden möchten
HTTP mit JavaScript
Das folgende Beispiel zeigt, wie Sie die Details Ihrer Looker-Datenquelle und Ihr Zugriffstoken im Text Ihrer HTTP-Anfrage angeben.
const requestBody = {
project: GCP_PROJECT,
messages: [
{
user_message: {
text: inputWithPreviousMessages,
},
},
],
context: {
system_instruction: agentConfig.system_instructions,
datasource_references: {
looker: {
explore_references: [
{
looker_instance_uri: YOUR-LOOKER-INSTANCE-URI,
lookml_model: YOUR-LOOKER-MODEL,
explore: YOUR-LOOKER-EXPLORE,
},
],
credentials: {
oauth: {
token: {
access_token: YOUR-TOKEN,
},
},
},
},
},
},
}
Ersetzen Sie die Beispielwerte so:
- YOUR-LOOKER-INSTANCE-URI: Die vollständige URL Ihrer Looker-Instanz
- YOUR-LOOKER-MODEL: Der Name des LookML-Modells, das Sie verwenden möchten
- YOUR-LOOKER-EXPLORE: Der Name des Explores im angegebenen Modell, das Sie verwenden möchten.
- YOUR-TOKEN: Der
access_token
-Wert, den Sie zur Authentifizierung bei Looker generieren.
Mit der Conversational Analytics API eine Verbindung zu BigQuery herstellen
Wenn Sie mit der Conversational Analytics API eine Verbindung zu BigQuery herstellen möchten, müssen Sie sich bei Ihrem BigQuery-Projekt authentifizieren und die folgenden Informationen angeben:
- Die BigQuery-Projekt-ID
- Die BigQuery-Dataset-ID
- Die BigQuery-Tabellen-ID
Mit der Conversational Analytics API können Sie gleichzeitig eine Verbindung zu bis zu 10 BigQuery-Tabellen herstellen und Abfragen ausführen.
In diesem Abschnitt wird beschrieben, wie Sie die Conversational Analytics API so konfigurieren, dass sie entweder über direkte HTTP-Anfragen oder über ein SDK eine Verbindung zu BigQuery herstellt.
HTTP mit Python
Nachdem Sie sich bei Ihrem BigQuery-Projekt authentifiziert haben, können Sie die Conversational Analytics API so konfigurieren, dass sie durch direkte HTTP-Anfragen auf Daten in BigQuery zugreift. Im folgenden Beispielcode wird gezeigt, wie Sie die Details Ihrer BigQuery-Datenquelle im Hauptteil Ihrer HTTP-Anfrage angeben.
bigquery_data_sources = {
"bq": {
"tableReferences": [
{
"projectId": "bigquery-public-data",
"datasetId": "san_francisco",
"tableId": "street_trees"
}
]
}
}
Ersetzen Sie die Beispielwerte so:
- bigquery-public-data: Die ID Ihres BigQuery-Projekts
- san_francisco: Die ID des BigQuery-Datasets
- street_trees: Die ID der BigQuery-Tabelle
Python SDK
Mit dem auth
SDK von Colaboratory können Sie sich mit den Anmeldedaten Ihres in Colaboratory authentifizierten Nutzers bei BigQuery authentifizieren.
Im folgenden Beispiel-Python-Code wird gezeigt, wie Sie Ihr Google-Konto in Colaboratory für BigQuery authentifizieren und die Conversational Analytics API für den Zugriff auf eine BigQuery-Datenquelle konfigurieren.
from google.colab import auth
auth.authenticate_user()
bq_project_id = "YOUR-PROJECT-ID" # @param {type:"string"}
bq_dataset_id = "YOUR-DATASET-ID" # @param {type:"string"}
bq_table_id = "YOUR-TABLE-ID" # @param {type:"string"}
# BigQuery data source
bigquery_table_reference = geminidataanalytics.BigQueryTableReference()
bigquery_table_reference.project_id = bq_project_id
bigquery_table_reference.dataset_id = bq_dataset_id
bigquery_table_reference.table_id = bq_table_id
# Connect to your data source
datasource_references = geminidataanalytics.DatasourceReferences()
datasource_references.bq.table_references = [bigquery_table_reference]
Ersetzen Sie die Beispielwerte so:
- YOUR-PROJECT-ID: Die ID Ihres BigQuery-Projekts
- YOUR-DATASET-ID: Die ID Ihres BigQuery-Datasets
- YOUR-TABLE-ID: Die ID Ihrer BigQuery-Tabelle
Mit der Conversational Analytics API eine Verbindung zu Looker Studio herstellen
Wenn Sie die Conversational Analytics API verwenden möchten, um eine Verbindung zu Looker Studio herzustellen, müssen Sie zuerst die Looker Studio API aktivieren. In diesem Abschnitt wird beschrieben, wie Sie die Conversational Analytics API konfigurieren, um eine Verbindung zu Looker Studio herzustellen. Dazu können Sie entweder direkte HTTP-Anfragen oder ein SDK verwenden.
Looker Studio API aktivieren
Folgen Sie der Anleitung unter API aktivieren, um die Looker Studio API zu aktivieren.
Bei Looker Studio authentifizieren
Wenn Sie mit der Conversational Analytics API eine Verbindung zu Looker Studio herstellen möchten, müssen Sie sich bei Looker Studio authentifizieren und die Looker Studio-Datenquellen-ID angeben.
HTTP mit Python
Nachdem Sie die Looker Studio API aktiviert haben, können Sie sich bei Looker Studio authentifizieren, indem Sie HTTP-Curl-Anfragen mit Python senden. Im folgenden Beispielcode wird gezeigt, wie Sie die Details Ihrer Looker-Datenquelle im Text Ihrer HTTP-Anfrage angeben.
Sie können sich bei Looker Studio authentifizieren, indem Sie direkte HTTP-Anfragen senden. Ein Beispiel für einen HTTP-Aufruf finden Sie im folgenden Codeblock.
looker_studio_data_source = {
"studio":{
"studio_references":
[
{
"datasource_id": "your_studio_datasource_id"
}
]
}
}
Ersetzen Sie your_studio_datasource_id durch die tatsächliche Datenquellen-ID der Looker Studio-Datenquelle, die Sie verwenden möchten.
Python SDK
Nachdem Sie die Looker Studio API aktiviert haben, können Sie sich mit einem SDK bei Looker Studio authentifizieren. Im folgenden Python-Beispielcode wird gezeigt, wie Sie die Details Ihrer Looker-Datenquelle angeben und sich bei Looker Studio authentifizieren.
datasource_id = "STUDIO-DATASOURCE-ID"
# Looker Studio
studio_references = geminidataanalytics.StudioDatasourceReference()
studio_references.datasource_id = studio_datasource_id
# Connect to your data source
datasource_references = geminidataanalytics.DatasourceReferences()
datasource_references.studio.studio_references = [studio_references]
Ersetzen Sie STUDIO-DATASOURCE-ID durch die tatsächliche Datenquellen-ID der Looker Studio-Datenquelle, die Sie verwenden möchten.