Autenticar e conectar-se a uma fonte de dados com a API de análise conversacional, Autenticar e conectar-se a uma fonte de dados com a API de análise conversacional

Prévia privada

Este produto ou recurso está sujeito aos "Termos de Ofertas Pré-GA" na seção Termos Gerais de Serviço dos Termos Específicos de Serviço . Os produtos e recursos pré-GA estão disponíveis "no estado em que se encontram" e podem ter suporte limitado. Para mais informações, consulte as descrições do estágio de lançamento .

Os desenvolvedores podem usar a API Conversational Analytics , acessada por meio de geminidataanalytics.googleapis.com , para criar uma interface de bate-papo com inteligência artificial (IA), ou um agente de dados, que responda a perguntas sobre dados estruturados no BigQuery, Looker e Looker Studio usando linguagem natural.

Observação: para usar a API de Análise Conversacional, você precisa participar da pré-visualização privada. Para expressar interesse, preencha o formulário de interesse na pré-visualização .

Esta página descreve como autenticar na API de Análise Conversacional e configurar conexões com seus dados no Looker , BigQuery e Looker Studio usando solicitações HTTP diretas ou o SDK. A API de Análise Conversacional usa o padrão Google Cloud métodos de autenticação .

Antes de começar

Antes de poder autenticar a API do Conversational Analytics e configurar conexões com seus dados, você deve concluir os pré-requisitos e habilitar as APIs necessárias para seus dados. Google Cloud projeto, conforme descrito em Habilitar a API de análise conversacional .

Autenticar na API de análise conversacional

Esta seção descreve como autenticar na API do Conversational Analytics (por meio de geminidataanalytics.googleapis.com ) usando métodos HTTP e Python para obter os tokens de autorização necessários.

HTTP curl

O comando curl de exemplo a seguir envia uma solicitação à API de Análise Conversacional. O comando gcloud auth print-identity-token fornece um token de acesso que é usado para autorização. No exemplo de código, substitua com o caminho de recurso da API apropriado.

curl  -H "Authorization: Bearer $(gcloud auth print-identity-token)" \
https://geminidataanalytics.googleapis.com/

HTTP usando Python

O código Python de exemplo a seguir demonstra como obter um token de acesso para autenticação HTTP usando o Google Cloud CLI e o Python.

  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]}'}

Substitua os valores de amostra da seguinte forma:

• YOUR_BILLING_PROJECT : O ID do seu projeto de faturamento que tem as APIs necessárias habilitadas .
• method : O caminho do recurso para o ponto de extremidade de destino. Por exemplo:
  • Para criar um agente de dados, use o método POST e o caminho do recurso /v1alpha/projects/{billing_project}/locations/global/dataAgents .
  • Para listar agentes de dados existentes, use o método GET e o caminho do recurso /v1alpha/projects/{billing_project}/locations/global/dataAgents .

SDK Python

O código Python de exemplo a seguir demonstra como autenticar sua Conta do Google para acessar a API de análise conversacional no Colaboratory:

from google.colab import auth
auth.authenticate_user()

Conecte-se ao Looker com a API de análise conversacional

Para se conectar ao Looker com a API de análise conversacional, você deve fornecer as seguintes informações:

• A URL da sua instância do Looker
• O modelo LookML específico e o Looker Explore que você deseja usar como fonte de dados

Você pode então escolher autenticar usando chaves da API do Looker (ID do cliente e segredo do cliente) ou um token de acesso .

Autenticação com chaves de API do Looker

Esta seção descreve como gerar as chaves de API e configurar a API do Conversational Analytics para se conectar ao Looker usando solicitações HTTP diretas ou o SDK.

Para estabelecer uma conexão com uma instância do Looker, você precisa de chaves de API válidas do Looker, que são criadas pelo Looker e consistem em um ID de cliente e um segredo de cliente. O Looker usa essas chaves para autorizar solicitações à API do Looker.

Para saber mais sobre como gerar novas chaves de API do Looker, consulte Configurações de administrador - Usuários . Para saber mais sobre métodos de autenticação e gerenciamento de chaves de API do Looker, consulte Autenticação da API do Looker .

HTTP usando Python

Após gerar as chaves de API (ID do cliente e segredo), você pode configurar a API do Conversational Analytics para se conectar ao Looker por meio de solicitações HTTP diretas. O código de exemplo a seguir demonstra como especificar os detalhes da fonte de dados do Looker e as chaves de API no corpo da solicitação HTTP.

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",
    }
  }
}

Substitua os valores de amostra da seguinte forma:

• your_looker_client_id : O ID do cliente da sua chave de API do Looker gerada
• your_looker_client_secret : O segredo do cliente da sua chave de API do Looker gerada
• https://your_company.looker.com : O URL completo da sua instância do Looker
• your_model : O nome do modelo LookML que você deseja usar
• your_explore : O nome do Explore dentro do modelo especificado que você deseja usar

SDK Python

Após gerar as chaves de API (ID do cliente e segredo), você pode configurar a API de Análise Conversacional para se conectar ao Looker usando Python. O código Python de exemplo a seguir demonstra como especificar os detalhes da fonte de dados do Looker e suas chaves de API para a API de Análise Conversacional.

Dica: armazene o ID do cliente do Looker ( looker_client_id ) e o segredo do cliente do Looker ( looker_client_secret ) como variáveis ​​de ambiente para maior segurança.

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]

Substitua os valores de amostra da seguinte forma:

• YOUR-LOOKER-CLIENT-ID : O ID do cliente da sua chave de API do Looker gerada
• YOUR-LOOKER-CLIENT-SECRET : O segredo do cliente da sua chave de API do Looker gerada
• YOUR-LOOKER-INSTANCE-URI : O URL completo da sua instância do Looker
• YOUR-LOOKER-MODEL : O nome do modelo Looker que você deseja usar
• YOUR-LOOKER-EXPLORE : O nome do Looker Explore que você deseja usar

Autenticação com um token de acesso

Esta seção descreve como configurar a API do Conversational Analytics para se conectar ao Looker usando um token de acesso.

Para estabelecer uma conexão com uma instância do Looker, você precisa de um valor OAuth2 access_token válido, que é criado por uma solicitação bem-sucedida ao ponto de extremidade da API do Looker login .

Para saber mais sobre como gerar um token de acesso, consulte Autenticação da API do Looker e como apresentar credenciais do cliente para obter um token de autorização .

Observação: as credenciais usadas para gerar o valor access_token devem ter as permissões necessárias para usar os endpoints do Looker Get LookML Model Explore e Run Inline Query . A permissão develop é um requisito mínimo.

HTTP usando Python

O código de exemplo a seguir demonstra como especificar os detalhes da fonte de dados do Looker e seu token de acesso no corpo da sua solicitação HTTP.

Dica: armazene o token de acesso do Looker ( access_token ) como uma variável de ambiente para maior segurança.

  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",
      }
    }
  }

Substitua os valores de amostra da seguinte forma:

• YOUR-TOKEN : O valor access_token que você gera para autenticar no Looker.
• https://your_company.looker.com : O URL completo da sua instância do Looker
• your_model : O nome do modelo LookML que você deseja usar
• your_explore : O nome do Explore dentro do modelo especificado que você deseja usar

SDK Python

O código Python de exemplo a seguir demonstra como definir os detalhes da fonte de dados do Looker e seu token de acesso para autenticação usando o SDK do Python.

Dica: armazene o token de acesso do Looker ( access_token ) como uma variável de ambiente para maior segurança.

  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]

Substitua os valores de amostra da seguinte forma:

• YOUR-TOKEN : O valor access_token que você usa para autenticar no Looker
• YOUR-LOOKER-INSTANCE-URI : O URL completo da sua instância do Looker
• YOUR-LOOKER-MODEL : O nome do modelo Looker que você deseja usar
• YOUR-LOOKER-EXPLORE : O nome do Looker Explore que você deseja usar

HTTP usando JavaScript

O código de exemplo a seguir demonstra como especificar os detalhes da fonte de dados do Looker e seu token de acesso no corpo da sua solicitação HTTP.

Dica: armazene o token de acesso do Looker ( access_token ) como uma variável de ambiente para maior segurança.

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,
                                    },
                                },
                            },
                        },
                    },
                },
            }

Substitua os valores de amostra da seguinte forma:

• YOUR-LOOKER-INSTANCE-URI : O URL completo da sua instância do Looker
• YOUR-LOOKER-MODEL : O nome do modelo LookML que você deseja usar
• YOUR-LOOKER-EXPLORE : O nome do Explore dentro do modelo especificado que você deseja usar
• YOUR-TOKEN : O valor access_token que você gera para autenticar no Looker.

Conecte-se ao BigQuery com a API de análise conversacional

Para se conectar ao BigQuery com a API de análise conversacional, você deve se autenticar no seu projeto do BigQuery e fornecer as seguintes informações:

• O ID do projeto do BigQuery
• O ID do conjunto de dados do BigQuery
• ID da tabela do BigQuery

Esta seção descreve como configurar a API do Conversational Analytics para se conectar ao BigQuery usando solicitações HTTP diretas ou um SDK.

HTTP usando Python

Após a autenticação no seu projeto do BigQuery, você pode configurar a API de Análise Conversacional para acessar dados no BigQuery por meio de solicitações HTTP diretas. O código de exemplo a seguir demonstra como especificar os detalhes da fonte de dados do BigQuery no corpo da solicitação HTTP.

bigquery_data_sources = {
    "bq": {
      "tableReferences": [
        {
          "projectId": "bigquery-public-data",
          "datasetId": "san_francisco",
          "tableId": "street_trees"
        }
      ]
    }
}

Substitua os valores de amostra da seguinte forma:

• bigquery-public-data : O ID do seu projeto do BigQuery
• san_francisco : O ID do conjunto de dados do BigQuery
• street_trees : O ID da tabela do BigQuery

SDK Python

Você pode usar o SDK de auth do Colaboratory para autenticar no BigQuery usando as credenciais do seu usuário autenticado no Colaboratory.

O código Python de exemplo a seguir demonstra como autenticar sua Conta do Google no BigQuery dentro do Colaboratory e configurar a API de análise conversacional para acessar uma fonte de dados do BigQuery.

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]

Substitua os valores de amostra da seguinte forma:

• YOUR-PROJECT-ID : O ID do seu projeto do BigQuery
• YOUR-DATASET-ID : O ID do seu conjunto de dados do BigQuery
• YOUR-TABLE-ID : O ID da sua tabela do BigQuery

Conecte-se ao Looker Studio com a API de análise conversacional

Para se conectar ao Looker Studio com a API de Análise Conversacional, você precisa primeiro habilitar a API do Looker Studio . Esta seção descreve como configurar a API de Análise Conversacional para se conectar ao Looker Studio usando solicitações HTTP diretas ou um SDK.

Habilitar API do Looker Studio

Para habilitar a API do Looker Studio, siga as instruções em Habilitar a API .

Autenticar no Looker Studio

Para se conectar ao Looker Studio com a API do Conversational Analytics, você deve se autenticar no Looker Studio e fornecer o ID da fonte de dados do Looker Studio.

HTTP usando Python

Após habilitar a API do Looker Studio, você pode se autenticar no Looker Studio fazendo solicitações HTTP curl com Python. O código de exemplo a seguir demonstra como especificar os detalhes da sua fonte de dados do Looker no corpo da sua solicitação HTTP.

Você pode se autenticar no Looker Studio fazendo solicitações HTTP diretas. Um exemplo de chamada HTTP é mostrado no bloco de código a seguir.

looker_studio_data_source = {
    "studio":{
        "studio_references":
        [
            {
              "datasource_id": "your_studio_datasource_id"
            }
        ]
    }
}

Substitua your_studio_datasource_id pelo ID da fonte de dados real do Looker Studio que você deseja usar.

SDK Python

Após habilitar a API do Looker Studio, você poderá se autenticar no Looker Studio usando um SDK. O código Python de exemplo a seguir demonstra como especificar os detalhes da fonte de dados do Looker e se autenticar no Looker Studio.

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]

Substitua STUDIO-DATASOURCE-ID pelo ID da fonte de dados real do Looker Studio que você deseja usar.