É possível criar várias versões dos fluxos, playbooks e ferramentas do agente e implantá-las em ambientes de veiculação separados.
Ao editar um fluxo, playbook ou ferramenta, você está editando o rascunho. A qualquer momento, você pode salvar o rascunho como uma versão. Uma versão é um snapshot imutável dos dados do fluxo, playbook ou ferramenta e dos dados do agente associados. Para fluxos, isso inclui intents, entidades, webhooks, páginas e grupos de rotas. Para playbooks, isso inclui apenas exemplos.
Quando você salva 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, é possível criar webhooks específicos do ambiente para isolar o ambiente de produção dos ambientes de desenvolvimento e teste.
Práticas recomendadas para tráfego de Production
Sempre use versões para o tráfego de produção
Um rascunho é atualizado sempre que um desenvolvedor da sua equipe faz uma mudança. É possível quebrar um rascunho sem querer, especialmente se várias pessoas tiverem acesso de gravação ao agente. Além disso, um rascunho editado recentemente pode ser inconsistente 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 precisam ser testados antes de serem promovidos para versões de produção, e é possível reverter para uma versão anterior se algum problema for descoberto.
Sempre use webhooks específicos do ambiente
Ao atualizar o agente, é comum que você tenha 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.
O uso de webhooks específicos do ambiente alcança esses dois objetivos.
Considere possíveis erros do agente ao mudar de versão
Se você mudar uma versão no ambiente de produção enquanto as sessões estiverem ativas, isso poderá causar erros de agente em algumas sessões ativas. Esses erros podem acontecer se as versões anterior e nova forem inconsistentes entre si de uma forma que interrompa o estado da sessão. Por isso, planeje mudar as versões durante períodos de inatividade ou fora dos horários de pico.
Carregar uma versão para rascunho
A qualquer momento, é possível carregar uma versão para rascunho, para que ela seja 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.
Da mesma forma, restaurar uma versão do playbook para rascunho vai substituir o playbook atual em rascunho e os exemplos dele. A restauração de uma ferramenta vai substituir a ferramenta atual no rascunho.
Gerenciar versões
Para gerenciar suas versões:
Console
Para listar as versões atuais de um fluxo:
- Abra o console do Dialogflow CX.
- Escolha o projeto do Google Cloud .
- Selecione seu agente.
- Clique na guia Recursos compartilhados.
- Clique em Versões.
- Os fluxos de agente são listados. Selecione uma opção.
- As versões são listadas para o fluxo selecionado.
Para listar as versões atuais de um playbook:
- Abra o console do Dialogflow CX.
- Escolha o projeto do Google Cloud .
- Selecione seu agente.
- Selecione o playbook
- Clique em Histórico de versões.
- Clique em Ver histórico de versões.
- As versões são listadas para o playbook selecionado.
Para listar as versões atuais de uma ferramenta:
- Abra o console do Dialogflow CX.
- Escolha o projeto do Google Cloud .
- Selecione seu agente.
- Selecione a ferramenta
- Clique em Histórico de versões.
- Clique em Ver histórico de versões.
- As versões são listadas para a ferramenta selecionada.
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 Criar 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:
- Mantenha o ponteiro do mouse sobre uma linha de versão.
- Clique no botão de opção more_vert.
- Clique na opção Carregar para rascunho.
- 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:
- Mantenha o ponteiro do mouse sobre uma linha de versão.
- Clique no botão de opção more_vert.
- 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 de versão | Interface de 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. Esse recurso não está disponível para playbooks. Para comparar versões:
Console
- Mantenha o ponteiro do mouse sobre uma linha de versão.
- Clique no botão de opção more_vert.
- Clique na opção Comparar versões.
- Selecione outra versão do fluxo ou fluxo de rascunho para comparação.
- 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 de versão | Interface de 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:
- Abra o console do Dialogflow CX.
- Escolha o projeto do Google Cloud .
- Selecione seu agente.
- Clique na guia Recursos compartilhados.
- Clique em Ambientes.
- 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, playbook e ferramenta 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 history 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 content_copy no lado direito de um ambiente na lista.
Para excluir um ambiente, clique no botão de exclusão delete 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 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 Testar agente no ambiente e escolha 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 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 agente com versões de fluxo específicas e, em seguida, selecione as versões de fluxo.
API
Para especificar versões de fluxo para chamadas REST de detectIntent, streamingDetectIntent, matchIntent e entidade de sessão, forneça as versões de fluxo escolhidas no campo query_parameters.flow_versions da solicitação.