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

Neste guia, você verá todas as etapas de configuração necessárias para começar a usar o Dialogflow.

Antes de começar

Faça o seguinte antes de ler este guia:

  1. Leia os Conceitos básicos do Dialogflow.
  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.

O Console do Dialogflow ( acessar a documentação , abrir o Console [em inglês]) cria um projeto básico quando for criar um agente. Caso planeje usar seu projeto para além do acesso básico com uma edição gratuita ou planeje usar a API, crie um projeto com o Google Console do Cloud, conforme descrito abaixo.

Recomendamos que você crie projetos separados para experimentos, testes e produção. Cada projeto é capaz de criar apenas um agente do Dialogflow. Se você precisa de vários agentes, é necessário criar diversos projetos.

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

Acessar a página do 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 confirmar se o faturamento está ativado para o projeto.

Ative 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 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

Configurar a autenticação:

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

    Acessar página "Criar chave da conta de serviço"
  2. Na lista Conta de serviço, selecione Nova conta de serviço.
  3. No campo Nome da conta de serviço, insira um nome.
  4. Na lista Papel, selecione Projeto > Proprietário.

  5. Clique em Criar. O download de um arquivo JSON que contém sua chave é feito no seu computador.

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. Substitua [PATH] pelo caminho do arquivo JSON que contém sua chave da conta de serviço. Essa variável só se aplica à sessão de shell atual. Assim, se você abrir uma nova sessão, precisará definir a variável novamente.

Linux ou macOS

export GOOGLE_APPLICATION_CREDENTIALS="[PATH]"

Exemplo:

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/my-key.json"

Windows

Com o PowerShell:

$env:GOOGLE_APPLICATION_CREDENTIALS="[PATH]"

Exemplo:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\my-key.json"

Com prompt de comando:

set GOOGLE_APPLICATION_CREDENTIALS=[PATH]

Instalar e inicializar o SDK do Cloud

Caso planeje usar a API do Dialogflow, é necessário instalar e inicializar o SDK do Cloud. Ele é um conjunto de ferramentas que pode ser usado para gerenciar recursos e aplicativos hospedados no Google Cloud. Isso inclui a ferramenta de linha de comando gcloud.

O link a seguir fornece as instruções:

Instale e inicialize o SDK do Cloud..

Testar o SDK e a autenticação

Se você tiver configurado a autenticação nas etapas anteriores, poderá usar a ferramenta `gcloud` para testar o 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

Você tem três opções para chamar a API: bibliotecas de cliente compatíveis com o Google, REST e gRPC. As bibliotecas de cliente estão disponíveis para vários idiomas conhecidos. Essas são as opções recomendadas. Para instalar uma biblioteca de cliente:

C#

Instale o pacote Google.Cloud.Dialogflow.V2 pelo NuGet. Adicione-o ao seu projeto da maneira normal, por exemplo, clicando com o botão direito do mouse no projeto no Visual Studio e escolha "Gerenciar Pacotes do NuGet..." Ative os pacotes de pré-lançamento (por exemplo, na interface do usuário do Visual Studio NuGet, marque a caixa "Include prerelease").

Como alternativa, use a interface de linha de comando do NuGet:

nuget install Google.Cloud.Dialogflow.V2 -PreRelease

Go

go get cloud.google.com/go/dialogflow/apiv2

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.

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>libraries-bom</artifactId>
      <version>16.1.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>com.google.cloud</groupId>
    <artifactId>google-cloud-dialogflow</artifactId>
  </dependency>

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

compile 'com.google.cloud:google-cloud-dialogflow:2.4.2'

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

libraryDependencies += "com.google.cloud" % "google-cloud-dialogflow" % "2.4.2"

Caso você esteja usando o IntelliJ ou o Eclipse, poderá adicionar bibliotecas de cliente ao seu projeto usando estes plug-ins de ambiente de desenvolvimento integrado:

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 dialogflow

PHP

  1. Instale o gerenciador de dependências recomendado para PHP, o Composer.
  2. Instale o componente do Dialogflow das bibliotecas de cliente do Google Cloud:
    composer require google/cloud-dialogflow
  3. Este componente é compatível com REST em HTTP/1.1 e gRPC. Para aproveitar os benefícios oferecidos pelo gRPC, como os métodos de streaming, siga as instruções no guia de instalação do gRPC.

Python

pip install dialogflow

Ruby

gem install google-cloud-dialogflow