From 8f58111d3b78055592046b52ad4f7f16403366ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=8Dtalo=20Vin=C3=ADcius?= Date: Tue, 31 Jan 2023 11:04:15 -0300 Subject: [PATCH 1/2] Fix some grammar errors and redundant words Co-authored-by: IanFPFerreira Co-authored-by: guilhermemoraisr --- docs/docs/action-server/actions.mdx | 2 +- docs/docs/action-server/events.mdx | 2 +- docs/docs/action-server/knowledge-base-actions.mdx | 2 +- docs/docs/action-server/sdk-events.mdx | 2 +- docs/docs/connectors/hangouts.mdx | 2 +- docs/docs/custom-graph-components.mdx | 2 +- docs/docs/deploy/deploy-rasa.mdx | 2 +- docs/docs/graph-recipe.mdx | 2 +- docs/docs/model-configuration.mdx | 2 +- docs/docs/monitoring/analytics/example-queries.mdx | 2 +- docs/docs/nlu-only.mdx | 2 +- docs/docs/rules.mdx | 2 +- docs/docs/training-data-format.mdx | 4 ++-- 13 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/docs/action-server/actions.mdx b/docs/docs/action-server/actions.mdx index e352005a7915..1bfad549e711 100644 --- a/docs/docs/action-server/actions.mdx +++ b/docs/docs/action-server/actions.mdx @@ -229,7 +229,7 @@ events, the order won't matter, but with other event types it can. ### `responses` -A response can be of any of the response types described in the +A response can be any of the response types described in the [documentation on rich responses](../responses.mdx#rich-responses). See the response sample of the [API spec](/pages/action-server-api) for the expected formats. diff --git a/docs/docs/action-server/events.mdx b/docs/docs/action-server/events.mdx index 8b337c229a13..fb95580d8941 100644 --- a/docs/docs/action-server/events.mdx +++ b/docs/docs/action-server/events.mdx @@ -87,7 +87,7 @@ Schedules an intent to be triggered at a certain time in the future. **Parameters**: -* `intent`: Intent which the reminder will trigger +* `intent`: Intent which the reminder will trigger * `entities`: Entities to send with the intent * `date_time`: Date at which the execution of the action should be triggered. This should either be in UTC or include a timezone. * `name`: ID of the reminder. If there are multiple reminders with the same id only the last will be run. diff --git a/docs/docs/action-server/knowledge-base-actions.mdx b/docs/docs/action-server/knowledge-base-actions.mdx index 554984a6f4c3..dbc277ba5ec4 100644 --- a/docs/docs/action-server/knowledge-base-actions.mdx +++ b/docs/docs/action-server/knowledge-base-actions.mdx @@ -170,7 +170,7 @@ you need to specify and annotate the following entities in your training example object type listed as a key in the knowledge base. * `mention`: If the user refers to an object via “the first one”, “that one”, or “it”, you should mark those terms - as `mention`. We also use synonyms to map some of the mentions to symbols. You can learn about that + as `mention`. We also use synonyms to map some mentions to symbols. You can learn about that in [resolving mentions](./knowledge-base-actions.mdx#resolve-mentions). * `attribute`: All attribute names defined in your knowledge base should be identified as `attribute` in the diff --git a/docs/docs/action-server/sdk-events.mdx b/docs/docs/action-server/sdk-events.mdx index d49a3dc81b62..2577d925eb3e 100644 --- a/docs/docs/action-server/sdk-events.mdx +++ b/docs/docs/action-server/sdk-events.mdx @@ -88,7 +88,7 @@ rasa_sdk.events.ReminderScheduled( **Parameters**: -* `intent_name`: Intent which the reminder will trigger +* `intent_name`: Intent which the reminder will trigger * `trigger_date_time`: Datetime at which the execution of the action should be triggered. * `entities`: Entities to send with the intent * `name`: ID of the reminder. If there are multiple reminders with the same id only the last will be run. diff --git a/docs/docs/connectors/hangouts.mdx b/docs/docs/connectors/hangouts.mdx index 53a4bf3d55bb..83823775982e 100644 --- a/docs/docs/connectors/hangouts.mdx +++ b/docs/docs/connectors/hangouts.mdx @@ -13,7 +13,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://:/webhooks/hangouts/webhook`, replacing +This endpoint should look like `https://:/webhooks/hangouts/webhook`, replacing the host and port with the appropriate values from your running Rasa server. :::note configure https diff --git a/docs/docs/custom-graph-components.mdx b/docs/docs/custom-graph-components.mdx index 495ce6260932..79a7eedeb001 100644 --- a/docs/docs/custom-graph-components.mdx +++ b/docs/docs/custom-graph-components.mdx @@ -384,7 +384,7 @@ to specify the following details: inference. Rasa will use the graph component's `train` method if `is_trainable=True` is specified. Rasa will use - the graph scomponent's `process` method to extract entities during inference. + the graph component's `process` method to extract entities during inference. * `ComponentType.POLICY_WITHOUT_END_TO_END_SUPPORT`: Component type for [policies](policies.mdx) which don't require additional end-to-end features diff --git a/docs/docs/deploy/deploy-rasa.mdx b/docs/docs/deploy/deploy-rasa.mdx index 8363a42cdea3..590aa9d7399e 100644 --- a/docs/docs/deploy/deploy-rasa.mdx +++ b/docs/docs/deploy/deploy-rasa.mdx @@ -143,7 +143,7 @@ Visit [the Rasa Helm Chart repository](https://github.com/RasaHQ/helm-charts/tre ### 3. Loading an initial model -The first time you install Rasa, you may not have a model server available yet, or you may want an lightweight model for testing the deployment. +The first time you install Rasa, you may not have a model server available yet, or you may want a lightweight model for testing the deployment. For this purpose, you can choose between training or downloading an initial model. By default, the Rasa chart downloads an example model from GitHub. To use this option, you don't have to change anything. diff --git a/docs/docs/graph-recipe.mdx b/docs/docs/graph-recipe.mdx index cc605541886f..8b1c4418d797 100644 --- a/docs/docs/graph-recipe.mdx +++ b/docs/docs/graph-recipe.mdx @@ -107,7 +107,7 @@ avoid slow first prediction). eager: true ``` -- `resource`: If given, graph node is loaded from this resource instead of of instantiated from scratch. This is e.g. used to load a trained component for predictions. +- `resource`: If given, graph node is loaded from this resource instead of instantiated from scratch. This is e.g. used to load a trained component for predictions. ```yaml-rasa resource: diff --git a/docs/docs/model-configuration.mdx b/docs/docs/model-configuration.mdx index 9ff2bd92d9b8..bf8115512927 100644 --- a/docs/docs/model-configuration.mdx +++ b/docs/docs/model-configuration.mdx @@ -12,7 +12,7 @@ Currently, "default.v1" and the experimental "graph.v1" recipes are supported. The language and pipeline keys specify the [components](./components.mdx) used by the model to make NLU predictions. The policies key defines the [policies](./policies.mdx) used by the model to predict the next action. -If you don't know which components or policies to choose, you can use the +If you don't know which components or policies to choose, you can use the [Suggested Config](./model-configuration.mdx#suggested-config) feature, which will recommend sensible defaults. ## Suggested Config diff --git a/docs/docs/monitoring/analytics/example-queries.mdx b/docs/docs/monitoring/analytics/example-queries.mdx index 4b27429fba38..ea5dc249fa05 100644 --- a/docs/docs/monitoring/analytics/example-queries.mdx +++ b/docs/docs/monitoring/analytics/example-queries.mdx @@ -27,7 +27,7 @@ Metabase queries because we used filters in Metabase to remove the noise and mak the graphs look nice. Please make sure that these SQL queries are kept in sync with the dashboard, it'll -make your colleagues' work next time easier :) +make your colleagues' work next time easier :). --> diff --git a/docs/docs/nlu-only.mdx b/docs/docs/nlu-only.mdx index 7f18aecc30d2..a42b1aa6f5dd 100644 --- a/docs/docs/nlu-only.mdx +++ b/docs/docs/nlu-only.mdx @@ -31,7 +31,7 @@ rasa shell nlu This will start the rasa shell and ask you to type in a message to test. You can keep typing in as many messages as you like. -Alternatively, you can leave out the ``nlu`` argument and pass in an nlu-only model directly: +Alternatively, you can leave out the ``nlu`` argument and pass in a nlu-only model directly: ```bash rasa shell -m models/nlu-20190515-144445.tar.gz diff --git a/docs/docs/rules.mdx b/docs/docs/rules.mdx index 4032658ad6f5..b20e5b7e98b0 100644 --- a/docs/docs/rules.mdx +++ b/docs/docs/rules.mdx @@ -45,7 +45,7 @@ rules: ``` This example rule applies at the start of conversation as well as when the user decides -to a send a message with an intent `greet` in the middle of an ongoing conversation. +to send a message with an intent `greet` in the middle of an ongoing conversation. Dialogue turns that only appear as rules in the training data and do not appear in stories will be ignored by ML-only policies like `TEDPolicy` at prediction time. diff --git a/docs/docs/training-data-format.mdx b/docs/docs/training-data-format.mdx index 91e8809f8c92..4eb628bd546f 100644 --- a/docs/docs/training-data-format.mdx +++ b/docs/docs/training-data-format.mdx @@ -312,7 +312,7 @@ nlu: - \d{10,12} ``` -Here `account_number` is the name of the regular expression. When used as as features for the `RegexFeaturizer` the name of the regular expression does not matter. When using the `RegexEntityExtractor`, the name of the regular expression should match the name of the entity you want to extract. +Here `account_number` is the name of the regular expression. When used as features for the `RegexFeaturizer` the name of the regular expression does not matter. When using the `RegexEntityExtractor`, the name of the regular expression should match the name of the entity you want to extract. Read more about when and how to use regular expressions with each component on the [NLU Training Data page](./nlu-training-data.mdx#regular-expressions). @@ -491,7 +491,7 @@ stories: The `action` step activates the form and begins looping over the required slots. The `active_loop: restaurant_form` step indicates that there is a currently active form. Much like a `slot_was_set` step, a `form` step doesn't **set** a form to active but indicates that it should already be activated. -In the same way, the `active_loop: null` step indicates that no form should be active before the subsequent +In the same way, the `active_loop: null` step indicates that no form should be active before the subsequent steps are taken. A form can be interrupted and remain active; in this case the interruption should come after the From addf0ebf19a9811d991e08a50a336f9836ac8a62 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=8Dtalo=20Vin=C3=ADcius?= Date: Fri, 3 Feb 2023 21:48:25 -0300 Subject: [PATCH 2/2] Changes requested in docs --- docs/docs/action-server/actions.mdx | 2 +- docs/docs/action-server/knowledge-base-actions.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/action-server/actions.mdx b/docs/docs/action-server/actions.mdx index 1bfad549e711..e352005a7915 100644 --- a/docs/docs/action-server/actions.mdx +++ b/docs/docs/action-server/actions.mdx @@ -229,7 +229,7 @@ events, the order won't matter, but with other event types it can. ### `responses` -A response can be any of the response types described in the +A response can be of any of the response types described in the [documentation on rich responses](../responses.mdx#rich-responses). See the response sample of the [API spec](/pages/action-server-api) for the expected formats. diff --git a/docs/docs/action-server/knowledge-base-actions.mdx b/docs/docs/action-server/knowledge-base-actions.mdx index dbc277ba5ec4..554984a6f4c3 100644 --- a/docs/docs/action-server/knowledge-base-actions.mdx +++ b/docs/docs/action-server/knowledge-base-actions.mdx @@ -170,7 +170,7 @@ you need to specify and annotate the following entities in your training example object type listed as a key in the knowledge base. * `mention`: If the user refers to an object via “the first one”, “that one”, or “it”, you should mark those terms - as `mention`. We also use synonyms to map some mentions to symbols. You can learn about that + as `mention`. We also use synonyms to map some of the mentions to symbols. You can learn about that in [resolving mentions](./knowledge-base-actions.mdx#resolve-mentions). * `attribute`: All attribute names defined in your knowledge base should be identified as `attribute` in the