Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENG-540: split content of testing-your-assistant.mdx docs #12833

Merged
merged 12 commits into from
Sep 22, 2023
6 changes: 3 additions & 3 deletions CHANGELOG.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2788,9 +2788,9 @@ Upgrade dependent libraries with security vulnerabilities (Pillow, TensorFlow, u

- [#6285](https://github.com/rasahq/rasa/issues/6285): Predictions of the [`FallbackClassifier`](./building-classic-assistants/components.mdx#fallbackclassifier) are
ignored when
[evaluating the NLU model](./production/testing-your-assistant.mdx#evaluating-an-nlu-model)
[evaluating the NLU model](./building-classic-assistants/testing-your-assistant.mdx#evaluating-an-nlu-model)
Note that the `FallbackClassifier` predictions still apply to
[test stories](./production/testing-your-assistant.mdx#writing-test-stories).
[test stories](./building-classic-assistants/testing-your-assistant.mdx#writing-test-stories).
- [#6474](https://github.com/rasahq/rasa/issues/6474): Adapt the training data reader and emulator for wit.ai to their latest format.
- [#6498](https://github.com/rasahq/rasa/issues/6498): Adding configurable prefixes to Redis [Tracker](./production/tracker-stores.mdx) and [Lock Stores](./production/lock-stores.mdx) so that a single Redis instance (and logical DB) can support multiple conversation trackers and locks.
By default, conversations will be prefixed with `tracker:...` and all locks prefixed with `lock:...`. Additionally, you can add an alphanumeric-only `prefix: value` in `endpoints.yml` such that keys in redis will take the form `value:tracker:...` and `value:lock:...` respectively.
Expand Down Expand Up @@ -4164,7 +4164,7 @@ This can help to fix problems when using `rasa shell` with custom actions which

### Improved Documentation

- [#2237](https://github.com/rasahq/rasa/issues/2237): Restructure the “Evaluating models” documentation page and rename this page to [Testing Your Assistant](./production/testing-your-assistant.mdx).
- [#2237](https://github.com/rasahq/rasa/issues/2237): Restructure the “Evaluating models” documentation page and rename this page to [Testing Your Assistant](./building-classic-assistants/testing-your-assistant.mdx).

- [#5302](https://github.com/rasahq/rasa/issues/5302): Improved documentation on how to build and deploy an action server image for use on other servers such as Rasa X deployments.

Expand Down
4 changes: 4 additions & 0 deletions docs/docs/building-classic-assistants/business-logic.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: Handling Business Logic
abstract: Conversational assistants often need to ask users for information in order to help them. You can use Forms to collect the required user information and fulfill a request.
---

import RasaNLUBasedBanner from "@theme/RasaNLUBasedBanner";

<RasaNLUBasedBanner />

Conversational assistants often support user goals that involve collecting required information
from the user before doing something for them. For example, a restaurant search bot would need to gather a few pieces of information
about the user's preferences to find them a suitable restaurant:
Expand Down
4 changes: 4 additions & 0 deletions docs/docs/building-classic-assistants/chitchat-faqs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: Chitchat and FAQs
abstract: FAQ assistants are the simplest assistants to build and typically the first kind of assistant anyone builds. This page is a guide to the concepts and training data you need to handle non-contextual questions like FAQs and chitchat.
---

import RasaNLUBasedBanner from "@theme/RasaNLUBasedBanner";

<RasaNLUBasedBanner />

[FAQs](./glossary.mdx#faqs) and [chitchat](./glossary.mdx#chitchat) are two cases where the conversational assistant responds with a fixed set of messages, and the assistant should always answer the same way,
no matter what has happened previously in the conversation.
For example, in the following conversation, every question can be asked at any point in the conversation,
Expand Down
4 changes: 4 additions & 0 deletions docs/docs/building-classic-assistants/components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ abstract:
pre-processing, and more.
---

import RasaNLUBasedBanner from "@theme/RasaNLUBasedBanner";

<RasaNLUBasedBanner />

## Language Models

The following components load pre-trained models that are needed if you want to use pre-trained
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: Contextual Conversations
abstract: Taking context into account is often key to providing a good user experience. This page is a guide to creating contextual conversation patterns.
---

import RasaNLUBasedBanner from "@theme/RasaNLUBasedBanner";

<RasaNLUBasedBanner />

In a contextual conversation, something beyond the previous step in the conversation
plays a role in what should happen next. For example, if a user asks "How many?",
it's not clear from the message alone what the user is asking about. In the context of the assistant saying,
Expand Down
4 changes: 4 additions & 0 deletions docs/docs/building-classic-assistants/domain.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: Domain
abstract: The domain defines the universe in which your assistant operates. It specifies the intents, entities, slots, responses, forms, and actions your bot should know about. It also defines a configuration for conversation sessions.
---

import RasaNLUBasedBanner from "@theme/RasaNLUBasedBanner";

<RasaNLUBasedBanner />

Here is a full example of a domain, taken from the
[concertbot](https://github.com/RasaHQ/rasa/tree/main/examples/concertbot) example:

Expand Down
3 changes: 3 additions & 0 deletions docs/docs/building-classic-assistants/fallback-handoff.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ abstract: This is a guide on how to handle various failures of your assistant.
---

import useBaseUrl from "@docusaurus/useBaseUrl";
import RasaNLUBasedBanner from "@theme/RasaNLUBasedBanner";

<RasaNLUBasedBanner />

Even if you design your bot perfectly, users will inevitably say things to your
assistant that you did not anticipate. In these cases, your assistant will fail,
Expand Down
4 changes: 4 additions & 0 deletions docs/docs/building-classic-assistants/forms.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ description: Follow a rule-based process of information gathering using forms in
abstract: One of the most common conversation patterns is to collect a few pieces of information from a user in order to do something (book a restaurant, call an API, search a database, etc.). This is also called **slot filling**.
---

import RasaNLUBasedBanner from "@theme/RasaNLUBasedBanner";

<RasaNLUBasedBanner />

## Usage

To use forms with Rasa you need to make sure that the
Expand Down
6 changes: 5 additions & 1 deletion docs/docs/building-classic-assistants/glossary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: Rasa Glossary
description: Glossary for all Rasa-related terms
---

import RasaNLUBasedBanner from "@theme/RasaNLUBasedBanner";

<RasaNLUBasedBanner />

## [Action](../concepts/custom-actions.mdx)

A single step that a bot takes in a conversation (e.g. calling an API or sending a response back to the user).
Expand Down Expand Up @@ -40,7 +44,7 @@ A way to store bot responses externally instead of including them directly in th

The process of using user messages and conversation data to influence the design of an assistant and train the model, combined with engineering best practices. There are 6 steps that make up CDD: Share, Review, Annotate, Fix, Track, and Test.

## [Conversation Tests](../production/testing-your-assistant.mdx)
## [Conversation Tests](./testing-your-assistant.mdx)

Modified story format that includes the full text of the user message in addition to the intent label. Test conversations are saved to a test set file (conversation_tests.md), which is used to evaluate the model’s predictions across an entire conversation.

Expand Down
4 changes: 4 additions & 0 deletions docs/docs/building-classic-assistants/language-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: Language Support
abstract: You can use Rasa to build assistants in any language you want.
---

import RasaNLUBasedBanner from "@theme/RasaNLUBasedBanner";

<RasaNLUBasedBanner />

Your Rasa assistant can be used on training data in **any language**.
If there are no word embeddings for your language, you can train your featurizers
from scratch with the data you provide.
Expand Down
4 changes: 4 additions & 0 deletions docs/docs/building-classic-assistants/model-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ description: Learn about model configuration for Rasa.
abstract: The configuration file defines the components and policies that your model will use to make predictions based on user input.
---

import RasaNLUBasedBanner from "@theme/RasaNLUBasedBanner";

<RasaNLUBasedBanner />

The recipe key allows for different types of config and model architecture.
Currently, "default.v1" and the experimental "graph.v1" recipes are supported.

Expand Down
4 changes: 4 additions & 0 deletions docs/docs/building-classic-assistants/nlu-only.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: Using NLU Only
abstract: Find out how to use only Rasa NLU as a standalone NLU service for your chatbot or virtual assistant.
---

import RasaNLUBasedBanner from "@theme/RasaNLUBasedBanner";

<RasaNLUBasedBanner />

If you want to use Rasa only as an NLU component, you can!

## Training NLU-only models
Expand Down
4 changes: 4 additions & 0 deletions docs/docs/building-classic-assistants/nlu-training-data.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ description: Read more about how to format training data with Rasa NLU for open
abstract: NLU training data stores structured information about user messages.
---

import RasaNLUBasedBanner from "@theme/RasaNLUBasedBanner";

<RasaNLUBasedBanner />

The goal of NLU (Natural Language Understanding) is to extract structured information from user messages. This usually includes the user's [intent](./glossary.mdx#intent) and any
[entities](./glossary.mdx#entity) their message contains. You can
add extra information such as [regular expressions](#regular-expressions) and [lookup tables](#lookup-tables) to your
Expand Down
4 changes: 4 additions & 0 deletions docs/docs/building-classic-assistants/policies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: Policies
abstract: NLU-based Rasa assistants use a variety of policies to decide which action to take at each step in a conversation. There are machine-learning and rule-based policies that your assistant can use in tandem.
---

import RasaNLUBasedBanner from "@theme/RasaNLUBasedBanner";

<RasaNLUBasedBanner />

When building an NLU-based assistant in Rasa, there are a number of dialogue policies available to you.
You can customize the policies your assistant uses by specifying the `policies`
key in your project's `config.yml`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ title: Reaching Out to the User
abstract: Sometimes you want your assistant to reach out to the user without the user's prompting. For example, you might want the assistant to send a message when the user opens the chat window, or you might want to prompt the user if they haven't sent a message for a while. This page is a guide to enabling your assistant to reach out to the user proactively.
---

import RasaNLUBasedBanner from "@theme/RasaNLUBasedBanner";

<RasaNLUBasedBanner />

## Reaching out first

In most use cases, when the user opens the chat window with your assistant, you will want the
Expand Down
4 changes: 4 additions & 0 deletions docs/docs/building-classic-assistants/rules.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ abstract:
Rules describe short pieces of conversations that should always follow the same path.
---

import RasaNLUBasedBanner from "@theme/RasaNLUBasedBanner";

<RasaNLUBasedBanner />

**Don't overuse rules**. Rules are great to handle small specific conversation patterns, but
unlike [stories](./stories.mdx), rules don't have the power to generalize to unseen conversation
paths. Combine rules and stories to make your assistant robust and able to handle
Expand Down
6 changes: 5 additions & 1 deletion docs/docs/building-classic-assistants/stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ abstract:
model. Stories can be used to train models that are able to generalize to unseen conversation paths.
---

import RasaNLUBasedBanner from "@theme/RasaNLUBasedBanner";

<RasaNLUBasedBanner />

## Format

A story is a representation of a conversation between a user and an AI assistant,
Expand Down Expand Up @@ -200,7 +204,7 @@ Overusing OR statements will slow down training.
## Test Conversation Format

The test conversation format is a format that combines both NLU data and stories
into a single file for evaluation. Read more about this format in [Testing Your Assistant](../production/testing-your-assistant.mdx).
into a single file for evaluation. Read more about this format in [Testing Your Assistant](./testing-your-assistant.mdx).

:::caution testing only
This format is only used for testing and cannot be used for training.
Expand Down
Loading