Parâmetros do guia interativo

Os playbooks podem aceitar e emitir informações de contexto através de parâmetros definidos explicitamente. Os parâmetros são usados para armazenar informações sobre uma conversa, como seleções do utilizador, resultados de ações, etc. Pode transmitir os valores destes parâmetros entre playbooks e fluxos.

Declaração de parâmetros

Pode definir parâmetros de entrada (leitura) e parâmetros de saída (escrita).

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 pode especificar se um parâmetro é uma lista.

Parâmetros de entrada (leitura)

Para cada manual de soluções, pode definir parâmetros de entrada, também denominados parâmetros de leitura, que permitem que os manuais de soluções usem valores transmitidos de fluxos e outros manuais de soluções. Por exemplo, um guião pode receber o nome preferido de um utilizador como parâmetro e usá-lo para agradecer pessoalmente ao utilizador ou pode receber um identificador de encomenda como parâmetro e usá-lo para obter detalhes da encomenda através de uma ferramenta.

Os parâmetros de entrada são definidos por manual de procedimentos e, por predefinição, os manuais de procedimentos não têm visibilidade de outros tipos de parâmetros da consola do Dialogflow CX. Quando um fluxo faz a transição para um playbook, os parâmetros de página e 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 guião durante uma transição, defina parâmetros de entrada do guião com o mesmo nome que um parâmetro de sessão ou de página presente antes da transição.

Nota: o manual de procedimentos predefinido não aceita parâmetros de entrada. O manual de estratégias predefinido serve como ponto de entrada para as conversas com o utilizador, pelo que não tem forma de receber parâmetros de entrada.

Crie exemplos para controlar a forma como o valor do parâmetro de entrada deve afetar as ações. Por exemplo, se um parâmetro de entrada afetar a forma como o agente se refere ao utilizador, crie exemplos que definam um valor para o parâmetro e, em seguida, use o mesmo valor nas ações de expressão no exemplo. Consulte o artigo sobre como transmitir parâmetros para ver detalhes.

Parâmetros de saída (gravar, devolver)

Para cada manual de procedimentos, pode definir parâmetros de saída, também denominados parâmetros de gravação e parâmetros de retorno, que permitem que os manuais de procedimentos emitam informações para serem usadas por outros fluxos ou manuais de procedimentos. Por exemplo, um guião de ações pode recolher um número de encomenda de um utilizador e emiti-lo através de um parâmetro de saída, ou um guião de ações pode usar uma ferramenta para reservar um voo e emitir o número de confirmação através de um parâmetro de saída.

Crie exemplos para controlar a forma como o manual de soluções deve 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 deve derivar o respetivo valor da saída de uma utilização de ferramenta, crie exemplos em que a saída da utilização de ferramenta corresponda ao valor do parâmetro de saída do livro de jogadas.

Parâmetros de aprovação

Nota: um manual de procedimentos de tarefas não pode chamar um manual de procedimentos de rotinas. Por isso, o cenário de transmissão de parâmetros não é descrito abaixo.

Ao contrário dos fluxos, os manuais de procedimentos não suportam a injeção de valores de parâmetros com uma sintaxe específica. Em alternativa, os playbooks baseiam-se em instruções e exemplos de comandos com poucos exemplos para determinar como os valores dos parâmetros devem ser usados e como os valores devem ser decididos quando especificar valores de parâmetros.

Guia interativo de rotinas para fluxo

Para transmitir parâmetros de um manual de procedimentos de rotina para um fluxo:

• Defina parâmetros de gravação para o manual de procedimentos de rotina. Estes parâmetros tornam-se parâmetros de sessão.
• Os fluxos podem usar os parâmetros de sessão.
• Inclua a utilização de parâmetros em instruções e exemplos.

Fluxo para o guia interativo de rotinas

Para transmitir parâmetros de um fluxo para um manual de procedimentos de rotina:

• Os fluxos escrevem os parâmetros de sessão.
• Defina parâmetros de leitura para o manual de procedimentos de rotina com os mesmos nomes.
• Inclua a utilização de parâmetros em instruções e exemplos.

Guia interativo de tarefas para fluxo

Para transmitir parâmetros de um manual de procedimentos de tarefas para um fluxo:

• Nas definições do fluxo, defina parâmetros de entrada com os mesmos nomes.
• Inclua a utilização de parâmetros em instruções e exemplos.

Fluxo para o guia de tarefas

Para transmitir parâmetros de um fluxo para um manual de estratégias de tarefas principal:

• Nas definições do fluxo, defina os parâmetros de retorno.
• Inclua a utilização de parâmetros em instruções e exemplos.

Para transmitir parâmetros de um fluxo para um conjunto de ações de uma tarefa secundária:

• Defina parâmetros de entrada de tarefas que partilham o mesmo nome que os parâmetros de sessão no fluxo.
• Inclua a utilização de parâmetros em instruções e exemplos.

Guia interativo de rotinas para tarefas

Para transmitir parâmetros de um playbook de rotina para um playbook de tarefas:

• Defina parâmetros de entrada para o manual de soluções de tarefas com os mesmos nomes.
• Inclua a utilização de parâmetros em instruções e exemplos.

Exemplo com ferramentas

Considere um agente concebido para vendas de bilhetes para eventos com os seguintes manuais de tarefas:

1. Um manual de estratégias denominado Ticket ordering que faz encomendas através de uma ferramenta denominada Ticket sales API.
   1. Este manual de estratégias aceita um parâmetro de entrada com o tipo number e o nome event_id.
   2. A ferramenta Ticket sales API espera um pedido que inclua um event_id.
2. Um manual de estratégias denominado Event selection que ajuda os utilizadores a selecionar um evento e, em seguida, encaminha-os para Ticket ordering com o parâmetro event_id para comprar bilhetes.

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

O manual de estratégias Ticket ordering deve incluir vários exemplos que:

• Ter o parâmetro de entrada event_id especificado com algum valor realista, diferente em cada exemplo.
• Inclua uma ação de utilização de ferramentas com um corpo do pedido que inclua o mesmo valor event_id realista especificado no parâmetro de entrada.

O manual de estratégias Event selection deve incluir vários exemplos que:

• Inclua uma expressão do utilizador em que o utilizador seleciona um evento com alguns valores realistas event_id, diferentes em cada exemplo.
• Inclua uma invocação do manual de procedimentos de Ticket ordering que defina o parâmetro event_id para o mesmo valor realista event_id conforme decidido pela seleção do utilizador.

Além de adicionar exemplos, experimente adicionar instruções específicas às instruções, meta ou detalhes da ferramenta que expliquem como os parâmetros devem ser usados. Por exemplo, o manual de estratégias 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 as instruções descritas, o Event selectionplaybook decide corretamente um event_id com base na seleção do utilizador e transmite-o como um parâmetro de entrada denominado event_id ao Ticket ordering playbook. Em seguida, Ticket ordering transmite o mesmo event_id no corpo de um pedido ao Ticket sales API. Os manuais de soluções dependem de exemplos com valores de parâmetros distintos para ajudar a inferir como os parâmetros devem ser usados.