From 8f1099f57c02b90d27f3f408932517d385323f99 Mon Sep 17 00:00:00 2001 From: Tom Bocklisch Date: Mon, 19 Jun 2023 22:11:36 +0200 Subject: [PATCH] docs improvements --- docs/docs/llms/flow-policy.mdx | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/docs/docs/llms/flow-policy.mdx b/docs/docs/llms/flow-policy.mdx index 83ac5b6eb5c1..8beac7dbfbde 100644 --- a/docs/docs/llms/flow-policy.mdx +++ b/docs/docs/llms/flow-policy.mdx @@ -41,12 +41,12 @@ involves two steps: 1. Configure the `FlowPolicy` in your `config.yml` file: -```yaml-rasa title="config.yml" -policies: -# - ... - - name: rasa.core.policies.flow_policy.FlowPolicy -# - ... -``` + ```yaml-rasa title="config.yml" + policies: + # - ... + - name: rasa.core.policies.flow_policy.FlowPolicy + # - ... + ``` 2. Add flows to your bot as per the [flows specification](../flows.mdx). This step involves defining the states and transitions that your bot should @@ -87,25 +87,26 @@ flows: # - ... ``` +The flow can be started with the intent `transfer_money`. The first step in the +flow is `ask_recipient`. A correction by the user, _"oh sorry I meant John"_, +initiates a correction flow. This correction is not explicitly modeled in +the `transfer_money` flow; it's handled by a conversational pattern: + -A correction by the user, _"oh sorry I meant John"_, initiates a correction -flow. This correction is not explicitly modeled in the `transfer_money` flow; -it's handled by a conversational pattern. + The correction flow only executes when the user wants to correct a previous input. Once triggered, it's placed on top of the flow stack for execution. For the `transfer_money` flow, the correction flow is an interruption. Once -completed, the `transfer_money` flow resumes. Before its res - -umption, a `resume_flow` flow is activated. You can customize what happens in -`resume_flow` and `correction` flows in -[Handling Unhappy Paths](./unhappy-paths.mdx). +completed, the `transfer_money` flow resumes. Before its res umption, a +`resume_flow` flow is activated. You can customize what happens in `resume_flow` +and `correction` flows in [Handling Unhappy Paths](./unhappy-paths.mdx). Upon completion of the `resume_flow` flow, the `transfer_money` flow resumes, and the bot returns to the state before the correction flow started. The