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

Update docs rasa x #11156

Merged
merged 5 commits into from
May 31, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,6 @@ body:
attributes:
label: Rasa SDK version
description: What's the rasa SDK version you used (if relevant)
- type: input
id: version-rasa-x
attributes:
label: Rasa X version
description: What's the Rasa X version you used (if relevant)
- type: dropdown
id: version-python
attributes:
Expand Down
1 change: 1 addition & 0 deletions changelog/11156.misc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
`rasa --version` does not print "Rasa X Version" anymore.
4 changes: 2 additions & 2 deletions docs/docs/chitchat-faqs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ with the answer being independent of anything the user has said previously.
<ChatBotText>My name is Sara!</ChatBotText>
<ChatUserText>Which languages can I build assistants in?</ChatUserText>
<ChatBotText>You can use Rasa to build assistants in any language you want!</ChatBotText>
<ChatUserText>What’s Rasa X?</ChatUserText>
<ChatBotText>Rasa X is a tool to learn from real conversations and improve your assistant.</ChatBotText>
<ChatUserText>What’s Rasa Enterprise?</ChatUserText>
<ChatBotText>Rasa Enterprise is a tool to learn from real conversations and improve your assistant.</ChatBotText>
</Chat>


Expand Down
37 changes: 5 additions & 32 deletions docs/docs/command-line-interface.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ abstract: The command line interface (CLI) gives you easy-to-remember commands f
|`rasa data validate` |Checks the domain, NLU and conversation data for inconsistencies. |
|`rasa export` |Exports conversations from a tracker store to an event broker. |
|`rasa evaluate markers` |Extracts markers from an existing tracker store. |
|`rasa x` |Launches Rasa X in local mode. |
|`rasa -h` |Shows all available commands. |

## Log Level
Expand Down Expand Up @@ -164,11 +163,7 @@ from scratch.

## rasa interactive

You can [use Rasa X in local mode](https://rasa.com/docs/rasa-enterprise) to do interactive learning in a UI,
check out the [docs](https://rasa.com/docs/rasa-enterprise/user-guide/test-assistant#talk-to-your-bot)
for more details.

If you'd rather use the command line, you can start an interactive learning session by running:
You can start an interactive learning session by running:

```bash
rasa interactive
Expand Down Expand Up @@ -209,11 +204,7 @@ The following arguments can be used to configure the interactive learning sessio

## rasa shell

You can [use Rasa X in local mode](https://rasa.com/docs/rasa-enterprise) to talk to your assistant in a UI.
Check out the [Rasa X docs](https://rasa.com/docs/rasa-enterprise/user-guide/test-assistant#talk-to-your-bot)
for more details.

If you'd rather use the command line, you can start a chat session by running:
You can start a chat session by running:

```bash
rasa shell
Expand Down Expand Up @@ -487,9 +478,9 @@ should be published:
```text [rasa export --help]
```

:::tip Import conversations into Rasa X
This command is most commonly used to import old conversations into Rasa X to annotate
them. Read more about [importing conversations into Rasa X](https://rasa.com/docs/rasa-enterprise/installation-and-setup/deploy#1-import-existing-conversations-from-rasa-open-source).
:::tip Import conversations into Rasa Enterprise
This command is most commonly used to import old conversations into Rasa Enterprise to annotate
them. Read more about [importing conversations into Rasa Enterprise](https://rasa.com/docs/rasa-enterprise/installation-and-setup/deploy#1-import-existing-conversations-from-rasa-open-source).
:::

## rasa evaluate markers
Expand Down Expand Up @@ -539,21 +530,3 @@ Python Logging Options:
-vv, --debug Print lots of debugging statements. Sets logging level to DEBUG. (default: None)
--quiet Be quiet! Sets logging level to WARNING. (default: None)
```

## rasa x

Rasa X is a tool for practicing Conversation-Driven Development.
You can find more information about it <a className="reference external" href="https://rasa.com/docs/rasa-enterprise/" target="_blank">here</a>.You can start Rasa X in local mode by executing

```bash
rasa x
```

To be able to start Rasa X you need to have Rasa X local mode [installed](https://rasa.com/docs/rasa-enterprise/installation-and-setup/install/local-mode)
and you need to be in a Rasa project directory.


The following arguments are available for `rasa x`:

```text [rasa x --help]
```
6 changes: 3 additions & 3 deletions docs/docs/connectors/cisco-webex-teams.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Please follow this link below to find the room ID
In the OAuth & Permissions section, add the URL of the Rasa Open Source endpoint
that Webex should forward the messages to. The endpoint for receiving Cisco Webex Teams messages
is `http://<host>:<port>/webhooks/webexteams/webhook`, replacing
the host and port with the appropriate values from your running Rasa X or Rasa Open Source server.
the host and port with the appropriate values from your running Rasa Open Source server.

## Running on Cisco Webex Teams

Expand All @@ -42,12 +42,12 @@ webexteams:
```


Restart your Rasa X or Rasa Open Source server
Restart your Rasa Open Source server
to make the new channel endpoint available for Cisco Webex Teams to send messages to.

:::note
If you do not set the `room` keyword
argument, messages will by delivered back to
the user who sent them.

:::
:::
2 changes: 1 addition & 1 deletion docs/docs/connectors/custom-connectors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ responses:

The webhook you give to the custom channel to call would be
`http://<host>:<port>/webhooks/myio/webhook`, replacing
the host and port with the appropriate values from your running Rasa X or Rasa Open Source server.
the host and port with the appropriate values from your running Rasa Open Source server.


## The `blueprint` method
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/connectors/facebook-messenger.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ You need to set up a Facebook app and a page.
6. Set up a **Webhook** and select at least the **messaging** and
**messaging_postback** subscriptions. Insert your callback URL, which will
look like `https://<host>:<port>/webhooks/facebook/webhook`, replacing
the host and port with the appropriate values from your running Rasa X or Rasa Open Source server.
the host and port with the appropriate values from your running Rasa Open Source server.

Insert the **Verify Token** which has to match the `verify`
entry in your `credentials.yml`.
Expand All @@ -65,7 +65,7 @@ facebook:
```


Restart your Rasa X or Rasa Open Source server
Restart your Rasa Open Source server
to make the new channel endpoint available for Facebook Messenger to send messages to.


Expand Down
4 changes: 2 additions & 2 deletions docs/docs/connectors/hangouts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ more information, see the Cards section).
In order to connect your Rasa bot to Google Hangouts Chat, you first need to create a project in
Google Developer Console that includes the Hangouts API. There you can specify your bot's endpoint.
This endpoint should look like look like `https://<host>:<port>/webhooks/hangouts/webhook`, replacing
the host and port with the appropriate values from your running Rasa X or Rasa Open Source server.
the host and port with the appropriate values from your running Rasa Open Source server.

:::note configure https
Hangouts Chat only forwards
Expand Down Expand Up @@ -47,7 +47,7 @@ hangouts:
```


Restart your Rasa X or Rasa Open Source server
Restart your Rasa Open Source server
to make the new channel endpoint available for Google Hangouts to send messages to.

### Cards and Interactive Cards
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/connectors/mattermost.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For information on converting existing user account into bot account please see

6. Add the Callback URL, which will
look like `http://<host>:<port>/webhooks/mattermost/webhook`, replacing
the host and port with the appropriate values from your running Rasa X or Rasa Open Source server.
the host and port with the appropriate values from your running Rasa Open Source server.

For more detailed steps, visit the
[Mattermost docs](https://docs.mattermost.com/guides/developer.html).
Expand All @@ -55,5 +55,5 @@ mattermost:
```


Restart your Rasa X or Rasa Open Source server
Restart your Rasa Open Source server
to make the new channel endpoint available for Mattermost to send messages to.
4 changes: 2 additions & 2 deletions docs/docs/connectors/microsoft-bot-framework.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Once you have them you can add these to your `credentials.yml`.

The endpoint URL that Microsoft Bot Framework should send messages to will
look like `http://<host>:<port>/webhooks/botframework/webhook`, replacing
the host and port with the appropriate values from your running Rasa X or Rasa Open Source server.
the host and port with the appropriate values from your running Rasa Open Source server.


## Running on Microsoft Bot Framework
Expand All @@ -24,5 +24,5 @@ botframework:
```


Restart your Rasa X or Rasa Open Source server
Restart your Rasa Open Source server
to make the new channel endpoint available for Microsoft Bot Framework to send messages to.
4 changes: 2 additions & 2 deletions docs/docs/connectors/rocketchat.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ description: Build a Rasa Chat Bot on Rocketchat

6. In the **URLs** section, set the URL to
`http://<host>:<port>/webhooks/rocketchat/webhook`, replacing
the host and port with the appropriate values from your running Rasa X or Rasa Open Source server.
the host and port with the appropriate values from your running Rasa Open Source server.

For more information on the Rocket.Chat Webhooks, see the
[Rocket.Chat Guide](https://docs.rocket.chat/guides/administrator-guides/integrations).
Expand All @@ -44,5 +44,5 @@ rocketchat:
```


Restart your Rasa X or Rasa Open Source server
Restart your Rasa Open Source server
to make the new channel endpoint available for RocketChat to send messages to.
2 changes: 1 addition & 1 deletion docs/docs/connectors/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -182,5 +182,5 @@ slack:
conversation_granularity: "sender" # sender allows 1 conversation per user (across channels), channel allows 1 conversation per user per channel, thread allows 1 conversation per user per thread. This configuration is optional and set to sender by default.
```

Make sure to restart your Rasa X or Rasa Open Source server after changing the
Make sure to restart your Rasa Open Source server after changing the
`credentials.yml` for the changes to take effect.
4 changes: 2 additions & 2 deletions docs/docs/connectors/telegram.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You need to set up a Telegram bot.
1. To create the bot, go to [Bot Father](https://web.telegram.org/#/im?p=@BotFather),
enter `/newbot` and follow the instructions. The URL that Telegram should send messages to will look like
`http://<host>:<port>/webhooks/telegram/webhook`, replacing
the host and port with the appropriate values from your running Rasa X or Rasa Open Source server.
the host and port with the appropriate values from your running Rasa Open Source server.

2. At the end you should get your `access_token` and the username you
set will be your `verify`.
Expand All @@ -39,7 +39,7 @@ telegram:
```


Restart your Rasa X or Rasa Open Source server
Restart your Rasa Open Source server
to make the new channel endpoint available for Telegram to send messages to.


Expand Down
4 changes: 2 additions & 2 deletions docs/docs/connectors/twilio.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You need to set up a Twilio account.
[Phone Numbers](https://www.twilio.com/console/phone-numbers/incoming) in the Twilio
dashboard and selecting your phone number. Find the `Messaging` section and add
your webhook URL (e.g. `https://<host>:<port>/webhooks/twilio/webhook`,
replacing the host and port with the appropriate values from your running Rasa X or Rasa Open Source server)
replacing the host and port with the appropriate values from your running Rasa Open Source server)
to the `A MESSAGE COMES IN` setting.

For more information, see the [Twilio REST API](https://www.twilio.com/docs/iam/api).
Expand All @@ -57,5 +57,5 @@ twilio:
twilio_number: "+440123456789" # if using WhatsApp: "whatsapp:+440123456789"
```

Restart your Rasa X or Rasa Open Source server
Restart your Rasa Open Source server
to make the new channel endpoint available for Twilio to send messages to.
16 changes: 6 additions & 10 deletions docs/docs/connectors/your-own-website.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ title: Your Own Website
description: Deploy and Run a Rasa Chat Bot on a Website
---

If you just want an easy way for users to test your bot, the best option
is usually the chat interface that ships with Rasa X, where you can [invite users
to test your bot](https://rasa.com/docs/rasa-enterprise/user-guide/share-assistant/#share-your-bot).

If you already have an existing website and want to add a Rasa assistant to it,
you can use the [Rasa Chat Widget](#chat-widget) a widget which you can incorporate into your existing webpage by adding a HTML snippet.

Expand All @@ -33,10 +29,10 @@ rest:
# require any credentials
```

Restart your Rasa X or Rasa Open Source server
Restart your Rasa Open Source server
to make the REST channel available to receive messages. You can then send messages to
`http://<host>:<port>/webhooks/rest/webhook`, replacing
the host and port with the appropriate values from your running Rasa X or Rasa Open Source server.
the host and port with the appropriate values from your running Rasa Open Source server.

#### Request and Response Format

Expand Down Expand Up @@ -73,10 +69,10 @@ callback:
url: "http://localhost:5034/bot"
```

Restart your Rasa X or Rasa Open Source server
Restart your Rasa Open Source server
to make the new channel endpoint available to receive messages.
You can then send messages to `http://<host>:<port>/webhooks/callback/webhook`, replacing
the host and port with the appropriate values from your running Rasa X or Rasa Open Source server.
the host and port with the appropriate values from your running Rasa Open Source server.

#### Request and Response Format

Expand Down Expand Up @@ -116,10 +112,10 @@ socketio:
The first two configuration values define the event names used by Rasa Open Source
when sending or receiving messages over socket.io.

Restart your Rasa X or Rasa Open Source server
Restart your Rasa Open Source server
to make the new channel endpoint available to receive messages.
You can then send messages to `http://<host>:<port>/socket.io`, replacing
the host and port with the appropriate values from your running Rasa X or Rasa Open Source server.
the host and port with the appropriate values from your running Rasa Open Source server.

:::note session persistence
By default, the SocketIO channel uses the socket id as `sender_id`, which causes
Expand Down
14 changes: 7 additions & 7 deletions docs/docs/contextual-conversations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ always have a higher [policy priority](./policies.mdx#policy-priority) and will

The [TEDPolicy](https://blog.rasa.com/unpacking-the-ted-policy-in-rasa-open-source/) is made to handle
unexpected user behaviors. For example,
in the conversation below (extracted from a conversation on [Rasa X](https://rasa.com/docs/rasa-enterprise/user-guide/review-conversations/)):
in the conversation below (extracted from a conversation on [Rasa Enterprise](https://rasa.com/docs/rasa-enterprise/user-guide/review-conversations/)):

```yaml-rasa
stories:
Expand All @@ -119,10 +119,10 @@ stories:
- action: action_chitchat
- intent: how_to_get_started
entities:
- product: x
- product: enterprise
- slot_was_set:
- product: x
- action: utter_explain_x
- product: enterprise
- action: utter_explain_enterprise
- action: utter_also_explain_nlucore
- intent: affirm
- action: utter_explain_nlu
Expand All @@ -131,13 +131,13 @@ stories:
```

Here we can see the user has completed a few chitchat tasks first, and then ultimately
asks how they can get started with Rasa X. The TEDPolicy correctly predicts that
Rasa X should be explained to the user, and then also takes them down the getting started
asks how they can get started with Rasa Enterprise. The TEDPolicy correctly predicts that
Rasa Enterprise should be explained to the user, and then also takes them down the getting started
path, without asking all the qualifying questions first.

Since the machine-learning policy has generalized to this situation, you should add this story
to your training data to continuously improve your bot and help the model generalize
better in future. [Rasa X](https://rasa.com/docs/rasa-enterprise/) is a tool that can help
better in future. [Rasa Enterprise](https://rasa.com/docs/rasa-enterprise/) is a tool that can help
you improve your bot and make it more contextual.


Expand Down
7 changes: 2 additions & 5 deletions docs/docs/conversation-driven-development.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ CDD is not a linear process; you'll circle back to the same actions over and ove

Read more about these actions and the concept of CDD on the [Rasa Blog](https://blog.rasa.com/conversation-driven-development-a-better-approach-to-building-ai-assistants/).

You can also check out [Rasa X](https://rasa.com/docs/rasa-enterprise/), a purpose-built tool for CDD.
You can also check out [Rasa Enterprise](https://rasa.com/docs/rasa-enterprise/), a purpose-built tool for CDD.

## CDD in early stages of development

Expand All @@ -42,13 +42,10 @@ If you're at the earliest stage of bot development, it might seem like CDD has n
CDD leads to frequent, smaller updates to your bot as you gather insights from bot conversations. [Setting up a CI/CD pipeline](setting-up-ci-cd.mdx) early on in development will enable you to act quickly on what you see in conversations.


At this stage, you can [install Rasa X in local mode](https://rasa.com/docs/rasa-enterprise/installation-and-setup/installation-guide/#local-mode) to make it easier to share your bot with test users, collect conversations, and apply NLU and Story best practices based on the conversations you collect.


## CDD with a bot in production

Once your bot is in production, you'll have more conversations to gain insights from. Then you can fully apply CDD actions.
At this stage, you can [install Rasa X on a server](https://rasa.com/docs/rasa-enterprise/installation-and-setup/installation-guide/#helm-chart)
At this stage, you can [install Rasa Enterprise on a server](https://rasa.com/docs/rasa-enterprise/installation-and-setup/installation-guide/#helm-chart)
to both deploy your bot and enable CDD with a bot in production.

### Review
Expand Down
18 changes: 0 additions & 18 deletions docs/docs/deploy/deploy-rasa-x.mdx

This file was deleted.

1 change: 0 additions & 1 deletion docs/docs/deploy/deploy-rasa.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -285,4 +285,3 @@ Visit [the Rasa helm chart README](https://github.com/RasaHQ/helm-charts/tree/ma
## Next Steps

- Visit [the Rasa helm chart repository](https://github.com/RasaHQ/helm-charts/tree/main/charts/rasa) where you can find examples of configuration
- Visit [the Rasa X docs](https://rasa.com/docs/rasa-enterprise/) and learn how to [integrate your Rasa Open Source deployment with Rasa X](https://rasa.com/docs/rasa-enterprise/installation-and-setup/deploy#2-connect-rasa-open-source-deployment-the-rasa-helm-chart).
Loading