Playbook 参数

Playbook 可以使用明确定义的参数接受和发出上下文信息。参数用于存储有关对话的信息，例如用户选择、操作结果等。您可以在 playbook 和流之间传递这些参数的值。

参数声明

您可以定义输入（读取）参数和输出（写入）参数。

参数具有名称、说明和以下类型之一：

• 字符串
• 数字
• 布尔值
• 工具专用参数类型

您还可以指定参数是否为列表。

输入（读取）参数

对于每个 playbook，您可以定义输入参数（也称为读取参数），以便 playbook 使用从流和其他 playbook 传递的值。例如，playbook 可能会接收用户的首选名称作为参数，并使用该名称亲自感谢用户；或者，它可能会接收订单标识符作为参数，并使用该标识符通过工具检索订单详情。

输入参数是按 playbook 定义的，默认情况下，playbook 无法查看其他 Dialogflow CX 控制台参数类型。当流转换到 playbook 时，如果目标 playbook 具有同名的输入参数，则页面和会话参数会传播到 playbook。如需在转换期间将信息从流传达给 playbook，请定义与转换前存在的会话或页面参数同名的 playbook 输入参数。

注意 ：默认 playbook 不接受输入参数。默认 playbook 是用户对话的入口点，因此无法接收输入参数。

创建示例，以控制输入参数值对操作的影响。 例如，如果输入参数应该影响智能体如何称呼用户，请创建为该参数定义值的示例，然后在示例中的话语操作中使用相同的值。如需了解详情，请参阅传递参数。

输出（写入、返回）参数

对于每个 playbook，您可以定义输出参数（也称为写入参数和返回参数），以便 playbook 发出信息供其他 flow 或 playbook 使用。例如，playbook 可能会从用户那里收集订单号，并通过输出参数发出该订单号；或者，playbook 可能会使用工具预订航班，并通过输出参数发出确认号。

创建示例，以控制 playbook 应如何确定每个输出参数的值。 例如，如果表示确认编号的输出参数应从工具使用的输出中派生其值，请创建工具使用的输出与 playbook 输出参数的值匹配的示例。

传递参数

注意： 任务 playbook 无法调用常规流程 playbook，因此下文不会介绍该参数传递场景。

与 flow 不同，playbook 不支持使用特定语法注入参数值。相反，Playbook 依赖于指令和少样本提示词示例来确定应如何使用参数值，以及在指定参数值时应如何确定值。

常规流程 playbook 到 flow

如需将参数从常规流程 playbook 传递到流，请执行以下操作：

• 为常规流程 playbook 定义写入参数。 这些参数将成为会话参数。
• 流程可以使用会话参数。
• 在说明和示例中包含参数用法。

常规流程 playbook

如需将参数从流传递到常规流程 playbook，请执行以下操作：

• 流会写入会话参数。
• 为同名的常规流程 playbook 定义读取参数。
• 在说明和示例中包含参数用法。

任务 playbook 到 flow

如需将参数从任务 playbook 传递到流，请执行以下操作：

• 在流设置中，定义同名的输入参数。
• 在说明和示例中包含参数用法。

流程到任务 playbook

如需将参数从流传递到父任务 playbook，请执行以下操作：

• 在流设置中，定义返回参数。
• 在说明和示例中包含参数用法。

如需将参数从一个 flow 传递到子任务 playbook，请执行以下操作：

• 定义与流中的会话参数同名的任务输入参数。
• 在说明和示例中包含参数用法。

常规流程 playbook 到任务 playbook

如需将参数从常规流程 playbook 传递到任务 playbook，请执行以下操作：

• 为同名的任务 playbook 定义输入参数。
• 在说明和示例中包含参数用法。

涉及工具的示例

假设有一个专为活动门票销售而设计的智能体，它具有以下任务 playbook：

1. 一个名为 Ticket ordering 的 playbook，它使用名为 Ticket sales API 的工具下单。
   1. 此 playbook 接受类型为 number 且名称为 event_id 的输入参数。
   2. Ticket sales API 工具需要一个包含 event_id 的请求。
2. 名为 Event selection 的 playbook，可帮助用户选择活动，然后将用户转到 Ticket ordering 并使用参数 event_id 购买门票。

在此示例中，为了确保 event_id 能够可靠地从 Event selection 传递到 Ticket ordering，再从 Ticket ordering 传递到 Ticket sales API，需要提供多个示例。

Ticket ordering playbook 应包含多个示例，这些示例应：

• 在每个示例中，为输入参数 event_id 指定一些不同的实际值。
• 添加一个工具使用操作，其请求正文包含与输入参数中指定的相同的真实 event_id 值。

Event selection playbook 应包含多个示例，这些示例应：

• 添加用户话语，其中用户选择具有一些真实 event_id 的事件，每个示例中的事件都不同。
• 添加 Ticket ordering 的 playbook 调用，该调用会将 event_id 参数设置为与用户选择决定的相同真实 event_id。

除了添加示例之外，还可以尝试在指令、目标或工具详情中添加具体指令，说明应如何使用参数。例如，playbook Ticket ordering 包含以下指令：

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

有了上述示例和说明，Event selection playbook 就能根据用户的选择正确确定 event_id，并将其作为名为 event_id 的输入参数传递给 Ticket ordering playbook。然后，Ticket ordering 在向 Ticket sales API 发出的请求的正文中传递相同的 event_id。Playbook 依赖于具有不同参数值的示例，以帮助其推断应如何使用参数。