Configuração e limpeza do Dialogflow ES

Neste guia, você verá todas as etapas de configuração necessárias para começar a usar o Dialogflow. Ele também dá recomendações para possíveis etapas de limpeza depois de testar o Dialogflow.

Antes de começar

Faça o seguinte antes de ler este guia:

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

Sobre o Google Cloud console do

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

Criar um projeto

Para usar os serviços fornecidos pelo Google Cloud, crie um projeto. Um projeto organiza todos os seus recursos do Google Cloud . O projeto 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 seus 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 ES (acessar a documentação, abrir o console) cria opcionalmente um projeto básico para você ao criar um agente. Caso planeje usar seu projeto para além do acesso básico com uma edição sem custo financeiro, ou planeje usar a API, crie um projeto com o Google Cloud console do , 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 Google Cloud console do, na página do seletor de projetos, escolha ou crie um Google Cloud projeto do.

Papéis necessários para selecionar ou criar um projeto

  • Selecionar um projeto: a seleção de um projeto não exige um papel específico do IAM. Você pode selecionar qualquer projeto em que tenha recebido um papel.
  • Criar um projeto: para criar um projeto, você precisa do papel de criador de projetos (roles/resourcemanager.projectCreator), que contém a resourcemanager.projects.create permissão. Saiba como conceder papéis.

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 o Google Cloud 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 API Dialogflow.

Funções necessárias para ativar APIs

Para ativar as APIs, é necessário ter o papel do IAM de administrador de uso do serviço (roles/serviceusage.serviceUsageAdmin), que contém a permissão serviceusage.services.enable. Saiba como conceder papéis.

Ativar a API

Ativar registros de auditoria

Ative os registros de auditoria de acesso a dados da API Dialogflow no seu projeto. Isso ajuda a rastrear as alterações no tempo de design nos agentes do Dialogflow vinculados a este projeto.

Instale e inicialize a Google Cloud CLI.

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

O link a seguir fornece as instruções:

Instale a Google Cloud CLI. Após a instalação, inicialize a Google Cloud CLI executando o seguinte comando:

gcloud init

Ao usar um provedor de identidade (IdP) externo, primeiro faça login na CLI gcloud com sua identidade federada.

Configurar a autenticação e o controle de acesso

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. Para saber mais, consulte a Visão geral da autenticação doGoogle Cloud .

Autenticação com contas de usuário

As contas de usuário são a melhor opção de autenticação para aprender sobre a API Dialogflow e desenvolvimento local. Use sua conta de usuário para fazer a autenticação para execuções de linha de comando REST ou chamadas de biblioteca de cliente.

Autenticação na conta de usuário da linha de comando REST

Para fazer a autenticação de chamadas da linha de comando REST, use a gcloud CLI. O comando gcloud auth login faz login no gcloud com sua conta de usuário, o que deve ser feito antes de chamar a API. O comando gcloud auth print-access-token é usado em todas as amostras de linha de comando REST nesta documentação para autenticar chamadas REST.

Se quiser criar credenciais de usuário para seu ambiente local:

gcloud auth login

Autenticação da conta de usuário da biblioteca de cliente

Para autenticar chamadas de biblioteca de cliente, use a gcloud CLI. O comando gcloud auth application-default login faz seu login no gcloud, configurando as credenciais padrão do aplicativo com a sua conta de usuário, o que deve ser feito antes de chamar a API. O comando gcloud auth application-default set-quota-project precisa ser usado para definir o projeto de faturamento e cotas relacionadas a chamadas de API. Normalmente, é o mesmo projeto usado pelo agente, e você fornece o ID do projeto criado nas etapas acima.

Não defina a variável de ambiente GOOGLE_APPLICATION_CREDENTIALS para que as credenciais padrão do aplicativo sejam usadas pelas bibliotecas de cliente.

Para criar as credenciais padrão do aplicativo do seu ambiente local:

gcloud auth application-default login
gcloud auth application-default set-quota-project PROJECT_ID

Autenticação com contas de serviço

As contas de serviço fornecem credenciais para aplicativos, e não para usuários finais. As contas de serviço são de propriedade dos projetos, e você pode criar várias para um projeto. Veja mais informações em:

Controle de acesso com papéis

Quando um principal (conta de usuário, conta de serviço e assim por diante) chama uma API, o Google Cloud exige que o principal tenha as permissões apropriadas. Você pode conceder permissões atribuindo papéis a um principal. Para saber mais, consulte a visão geral do papel.

Se você criou o projeto com essa conta, ela terá o papel básico de proprietário para o projeto. Esse papel fornece acesso para chamar qualquer API do projeto. No entanto, se outra conta criou o projeto, talvez seja necessário conceder papéis à sua conta de usuário antes de chamar a API. Para instruções, consulte o Guia de controle de acesso do Dialogflow CX.

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.

Bibliotecas de clientes estão disponíveis para várias linguagens conhecidas. Para instruções de instalação, consulte a linguagem desejada em Bibliotecas de cliente.

Revisão dos dados

Depois de configurar e testar o Dialogflow CX, é possível excluir os recursos criados:

  • Saiba como excluir seu agente.
  • É possível encerrar seu projeto .
  • Se você chamou gcloud auth login, isso armazena as credenciais no diretório do usuário no seu computador. Você pode querer excluir essas credenciais chamando:
    gcloud auth revoke
  • Se você chamou gcloud auth application-default login, isso armazena as credenciais no diretório do usuário no seu computador. Você pode querer excluir essas credenciais chamando:
    gcloud auth application-default revoke