Versões e ambientes

É possível criar várias versões dos fluxos de agentes e playbooks (também conhecidos como agentes da Vertex AI) e implantá-los em ambientes de exibiçã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 dos dados do fluxo ou playbook e dos dados associados do agente. 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 o tráfego de Production

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

Um rascunho é atualizado sempre que um desenvolvedor da 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 pode ser inconsistente com o modelo treinado, porque o treinamento pode ter um atraso ou exigir uma execução manual.

Use sempre versões para o tráfego de produção. É necessário testar os rascunhos de recursos antes de promovê-los a versões de produção. Você pode reverter para uma versão anterior se encontrar algum problema.

Sempre use webhooks específicos do ambiente

Ao fazer atualizações no seu 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 você conclua os testes.

O uso de webhooks específicos do ambiente atinge essas duas metas.

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 anteriores e novas forem inconsistentes entre si de uma forma que atrapalhe o estado da sessão. Por isso, planeje mudar as versões durante o tempo 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. 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.

Da mesma forma, a restauração de uma versão de manual para rascunho vai substituir o manual existente e os exemplos.

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 cursor sobre uma linha da 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. Acessar a referência da API Version

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

Protocolo	V3	V3beta1
REST	Recurso da 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

Fechar

Observação: o método load tem um campo allowOverrideAgentResources, que pode ser usado para controlar se os recursos do nível de agente são substituídos ao restaurar um fluxo como fluxo de rascunho.

Observação: ao chamar o método delete para excluir uma versão, primeiro é preciso remover todas as referências à versão em dados de ambientes.

Comparar versões do fluxo

Observação: a comparação de versões é limitada a um tamanho de resposta de 2 MB. Use o método da API REST para superar essa limitação.

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

1. Mantenha o cursor sobre uma linha da 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. Acessar a referência da API Version

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

Protocolo	V3	V3beta1
REST	Recurso da 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

Fechar

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. Acessar a referência da API 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

Fechar

Observação: para fazer referência a um fluxo de rascunho, use 0 como o ID da versão do fluxo.

Especificar o ambiente para chamadas de sessão

Usando o simulador de console ou a API, é possível especificar um ambiente ao fazer chamadas de sessão 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 simulador de console ou a API, é possível especificar um conjunto de versões de fluxo ao fazer chamadas de sessão 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 Test agent with specific flow versions 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.