Skip to content

Commit

Permalink
Merge pull request #255 from botpress/bassamtantawi-new-Kb-Scopes
Browse files Browse the repository at this point in the history
Update knowledge-base.mdx by the new scopes
  • Loading branch information
ptrckbp authored Mar 21, 2024
2 parents 72b8c3d + 9774538 commit 99e295d
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions pages/cloud/studio/knowledge-base.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -163,33 +163,34 @@ The storage quota is the maximum amount of data that can be stored in the Knowle
pages.
</Callout>

## Enabling/Disabling KB on Nodes
## Enabling/Disabling KB on Capture Information cards

In Botpress, you have the ability to enable or disable the Knowledge Base feature for specific nodes that utilize the Capture Info action.
In Botpress, you have the ability to enable or disable the Knowledge Base feature for specific Capture Information cards - it is enabled by default.

To enable the Knowledge Base on nodes with a Capture Information Card:
To enable the Knowledge Base on a Capture Information Card:

1. Locate the nodes that include a Capture Information Card.
2. In the Inspector panel, look for the option called **Enable Knowledge Answering** and select it.
1. Locate the Capture Information Card.
2. In the Inspector panel, look for the option called **Knowledge Base**.
3. In the "Search all KBs" field, you can choose either specific KBs to search in, or you can choose "Disable Search"

By enabling this option, you allow the Knowledge Base to provide answers during the interaction when the user is asked for a response. If the user's input is relevant to the information stored in the Knowledge Base, Botpress's Natural Language Understanding (NLU) will retrieve the corresponding answer from the Knowledge Base and display it to the user. The conversation then proceeds to the next step of capturing information.
This feature helps to enhance the user experience by providing quick and accurate answers sourced from the Knowledge Base when appropriate.

If you disable the Knowledge Base feature on nodes that use the Capture Info action in Botpress, the system **will not** utilize the Knowledge Base to provide answers during the interaction.
If you disable the Knowledge Base feature on the Capture Info action in Botpress, the system **will not** utilize the Knowledge Base to provide answers during the interaction.

Disabling the Knowledge Base means that when users are prompted for a response and their input matches a query that could be answered using the Knowledge Base, Botpress's NLU will not retrieve answers from the Knowledge Base. Instead, the conversation will continue without incorporating information from the Knowledge Base.

By disabling the Knowledge Base, you essentially exclude it as a potential source of information for those specific nodes. This may be useful if you want to handle user responses differently or if you prefer to rely on other mechanisms to provide answers or capture information in those particular nodes.
By disabling the Knowledge Base, you essentially exclude it as a potential source of information for those specific cards. This may be useful if you want to handle user responses differently or if you prefer to rely on other mechanisms to provide answers or capture information in those particular cards.

Let's consider an example of a chatbot for a travel agency. The bot is designed to capture information from users regarding their travel preferences and provide relevant recommendations. The bot uses the Capture Info action in certain nodes to gather specific details from users.
Let's consider an example of a chatbot for a travel agency. The bot is designed to capture information from users regarding their travel preferences and provide relevant recommendations. The bot uses the Capture Info action in certain cards to gather specific details from users.

#### Example 1: Enabling the Knowledge Base

```text
Node: Capture Destination
Action: Capture Info
Scenario: The user is asked to provide their desired travel destination.
Enable Knowledge Answering: Enabled
Included Knowledge Bases: Search all KBs
User Input: "I want to go to Paris."
Expand All @@ -204,16 +205,16 @@ The conversation then proceeds to the next step of capturing additional informat
Node: Capture Transportation
Action: Capture Info
Scenario: The user is asked to specify their preferred mode of transportation for travel.
Enable Knowledge Answering: Disabled
Included Knowledge Bases: Disable Search
User Input: "I prefer to travel by train."
Response: Since the Knowledge Base feature is disabled for this node, the bot's NLU does not consult the Knowledge Base. It simply captures the user's response without incorporating any information from the Knowledge Base.
Response: Since the Knowledge Base feature is disabled for this card, the bot's NLU does not consult the Knowledge Base. It simply captures the user's response without incorporating any information from the Knowledge Base.
```

The conversation continues to the next step based on the specific logic or action defined for that node, without utilizing the Knowledge Base to provide answers or additional information.
The conversation continues to the next step based on the specific logic or action defined for that card, without utilizing the Knowledge Base to provide answers or additional information.

In both examples, enabling or disabling the Knowledge Base on nodes using the Capture Info action determines whether the bot incorporates Knowledge Base information into the conversation flow or relies solely on other mechanisms to handle user responses.
In both examples, enabling or disabling the Knowledge Base on the Capture Info action determines whether the bot incorporates Knowledge Base information into the conversation flow or relies solely on other mechanisms to handle user responses.

## Removing the references

Expand Down

0 comments on commit 99e295d

Please sign in to comment.