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 fornece recomendações para possíveis etapas de limpeza depois de tentar ou testar o Dialogflow.

Antes de começar

Faça o seguinte antes de ler este guia:

1. Leia os Conceitos básicos do Dialogflow ES.
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 ES (acesse a documentação e abra o console) pode criar um projeto básico para você, se quiser quando você cria um agente. Se você planeja usar seu projeto para algo além do acesso básico a uma edição sem custos ou pretende usar a API, crie um projeto com o Console do Google 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.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Aviso: se um projeto for excluído, não será possível recuperar os agentes vinculados a ele.

Ativar faturamento

Observação: ignore esta etapa se você usar Edição do Dialogflow disponível sem custos financeiros.

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 a cobrança está ativada para o seu projeto do Google Cloud.

Ative a API

Observação: ignore essa etapa se estiver usando o Console do Dialogflow para criar seu projeto.

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

Enable the Dialogflow API.

Enable the API

Ativar registros de auditoria

Observação: ignore esta etapa para agentes de não produção.

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 CLI do Google Cloud.

Observação: ignore esta etapa se não estiver usando a API.

Se você planeja usar a API Dialogflow, é necessário instalar e inicializar a CLI do Google Cloud. Ela é um conjunto de ferramentas para gerenciar recursos e aplicativos hospedados no Google Cloud.

O link a seguir fornece as instruções:

Install the Google Cloud CLI, then initialize it by running the following command:

gcloud init

Configurar a autenticação e o controle de acesso

Observação: ignore esta etapa se não estiver usando a API.

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.

Autenticação com contas de usuário

Contas de usuário são a melhor opção de autenticação ao aprender sobre a API Dialogflow e ao 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

Observação: se você estiver usando o Cloud Shell, o login no gcloud será feito automaticamente, então não precisa executar gcloud auth login.

Para fazer a autenticação em chamadas de linha de comando REST, use a CLI gcloud. 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.

Para 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 CLI gcloud. O comando gcloud auth application-default login faz login no gcloud para as credenciais padrão do aplicativo com 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 para 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 o Application Default Credentials para 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 são outra opção de autenticação que só deve ser usada em ambientes seguros, como produção ou preparo. 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. Veja mais informações em:

• Visão geral da conta de serviço
• Práticas recomendadas de conta de serviço
• Criar e gerenciar contas de serviço
• Criar e gerenciar chaves de contas de serviço
• Como autenticar com chaves de conta de serviço

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 concedendo 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 a Guia de controle de acesso do Dialogflow.

Instalar a biblioteca de cliente do Dialogflow

Observação: ignore esta etapa se não estiver usando a API.

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 obter instruções de instalação, consulte o idioma desejado em Bibliotecas de cliente.

Limpeza

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

• Exclua 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