Skip to content
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
1 change: 0 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,6 @@
"/integrations/integration-guides/bamboohr",
"/integrations/integration-guides/canny",
"/integrations/integration-guides/chat",
"/integrations/integration-guides/conversation-analyzer",
"/integrations/integration-guides/chatwoot",
"/integrations/integration-guides/plus-email-notifier",
"/integrations/integration-guides/github",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified integrations/integration-guides/assets/auto-optimize.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
52 changes: 0 additions & 52 deletions integrations/integration-guides/conversation-analyzer.mdx

This file was deleted.

4 changes: 2 additions & 2 deletions integrations/integration-guides/hubspot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ description: Add a bot to HubSpot using the official integration.
icon: '/integrations/integration-guides/assets/icons/hubspot.svg'
---

{/* vale off */}


import integrationVersions from '/snippets/integrations/versions.mdx'
import { OpenInHub } from '/snippets/integrations/open-in-hub.jsx'
import Cards from '/snippets/integrations/cards/botpress/hubspot.mdx'
import Triggers from '/snippets/integrations/triggers/botpress/hubspot.mdx'

{/* vale on */}


<OpenInHub integration={integrationVersions.hubspot}/>

Expand Down
127 changes: 83 additions & 44 deletions integrations/integration-guides/improvement.mdx
Original file line number Diff line number Diff line change
@@ -1,49 +1,88 @@
---
title: Improvement
description: Provide feedback on specific LLMz iterations to improve future conversations.
icon: '/integrations/integration-guides/assets/icons/improvement.svg'
---

The Improvement integration lets you provide feedback on specific LLMz

<Warning>
The Improvement integration is in beta and shouldn't be used in production or critical Workflows. We encourage testing in non-production environments and welcome your feedback to improve its stability and functionality.

Each stored iteration uses your Workspace's Table Rows quota, and may demonstrate increased usage.
</Warning>

## Install

Start by installing the [Improvement integration](https://studio.botpress.cloud/home?exploreHub=1&hubItemId=intver_01JTPD08AXCWVWBCTJQSPGBSB1&search=Conversation+Analyzer) from the integration hub.

<img src="./assets/improvement-integration.png" />

## Store Iterations

After installing the integration, all of the iterations produced by LLMz via an Autonomous Node will be stored in the automatically-created "LLMz iterations" Table. Iterations are produced at the message level, meaning a single conversation will typically have multiple iterations.

<img src="./assets/improvement-table.png" />

This table is automatically populated every time an iteration ends. Each iteration takes up its own record, and stores specific data like the conversation or event ID, along with the iteration itself.

## Provide Feedback

Once you've installed the Improvement integration, you can access the "Improvement" window through the "Views" button on the top-right corner of the Studio.

<img src="./assets/view-improvement.png" />

You can access the Improvements UI from this menu.

<img src="./assets/improvement-ui.png" />

The Improvements UI shows all of your bot's conversations, along with each individual LLMz iteration. This iteration is the code your bot generated to take an action and/or respond to the user.

Hovering over a specific iteration will let you access the Feedback window, in which you can suggest improvements to future iterations of similar tasks.

<img src="./assets/improvement-ui-diff.png" />

Clicking "Re-generate" will produce a new iteration for your review. Once you're satisfied with the new iteration, clicking "Save" will store this to your bot's "Feedback" Table.

Your bot uses the information stored in its "Feedback" Table to inform future LLMz iterations.

<img src="./assets/improvement-table-result.png" />
The official Improvement integration lets you provide feedback on your bot's responses in the [emulator](/studio/concepts/emulator). Your bot can then use that feedback when generating future responses.

## Setup

The Improvement integration comes pre-installed on every bot. If you need to install it manually:

<Info>
You will need:

- A [published bot](/get-started/quick-start)
</Info>

<Steps>
<Step>In Botpress Studio, select **Explore Hub** in the upper-right corner.</Step>
<Step>Search for the **Improvement** integration, then select **Install Integration**.</Step>
<Step>In the **Configuration** menu, select **Save Configuration**.</Step>
</Steps>

## Suggesting improvements

You can suggest improvements when chatting with your bot in the emulator:

<Steps>
<Step>
Select <Icon icon="pencil"/> **Improve Response** on any message:

<Frame>
<img
alt="Improve response"
className="block dark:hidden"
src="./assets/improve-response.png"
/>
<img
alt="Improve response"
className="hidden dark:block"
src="./assets/improve-response-dark.png"
/>
</Frame>
</Step>

<Step>
Enter your feedback and select <Icon icon="refresh-ccw"/ > **Re-generate**., This will show you a preview of an updated response based on your feedback:

<Frame>
<img
alt="Feedback"
className="block dark:hidden"
src="./assets/feedback.png"
/>
<img
alt="Feedback"
className="hidden dark:block"
src="./assets/feedback-dark.png"
/>
</Frame>

The **Code** section shows you exactly how your bot's execution will be different after the feedback is applied.
</Step>
<Step>
If you're happy with the updated response, select <Icon icon="save"/> **Save as learning**.
</Step>
</Steps>

## Managing feedback

Any time you save feedback, it gets added to the **Feedback** [Table](/studio/concepts/tables) as a row:

<Frame>
<img
alt="Feedback"
className="block dark:hidden"
src="./assets/feedback-table.png"
/>
<img
alt="Feedback"
className="hidden dark:block"
src="./assets/feedback-table-dark.png"
/>
</Frame>

Your bot reads directly from this table when applying your feedback. This means you can modify the table's rows and columns to modify how feedback is applied.

You can also delete a specific piece of feedback by deleting its associated table row.
61 changes: 29 additions & 32 deletions integrations/integration-guides/knowledge-base-optimization.mdx
Original file line number Diff line number Diff line change
@@ -1,48 +1,45 @@
---
title: Knowledge Base Optimization
description: Automatically improve your bot's ability to respond to knowledge queries.
title: Knowledge Base Optimizer
icon: '/integrations/integration-guides/assets/icons/knowledge-base-optimization.svg'
---

The official Knowledge Base Optimizer integration improves your bot's ability to respond to questions using information contained in your Knowledge Base.

<Warning>
Early Beta
## Setup

The Knowledge Base Optimization feature is in beta and shouldn't be used in production or critical Workflows. We encourage testing in non-production environments and welcome your feedback to improve its stability and functionality.
<Info>
You will need:

While in early beta, optimization is a manual process.
- A [published bot](/get-started/quick-start)
</Info>

Each optimization can cost up to 2x the total number of tokens present in each document and consumes a portion of your [AI Spend quota](/get-started/configure-your-workspace#track-usage-quotas).

Optimization uses your default "Best Model", configured through your LLM settings in the Studio.
</Warning>

You can use the Knowledge Base Optimization feature to improve your bot's ability to respond to questions with information contained in your Knowledge Base.

## Install

Start by installing the [Knowledge Base Optimizer integration](https://studio.botpress.cloud/home?exploreHub=1&hubItemId=intver_01JSPMN283VH8Y25171DMMGYGS&search=Knowledge+Base+Optimizer) from the integration hub.

<img src="./assets/kb-optimizer.png" />
<Steps>
<Step>In Botpress Studio, select **Explore Hub** in the upper-right corner.</Step>
<Step>Search for the **Knowledge Base Optimizer** integration, then select **Install Integration**.</Step>
<Step>In the **Configuration** menu, select **Save Configuration**.</Step>
</Steps>

## Optimize

After installing the integration, you can use the "Auto-optimize" feature that now appears on your knowledge bases.

<img src="./assets/auto-optimize.png" />

Optimizing improves your bot's ability to respond to queries with the information contained in your knowledge bases.

## Test

### Before optimizing
Now you can select <Icon icon="wand-sparkles"/> **Auto-optimize** on any of your Knowledge Bases:

In the example below, the bot is unable to parse the user's question, and doesn't understand that the user is trying to query the information contained in the Knowledge Base.
<Frame>
<img
alt="Auto-optimize"
className="block dark:hidden"
src="./assets/auto-optimize.png"
/>
<img
alt="Auto-optimize"
className="hidden dark:block"
src="./assets/auto-optimize-dark.png"
/>
</Frame>

<img src="./assets/test-before-optimize.png" />
This improves your bot's ability to respond to queries with the information contained in your Knowledge Bases.

### After optimizing
## How it works

After optimizing the same example, the bot is able to take the same input and recognize that it's being asked a question that pertains to the information contained in its Knowledge Base.
The Knowledge Base Optimizer analyzes each document in your Knowledge Base with AI. It then automatically generates smart summaries for every file and creates an overall summary for the entire Knowledge Base.

<img src="./assets/test-after-optimizing.png" />
When your bot gets a question, it uses these summaries—along with the full content—to quickly find and deliver more relevant, accurate answers from your Knowledge Base.