Guia de início rápido: configuração do Dialogflow CX

Este guia fornece todas as etapas de configuração necessárias para começar a usar o Dialogflow CX.

Antes de começar

Faça o seguinte antes de ler este guia:

  1. Leia os Princípios básicos do Dialogflow CX.
  2. Leia as Edições.

Sobre o Console do Google Cloud

O Console do Google Cloud (acesse a documentação, abra o console) é uma IU da Web usada para provisionar, configurar, gerenciar e monitorar sistemas que usam os produtos do Google Cloud. Você usa o Console do Google Cloud para configurar e gerenciar recursos do Dialogflow.

Crie um projeto

Para usar os serviços fornecidos pelo Google Cloud, crie um projeto. Um projeto organiza todos os seus recursos do Google Cloud. Ele consiste em um conjunto de colaboradores, APIs ativadas (e outros recursos), ferramentas de monitoramento, informações de faturamento e controles de autenticação e acesso. Crie um ou vários projetos e use-os para organizar os recursos do Google Cloud em uma hierarquia de recursos. Ao criar um projeto, anote o ID do projeto. Você precisará desse ID para fazer chamadas de API. Para mais informações sobre projetos, consulte a documentação do Resource Manager.

No console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

Acessar o seletor de projetos

Ativar faturamento

Uma conta de faturamento é usada para definir quem paga por determinado conjunto de recursos e pode estar associada a um ou mais projetos. O uso do projeto é cobrado na conta de faturamento vinculada. Na maioria dos casos, você configura o faturamento ao criar um projeto. Para mais informações, consulte a Documentação de faturamento.

Verifique se o faturamento está ativado para seu projeto na nuvem. Saiba como verificar se o faturamento está ativado em um projeto.

Ativar a API

Ative a API do Dialogflow para o projeto. Para mais informações sobre como ativar APIs, consulte a documentação do Service Usage.

Ative a Dialogflow API.

Ative a API

Configurar a autenticação

Se você pretende usar a API do Dialogflow, precisará configurar a autenticação. Qualquer aplicativo cliente que use a API precisa ser autenticado e ter acesso aos recursos solicitados. Nesta seção, você verá importantes conceitos de autenticação e etapas para a configuração deles. Para mais informações, consulte a Visão geral da autenticação do Google Cloud.

Sobre as contas de serviço

Há várias opções de autenticação, mas é recomendável usar contas de serviço para autenticação e controle de acesso. Uma conta de serviço fornece credenciais de aplicativos e não de usuários finais. As contas de serviço são de propriedade dos projetos, e você pode criar muitas para um projeto. Para mais informações, consulte as Noções básicas sobre contas de serviço.

Sobre os papéis

Quando uma identidade chama uma API, o Google Cloud exige que a identidade tenha as permissões apropriadas. Atribua papéis a uma conta de serviço para conceder permissões. Para mais informações, consulte a documentação do Gerenciamento de identidade e acesso (IAM, na sigla em inglês).

Para testar a API do Dialogflow, use o papel Projeto > Proprietário, que concede à conta de serviço acesso total ao projeto, nas etapas abaixo. Para mais informações sobre papéis específicos do Dialogflow, consulte o documento de controle de acesso do Dialogflow.

Sobre as chaves da conta de serviço

As contas de serviço estão associadas a um ou mais pares de chaves públicas/privadas. Ao criar um novo par de chaves, você faz o download da chave privada. Ela é usada para gerar credenciais ao chamar a API. Você é responsável pela segurança da chave privada e outras operações de gerenciamento, como a rotação de chaves.

Criar uma conta de serviço e fazer o download do arquivo de chave privada

Crie uma conta de serviço:

  1. No Console do Cloud, acesse a página Criar conta de serviço.

    Acesse "Criar conta de serviço"
  2. Selecione o projeto.
  3. No campo Nome da conta de serviço, insira um nome. O Console do Cloud preenche o campo ID da conta de serviço com base nesse nome.

    No campo Descrição da conta de serviço, insira uma descrição. Por exemplo, Service account for quickstart.

  4. Clique em Criar e continuar.
  5. Para fornecer acesso ao projeto, conceda os seguintes papéis à conta de serviço: Projeto > Proprietário.

    Na lista Selecionar um papel, escolha um.

    Para papéis adicionais, clique em Adicionar outro papel e adicione cada papel adicional.

  6. Clique em Continuar.
  7. Clique em Concluído para terminar a criação da conta de serviço.

    Não feche a janela do navegador. Você vai usá-la na próxima etapa.

Crie uma chave de conta de serviço:

  1. No Console do Cloud, clique no endereço de e-mail da conta de serviço que você criou.
  2. Clique em Chaves.
  3. Clique em Adicionar chave e em Criar nova chave.
  4. Clique em Criar. O download de um arquivo de chave JSON é feito no seu computador.
  5. Clique em Fechar.

Usar o arquivo de chave da conta de serviço no seu ambiente

Forneça credenciais de autenticação ao código do aplicativo definindo a variável de ambiente GOOGLE_APPLICATION_CREDENTIALS. Essa variável se aplica somente à sessão de shell atual. Se você quiser que a variável seja aplicada em sessões de shell futuras, defina a variável no arquivo de inicialização de shell, por exemplo, no arquivo ~/.bashrc ou ~/.profile.

Linux ou macOS

export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

Substitua KEY_PATH pelo caminho do arquivo JSON que contém a chave da conta de serviço.

Exemplo:

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

Windows

Para PowerShell:

$env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

Substitua KEY_PATH pelo caminho do arquivo JSON que contém a chave da conta de serviço.

Exemplo:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

Para prompt de comando:

set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

Substitua KEY_PATH pelo caminho do arquivo JSON que contém a chave da conta de serviço.

Instale e inicialize a CLI gcloud

Se você planeja usar a API Dialogflow, precisará instalar e inicializar a Google Cloud CLI. A CLI gcloud é um conjunto de ferramentas usadas para gerenciar recursos e aplicativos hospedados no Google Cloud.

O link a seguir fornece as instruções:

Instale e inicialize a Google Cloud CLI.

Testar a CLI gcloud e a autenticação

Se você configurou a autenticação nas etapas anteriores, use a ferramenta gcloud para testar seu ambiente de autenticação. Execute o comando a seguir, verifique se não há nenhum erro e se as credenciais foram retornadas:

gcloud auth application-default print-access-token

Esse comando é usado por todas as amostras de REST da linha de comando do Dialogflow para autenticar chamadas de API.

Instalar a biblioteca de cliente do Dialogflow

Bibliotecas de clientes estão disponíveis para várias linguagens conhecidas. Para instalar uma biblioteca de cliente:

Java

Se você estiver usando o Maven, adicione o código abaixo ao arquivo pom.xml. Para mais informações sobre BOMs, consulte BOM das bibliotecas do Google Cloud Platform.

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-dialogflow-cx</artifactId>
  <version>0.14.2</version>
</dependency>

Se você estiver usando o Gradle, adicione isto às dependências:

implementation 'com.google.cloud:google-cloud-dialogflow-cx:0.14.2'

Se você estiver usando o sbt, adicione o seguinte às suas dependências:

libraryDependencies += "com.google.cloud" % "google-cloud-dialogflow-cx" % "0.14.2"

Se você estiver usando o Visual Studio Code, o IntelliJ ou o Eclipse, poderá adicionar bibliotecas de cliente ao projeto usando estes plug-ins de IDE:

Os plug-ins também oferecem outras funcionalidades, como gerenciamento de chaves de contas de serviço. Consulte a documentação de cada plug-in para mais detalhes.

Node.js

npm install @google-cloud/dialogflow-cx

Python

pip install google-cloud-dialogflow-cx