diff --git a/docs.json b/docs.json index 9548a2dc..a5a42dce 100644 --- a/docs.json +++ b/docs.json @@ -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", diff --git a/integrations/integration-guides/assets/auto-optimize-dark.png b/integrations/integration-guides/assets/auto-optimize-dark.png new file mode 100644 index 00000000..dd443918 Binary files /dev/null and b/integrations/integration-guides/assets/auto-optimize-dark.png differ diff --git a/integrations/integration-guides/assets/auto-optimize.png b/integrations/integration-guides/assets/auto-optimize.png index 9adb410d..a7c724a3 100644 Binary files a/integrations/integration-guides/assets/auto-optimize.png and b/integrations/integration-guides/assets/auto-optimize.png differ diff --git a/integrations/integration-guides/assets/feedback-dark.png b/integrations/integration-guides/assets/feedback-dark.png new file mode 100644 index 00000000..4c7f1368 Binary files /dev/null and b/integrations/integration-guides/assets/feedback-dark.png differ diff --git a/integrations/integration-guides/assets/feedback-table-dark.png b/integrations/integration-guides/assets/feedback-table-dark.png new file mode 100644 index 00000000..391b3145 Binary files /dev/null and b/integrations/integration-guides/assets/feedback-table-dark.png differ diff --git a/integrations/integration-guides/assets/feedback-table.png b/integrations/integration-guides/assets/feedback-table.png new file mode 100644 index 00000000..81d16d55 Binary files /dev/null and b/integrations/integration-guides/assets/feedback-table.png differ diff --git a/integrations/integration-guides/assets/feedback.png b/integrations/integration-guides/assets/feedback.png new file mode 100644 index 00000000..bf04268c Binary files /dev/null and b/integrations/integration-guides/assets/feedback.png differ diff --git a/integrations/integration-guides/assets/improve-response-dark.png b/integrations/integration-guides/assets/improve-response-dark.png new file mode 100644 index 00000000..9a224767 Binary files /dev/null and b/integrations/integration-guides/assets/improve-response-dark.png differ diff --git a/integrations/integration-guides/assets/improve-response.png b/integrations/integration-guides/assets/improve-response.png new file mode 100644 index 00000000..8f5e363a Binary files /dev/null and b/integrations/integration-guides/assets/improve-response.png differ diff --git a/integrations/integration-guides/assets/improvement-integration.png b/integrations/integration-guides/assets/improvement-integration.png deleted file mode 100644 index 2ea9b579..00000000 Binary files a/integrations/integration-guides/assets/improvement-integration.png and /dev/null differ diff --git a/integrations/integration-guides/assets/improvement-table-result.png b/integrations/integration-guides/assets/improvement-table-result.png deleted file mode 100644 index 5b286fc3..00000000 Binary files a/integrations/integration-guides/assets/improvement-table-result.png and /dev/null differ diff --git a/integrations/integration-guides/assets/improvement-table.png b/integrations/integration-guides/assets/improvement-table.png deleted file mode 100644 index 64f34cac..00000000 Binary files a/integrations/integration-guides/assets/improvement-table.png and /dev/null differ diff --git a/integrations/integration-guides/assets/improvement-ui-diff.png b/integrations/integration-guides/assets/improvement-ui-diff.png deleted file mode 100644 index c5f7dac5..00000000 Binary files a/integrations/integration-guides/assets/improvement-ui-diff.png and /dev/null differ diff --git a/integrations/integration-guides/assets/improvement-ui.png b/integrations/integration-guides/assets/improvement-ui.png deleted file mode 100644 index 26bfbcac..00000000 Binary files a/integrations/integration-guides/assets/improvement-ui.png and /dev/null differ diff --git a/integrations/integration-guides/assets/kb-optimizer.png b/integrations/integration-guides/assets/kb-optimizer.png deleted file mode 100644 index c6f5be58..00000000 Binary files a/integrations/integration-guides/assets/kb-optimizer.png and /dev/null differ diff --git a/integrations/integration-guides/assets/test-after-optimizing.png b/integrations/integration-guides/assets/test-after-optimizing.png deleted file mode 100644 index cd947eaf..00000000 Binary files a/integrations/integration-guides/assets/test-after-optimizing.png and /dev/null differ diff --git a/integrations/integration-guides/assets/test-before-optimize.png b/integrations/integration-guides/assets/test-before-optimize.png deleted file mode 100644 index 42a092a5..00000000 Binary files a/integrations/integration-guides/assets/test-before-optimize.png and /dev/null differ diff --git a/integrations/integration-guides/conversation-analyzer.mdx b/integrations/integration-guides/conversation-analyzer.mdx deleted file mode 100644 index f6f92e40..00000000 --- a/integrations/integration-guides/conversation-analyzer.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Conversation Analyzer -description: >- - This functional integration automatically stores all of your bot's - conversations and provides AI-generated analysis. -icon: '/integrations/integration-guides/assets/icons/conversation-analyzer.svg' ---- - - - -Early Beta - -The Conversation Analyzer 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 conversation uses your Workspace's Table Rows quota, and may demonstrate increased usage. - - -## Install - -Start by installing the [Conversation Analyzer integration](https://studio.botpress.cloud?exploreHub=1&hubItemId=intver_01JFQPN3KKAX01TM7JQX171C58) from the integration hub. - - - -## Analyze - -After installing the integration, all of your bot's production conversations will be stored in the automatically created "Conversations" table. - - - -This table is automatically populated every time a conversation ends. Each conversation takes up its own record, and stores information like sentiment analysis, topics covered, and an AI-generated summary of the conversation. - -## Reinforcement Learning - -Botpress tables include built-in reinforcement learning mechanisms designed to continuously improve the accuracy and effectiveness of your bots. When you use the Conversation Analyzer, the computed columns in the Conversations table enable feedback loops that refine your bot's understanding of conversation patterns over time. - -### How It Works - -The "Conversations" table contains computed columns that analyze and interpret key aspects of each conversation, such as sentiment, topics, and AI-generated summaries. These columns act as the foundation for reinforcement learning by creating structured data that can be evaluated and improved. - -You can manually review and adjust the computed data (e.g., correct a misidentified topic or adjust the sentiment). These adjustments provide feedback that the system uses to update its underlying models. The more corrections you make, the better the bot becomes at accurately interpreting similar conversations in the future. - -Based on the feedback provided, Botpress dynamically retrains the relevant models. For example: - -**Topic Classification:** Retrains the model to better associate keywords, phrases, or intents with specific topics. - -**Sentiment Analysis:** Adjusts the sentiment detection algorithms to align more closely with your specific use case. - -**Summarization:** Enhances the AI's ability to create concise, accurate summaries by learning from your manual edits. - -### Continuous Improvement - -Over time, this process leads to a self-improving system. As the volume of analyzed conversations grows, the bot becomes more adept at handling various conversation scenarios, understanding user inputs, and producing meaningful insights. diff --git a/integrations/integration-guides/hubspot.mdx b/integrations/integration-guides/hubspot.mdx index 97c4b826..1dfcb53a 100644 --- a/integrations/integration-guides/hubspot.mdx +++ b/integrations/integration-guides/hubspot.mdx @@ -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 */} + diff --git a/integrations/integration-guides/improvement.mdx b/integrations/integration-guides/improvement.mdx index 08856330..bc765d68 100644 --- a/integrations/integration-guides/improvement.mdx +++ b/integrations/integration-guides/improvement.mdx @@ -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 - - -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. - - -## Install - -Start by installing the [Improvement integration](https://studio.botpress.cloud/home?exploreHub=1&hubItemId=intver_01JTPD08AXCWVWBCTJQSPGBSB1&search=Conversation+Analyzer) from the integration hub. - - - -## 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. - - - -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. - - - -You can access the Improvements UI from this menu. - - - -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. - - - -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. - - +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: + + + You will need: + + - A [published bot](/get-started/quick-start) + + + + In Botpress Studio, select **Explore Hub** in the upper-right corner. + Search for the **Improvement** integration, then select **Install Integration**. + In the **Configuration** menu, select **Save Configuration**. + + +## Suggesting improvements + +You can suggest improvements when chatting with your bot in the emulator: + + + + Select **Improve Response** on any message: + + + Improve response + Improve response + + + + + Enter your feedback and select **Re-generate**., This will show you a preview of an updated response based on your feedback: + + + Feedback + Feedback + + + The **Code** section shows you exactly how your bot's execution will be different after the feedback is applied. + + + If you're happy with the updated response, select **Save as learning**. + + + +## Managing feedback + +Any time you save feedback, it gets added to the **Feedback** [Table](/studio/concepts/tables) as a row: + + + Feedback + Feedback + + +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. diff --git a/integrations/integration-guides/knowledge-base-optimization.mdx b/integrations/integration-guides/knowledge-base-optimization.mdx index 760073bd..de2d1b75 100644 --- a/integrations/integration-guides/knowledge-base-optimization.mdx +++ b/integrations/integration-guides/knowledge-base-optimization.mdx @@ -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. - -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. + + You will need: -While in early beta, optimization is a manual process. + - A [published bot](/get-started/quick-start) + -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. - - -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. - - + + In Botpress Studio, select **Explore Hub** in the upper-right corner. + Search for the **Knowledge Base Optimizer** integration, then select **Install Integration**. + In the **Configuration** menu, select **Save Configuration**. + ## Optimize -After installing the integration, you can use the "Auto-optimize" feature that now appears on your knowledge bases. - - - -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 **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. + + Auto-optimize + Auto-optimize + - +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. - +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.