Versões e ambientes

É possível criar várias versões dos fluxos de agentes e implantá-las em ambientes de exibição separados.

Ao editar um fluxo, você está editando um fluxo de rascunho. A qualquer momento, é possível salvar um fluxo de rascunho como uma versão de fluxo. Uma versão de fluxo é um snapshot imutável dos dados do fluxo e dos dados associados do agente, como intents, entidades, webhooks, páginas, grupos de rotas, etc.

Quando você salva um fluxo de rascunho, ele é implantado no ambiente padrão. Se você criar versões de fluxo específicas, poderá implantá-las em ambientes personalizados. É possível criar uma variedade de ambientes personalizados para:

  • testes;
  • desenvolvimento;
  • produção;
  • para o Anthos, etc.

Além disso, é possível criar webhooks específicos de ambiente, para isolar seu ambiente de produção de ambientes de desenvolvimento e teste.

Práticas recomendadas do tráfego Production

Sempre use versões de fluxo para o tráfego de produção

Os rascunhos de fluxo são atualizados sempre que um desenvolvedor da equipe faz uma alteração. É fácil interromper um rascunho de fluxo involuntariamente, principalmente se várias pessoas tiverem acesso de gravação ao agente. Além disso, um rascunho de fluxo editado recentemente pode ser inconsistente com o modelo treinado, porque o treinamento pode ter um atraso ou exigir uma execução manual.

Use sempre as versões do fluxo que estiverem no tráfego de produção. É necessário testar os rascunhos de fluxo antes de promovê-los a versões de produção, e eles podem ser revertidos para uma versão anterior no caso de problemas.

Sempre usar webhooks específicos do ambiente

Ao fazer atualizações no agente, muitas vezes há atualizações interdependentes no código do webhook. Durante o desenvolvimento e o teste dessas mudanças, você quer o seguinte:

  • Para testar as atualizações do agente em relação às atualizações do código do webhook.
  • Para evitar a implantação do código do webhook na produção até que o teste seja concluído.

O uso de Webhooks específicos de ambiente alcança essas duas metas.

Considere possíveis erros do agente ao alterar as versões

Se você alterar uma versão do fluxo em seu ambiente de produção enquanto as sessões estiverem ativas, isso poderá causar erros no agente para algumas sessões ativas. Esses erros podem acontecer se as versões anterior e nova forem inconsistentes entre si, de forma a interromper o estado da sessão. Por isso, planeje a alteração das versões durante o tempo de inatividade ou fora dos horários de pico.

Carregar uma versão de fluxo para rascunho

A qualquer momento, é possível carregar uma versão de fluxo para rascunho. Assim, ela será editável e usada pelo ambiente padrão.

Carregar uma versão de fluxo para rascunho pode atualizar vários recursos em um agente, incluindo recursos no nível do agente, como intents e entidades. Ao carregar uma versão como rascunho com o console ou a API, é possível escolher se os recursos no nível do agente serão substituídos.

Gerenciar versões de fluxo

Para gerenciar suas versões de fluxo:

Console

Para listar as versões atuais de um fluxo:

  1. Abra o Console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Clique na guia Gerenciar.
  5. Clique em Versões.
  6. Os fluxos de agente são listados. Selecione uma opção.
  7. As versões são listadas para o fluxo selecionado.

As informações a seguir são exibidas para cada fluxo:

  • Nome de exibição: o nome de exibição da versão.
  • ID da versão: o ID da versão.
  • Tipo PLN: o tipo PLN para a versão do fluxo.
  • Carimbo de data/hora da criação: a data e a hora em que a versão foi criada.
  • Status: o status do treinamento. Uma versão de fluxo não está pronta para ser usada até que o status seja marcado como Pronto.

Para criar uma nova versão de fluxo, clique no botão Create e forneça o Nome de exibição e a Descrição da versão.

Para carregar uma versão de fluxo específica como fluxo de rascunho:

  1. Mantenha o ponteiro sobre uma linha de versão.
  2. Clique no botão de opção .
  3. Clique na opção Carregar para rascunho.
  4. Há uma opção para substituir os dados no nível do agente durante o carregamento.

Para excluir uma versão de fluxo específica:

  1. Mantenha o ponteiro sobre uma linha de versão.
  2. Clique no botão de opção .
  3. Clique na opção Excluir versão.

API

Veja os métodos para o tipo Version.

Selecione um protocolo e uma versão para referência da versão:

Protocolo V3 V3beta1
REST Recurso de versão Recurso de versão
RPC (remote procedure call) Interface da versão Interface da versão
C++ VersionsClient Indisponível
C# VersionsClient Indisponível
Go VersionsClient Indisponível
Java VersionsClient VersionsClient
Node.js VersionsClient VersionsClient
PHP Indisponível Indisponível
Python VersionsClient VersionsClient
Ruby Indisponível Indisponível

Comparar versões do fluxo

Depois de criar versões de fluxo, use a ferramenta de comparação de versões para ver uma comparação lado a lado entre as versões de fluxo ou a versão de rascunho. Para comparar versões:

Console

  1. Mantenha o ponteiro sobre uma linha de versão.
  2. Clique no botão de opção .
  3. Clique na opção Comparar versões.
  4. Selecione outra versão do fluxo ou fluxo de rascunho para comparação.
  5. Uma comparação lado a lado é exibida.

API

Veja o método compareVersions para o tipo Version.

Selecione um protocolo e uma versão para referência da versão:

Protocolo V3 V3beta1
REST Recurso de versão Recurso de versão
RPC (remote procedure call) Interface da versão Interface da versão
C++ VersionsClient Indisponível
C# VersionsClient Indisponível
Go VersionsClient Indisponível
Java VersionsClient VersionsClient
Node.js VersionsClient VersionsClient
PHP Indisponível Indisponível
Python VersionsClient VersionsClient
Ruby Indisponível Indisponível

Gerenciar ambientes

Para gerenciar os ambientes de agente:

Console

Para listar os ambientes atuais de um agente:

  1. Abra o Console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Clique na guia Gerenciar.
  5. Clique em Ambientes.
  6. Os ambientes de agente são listados.

Para criar um novo ambiente, clique no botão Criar e forneça informações.

Para selecionar versões de fluxo e configurar um ambiente, clique em um ambiente e forneça informações.

Para visualizar o histórico de edição de um ambiente, clique no botão de histórico no lado direito de um ambiente na lista.

Para copiar um nome de recurso do ambiente que inclua o ID do ambiente, clique no botão de cópia no lado direito de um ambiente na lista.

Para excluir um ambiente, clique no botão de exclusão no lado direito de um ambiente na lista.

API

Veja os métodos para o tipo Environment.

Selecione um protocolo e uma versão para a Referência de ambiente:

Protocolo V3 V3beta1
REST Recurso do ambiente Recurso do ambiente
RPC (remote procedure call) Interface do ambiente Interface do ambiente
C++ EnvironmentsClient Indisponível
C# EnvironmentsClient Indisponível
Go EnvironmentsClient Indisponível
Java EnvironmentsClient EnvironmentsClient
Node.js EnvironmentsClient EnvironmentsClient
PHP Indisponível Indisponível
Python EnvironmentsClient EnvironmentsClient
Ruby Indisponível Indisponível

Especificar o ambiente para chamadas de sessão

Com o simulador do console ou a API, é possível especificar um ambiente ao fazer chamadas de sessão de tempo de execução. Se um ambiente não for especificado, o ambiente padrão será usado.

Console

Ao usar o simulador do console, selecione a opção Testar agente no ambiente e, em seguida, selecione um ambiente.

API

Se quiser especificar um ambiente para detectIntent, streamingDetectIntent, matchIntent e chamadas REST de entidade de sessão, altere o URL inserindo environments/environment-id entre os parâmetros de caminho agent e sessions.

Por exemplo, o URL a seguir usa o ID de ambiente 6db409d7-57ac-41d7-83bd-89b8768e2745:

https://dialogflow.googleapis.com/v3/projects/my-project-id/locations/us/agents/my-agent-id/environments/6db409d7-57ac-41d7-83bd-89b8768e2745/sessions/my-session-id:detectIntent

Especificar versões de fluxo para chamadas de sessão

Com o simulador do console ou a API, é possível especificar um conjunto de versões de fluxo ao fazer chamadas de sessão de ambiente de execução. As versões de fluxo selecionadas não precisam necessariamente ser referenciadas em nenhum ambiente.

Console

Ao usar o simulador do console, selecione a opção Testar o agente com versões de fluxo específicas e, em seguida, selecione as versões do fluxo.

API

Para especificar versões de fluxo para detectIntent, streamingDetectIntent, matchIntent e chamadas REST de entidade de sessão, forneça as versões de fluxo escolhidas no campo query_parameters.flow_versions da solicitação.