Parâmetros do playbook

Visualização

Este produto ou recurso está sujeito aos "Termos das ofertas pré-GA" na seção "Termos de Serviço gerais" dos Termos específicos do serviço. Os produtos e recursos pré-GA estão disponíveis "no estado em que se encontram" e podem ter suporte limitado. Para mais informações, consulte as descrições da fase de lançamento.

Observação: o console do Criador de agentes ainda se refere aos playbooks como agentes. Isso será atualizado para playbook em breve no console.

Importante: os playbooks de agentes de conversação (Dialogflow CX) e a transmissão de parâmetros entre fluxos e playbooks de agentes de conversação (Dialogflow CX) estão documentados aqui, mas o acesso está restrito no momento. A transmissão de parâmetros entre agentes do Dialogflow está disponível publicamente.

Os playbooks podem aceitar e emitir informações de contexto usando parâmetros definidos explicitamente. Os parâmetros são usados para armazenar informações sobre uma conversa, como seleções do usuário, resultados de ações e assim por diante. É possível transmitir os valores desses parâmetros entre playbooks e fluxos.

Declaração de parâmetro

É possível definir parâmetros de entrada e de saída.

Ao usar o console do Criador de agentes, é possível definir parâmetros na página do editor de agentes.

Ao usar o console do Dialogflow CX, os parâmetros são definidos por playbook usando a guia Parâmetros depois que você cria um playbook.

Os parâmetros têm um nome, uma descrição e um dos seguintes tipos:

• String
• Número
• Booleano
• Tipo de parâmetro específico da ferramenta

Também é possível especificar se um parâmetro é uma lista.

Parâmetros de entrada

Os parâmetros de entrada permitem que os playbooks usem valores transmitidos de fluxos e outros playbooks. Por exemplo, um playbook pode receber o nome preferido de um usuário como parâmetro e usá-lo para agradecer o usuário pessoalmente, ou pode receber um identificador de pedido como parâmetro e usá-lo para extrair detalhes do pedido usando uma ferramenta.

Os parâmetros de entrada são definidos por playbook, e os playbooks não têm visibilidade de outros tipos de parâmetros do console do Dialogflow CX por padrão. Quando um fluxo é transferido para um playbook, os parâmetros de página e de sessão são propagados para o playbook se o playbook de destino tiver um parâmetro de entrada com o mesmo nome. Para comunicar informações de um fluxo a um playbook durante uma transição, defina parâmetros de entrada do playbook com o mesmo nome de um parâmetro de sessão ou página presente antes da transição.

Observação: o playbook padrão não aceita parâmetros de entrada. O playbook padrão serve como ponto de entrada para as conversas com o usuário, então não tem como receber parâmetros de entrada.

Crie exemplos para controlar como o valor do parâmetro de entrada afeta as ações. Por exemplo, se um parâmetro de entrada precisa afetar a forma como o agente se refere ao usuário, crie exemplos que definam um valor para o parâmetro e use o mesmo valor nas ações de fala no exemplo. Consulte Como transmitir parâmetros para mais detalhes.

Parâmetros de saída

Os parâmetros de saída permitem que os playbooks emitam informações para serem usadas por outros fluxos ou playbooks. Por exemplo, um playbook pode coletar um número de pedido de um usuário e emiti-lo por um parâmetro de saída, ou pode usar uma ferramenta para reservar um voo e emitir o número de confirmação por um parâmetro de saída.

Crie exemplos para controlar como o playbook precisa decidir o valor de cada parâmetro de saída. Por exemplo, se um parâmetro de saída que representa um número de confirmação precisa derivar o valor da saída de um uso de ferramenta, crie exemplos em que a saída do uso da ferramenta corresponde ao valor do parâmetro de saída do playbook.

Como transmitir parâmetros

Os playbooks, ao contrário dos fluxos, não oferecem suporte à injeção de valores de parâmetro com uma sintaxe específica. Em vez disso, os playbooks dependem de instruções e exemplos de comandos de poucas palavras para determinar como os valores dos parâmetros devem ser usados e como os valores devem ser decididos ao especificar os valores dos parâmetros.

Considere um agente criado para vendas de ingressos de eventos com os seguintes playbooks:

1. Um playbook chamado Ticket ordering que faz pedidos usando uma ferramenta chamada Ticket sales API.
   1. Esse playbook aceita um parâmetro de entrada com o tipo number e o nome event_id.
   2. A ferramenta Ticket sales API espera uma solicitação que inclua um event_id.
2. Um playbook chamado Event selection, que ajuda os usuários a selecionar um evento e os encaminha para Ticket ordering com o parâmetro event_id para comprar ingressos.

Neste exemplo, para garantir que event_id seja transmitido de forma confiável de Event selection para Ticket ordering e de Ticket ordering para Ticket sales API, vários exemplos são necessários.

O playbook Ticket ordering precisa incluir vários exemplos que:

• O parâmetro de entrada event_id é especificado com algum valor realista, diferente em cada exemplo.
• Inclua uma ação de uso de ferramenta com um corpo de solicitação que inclua o mesmo valor realista de event_id especificado no parâmetro de entrada.

O playbook Event selection precisa incluir vários exemplos que:

• Inclua uma frase do usuário em que ele selecione um evento com um event_id realista, diferente em cada exemplo.
• Inclua uma invocação de playbook de Ticket ordering que defina o parâmetro event_id como o mesmo event_id realista, conforme decidido pela seleção do usuário.

Além de adicionar exemplos, tente incluir instruções específicas nas instruções, metas ou detalhes da ferramenta explicando como os parâmetros devem ser usados. Por exemplo, o playbook Ticket ordering inclui a seguinte instrução:

- Use parameter event_id to send a buy_tickets request with ${TOOL: Ticket sales API}

Com os exemplos e instruções descritos, o manual de Event selection decide corretamente um event_id com base na seleção do usuário e o transmite como um parâmetro de entrada chamado event_id para o Ticket ordering playbook. Em seguida, Ticket ordering transmite o mesmo event_id no corpo de uma solicitação para o Ticket sales API. Os playbooks dependem de exemplos com valores de parâmetros distintos para ajudar a inferir como os parâmetros devem ser usados.