Versões e ambientes

É possível criar várias versões dos fluxos de agente e playbooks (também conhecidos como agentes da Vertex AI). e implantá-los em ambientes de veiculação separados.

Ao editar um fluxo ou playbook, você está editando o rascunho. A qualquer momento, é possível salvar o rascunho como uma versão. Uma versão é um snapshot imutável do fluxo ou dos dados do playbook e os dados associados do agente. Para fluxos, isso inclui intents, entidades, webhooks, páginas e grupos de rotas. Para playbooks, isso inclui apenas exemplos.

Ao salvar um rascunho, ele é implantado no ambiente padrão. Ao criar versões específicas, é possível implantá-las em ambientes personalizados. É possível criar vários ambientes personalizados, como:

  • testando
  • desenvolvimento;
  • produção

Além disso, crie webhooks específicos do ambiente, para isolar o ambiente de produção de ambientes de desenvolvimento e teste.

Práticas recomendadas para o tráfego de produção

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

Um rascunho é atualizado sempre que um desenvolvedor da sua equipe faz uma alteração. É possível interromper um rascunho acidentalmente, principalmente se várias pessoas tiverem acesso de gravação ao agente. Além disso, um rascunho editado recentemente podem ser inconsistentes com o modelo treinado, porque o treinamento pode ter um atraso ou exigir execução manual.

Sempre use versões para o tráfego de produção. Os recursos de rascunho devem ser testados antes de promovê-los para versões de produção. É possível reverter para uma versão anterior caso algum problema seja descoberto.

Sempre use webhooks específicos do ambiente

Ao fazer atualizações no seu agente, muitas vezes você tem 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 os testes sejam concluídos.

Usando Webhooks específicos do ambiente atinja as duas metas.

Considerar possíveis erros do agente ao alterar versões

Se você alterar uma versão no ambiente de produção enquanto as sessões estão ativas, isso pode causar erros no agente em algumas sessões ativas. Esses erros podem acontecer se as versões anteriores e novas forem inconsistentes entre si de uma forma que atrapalhe o estado da sessão. Por isso, planeje a alteração das versões durante 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. Esse recurso ainda não está disponível para playbooks.

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

Para gerenciar suas versões:

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 Recursos compartilhados.
  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.

Para listar as versões atuais de um playbook:

  1. Abra o Console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecionar o playbook
  5. Clique em Histórico de versões.
  6. Clique em Ver histórico de versões.
  7. As versões são listadas para o playbook selecionado.

As seguintes informações são exibidas para cada recurso:

  • 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, 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 cursor sobre uma linha da 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 do mouse 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 de 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. Este recurso não está disponível para playbooks. Para comparar versões:

Console

  1. Mantenha o ponteiro do mouse 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 da 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 Recursos compartilhados.
  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 playbook 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 de ambiente Recurso de 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

Usando o método simulador do console ou a API, é possível especificar um ambiente ao fazer chamadas de sessão de ambiente 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 Test agent in environment e, em seguida, selecione um ambiente.

API

Para especificar um ambiente para chamadas REST de detectIntent, streamingDetectIntent, matchIntent e 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

Usando o método simulador do console ou a API, especifique 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 ser referenciadas em nenhum ambiente.

Console

Ao usar o simulador do console, Selecione a opção Agente de teste com versões específicas de fluxo. e, em seguida, selecionar versões de 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.