diff --git a/docs/docs/concepts/dialogue-understanding.mdx b/docs/docs/concepts/dialogue-understanding.mdx index cb6e3b7957db..abe169853706 100644 --- a/docs/docs/concepts/dialogue-understanding.mdx +++ b/docs/docs/concepts/dialogue-understanding.mdx @@ -7,6 +7,10 @@ abstract: | to progress the conversation. --- +import RasaProLabel from "@theme/RasaProLabel"; + +import RasaProBanner from "@theme/RasaProBanner"; + :::info New in 3.7 The _Command Generator_ is part of Rasa's new @@ -20,10 +24,11 @@ The `CommandGenerator` component performs _Dialogue Understanding_. In the CALM approach, _Dialogue Understanding_ aims to represent how the end user wants to progress the conversation. There is currently only one command generator available: the `LLMCommandGenerator`. +You can find all generated commands in the [command reference](#command-reference) below. -## Using the LLMCommandGenerator in Your Bot +## Using the LLMCommandGenerator -To use this component in your bot, you need to add the +To use this component in your assistant, you need to add the `LLMCommandGenerator` to your NLU pipeline in the `config.yml` file. ```yaml-rasa title="config.yml" @@ -154,3 +159,58 @@ pipeline: # highlight-next-line prompt: prompts/command-generator.jinja2 ``` + +## Command reference + +Like its name indicates, the `CommandGenerator` generates "commands" that are then internally processed to +trigger operations on the current conversation. Here is a reference of all supported commands: + +### Start Flow + +This command indicates the assistant should start a new [flow](./flows.mdx). + +### Cancel Flow + +This command indicates the assistant should cancel the current [flow](./flows.mdx). +It powers [Conversation Repair's Cancellation use case](./conversation-repair.mdx#3-cancellations). + +### Set Slot + +This command indicates the assistant should set a [slot](./domain.mdx#slots) to a given value. + +### Correct Slots + +This command indicates the assistant should change the value of a given [slot](./domain.mdx#slots) +to a new value. It powers [Conversation Repair's Correction use case](./conversation-repair.mdx#2-corrections). + +### Clarify + +This command indicates the assistant should ask for clarification. It powers +[Conversation Repair's Clarification use case](./conversation-repair.mdx#6-clarification). + +### Chit-Chat Answer + + + + + +This command indicates the assistant should reply a chitchat style free-form answer. +It powers [Conversation Repair's Chitchat use case](./conversation-repair.mdx#4-chitchat). + +### Knowledge Answer + + + + + +This command indicates the assistant should reply a knowledge-based free-form answer. It works +hand in hand with the [DocSearch policy](./policies.mdx#docsearch-policy). + +### Human Handoff + +This command indicates the assistant should hand off the conversation to a human. + +### Error + +This command indicates the assistant failed to handle the dialogue due to +an [internal error](./conversation-repair.mdx#7-internal-errors).