diff --git a/.vale/styles/config/ignore/ignore.txt b/.vale/styles/config/ignore/ignore.txt index 83a99c69..99e22cce 100644 --- a/.vale/styles/config/ignore/ignore.txt +++ b/.vale/styles/config/ignore/ignore.txt @@ -34,4 +34,6 @@ yarn bun dev lookups -micropatch \ No newline at end of file +micropatch +recrawling +resync \ No newline at end of file diff --git a/docs.json b/docs.json index 3bc11180..723e62ad 100644 --- a/docs.json +++ b/docs.json @@ -72,47 +72,19 @@ "/index", "/get-started/quick-start", { - "group": "Dashboard", + "group": "Manage your agent", "pages": [ - { - "group": "Monitor", - "pages": [] - }, - { - "group": "Workspace", - "pages": [ - "/get-started/dashboard/workspace/introduction", - "/get-started/dashboard/workspace/home", - "/get-started/dashboard/workspace/your-integrations", - "/get-started/dashboard/workspace/usage", - { - "group": "Settings", - "pages": [ - "/get-started/dashboard/workspace/settings/introduction", - "/get-started/dashboard/workspace/settings/members", - "/get-started/dashboard/workspace/settings/audits" - ] - }, - "/get-started/dashboard/workspace/user-profile" - ] - }, - { - "group": "Bot", - "pages": [ - "/get-started/dashboard/bot/introduction", - "/get-started/dashboard/bot/overview", - "/get-started/dashboard/bot/integrations", - "/get-started/dashboard/bot/webchat", - "/get-started/dashboard/bot/logs", - "/get-started/dashboard/bot/conversations", - "/get-started/dashboard/bot/analytics", - "/get-started/dashboard/bot/events", - "/get-started/dashboard/bot/issues", - "/get-started/dashboard/bot/configuration-variables" - ] - } + "/get-started/manage-your-agent/preview", + "/get-started/manage-your-agent/monitor", + "/get-started/manage-your-agent/knowledge", + "/get-started/manage-your-agent/inspect", + "/get-started/manage-your-agent/human-handoff", + "/get-started/manage-your-agent/edit-appearance", + "/get-started/manage-your-agent/control-access" + ] - } + }, + "/get-started/configure-your-workspace" ] }, { @@ -657,6 +629,9 @@ "discord": "https://discord.com/invite/botpress" } }, + "metadata": { + "timestamp": true + }, "redirects": [ { "source": "/home", diff --git a/for-developers/sdk/bots-as-code.mdx b/for-developers/sdk/bots-as-code.mdx index 40833a0b..f4b428eb 100644 --- a/for-developers/sdk/bots-as-code.mdx +++ b/for-developers/sdk/bots-as-code.mdx @@ -4,7 +4,7 @@ title: Bots-as-code Just like [Botpress Studio](/studio/introduction), the Botpress SDK allows you to create bots. However, instead of using a web interface, you can use code to define your bots. These are called **bots-as-code**. -Bots-as-code are still visible in the [Dashboard](/get-started/dashboard/bot/overview) and can be managed from there, but can't be edited using the Studio. Opening a bot-as-code in the Studio will display an empty bot. +Bots-as-code are still visible in the [Dashboard](/get-started/configure-your-workspace#manage-your-agents) and can be managed from there, but can't be edited using the Studio. Opening a bot-as-code in the Studio will display an empty bot. ## 1. Install The Botpress CLI diff --git a/get-started/assets/add-custom-instruction.png b/get-started/assets/add-custom-instruction.png deleted file mode 100644 index a94dd8a5..00000000 Binary files a/get-started/assets/add-custom-instruction.png and /dev/null differ diff --git a/get-started/assets/ask-question-emulator.png b/get-started/assets/ask-question-emulator.png deleted file mode 100644 index fd038121..00000000 Binary files a/get-started/assets/ask-question-emulator.png and /dev/null differ diff --git a/get-started/assets/autonomous-node.png b/get-started/assets/autonomous-node.png deleted file mode 100644 index b04a1839..00000000 Binary files a/get-started/assets/autonomous-node.png and /dev/null differ diff --git a/get-started/assets/emulator.png b/get-started/assets/emulator.png deleted file mode 100644 index 401df424..00000000 Binary files a/get-started/assets/emulator.png and /dev/null differ diff --git a/get-started/assets/home-dark.png b/get-started/assets/home-dark.png new file mode 100644 index 00000000..b1ca8769 Binary files /dev/null and b/get-started/assets/home-dark.png differ diff --git a/get-started/assets/home.png b/get-started/assets/home.png new file mode 100644 index 00000000..6c80facc Binary files /dev/null and b/get-started/assets/home.png differ diff --git a/get-started/assets/send-message-card.png b/get-started/assets/send-message-card.png deleted file mode 100644 index e5b489bb..00000000 Binary files a/get-started/assets/send-message-card.png and /dev/null differ diff --git a/get-started/assets/start-node.png b/get-started/assets/start-node.png deleted file mode 100644 index f3b9b511..00000000 Binary files a/get-started/assets/start-node.png and /dev/null differ diff --git a/get-started/assets/studio-workflow.png b/get-started/assets/studio-workflow.png deleted file mode 100644 index d8c72b3b..00000000 Binary files a/get-started/assets/studio-workflow.png and /dev/null differ diff --git a/get-started/assets/transition-between-nodes.png b/get-started/assets/transition-between-nodes.png deleted file mode 100644 index d6a34b4b..00000000 Binary files a/get-started/assets/transition-between-nodes.png and /dev/null differ diff --git a/get-started/assets/usage-dark.png b/get-started/assets/usage-dark.png new file mode 100644 index 00000000..f3bb1656 Binary files /dev/null and b/get-started/assets/usage-dark.png differ diff --git a/get-started/assets/usage.png b/get-started/assets/usage.png new file mode 100644 index 00000000..1fb540c1 Binary files /dev/null and b/get-started/assets/usage.png differ diff --git a/get-started/assets/webchat-preview.png b/get-started/assets/webchat-preview.png deleted file mode 100644 index d41c5fbd..00000000 Binary files a/get-started/assets/webchat-preview.png and /dev/null differ diff --git a/get-started/configure-your-workspace.mdx b/get-started/configure-your-workspace.mdx new file mode 100644 index 00000000..eef1b3d6 --- /dev/null +++ b/get-started/configure-your-workspace.mdx @@ -0,0 +1,249 @@ +In Botpress, your workspace is the environment where you organize, manage, and collaborate on your agent projects. + +Each Workspace can contain multiple agents, so you can keep them organized by customer, department, or use case. Within a workspace, you can manage permissions, usage, billing, and more. + + +## Using multiple workspaces + +Any add-ons you purchase are distributed at the workspace level, meaning that they only apply to agents in the workspace where they were purchased. + +This means you can use multiple workspaces within a single account, then subscribe to different plans and add-ons for each one. + +To add a new workspace: + + + + Select the current workspace in the upper-left corner. + + + Select **+ Create a workspace**. + + + Enter a name for the new workspace, then select **Create**. + + + + + There is no limit to the number of workspaces you can create on one account. + + +## Manage your agents + +You can manage all your agents in your workspace's ** Home** menu: + + + Home + Home + + +### Create a new agent + +You can create a new agent at any time by selecting **+ Create Bot** in the upper-right corner. + +### Rename an agent + +To rename an existing agent, select then ** Rename**. + +### Enable Always Alive {Plus} + +You can enable [Always Alive](#always-alive) on any agent to keep it running continuously, even when no conversation is active. This allows for quicker response times when users first begin a conversation. + + + The number of agents you can enable Always Alive for depends on your [plan](https://botpress.com/pricing). + + +### Copy an existing agent + +You can copy an existing agent's configuration (including all settings and [Workflows](/studio/concepts/workflows)) for any other agent: + + + + Select on the agent you want to copy the configuration *to*. + + + Select ** Copy to bot**, then select the agent you want to copy *from*. + + + Select **Copy**. + + + +### Delete an agent + +To delete an agent, select then ** Delete**. + +## View deployed integrations + +You can manage any integrations you've built and deployed to your workspace in the ** Integrations** menu. + + +If you just want to install third-party integrations, you can ignore this menu—instead, check out the official [integrations documentation](/integrations/get-started/introduction). + + +To learn more about building and deploying your own integrations: + + + Software development kit for building and deploying integrations on Botpress. + + +## Track usage quotas + +You can track information about usage across your workspace in the ** Usage** menu. + + + Usage + Usage + + +This page contains a breakdown of each type of usage quota. + + + You can always increase any limits in the [Billing menu](#billing). + + +### AI Spend + +Your **AI Spend** quota is the budget you allocate for your agent's usage of LLMs. This includes: + +- Generating text +- Retrieving answers from Knowledge Bases +- Any other AI-powered actions + +AI Spend cost is charged at cost, meaning you pay for the exact amount of tokens used by your agent without any additional markup. You can find detailed information about your agent's AI spend usage for each individual action in its [logs](/studio/concepts/debugger-logs-json#logs). + + +You can estimate your required AI Spend using our [AI Spend Calculator](https://botpress.com/ai-spend-calculator). + + +### File Storage + +Your **File Storage** quota determines the storage in megabytes (MB) available across your workspace. Files included in this storage include photos, videos, and audio files that you've uploaded to be sent by your agent. + +### Table Rows + +Your **Table Rows** quota determines the total number of rows you can add to your agent's [Tables](/studio/concepts/tables). + +### Vector DB Storage + +Your **Vector DB Storage** quota determines the maximum storage available for Knowledge Base documents. It accounts for the total number of vectors in all of your [Knowledge Base](/studio/concepts/knowledge-base/introduction) documents, as well as searchable columns in your tables. + +This value is expressed in MB for convenience, but the actual billing unit is a measure of vectorized storage, used for performing Retrieval Augmented Generation (RAG) on your Knowledge Bases. + +### Incoming Messages & Events + +Your **Incoming Messages & Events** quota determines the number of times your agent has been invoked in any channel and the maximum amount of times it can be invoked before it will stop responding. This includes: + +- New conversations +- Conversations resumed after a [Timeout](/studio/concepts/bot-settings#inactivity-timeout) +- Conversations started by [Triggers](/studio/concepts/triggers). + +### Collaborators + +Your **Collaborators** quota determines the maximum amount of users that can collaborate in this Workspace. + +### Bot Count + +Your **Bot Count** quota determines the maximum number of bots this Workspace can hold. Once you reach the maximum number, you can purchase additional slots, or delete any unused bots to make room for new ones. + +### Always Alive + +Your **Always Alive** quota indicates how many remaining bots you can allocate the Always Alive status to. + + + Botpress agents are powered by remote, virtual compute instances. Every time your agent begins a new conversation, Botpress spins up a new instance for that agent. This is known as a *cold start*. + + During a cold start, the system must: + + - Allocate resources + - Initialize the environment + - Load necessary code + - Perform any required configuration before the agent is ready to handle requests or tasks. + + Always Alive reserves an instance for your agent so that it can bypass this cold start and maintain a ready-to-use instance. The end result is that the first message sent and received from your agent are processed much faster. + + +## Billing + +You can update your billing preferences and manage your plan in the ** Billing** menu. + + + Learn more about pricing and plans. + + +### Automatically purchase add-ons + +If you often find yourself having to increase a specific quota, you can automatically increase it using Auto Recharge: + + + + Scroll to **Add-ons**, then find the add-on you'd like to automatically increase. + + + Under **Auto Recharge**, select **Disabled ** to enable it for that add-on. + + + +Now when your agent hits that specific quota, it'll adjust your plan automatically instead of notifying you. + +### FAQs + + + + Because subscriptions are active throughout an entire month (or billing cycle), changes made to your subscription will appear when the next billing cycle begins. + + + Upgrades to your subscription are immediately pro-rated. If you purchase a Team plan in the middle of the month, you will pay half the value of the Team plan (for the remainder of that month), and then you will be billed as normal starting the 1st of the following month. + + + You can access invoices by selecting **Invoice History** in the ** Billing** menu. + + + You can access invoices by selecting **Billing Information** in the ** Billing** menu. + + + You can adjust billing email preferences by selecting **Billing Information** in the ** Billing** menu. + + + All usage-based billing, like AI Spend, is charged at the end of the billing period. + + + No, you can't upgrade a plan or subscription if your payment fails. + + + +## Manage roles {Team} + +You can view and update roles for members of your workspace in ** Settings** > **Members**. + +Here's a breakdown of each role: + +| Role | Permissions | +|------|-------------| +| **Viewer** | Can only view bots and Workspaces. Can't make any edits or changes | +| **Billing manager** | Can view and modify the Workspace's billing information | +| **Developer** | Can create, view, and update bots in the Workspace. Can only delete bots they have created | +| **Manager** | Can create, view, and update bots in the Workspace. Can view audit records | +| **Developer** | Can add and remove Workspace collaborators, and manage all bots in the Workspace | +| **Owner** | The user who creates a Workspace is automatically its owner, and has the privileges of all roles | + +## View workspace activity + +You can view a list of all activity that's occurred in your workspace in ** Settings** > **Audits**. diff --git a/get-started/dashboard/bot/analytics.mdx b/get-started/dashboard/bot/analytics.mdx deleted file mode 100644 index f55317c5..00000000 --- a/get-started/dashboard/bot/analytics.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: Analytics -description: >- - Insights into bot performance, user engagement, and conversation - effectiveness. ---- - -Using the Analytics tab in your bot's dashboard, you can visualize your bot's recent activity as well as monitor the health of your bot project. - - -Note - -Some features in the Analytics tab, like selecting custom time periods or creating and saving additional custom displays, are only available to Team plan subscribers. [Learn more](https://botpress.com/pricing) - - -## Default Layout - -By default, each bot in your Workspace comes with pre-configured analytics charts. These cover last month's users, new or returning users, how many messages users send per session, how many sessions your bot had over the last month, how many messages were sent to your bot over the last month, and a general overview of the previous 3 months. - -### Custom Boards - -You can create custom boards, which visualize data related to your bot, by either editing an existing board from your default layout or creating a new chart altogether. - -## Time Period - -When customizing a board, you can select from a list of pre-configured time periods to determine which time period's data gets visualized in your Analytics tab. Each of the boards in this tab can display information from different time periods. - -## Event Types - -When choosing what data your Analytics tab will display, you can choose from a list of conversation-related events. These include: - -* total, new, and returning users -* sessions -* bot, user, and total messages -* average messages sent by your bot per session -* average messages sent by users per session -* average number of sessions per user -* the custom `botready`, `botpublished`, `state\_expired`, and `conversationStarted` events. - -## Chart Types - -You can visualize data in the analytics tab with the following charts: area, doughnut, bar, pie, metric, spark bar, and spark area. - -## Analytics Agent - - -Note - -The Analytics Agent is only available to Team Plan subscribers. - - -Once you've enabled the Analytics Agent from your bot's Agents menu, you can designate custom events that your bot will track. These events can be selected from the list of trackable events, or "Event Types." - -## Tracking custom events - -Follow these steps to track custom events: - -1. Place the "Track Event" card found in the "Agents" section of the card tray into a node -2. In the details panel, use a descriptive name for the event that will allow you to keep track of it later. For example, you might track "Successful resolution" or "Unanswered question." - -Once you've successfully created a custom event, your bot will track each event as the card is executed in a given node. For example, your bot can track how many times a conversation successfully reaches a specific node, or how often users go through a certain node. - - -Warning - -After creating a custom event, it can take up to an hour before the data is available to be visualized in your Analytics tab. - diff --git a/get-started/dashboard/bot/configuration-variables.mdx b/get-started/dashboard/bot/configuration-variables.mdx deleted file mode 100644 index 91bd465d..00000000 --- a/get-started/dashboard/bot/configuration-variables.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Configuration variables -description: Store essential information like API keys and database credentials. ---- - -Configuration Variables are containers that store essential information such as API keys and database credentials, and allow bot developers to easily access and modify them as needed. They provide a central location for configuration settings, which helps developers ensure that the bot functions correctly and stays up-to-date. Configuration variables also provide a level of security by keeping sensitive information separate from the codebase, reducing the risk of data exposure. - - -Development vs. production - -Configuration values set in the Botpress Studio are strictly for testing your bot in the emulator. They don't apply to any production deployments of your bot. - -To set configuration variables for a production bot in deployment, use the configuration variables tab in the dashboard. - - -## Using Configuration Variables - -In the Studio, navigate to the Variables menu in **Bot Settings**. Here, you can add configuration variables. - -You can create a new key and add the value you'd like to use in your development environment. This value should only be used for testing purposes in the emulator. - -Save and publish your bot to enable these changes. - -## Development - -### Usage - -You can use **`{{env.key}}`** to retrieve the value of a Configuration Variable Key that you created. - -You can use **`env.key`** to access its value in an Execute Code card, when writing custom code. - -## Production - -### Usage - -In the Configuration Variables tab of your bot's dashboard, you can set key values. diff --git a/get-started/dashboard/bot/conversations.mdx b/get-started/dashboard/bot/conversations.mdx deleted file mode 100644 index a76fde0d..00000000 --- a/get-started/dashboard/bot/conversations.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Conversations -description: View and manage all interactions between users and your bot. ---- - -Once you [publish and share your bot](/get-started/quick-start), you can use the Conversations tab to view and manage your bot's interactions with users. This means you can: - -* View user messages and replies -* Identify and fix issues with your bot -* Improve your user experience - -## Features - -### Listing conversations - -This menu lists each conversation your bot has had, sorted by the conversation's most recent message. It provides the conversation ID, a unique identifier for each conversation, as well as an AI-generated summary of the conversation. - -You can click the conversation ID to navigate to the specific conversation and view it in greater detail. - -When viewing a conversation, you can click on any message to inspect its properties, like the time at which it was sent, a unique message ID, and the JSON for that specific message. - -### Filtering conversations - -You can filter the conversations presented in this tab in a number of ways. - -#### Conversation - -Search for a conversation by entering a specific conversation ID. - -#### Message - -Search for a conversation by entering a specific message ID. - -#### Participant - -Search for a conversation by entering a specific user ID. - -#### Integration - -List all conversations taking place on a specific integration. diff --git a/get-started/dashboard/bot/events.mdx b/get-started/dashboard/bot/events.mdx deleted file mode 100644 index d232869e..00000000 --- a/get-started/dashboard/bot/events.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Events -description: Triggers that your bot recognizes and responds to. ---- - -Events on Botpress are key triggers that the bot recognizes and reacts to during a conversation. - -Botpress provides a comprehensive system for managing and inspecting events that occur within your bot. This system is essential for understanding how your bot interacts with users and for troubleshooting any issues that may arise. - -**Events** represent anything that happens within the bot, such as messages from users, bot replies, and various system-level occurrences. By examining these events, builders can debug triggers, inspect payloads, and monitor the health and activity of their bot. - -## Filtering Events - -The Events page allows you to filter events by the following criteria: - -* **Event**: The type of event that occurred. -* **Conversation**: The conversation to which the event belongs. You can filter by conversation ID. -* **User**: The user who triggered the event. You can filter by user ID. -* **Message**: The message content. You can filter by message ID. - -Each event in Botpress has a specific type and status. These characteristics provide detailed information about what the event represents and the state of its processing. - -### Types of Events - -* `message_created`: Generated when a new message is created by a user. -* `state_expired`: Indicates that a conversation state has expired. -* `task_update`: Reflects changes in the status of a task. -* `webhook:event`: Triggered by a webhook event. -* `webchat:conversationStarted`: Marks the beginning of a new conversation. -* `webchat:trigger`: Indicates that a trigger has been activated. -* `botready`: Signifies that the bot is ready to receive messages. -* `botpublished`: Occurs when the bot is published. - -### Event Statuses - -Events can have one of the following statuses: - -* `Processed`: The event has been successfully handled by the bot. -* `Failed`: The bot encountered an error while processing the event. -* `Pending`: The event is in the queue, awaiting processing. -* `Ignored`: The event has been deliberately ignored, usually by design. diff --git a/get-started/dashboard/bot/integrations.mdx b/get-started/dashboard/bot/integrations.mdx deleted file mode 100644 index 13d62058..00000000 --- a/get-started/dashboard/bot/integrations.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Integrations -description: Displays integrations currently installed on your bot. ---- - -This tab lists integrations that are currently installed on your bot. - -From this menu, you can uninstall existing integrations, or navigate to the Botpress Hub to search for new ones. - - -Configure integrations from the Studio - -Integration configuration has been moved to the Studio. - -To set up integrations you've installed, or to install new integrations, you can navigate to the [integrations menu](/studio/concepts/integrations) found directly in the Studio. - diff --git a/get-started/dashboard/bot/introduction.mdx b/get-started/dashboard/bot/introduction.mdx deleted file mode 100644 index 134b643a..00000000 --- a/get-started/dashboard/bot/introduction.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Bot -description: The software application you build on Botpress. -sidebarTitle: Introduction ---- - -{/* vale Vale.Spelling["Chatbot", "Chatbots", "chatbot", "chatbots"] = NO */} - -In Botpress, a bot is an AI-powered conversational agent designed to interact with users through various messaging platforms, automate tasks, and provide information based on predefined Workflows, content, and integrations. A bot can handle tasks such as answering questions, processing requests, and executing complex Workflows, making it a key component of forward-thinking digital experience, customer support, and IT teams, among many others. - -## Chatbot vs. AI Agent - -On Botpress, you build bots. This is the name given to the defined piece of software you create in the Studio or through the API and deploy to the channel(s) of your choice. - -A bot can be a traditional chatbot, an AI agent, or a combination of the two. Here's a quick rundown of the differences between these semantic categories. - -### Chatbot - -A chatbot is a software application designed to simulate conversation with human users, typically through text or voice interactions. It follows predefined scripts and rules to provide responses based on user inputs. Chatbots are often used for tasks like answering FAQs, guiding users through processes, or providing basic customer support. - -### AI Agent - -An AI agent is a more advanced software application that uses artificial intelligence to make decisions, learn from interactions, and take actions autonomously. Unlike a traditional chatbot, an AI agent can analyze data, understand context, and adapt its behavior based on previous interactions or external factors. AI agents can handle more complex tasks, including problem-solving, decision-making, and predictive analytics. - -
- - -The choice is yours! - -Botpress allows you to build chatbots, AI agents, or combine the two depending on what task you're looking to accomplish. - -You can combine the predictable, rule-based logic of traditional chatbots with the flexible autonomy of LLM-driven AI agents to customize a bot to your specific need. - diff --git a/get-started/dashboard/bot/issues.mdx b/get-started/dashboard/bot/issues.mdx deleted file mode 100644 index 82ec8d57..00000000 --- a/get-started/dashboard/bot/issues.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Issues -description: Identify and track problems or errors in your bot's interactions. ---- - -This tab lists any issues present in your bot's interactions with users. - -The information in this tab complements the information found in the [Logs](doc:logs) and the [Events](doc:events) tabs by providing information about persistent, repeatable errors. This includes, for example, errors thrown in execute code cards, but won't diagnose problems like AI hallucinations or inconsistent responses. - -Issues listed in this tab are grouped by error type. Inspecting a specific issue will show you a list of all the times that event has occurred. Further inspecting each individual event allows you to see detailed information about the issue, like the payload, user and conversation IDs, and the channel or integration on which it occurred. - -The Issues tab is a critical feature for monitoring and improving the quality and reliability of your bot. It serves as a centralized hub for identifying, tracking, and resolving problems or errors that occur during bot interactions. It's essential for maintaining the operational integrity of your bot, ensuring that problems are quickly identified and resolved. - -
- - -Resolve issues - -The Issues tab is a critical feature for monitoring and improving the quality and reliability of your bot. It serves as a centralized hub for identifying, tracking, and resolving problems or errors that occur during bot interactions. It's essential for maintaining the operational integrity of your bot, ensuring that problems are quickly identified and resolved. - diff --git a/get-started/dashboard/bot/logs.mdx b/get-started/dashboard/bot/logs.mdx deleted file mode 100644 index 29f3a97f..00000000 --- a/get-started/dashboard/bot/logs.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Logs -description: >- - Detailed records of bot activities, errors, and system performance in a - production environment. ---- - -Botpress production logs are detailed records of the activities, events, and errors that occur during the execution of a Botpress bot in a production environment. These logs are essential for monitoring your bot's performance, diagnosing issues, and maintaining the overall health of your bot project. - -You can filter logs by date and time to narrow down your search for a specific event or conversation. - -## Custom logging - -The `console.log()` function is used to log information to the Botpress logs. - -To add logging to your bot, follow these steps: - -* In a new or existing Execute Code card, add the following code: - -```typescript -console.log("Some text"); -``` - -* Replace the text with the information you wish to log, or the statement you'd like to print to the console. - -Once you've saved and published your changes, your bot will print that statement to its logs every time the Execute Code card is triggered as part of a Workflow. - -You can customize this message to include any information that you need to log, such as user input or API responses. diff --git a/get-started/dashboard/bot/overview.mdx b/get-started/dashboard/bot/overview.mdx deleted file mode 100644 index 96d59704..00000000 --- a/get-started/dashboard/bot/overview.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Overview -description: A general overview of relevant information at a glance for your bot. ---- - -This tab covers basic information and provides a general overview of your bot's performance and configurations. - -## About your bot - -This window shows basic statistics about your bot so you can quickly grasp any changes over time in the number of messages, sessions, or new users interacting with your bot. You can use the information found in this chart to make decisions about your bot's behaviour and quickly monitor its performance. - - -Note - -You can view more detailed analytics about your bot in the [Analytics tab](/get-started/dashboard/bot/analytics#analytics). - - -## Recent issues - -This window flags any recent issues your bot has run into while deployed in a production environment. You can use the information here to quickly diagnose and troubleshoot any usability blockers in your bot, or understand where end users are unable to move forward with conversations. - -## Installed integrations - -This menu shows which integrations your bot has installed. You can use this to quickly navigate to those integrations to manage them. diff --git a/get-started/dashboard/bot/webchat.mdx b/get-started/dashboard/bot/webchat.mdx deleted file mode 100644 index 02ba9696..00000000 --- a/get-started/dashboard/bot/webchat.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Webchat -description: Manage and configure your Webchat deployment settings. ---- - -Webchat is the native integration that allows you to deploy your bot on a website. - -From this menu, you can test your Webchat, make adjustments to its appearance and settings, and generate the code needed to embedded it on your website. - - -Note - -For a more detailed guide on using Webchat, [consult the Webchat documentation](/webchat/). - diff --git a/get-started/dashboard/workspace/assets/user-profile-options.png b/get-started/dashboard/workspace/assets/user-profile-options.png deleted file mode 100644 index a3708d26..00000000 Binary files a/get-started/dashboard/workspace/assets/user-profile-options.png and /dev/null differ diff --git a/get-started/dashboard/workspace/home.mdx b/get-started/dashboard/workspace/home.mdx deleted file mode 100644 index d851345c..00000000 --- a/get-started/dashboard/workspace/home.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Home -description: An overview of all bots and recent activity in your Workspace. ---- - -## Recent - -A dashboard that shows recently active and edited bots in your Workspace, along with a real-time overview of analytics and bot activity. - -## Bots - -Lists all of the bots in your Workspace. At a glance you can see the bot's name, how many integrations it has installed, any runtime errors, whether it has enabled Always Alive status, and view more information about the bot or edit it directly in the Studio. - -## View as - -This menu allows you to preview your Workspace profile as a member of the public, or a member of the Workspace itself. You can use this to gauge how other builders will see your Workspace when you contribute an integration or Workflow. - -## Usages - -Shows relevant usage metrics, sorted by consumption. You can use this to get a quick overview of which usage limits are closest to reaching their cap. - -## Recent changes - -A log of the most recent changes and updates made to bots in the given Workspace, sorted by the time of the change. - -## Hub contributions - -The most recent contributions this Workspace has made to the Botpress Hub. - -## Members - -Lists all of the members in the Workspace. diff --git a/get-started/dashboard/workspace/introduction.mdx b/get-started/dashboard/workspace/introduction.mdx deleted file mode 100644 index ca45856f..00000000 --- a/get-started/dashboard/workspace/introduction.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Workspace -description: Environment to manage and organize bot projects. -sidebarTitle: Introduction ---- - -In Botpress, a workspace is an environment where you can organize, manage, and collaborate on multiple bot projects. It allows teams to collaborate effectively by sharing access to these resources in a defined space. - -Each Workspace can contain multiple bots, so you can keep them organized by client, department, or other specific use case. Within a Workspace, you can manage permissions, track integrations, and monitor analytics. - -
- - -Workspaces are the billing unit on Botpress - -Add-ons purchased by PAYG and Team plan users are distributed at the Workspace level, meaning that they only apply to the bots living in the Workspace in which those add-ons are purchased. - -Various Workspaces in a single account can subscribe to different plans and add-ons. - diff --git a/get-started/dashboard/workspace/settings/audits.mdx b/get-started/dashboard/workspace/settings/audits.mdx deleted file mode 100644 index 3f087038..00000000 --- a/get-started/dashboard/workspace/settings/audits.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Audits -description: A log of changes made to the Workspace and bots it contains. ---- - -This tab contains a list of recent changes and edits made to the Workspace and any bots it contains. - -Audit logs are particularly useful in collaborative environments where multiple team members work in the same Workspace. - -Ordered chronologically, the Audit log lists the Workspace member, the action they took, and on what time and date this action was taken. diff --git a/get-started/dashboard/workspace/settings/introduction.mdx b/get-started/dashboard/workspace/settings/introduction.mdx deleted file mode 100644 index b10ffcbb..00000000 --- a/get-started/dashboard/workspace/settings/introduction.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: Settings -excerpt: General administration and management settings for your Workspace. -sidebarTitle: Introduction ---- -## Details - -From the Details menu in this tab, you can adjust the Workspace name and handle. - -You can also adjust the public profile of your Workspace and add social media profiles that link to your business or agency. From this menu, you also have the option to delete a Workspace. - - -Deleting a Workspace is irreversible - -Note that deleting a Workspace is an irreversible process, and we're unable to restore the contents of any Workspace that has been deleted. - - -## Billing - -From the Billing menu, you can see an overview of your next upcoming payment, your current AI Spend limit, and retrieve any invoices or details about your payment information. - -You will also see an overview of your current plan, and can compare or make changes to this plan. - -PAYG and Team plan customers can also make amendments to their subscription, including purchasing or removing add-ons. - -### Billing FAQs - -#### I've changed my subscription but the changes don't appear reflected in my dashboard? - -Because subscriptions are active throughout an entire month (or billing cycle), changes made to your subscription will appear when the next billing cycle begins. - -The Billing page in your dashboard displays next month's subscription, so you can see when your changes will take effect. - -#### If I purchase a plan or subscription upgrade in the middle of the month, when will I get charged? - -Upgrades to your subscription are immediately pro-rated. If you purchase a Team plan in the middle of the month, you will pay half the value of the Team plan (for the remainder of that month), and then you will be billed as normal starting the 1st of the following month. - -#### Where can I find Botpress invoices? - -You can access invoices by clicking on the 'View invoices and payment information' link in the Billing menu. - -#### Where can I add my Tax ID? - -You can add your Tax ID by clicking on the 'View invoices and payment information' link in the Billing menu. - -#### Where can I change which email receives receipts and invoices? - -You can adjust billing email preferences by clicking on the 'View invoices and payment information' link in the Billing menu. - -#### When does AI Spend get charged? - -All usage-based billing, like AI Spend, is charged at the end of the billing period. - -#### Can I make purchases on Botpress even though my payment has failed? - -No, you can can't upgrade a plan or subscription if your payment fails. diff --git a/get-started/dashboard/workspace/settings/members.mdx b/get-started/dashboard/workspace/settings/members.mdx deleted file mode 100644 index b2779bfb..00000000 --- a/get-started/dashboard/workspace/settings/members.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Members -description: View and manage access to a Workspace. ---- - -This tab lists all of the members who have access to the Workspace. - -From here, you can adjust what permissions and roles users have. - - -Premium Feature - -Only Team and Enterprise plan customers have access to dedicated RBAC (Role-Based Access Control). - -Plus and PAYG users can add and remove users to their Workspace. - - -## Collaborator Roles - -### Viewer - -Can only view bots and Workspaces. Can't make any edits or changes. - -### Billing manager - -Can view and modify the Workspace's billing information. - -### Developer - -Can create, view, and update bots in the Workspace. Can only delete bots they have created. - -### Manager - -Can create, view, and update bots in the Workspace. Can view audit records. - -### Administrator - -Can add and remove Workspace collaborators, and manage all bots in the Workspace. - -### Owner - -The user who creates a Workspace is automatically its owner, and has the privileges of all roles. - -
- - -Workspace ownership - -Workspace ownership can't be moved or assigned to another user. - diff --git a/get-started/dashboard/workspace/usage.mdx b/get-started/dashboard/workspace/usage.mdx deleted file mode 100644 index 3f45e637..00000000 --- a/get-started/dashboard/workspace/usage.mdx +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: Usage -description: See your monthly Workspace limits. ---- - -The Usage tab provides a view of the computational resources used by all of the bots in your Workspace. This helps you understand the performance of each bot in your Workspace and plan for future growth. The resources are grouped by the following categories: - -## AI Spend - -The AI Spend resource shows the amount that service providers charge for the consumption of tokens used to perform actions powered by AI models like generate text and retrieve answers from knowledge bases. AI Spend cost is charged at cost, meaning you pay for the exact amount of tokens used by your bot without any additional markup. You can find additional information about the token consumption of each action taken by your bot in the logs available through the emulator. - -AI Spend includes a free monthly credit of 5 USD per month. You can increase this limit by following these steps: - -1. Navigate to your Dashboard -2. Navigate to the Usage tab -3. Click on 'Manage spending limit' -4. Change the amount of your 'AI Spend Limit'. You will be prompted to input a credit card. - -AI Spend is capped at 100 USD per month. If you plan to exceed 100 USD of AI Spend in a given calendar month, please [contact us](https://botpress.com/contact-us) to increase this limit. You can estimate your AI Spend using our [AI Spend Calculator](https://botpress.com/ai-spend-calculator). - -
- -## File Storage - -The File Storage section shows the amount of storage in Megabytes (MB) used across your Workspace, as well as the maximum storage limit. Files included in this storage include photos, videos, and audio files that you've uploaded to be sent by your bot. - -
- -## Table Rows - -The Table Row section shows the number of rows in the bot's tables and the limit. It accounts for total the number of rows in all of your bot's [Tables](/studio/concepts/tables). - -
- -## Vector DB Storage - -The Vector Database Storage section shows the maximum storage available for Knowledge Base documents. It accounts for the total number of vectors (condensed pieces of your content) in all of your [Knowledge Base](/studio/concepts/knowledge-base/introduction) documents as well as searchable columns in your tables. - -This value is expressed in MB for convenience, but the actual billing unit is a measure of vectorized storage, used for performing RAG (Retrieval Augmented Generation) functions on your Knowledge Base(s). - -
- -## Incoming Messages & Events - -The Incoming Messages & Events section shows the number of times the bot has been invoked in any channel and the maximum amount of times it can be invoked before it will stop responding. It counts new conversations, conversations resumed after a [Timeout](/studio/concepts/bot-settings#inactivity-timeout), and conversations started by [Triggers](/get-started/dashboard/bot/events). - -
- -## Collaborators - -Collaborators indicates the maximum amount of users that can collaborate in this Workspace. Adding or removing collaborators will increase or decrease this number in real time. - -
- -## Bot Count - -Bot Count indicates the maximum number of bots this Workspace can hold. Once you reach the maximum number of bots, you can purchase additional slots, or delete any unused bots to make room for new ones. - -
- -## Always Alive - -The Always Alive usage limit indicates how many remaining bots you can allocate the Always Alive status to. - -
- -### What's Always Alive? - -Botpress bots are powered by remote, virtual compute instances. Every time your bot begins a conversation, for example when a Trigger is activated or a new user sends a message, Botpress spins up a new instance for that bot. This is known as a 'cold start', which refers to the initial startup process when a virtual machine (VM) or a serverless function is launched for the first time, or after it has been idle and terminated. During a cold start, the system must allocate resources, initialize the environment, load necessary code, and perform any required configuration before the instance is ready to handle requests or tasks. - -Always Alive reserves an instance for your bot so that it can bypass this cold start and maintains a ready-to-use instance. The end result is that the first message sent and received from your bot are processed much faster. - -Always Alive can be purchased and allocated on a per-bot basis. diff --git a/get-started/dashboard/workspace/user-profile.mdx b/get-started/dashboard/workspace/user-profile.mdx deleted file mode 100644 index 19c239d6..00000000 --- a/get-started/dashboard/workspace/user-profile.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Profile Setting ---- - - - -## Update Profile - -1. Click on the profile icon in the top right corner of your Botpress dashboard and click on the `Update Profile` button. -2. To change the profile image, click on the `Upload Image` button and select the image you want to upload. -3. To change the profile name, enter the new name in the `Full Name` field. -4. Click on the `Confirm` button to save the changes. - -## Link/Unlink Social Accounts - -1. Click on the profile icon in the top right corner of your Botpress dashboard and click on the `Link Social Accounts` button. -2. Click on the social media platform you want to link/unlink. (GitHub, Google, Microsoft, LinkedIn) -3. Enter the credentials for the social media platform. - -## Change Profile Password - -1. Click on the profile icon in the top right corner of your Botpress dashboard and click on the `Change Password` button. -2. Enter the new password in the `Password` field. -3. Re-enter the new password in the `Confirm Password` field. -4. Click on the `Confirm` button. - -## Personal Access Tokens - -1. Click on the profile icon in the top right corner of your Botpress dashboard and click on the `Personal Access Tokens` button. -2. Click on the `Generate New Token` button. -3. Enter the note for the token (Optional) and click on the `Generate Token` button. -4. Copy the token and store it in a safe place. diff --git a/get-started/dashboard/workspace/your-integrations.mdx b/get-started/dashboard/workspace/your-integrations.mdx deleted file mode 100644 index 078afddd..00000000 --- a/get-started/dashboard/workspace/your-integrations.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Your integrations -description: Lists integrations this Workspace owns. ---- - -This tab lists integrations your Workspace has contributed to the Botpress Hub. - -
- - -About the Botpress Hub - -The Botpress Hub is a public repository of integrations you can use to extend your Botpress bot's functionalities and options for deployment. - -It's open to the public, so you can make contributions to it, share integrations with colleagues or bot builders across the world, and download integrations developed by Botpress and other builders. - -Consult the [Botpress Hub documentation](/studio/concepts/card-hub) to learn more. - - -
- -From this tab, you can keep track of all integrations your Workspace currently owns and manages. You can manage the privacy of the integration, view detailed logs and settings, and keep track of previous versions. diff --git a/get-started/manage-your-agent/assets/access-control-dark.png b/get-started/manage-your-agent/assets/access-control-dark.png new file mode 100644 index 00000000..6780e862 Binary files /dev/null and b/get-started/manage-your-agent/assets/access-control-dark.png differ diff --git a/get-started/manage-your-agent/assets/access-control.png b/get-started/manage-your-agent/assets/access-control.png new file mode 100644 index 00000000..51a30124 Binary files /dev/null and b/get-started/manage-your-agent/assets/access-control.png differ diff --git a/get-started/manage-your-agent/assets/ai-insights-dark.png b/get-started/manage-your-agent/assets/ai-insights-dark.png new file mode 100644 index 00000000..e429697e Binary files /dev/null and b/get-started/manage-your-agent/assets/ai-insights-dark.png differ diff --git a/get-started/manage-your-agent/assets/ai-insights.png b/get-started/manage-your-agent/assets/ai-insights.png new file mode 100644 index 00000000..4fdefbd4 Binary files /dev/null and b/get-started/manage-your-agent/assets/ai-insights.png differ diff --git a/get-started/manage-your-agent/assets/analytics-dark.png b/get-started/manage-your-agent/assets/analytics-dark.png new file mode 100644 index 00000000..790c6ed5 Binary files /dev/null and b/get-started/manage-your-agent/assets/analytics-dark.png differ diff --git a/get-started/manage-your-agent/assets/analytics.png b/get-started/manage-your-agent/assets/analytics.png new file mode 100644 index 00000000..36b16a55 Binary files /dev/null and b/get-started/manage-your-agent/assets/analytics.png differ diff --git a/get-started/manage-your-agent/assets/assign-conversation-dark.png b/get-started/manage-your-agent/assets/assign-conversation-dark.png new file mode 100644 index 00000000..f765fae8 Binary files /dev/null and b/get-started/manage-your-agent/assets/assign-conversation-dark.png differ diff --git a/get-started/manage-your-agent/assets/assign-conversation.png b/get-started/manage-your-agent/assets/assign-conversation.png new file mode 100644 index 00000000..a5d32499 Binary files /dev/null and b/get-started/manage-your-agent/assets/assign-conversation.png differ diff --git a/get-started/manage-your-agent/assets/conversation-dark.png b/get-started/manage-your-agent/assets/conversation-dark.png new file mode 100644 index 00000000..a5709eb7 Binary files /dev/null and b/get-started/manage-your-agent/assets/conversation-dark.png differ diff --git a/get-started/manage-your-agent/assets/conversation.png b/get-started/manage-your-agent/assets/conversation.png new file mode 100644 index 00000000..4432bfb6 Binary files /dev/null and b/get-started/manage-your-agent/assets/conversation.png differ diff --git a/get-started/manage-your-agent/assets/event-json-data-dark.png b/get-started/manage-your-agent/assets/event-json-data-dark.png new file mode 100644 index 00000000..aacec4c9 Binary files /dev/null and b/get-started/manage-your-agent/assets/event-json-data-dark.png differ diff --git a/get-started/manage-your-agent/assets/event-json-data.png b/get-started/manage-your-agent/assets/event-json-data.png new file mode 100644 index 00000000..10a8f414 Binary files /dev/null and b/get-started/manage-your-agent/assets/event-json-data.png differ diff --git a/get-started/manage-your-agent/assets/events-dark.png b/get-started/manage-your-agent/assets/events-dark.png new file mode 100644 index 00000000..f7482059 Binary files /dev/null and b/get-started/manage-your-agent/assets/events-dark.png differ diff --git a/get-started/manage-your-agent/assets/events.png b/get-started/manage-your-agent/assets/events.png new file mode 100644 index 00000000..da25d0de Binary files /dev/null and b/get-started/manage-your-agent/assets/events.png differ diff --git a/get-started/manage-your-agent/assets/file-json-data-dark.png b/get-started/manage-your-agent/assets/file-json-data-dark.png new file mode 100644 index 00000000..225eaaa5 Binary files /dev/null and b/get-started/manage-your-agent/assets/file-json-data-dark.png differ diff --git a/get-started/manage-your-agent/assets/file-json-data.png b/get-started/manage-your-agent/assets/file-json-data.png new file mode 100644 index 00000000..0cfcc3e9 Binary files /dev/null and b/get-started/manage-your-agent/assets/file-json-data.png differ diff --git a/get-started/manage-your-agent/assets/issue-events-dark.png b/get-started/manage-your-agent/assets/issue-events-dark.png new file mode 100644 index 00000000..5a149d49 Binary files /dev/null and b/get-started/manage-your-agent/assets/issue-events-dark.png differ diff --git a/get-started/manage-your-agent/assets/issue-events.png b/get-started/manage-your-agent/assets/issue-events.png new file mode 100644 index 00000000..613398de Binary files /dev/null and b/get-started/manage-your-agent/assets/issue-events.png differ diff --git a/get-started/manage-your-agent/assets/issues-dark.png b/get-started/manage-your-agent/assets/issues-dark.png new file mode 100644 index 00000000..c27dbc0f Binary files /dev/null and b/get-started/manage-your-agent/assets/issues-dark.png differ diff --git a/get-started/manage-your-agent/assets/issues.png b/get-started/manage-your-agent/assets/issues.png new file mode 100644 index 00000000..9df71672 Binary files /dev/null and b/get-started/manage-your-agent/assets/issues.png differ diff --git a/get-started/manage-your-agent/assets/logs-dark.png b/get-started/manage-your-agent/assets/logs-dark.png new file mode 100644 index 00000000..b8cf7b3f Binary files /dev/null and b/get-started/manage-your-agent/assets/logs-dark.png differ diff --git a/get-started/manage-your-agent/assets/logs.png b/get-started/manage-your-agent/assets/logs.png new file mode 100644 index 00000000..1e239c92 Binary files /dev/null and b/get-started/manage-your-agent/assets/logs.png differ diff --git a/get-started/manage-your-agent/assets/message-json-data-dark.png b/get-started/manage-your-agent/assets/message-json-data-dark.png new file mode 100644 index 00000000..2da55fda Binary files /dev/null and b/get-started/manage-your-agent/assets/message-json-data-dark.png differ diff --git a/get-started/manage-your-agent/assets/message-json-data.png b/get-started/manage-your-agent/assets/message-json-data.png new file mode 100644 index 00000000..5347929e Binary files /dev/null and b/get-started/manage-your-agent/assets/message-json-data.png differ diff --git a/get-started/manage-your-agent/assets/pending-conversation-dark.png b/get-started/manage-your-agent/assets/pending-conversation-dark.png new file mode 100644 index 00000000..a06f28e2 Binary files /dev/null and b/get-started/manage-your-agent/assets/pending-conversation-dark.png differ diff --git a/get-started/manage-your-agent/assets/pending-conversation.png b/get-started/manage-your-agent/assets/pending-conversation.png new file mode 100644 index 00000000..a895de12 Binary files /dev/null and b/get-started/manage-your-agent/assets/pending-conversation.png differ diff --git a/get-started/manage-your-agent/assets/preview-dark.png b/get-started/manage-your-agent/assets/preview-dark.png new file mode 100644 index 00000000..2f316bcd Binary files /dev/null and b/get-started/manage-your-agent/assets/preview-dark.png differ diff --git a/get-started/manage-your-agent/assets/preview.png b/get-started/manage-your-agent/assets/preview.png new file mode 100644 index 00000000..b6b463c1 Binary files /dev/null and b/get-started/manage-your-agent/assets/preview.png differ diff --git a/get-started/manage-your-agent/assets/respond-to-user-dark.png b/get-started/manage-your-agent/assets/respond-to-user-dark.png new file mode 100644 index 00000000..16eb7756 Binary files /dev/null and b/get-started/manage-your-agent/assets/respond-to-user-dark.png differ diff --git a/get-started/manage-your-agent/assets/respond-to-user.png b/get-started/manage-your-agent/assets/respond-to-user.png new file mode 100644 index 00000000..533a728c Binary files /dev/null and b/get-started/manage-your-agent/assets/respond-to-user.png differ diff --git a/get-started/manage-your-agent/assets/trigger-human-handoff-dark.png b/get-started/manage-your-agent/assets/trigger-human-handoff-dark.png new file mode 100644 index 00000000..abe172fe Binary files /dev/null and b/get-started/manage-your-agent/assets/trigger-human-handoff-dark.png differ diff --git a/get-started/manage-your-agent/assets/trigger-human-handoff.png b/get-started/manage-your-agent/assets/trigger-human-handoff.png new file mode 100644 index 00000000..e8109366 Binary files /dev/null and b/get-started/manage-your-agent/assets/trigger-human-handoff.png differ diff --git a/get-started/manage-your-agent/control-access.mdx b/get-started/manage-your-agent/control-access.mdx new file mode 100644 index 00000000..749f14d5 --- /dev/null +++ b/get-started/manage-your-agent/control-access.mdx @@ -0,0 +1,45 @@ +--- +title: Control access to your agent +sidebarTitle: Control access +tag: Team +--- + +If you're an owner or administrator in your workspace, you can restrict who in your Workspace has access to your agent. + + + Access control requires a [Plus plan](https://botpress.com/pricing) or higher. + + + + + Go to ** Settings** in your agent's menu. + + + Select **Access Control**. + + + +Here, you can select which members of your Workspace have access to your agent: + + + Access control + Access control + + +When you're done, select **Save**. + +## Access control vs. roles + +Access control is an *agent-level setting*—it doesn't change the workspace member's access to any other agents or their overall role in the workspace. You can configure workspace-level roles in your [Workspace settings](/get-started/configure-your-workspace#manage-roles). + + + Workspace owners and administrators always have access to all bots in a workspace. + diff --git a/get-started/manage-your-agent/edit-appearance.mdx b/get-started/manage-your-agent/edit-appearance.mdx new file mode 100644 index 00000000..0a8d19b3 --- /dev/null +++ b/get-started/manage-your-agent/edit-appearance.mdx @@ -0,0 +1,9 @@ +--- +title: Edit appearance +--- + +You can configure your agent's appearance using its Webchat configuration: + + +Check out the Webchat documentation for more information on configuring and styling your agent. + diff --git a/get-started/manage-your-agent/human-handoff.mdx b/get-started/manage-your-agent/human-handoff.mdx new file mode 100644 index 00000000..c870fe89 --- /dev/null +++ b/get-started/manage-your-agent/human-handoff.mdx @@ -0,0 +1,112 @@ +--- +title: Configure Human Handoff +tag: Plus +--- + +If you want to allow a live agent to join your agent's conversations, you can configure this in the ** Human Handoff** section of your bot's menu. + +## Setup + +To get started using Human Handoff, you need to install and configure the official Human-in-the-Loop (HITL) integration: + + + Install and configure the official integration Plus + + +When you've finished setting up the integration, you'll have access to the Human Handoff **Dashboard**. + +{/* You can assign members of your Workspace to join conversations that have triggered Human Handoff, and they can directly assist your users. */} + +--- + +## Dashboard + +When you've finished setting up the integration, you'll have access to the Human Handoff **Dashboard**. Here's how it works: + +### View your tickets + +When a user triggers Human Handoff, a ticket is opened. You can view your tickets in the left sidebar: + + + Pending conversation + Pending conversation + + +Select any ticket to view the conversation with the user. + + + You can use the drop-down menus to filter your tickets by their status. + + +### Assign a ticket + +You can assign a ticket to anyone in your Workspace, including yourself. For example, select ** Assign to me**: + + + Assign conversation + Assign conversation + + +Now you can chat directly with the user: + + + Respond to user + Respond to user + + +### Close a ticket + +{/* vale Vale.Spelling = NO */} +When you've resolved the conversation with the user, select **Resume Chatbot **. This removes you from the conversation and lets the user keep chatting with your agent. +{/* vale Vale.Spelling = YES */} + +## Testing + +You can test Human Handoff by using your agent's preview to simulate an escalation. + + + Open your agent's [preview](/get-started/manage-your-agent/preview). + + Chat with your agent until it triggers Human Handoff: + + + Trigger Human Handoff + Trigger Human Handoff + + + + Navigate to the Dashboard, then go to the bot's ** Human Handoff** menu. From there, you can assign and interact with the ticket. + + diff --git a/get-started/manage-your-agent/inspect.mdx b/get-started/manage-your-agent/inspect.mdx new file mode 100644 index 00000000..cbe9e9ff --- /dev/null +++ b/get-started/manage-your-agent/inspect.mdx @@ -0,0 +1,158 @@ +--- +title: Inspect behaviour +--- + +You can inspect your agent's behaviour in the ** Inspect** section of your agent's menu. Here's a breakdown of each sub-section: + +## Logs + +You can view logs from all your agent's conversations in the **Logs** sub-section. This includes system logs that provide updates on your agent's status, as well as logs from any integrations you have installed: + + + Logs + Logs + + +You can filter logs by date and time to narrow down your search for a specific event or conversation. + +### Custom logs + +You can add custom logs when [writing code in Studio](/studio/guides/advanced/use-code)—just use JavaScript's `console.log`: + +```js +console.log('An error occured.') +``` + +Once you’ve published your changes, your bot will print that statement to its logs every time the code executes. + +--- + +## Events + +Events represent anything that happens within the bot, such as messages from users, bot replies, and system-level occurrences. You can view all incoming events processed by your agent in the **Events** section: + + + Events + Events + + +### Event data + +Select any event to view a detailed JSON representation of all its associated data: + + + Event JSON data + Event JSON data + + +### Quota + +Incoming events count towards your plan's Incoming Messages & Events quota. If you need to increase this quota, go to the [Billing](/get-started/configure-your-workspace/#billing) section. + +--- + +## Files + +You can view all files uploaded to your agent in the **Files** section. This includes: + +- [Files uploaded by users](/webchat/get-started/configure-your-webchat#features) +- Files indexed as part of a [Knowledge Base](/get-started/manage-your-agent/knowledge#knowledge-bases) +- System files +- Files you've uploaded yourself using the [Files API](/api-reference/files-api/getting-started) + +### Inspect file data + +Select any file to view a detailed JSON representation of all its associated data: + + + File JSON data + File JSON data + + +### View a file + +To view a file, select it and open its URL. + +### Download a file + +To download a file, select to open additional options, then **Download**. + +### Delete a file + +To delete a file, select to open additional options, then **Delete**. + +### Quota + +Any files you store count against your File Storage quota. You can increase your quota in your dashboard's [Billing](/get-started/configure-your-workspace#billing) menu. + +--- + +## Issues + +You can view any problems or errors your agent encountered in the **Issues** sub-section: + + + Issues + Issues + + +The **Category** field tells you where the issue came from, while the **Events** field tells you how many times it occurred. Select any issue to view a list of all occurrences: + + + Issue events + Issue events + + +This gives you detailed information about each occurrence, like: + +- Its payload +- The associated user and conversation IDs +- The channel or integration on which it occurred diff --git a/get-started/manage-your-agent/knowledge.mdx b/get-started/manage-your-agent/knowledge.mdx new file mode 100644 index 00000000..23aa89ac --- /dev/null +++ b/get-started/manage-your-agent/knowledge.mdx @@ -0,0 +1,43 @@ +--- +title: Add knowledge sources +--- + +You can add and manage knowledge sources in the ** Knowledge** section of your agent's menu. Here's a breakdown of each sub-section: + +## Tables + +You can view data your agent has stored in the **Tables** sub-section. Select any table to view its contents. + + + You can [create new tables in Studio](/studio/concepts/tables) if you want your agent to store custom data. + + +--- + +## Knowledge Bases + +You can manage which sources your bot has access to in the **Knowledge Bases** sub-section. + +Every new agent has a default empty Knowledge Base. Open it, then select **+ Add Knowledge Source** to provide your agent with new sources—it'll automatically reference them when answering users. + + + You can also select **+ Add Knowledge Base** to create an entirely new Knowledge Base. + + +### Manage website indexing + +To manage a website Knowledge Base's indexing/recrawling options, open it and select ** Manage**. You can: + +- **Reconfigure**: Change the recrawling frequency (how often the Knowledge Base updates) +- **Resync**: Trigger a manual recrawl of the website +- **Remove this source**: Remove the source from the Knowledge Base + +### Configure in Studio + +If you need more control over your Knowledge Bases, you can [configure them in Studio](/studio/concepts/knowledge-base/introduction). This gives you access to advanced options for each [type of source](/studio/concepts/knowledge-base/add-sources). + +### Storage + +When you add and use knowledge sources, it counts towards your File Storage and Vector DB Storage. You can see an overview of your current usage at the top of the section. + +If you need additional storage, select **Add Storage**. Check out our [pricing page](https://botpress.com/pricing) for more details. diff --git a/get-started/manage-your-agent/monitor.mdx b/get-started/manage-your-agent/monitor.mdx new file mode 100644 index 00000000..e514d1f7 --- /dev/null +++ b/get-started/manage-your-agent/monitor.mdx @@ -0,0 +1,98 @@ +--- +title: Monitor performance +--- + +You can monitor your agent's performance in the ** Monitor** section of your agent's menu. Here's a breakdown of each sub-section: + +## Conversations + +You can view a list of all your agent's conversations in the **Conversations** sub-section. Just select any conversation to view its details: + + + Conversation + Conversation + + +In this menu, you can access: + +- The conversation's participants +- Its conversation ID +- Which integration it occurred on +- Its start date and last activity +- Its current status +- Any tags associated with it + +### Message data + +You can select any message in the conversation to get a detailed JSON representation of all its associated data: + + + Message JSON data + Message JSON data + + +### AI insights {BETA} + +Select ** Enable AI** to enable sentiment analysis and AI summaries for incoming conversations: + + + AI insights + AI insights + + +--- + +## Users + +You can view all your agent's unique users in the **Users** sub-section. Select any user ID to open [conversations](#conversations), [events](/get-started/manage-your-agent/inspect#events), or [logs](/get-started/manage-your-agent/inspect#logs) associated with that user. + +## Analytics + +You can view detailed analytics about your agent's performance in the **Analytics** sub-section: + + + Analytics + Analytics + + +For any tile, you can: + +- Select the current range to modify it +- Select **Edit Source** to change which data the tile displays +- Select to access additional options: + - **Show/Hide Legend** + - **Type** + - **Duplicate** + - **Delete** diff --git a/get-started/manage-your-agent/preview.mdx b/get-started/manage-your-agent/preview.mdx new file mode 100644 index 00000000..b7bd258b --- /dev/null +++ b/get-started/manage-your-agent/preview.mdx @@ -0,0 +1,40 @@ +--- +title: Preview +--- + +You can chat with a preview of your published agent at any time: + + + Go to the ** Overview** section in your agent's menu. + + Select ** Preview** to open the preview. + + + +## Test your agent + +Start a conversation with your agent and test its behaviour: + + + Preview + Preview + + +## Styling + +The preview is generated using [Webchat](/webchat/get-started/introduction), Botpress' custom frontend. It shows how your agent will appear to users when you add it to your website. + +For more information about styling your agent: + + +Configure your agent's appearance using Webchat. + + diff --git a/get-started/quick-start.mdx b/get-started/quick-start.mdx index cfa9ca80..956ee920 100644 --- a/get-started/quick-start.mdx +++ b/get-started/quick-start.mdx @@ -17,9 +17,11 @@ Visual learner? Check out our [platform walkthrough on YouTube](https://www.yout ## Step 1: Build your bot -1. [Sign up for Botpress](https://sso.botpress.cloud/login). -2. Select either **Start building** or **Build my agent**. -3. Follow the on-screen instructions to configure your first bot. We'll take care of everything for you, and your AI agent will be ready to test and deploy within minutes. + + [Sign up for Botpress](https://sso.botpress.cloud/login). + Select either **Start building** or **Build my agent**. + Follow the on-screen instructions to configure your first bot. We'll take care of everything for you, and your AI agent will be ready to test and deploy within minutes. + If you'd prefer to set your bot up from scratch, hit **Skip** and head over to the [tutorial](/tutorial/introduction)—we'll show you how to start building with Botpress Studio. @@ -94,3 +96,7 @@ When you're ready to deploy your bot, select one of the options below: You just built and deployed your first bot with Botpress! + +## Next steps + +Once your bot is deployed, you can diff --git a/integrations/functional-integrations/knowledge-base-optimization.mdx b/integrations/functional-integrations/knowledge-base-optimization.mdx index 41c3be18..c0efaf2a 100644 --- a/integrations/functional-integrations/knowledge-base-optimization.mdx +++ b/integrations/functional-integrations/knowledge-base-optimization.mdx @@ -11,7 +11,7 @@ The Knowledge Base Optimization feature is in beta and shouldn't be used in prod While in early beta, optimization is a manual process. -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/dashboard/workspace/usage). +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. diff --git a/integrations/integration-guides/assets/hitl.png b/integrations/integration-guides/assets/hitl.png deleted file mode 100644 index ded70f86..00000000 Binary files a/integrations/integration-guides/assets/hitl.png and /dev/null differ diff --git a/integrations/integration-guides/assets/start-hitl-card-dark.png b/integrations/integration-guides/assets/start-hitl-card-dark.png new file mode 100644 index 00000000..fc5c6095 Binary files /dev/null and b/integrations/integration-guides/assets/start-hitl-card-dark.png differ diff --git a/integrations/integration-guides/assets/start-hitl-card.png b/integrations/integration-guides/assets/start-hitl-card.png new file mode 100644 index 00000000..c467cc8b Binary files /dev/null and b/integrations/integration-guides/assets/start-hitl-card.png differ diff --git a/integrations/integration-guides/assets/start-hitl.png b/integrations/integration-guides/assets/start-hitl.png deleted file mode 100644 index 149d1380..00000000 Binary files a/integrations/integration-guides/assets/start-hitl.png and /dev/null differ diff --git a/integrations/integration-guides/hitl.mdx b/integrations/integration-guides/hitl.mdx index 199351fe..dab90bf7 100644 --- a/integrations/integration-guides/hitl.mdx +++ b/integrations/integration-guides/hitl.mdx @@ -1,5 +1,5 @@ --- -title: Human-in-the-loop (HITL) +title: Human-in-the-Loop (HITL) description: >- Allow a live agent to participate directly in the bot's conversation. @@ -18,12 +18,16 @@ import Triggers from '/snippets/integrations/triggers/botpress/hitl.mdx' -The Human-in-the-Loop (HITL) integration brings human oversight and intervention into AI-driven Workflows. It allows members of your Workspace to: +The Human-in-the-Loop (HITL) integration allows members of your Workspace to: - Chat directly with users - Approve AI-generated outputs before they're sent - Handle complex or sensitive scenarios + + The HITL integration needs to be configured before you can use [Human Handoff](/get-started/manage-your-agent/human-handoff). + + ## Setup @@ -32,146 +36,82 @@ The Human-in-the-Loop (HITL) integration brings human oversight and intervention - A [Botpress Plus plan](https://botpress.com/pricing) or higher - - - - First, install the official HITL integration. This will allow you to respond to users directly within Botpress. +### Step 1: Install the HITL integration - 1. In the Studio, select **Explore Hub** in the upper-right corner. - 2. Search for the HITL integration. Select it, then select **Install Integration**: - - ![Install HITL](./assets/install-hitl.png) +First, install the official HITL integration: + + + In Botpress Studio, select **Explore Hub** in the upper-right corner. - - - Next, install the official HITL plugin. This will allow you to start HITL from any point in your Workflow. + + Search for the HITL integration, then select **Install Integration**. + + - 1. Navigate back to Botpress Hub and search for the HITL plugin. - 2. Select it, then select **Install Plugin**: +### Step 2: Install the HITL plugin - ![Install HITL plugin](./assets/install-hitl-plugin.png) + Next, install the official HITL plugin. This will allow you to start HITL from any point in your Workflow. - 3. In the **Configuration** menu, open the dropdown under **HITL integration**. + + + Navigate back to Botpress Hub and search for the HITL plugin. + + + Select it, then select **Install Plugin**. + + + In the **Configuration** menu, open the dropdown under **HITL integration**. This dropdown will display all HITL-compatible integrations you've installed. Since this is a guide to the official Botpress HITL integration, we'll select that one for now. - - 4. Select **HITL**. - 5. Scroll down and select **Save**. - - - The **Configuration** section contains many optional fields. You can use these to customize your HITL experience. - - - - - Now, you can bring a live agent into the conversation anywhere in your Workflow: + Select **HITL**. + + Scroll down and select **Save**. + + - 1. Open a Workflow in Studio and create (or select) a Node. - 2. Add the **Start HITL** Card: + + The plugin's **Configuration** section contains many optional fields. You can use these to customize your HITL experience. + - ![Start HITL](./assets/start-hitl.png) +### Step 3: Add the Start HITL card to your Workflow - 3. Fill in the required fields: + + + Open a Workflow in Studio and create (or select) any Node. + + + Add the **Start HITL** Card at the point where you want to hand off conversations to a live agent: + + + Start HITL Card + Start HITL Card + + + + In the Card's [inspector](/studio/concepts/cards/introduction#configure-a-card), fill in the required fields: | Fields | Description | :----------------- | :---------- | | **Ticket Title** | The name of the ticket created for the live agent. | | **User ID** | The user ID associated with the ticket. Enter the `{{event.userId}}` variable to use the current user's ID. | | **Conversation ID** | The conversation ID associated with the ticket. Enter the `{{event.conversationId}}` variable to use the current conversation's ID. | - Done! HITL will begin whenever the **Start HITL** card executes. - - -## Respond to users - -Now that you've set up HITL, you can assign someone in your Workspace to respond to users. - - - - This guide shows you how respond to users with the official Botpress HITL integration. However, you can also use a compatible third-party integration like [Zendesk](./zendesk). - - - - - - First, let's simulate a user escalation. - - - HITL won't work in the Emulator—you'll need to test it using Webchat. - - - 1. Publish your bot and open the Webchat preview window. - 2. Chat with your bot until it begins HITL: - - ![HITL test](./assets/hitl-test.png) - - - 1. Navigate to your Dashboard, then select **Human-in-the-loop** under your bot's navigation bar. - 2. Select the conversation you just started: - - ![HITL ticket](./assets/hitl-ticket.png) - - This will open the conversation with the user. From here, you can either assign the conversation to yourself or to another member in your Workspace. - - 3. Try assigning the conversation to yourself. Select **Assign to me**: - - ![Assign HITL](./assets/hitl-assign.png) - - Now you can chat directly with the user: - - ![Respond to user with HITL](./assets/hitl-respond.png) - - - - - - Done! Now you can chat with your users directly using HITL. + For more information about assigning live agents and managing conversations, check out the [Human Handoff](/get-started/manage-your-agent/human-handoff) guide. - -## Key Features - -There are many advantages to incorporating HITL in your Workflow: - - - - The HITL Agent can seamlessly transfer conversations to a human agent when predefined conditions are met. This allows for immediate intervention in cases where the AI model detects uncertainty, user frustration, or when a high-stakes decision is required. - - - Incorporate human decision points into Workflows, allowing for human review and approval of AI-generated outputs before final actions are taken. This ensures compliance with business rules and reduces the risk of errors in critical processes. - - - The HITL Agent maintains a detailed record of all human interventions, providing transparency and accountability. This feature is essential for industries requiring regulatory compliance or quality assurance, allowing teams to review the history of human interactions with the AI. - - - Users can define specific triggers for human intervention based on various criteria, such as conversation sentiment, keyword detection, or task complexity. This ensures that human involvement is precisely targeted where it adds the most value. - - - ---- - -## Cards - - - ---- - -## Triggers - - diff --git a/integrations/integration-guides/zendesk.mdx b/integrations/integration-guides/zendesk.mdx index 9bf98fe7..21a5e425 100644 --- a/integrations/integration-guides/zendesk.mdx +++ b/integrations/integration-guides/zendesk.mdx @@ -71,7 +71,18 @@ Your Zendesk agent can continue the conversation on any messaging channel suppor 1. Open a Workflow in Studio and create (or select) a Node. 2. Add the **Start HITL** Card: - ![Start HITL](./assets/start-hitl.png) + + Start HITL Card + Start HITL Card + 3. Fill in the required fields: diff --git a/snippets/webchat/get-embed-code.mdx b/snippets/webchat/get-embed-code.mdx index 4b2eb2f8..5fc7974d 100644 --- a/snippets/webchat/get-embed-code.mdx +++ b/snippets/webchat/get-embed-code.mdx @@ -1,4 +1,4 @@ -To embed a bot on your website, you need the bot's Webchat embed code. You can get the embed code from the [Dashboard](/get-started/dashboard/): +To embed a bot on your website, you need the bot's Webchat embed code. You can get the embed code from the Dashboard: 1. Open your bot's Workspace and select the bot you want to embed. 2. In the left sidebar, go to **Webchat** > **Deploy Settings**. diff --git a/snippets/webchat/get-init-script.mdx b/snippets/webchat/get-init-script.mdx deleted file mode 100644 index 85b6e7f0..00000000 --- a/snippets/webchat/get-init-script.mdx +++ /dev/null @@ -1,40 +0,0 @@ -Navigate to either the [Studio](/studio/introduction) or the [Dashboard](/get-started/dashboard/). - - - - 1. Select **Share** in the upper-right corner. - 2. Select **Configure**, then copy the `src` URL in the **second** `script` tag: - - - Studio manual init - Studio manual init - - - - 1. Open your bot's Workspace. In the left navigation bar, find the bot you want to embed. - 2. Select **Webchat**, then open the Share tab. - 3. Copy the `src` URL in the **second** `script` tag: - - - Dashboard manual init - Dashboard manual init - - - - \ No newline at end of file diff --git a/studio/concepts/debugger-logs-json.mdx b/studio/concepts/debugger-logs-json.mdx index a688f36d..d688d443 100644 --- a/studio/concepts/debugger-logs-json.mdx +++ b/studio/concepts/debugger-logs-json.mdx @@ -63,7 +63,7 @@ The logs are displayed in reverse chronological order, with the most recent log ### Checking the Production Logs -To check the [Production Logs](/get-started/dashboard/bot/logs) (or logs from a deployed bot), go to the admin dashboard -> select your workspace and bot -> click on the **Logs** tab. This will display all the logs that have been generated by your deployed bot. +To check the [Production Logs](/get-started/manage-your-agent/inspect#logs) (or logs from a deployed bot), go to the admin dashboard -> select your workspace and bot -> click on the **Logs** tab. This will display all the logs that have been generated by your deployed bot. ## State diff --git a/studio/concepts/emulator.mdx b/studio/concepts/emulator.mdx index 5de7cc55..bab43a77 100644 --- a/studio/concepts/emulator.mdx +++ b/studio/concepts/emulator.mdx @@ -8,7 +8,7 @@ You can debug your bot conversation using the built-in Emulator in the right-sid Note -To visualize the actual user experience, use the Share button to have a hosted easily shareable version of the [Web Chat](/webchat/get-started/introduction) (this is the production bot already, conversations will be saved) or ideally test the bot in the channel you intend to deploy it on. Conversations in the Emulator won't be saved and the [bot invocations](/get-started/dashboard/workspace/usage) won't be counted against your usage quota, but AI operations will. +To visualize the actual user experience, use the Share button to have a hosted easily shareable version of the [Web Chat](/webchat/get-started/introduction) (this is the production bot already, conversations will be saved) or ideally test the bot in the channel you intend to deploy it on. Conversations in the Emulator won't be saved and the [bot invocations](/get-started/configure-your-workspace#track-usage-quotas) won't be counted against your usage quota, but AI operations will. ## Shortcuts @@ -47,7 +47,7 @@ The Emulator shows the status of the conversation and the different steps that a ### Bot events -* Conversation started: The user has started the conversation by sending a message or a [Trigger](/get-started/dashboard/bot/events) Event has been triggered. +* Conversation started: The user has started the conversation by sending a message or a [Trigger](/studio/concepts/triggers) has fired. * Conversation ended: The conversation flowed to an End node and has gone through the [Conversation End Workflow](/studio/concepts/workflows#conversation-end), or it has ended by not having possible transitions. * Error occurred: An irrecoverable error has occurred and the conversation has flowed to the [Error](/studio/concepts/workflows#error) . The error message is visible by hovering the status. * Waiting for user input: The bot is waiting for the user to send a message in order to proceed with the conversation. diff --git a/studio/concepts/knowledge-base/introduction.mdx b/studio/concepts/knowledge-base/introduction.mdx index 54b08984..2090a5c0 100644 --- a/studio/concepts/knowledge-base/introduction.mdx +++ b/studio/concepts/knowledge-base/introduction.mdx @@ -210,7 +210,7 @@ Now, your bot will activate the Transition Card whenever it doesn't find an answ ## Storage limit -Information you store in Knowledge Bases counts towards your [Vector DB Storage](/get-started/dashboard/workspace/usage#vector-db-storage), which depends on your [Botpress plan/add-ons](https://botpress.com/pricing). +Information you store in Knowledge Bases counts towards your [Vector DB Storage](/get-started/configure-your-workspace#vector-db-storage), which depends on your [Botpress plan/add-ons](https://botpress.com/pricing). --- diff --git a/studio/guides/advanced/exporting-data/analyze-llmz-responses.mdx b/studio/guides/advanced/exporting-data/analyze-llmz-responses.mdx index 120974b6..e69311d9 100644 --- a/studio/guides/advanced/exporting-data/analyze-llmz-responses.mdx +++ b/studio/guides/advanced/exporting-data/analyze-llmz-responses.mdx @@ -39,7 +39,7 @@ To set up this hook: This hook function provides access to two key parameters: -* `event`: The [Event object](/get-started/dashboard/bot/events) with details about the interaction. +* `event`: The [Event object](/studio/guides/advanced/event-properties) with details about the interaction. * `execution`: An object containing data on the LLMz execution, including details of each iteration and response content. More information on the `execution` object structure is provided [below](#the-execution-object). ## Example Code for the After LLMz Execution Hook diff --git a/studio/guides/advanced/exporting-data/exporting-raw-conversations-with-the-botpress-api.mdx b/studio/guides/advanced/exporting-data/exporting-raw-conversations-with-the-botpress-api.mdx index bfd5a760..ebe76fc1 100644 --- a/studio/guides/advanced/exporting-data/exporting-raw-conversations-with-the-botpress-api.mdx +++ b/studio/guides/advanced/exporting-data/exporting-raw-conversations-with-the-botpress-api.mdx @@ -7,7 +7,7 @@ The Botpress API allows you to access your bot's conversations from an external Note -Access the API documentation to verify the schema/structure of the [Conversations](/get-started/dashboard/bot/conversations) and the [Messages](/get-started/dashboard/bot/conversations#message) and see if the data is useful for your use case. +Access the API documentation to verify the schema/structure of the [Conversations and Messages](/get-started/manage-your-agent/monitor#conversations) and see if the data is useful for your use case. diff --git a/studio/guides/advanced/retention-period.mdx b/studio/guides/advanced/retention-period.mdx index 62980cbd..ae710d1f 100644 --- a/studio/guides/advanced/retention-period.mdx +++ b/studio/guides/advanced/retention-period.mdx @@ -7,9 +7,9 @@ The retention period for your Botpress data depends on its type: | **Data type** | **Retention period** | **Notes** | |:------------------|:----------------------|:-----------| | [Logs](/studio/concepts/debugger-logs-json#logs) | 30 days | | -| [Conversations](/get-started/dashboard/bot/conversations) | 90 days | Can be manually deleted using the [Chat API](/api-reference/chat-api/openapi/deleteConversation)| -| [Messages](/get-started/dashboard/bot/conversations) | 90 days | Can be manually deleted using the [Chat API](/api-reference/chat-api/openapi/deleteMessage)| -| [Events](/get-started/dashboard/bot/events) | 90 days | | +| [Conversations](/get-started/manage-your-agent/monitor#conversations) | 90 days | Can be manually deleted using the [Chat API](/api-reference/chat-api/openapi/deleteConversation)| +| [Messages](/get-started/manage-your-agent/monitor#conversations) | 90 days | Can be manually deleted using the [Chat API](/api-reference/chat-api/openapi/deleteMessage)| +| [Events](/get-started/manage-your-agent/inspect#events) | 90 days | | | Files | Indefinitely, unless [created with an expiry date](/api-reference/files-api/openapi/upsertFile#body-expires-at) | Can be manually deleted using the [Files API](/api-reference/files-api/openapi/deleteFile)| diff --git a/studio/guides/advanced/safety/preventing-abuse.mdx b/studio/guides/advanced/safety/preventing-abuse.mdx index 9f240982..2d039300 100644 --- a/studio/guides/advanced/safety/preventing-abuse.mdx +++ b/studio/guides/advanced/safety/preventing-abuse.mdx @@ -29,5 +29,5 @@ In summary, our abuse prevention strategy combines rate limits, WAF protection, Info -You can watch the [Usage tab](/get-started/dashboard/workspace/usage) in the Admin Dashboard to continuously verify the usage of Botpress computational resources by your bot, ensuring that it's operating within the expected limits. +You can watch the [Usage tab](/get-started/configure-your-workspace#track-usage-quotas) in the Admin Dashboard to continuously verify the usage of Botpress computational resources by your bot, ensuring that it's operating within the expected limits. diff --git a/studio/guides/how-to/send-reminders.mdx b/studio/guides/how-to/send-reminders.mdx index 8b3e8050..99f61f13 100644 --- a/studio/guides/how-to/send-reminders.mdx +++ b/studio/guides/how-to/send-reminders.mdx @@ -12,12 +12,12 @@ You can have your bot send a message to all your users' active conversations at ## Step 1: Setup your Personal Access Token -Since you need to use the Botpress API to send a reminder to all users, you need to set up a [Personal Access Token](/get-started/dashboard/workspace/user-profile#personal-access-tokens) for authentication. +Since you need to use the Botpress API to send a reminder to all users, you need to set up a Personal Access Token (PAT) for authentication. ### Create the token -1. In the bottom-left corner of the [Dashboard](/get-started/dashboard/), select your profile picture. -2. Select **Personal access tokens**, then **Generate new token.** +1. In the upper-right corner of your workspace, select your profile picture. +2. Select **Account Settings > Access Tokens > Personal access tokens** > **Generate new token.** 3. Enter a note to remember the token's purpose—like "Reminders". 4. Select **Generate Token**. 5. Copy the generated token and store it somewhere—once you leave this page, you won't be able read it again. diff --git a/studio/guides/how-to/translate.mdx b/studio/guides/how-to/translate.mdx index db2e82f4..893e8e60 100644 --- a/studio/guides/how-to/translate.mdx +++ b/studio/guides/how-to/translate.mdx @@ -17,9 +17,9 @@ If your bot is having conversations in a language other than English, you can tr Visual learner? Check out our [YouTube guide](https://www.youtube.com/watch?v=afZCpkWHZsI) on translating your bot. -## Step 1: Translate elements from Dashboard +## Step 1: Translate elements from Webchat settings -You can translate some elements of the Webchat UI directly from your bot's Webchat settings in the [Dashboard](/get-started/dashboard): +You can translate some elements of the Webchat UI directly from your bot's [Webchat settings](/webchat/get-started/configure-your-webchat): ### Name and description @@ -41,8 +41,8 @@ To translate the placeholder text in the Composer, modify the **Composer placeho Other elements of the Webchat UI need to be translated using CSS. To modify Webchat's built-in CSS classes: -1. Open your bot's Webchat settings in the [Dashboard](/get-started/dashboard). -2. Select the **Theme** tab, then scroll to the **Styles** section. +1. Open your bot's [Webchat settings](/webchat/get-started/configure-your-webchat). +2. Go to **Bot Appearance**, then scroll to the **Styles** section. 3. Copy and paste the CSS snippets below into the **Styles** section, then modify the highlighted lines as needed. diff --git a/styles.css b/styles.css index 65774f65..7e7eba79 100644 --- a/styles.css +++ b/styles.css @@ -18,12 +18,8 @@ color: light-dark(rgba(112, 26, 117), rgba(245, 208, 254)); } -.tooltip { - text-decoration-line: none !important; -} - -.bg-tooltip { - background-color: rgb(255, 0, 255); +.steps { + margin-top: 0; } .bpFab { @@ -85,6 +81,17 @@ color: light-dark(rgb(120 53 15/var(--tw-text-opacity)), rgb(253 230 138/var(--tw-text-opacity))) !important; } +[data-nav-tag="Plus"] { + background-color: light-dark(#E3EAFD, #07296A) !important; + color: light-dark(#133A9A, #7196F4) !important; +} + + +[data-nav-tag="Team"] { + background-color: light-dark(#D1FAE4, #0F4C2C) !important; + color: light-dark(#166E3F, #6AE1A1) !important; +} + @media (min-width: 768px) { .bpWebchat { /* box-shadow: none !important; */ min-width: 450px; diff --git a/webchat/get-started/configure-your-webchat.mdx b/webchat/get-started/configure-your-webchat.mdx index f3190d6d..45bf92ff 100644 --- a/webchat/get-started/configure-your-webchat.mdx +++ b/webchat/get-started/configure-your-webchat.mdx @@ -13,7 +13,7 @@ You will need: You can configure your bot in the Dashboard: -1. Navigate to the [Dashboard](/get-started/dashboard/) and open your bot's Workspace. +1. Open your Botpress workspace. 2. Select the bot you want to configure, then go to ** Webchat**. Here's a breakdown of each configuration section: @@ -233,7 +233,7 @@ This section lets you configure and preview a [proactive message bubble](/webcha This section lets you configure optional features for your bot: -- **Message feedback**: Enable/disable message feedback. When enabled, you can view feedback data in the [Analytics](/get-started/dashboard/bot/analytics) tab +- **Message feedback**: Enable/disable message feedback. When enabled, you can view feedback data in the [Analytics](/get-started/manage-your-agent/monitor#analytics) menu - **Allow file upload**: Enable/disable user file upload - **Message notification sound**: Enable sound notifications for new messages. This requires Webchat v3.3+ - **Chat history reset**: Choose whether users can continue conversations after the tab closes (local storage) or not (local storage) diff --git a/webchat/get-started/embed-in-element.mdx b/webchat/get-started/embed-in-element.mdx index 8ac3efe0..841dcd51 100644 --- a/webchat/get-started/embed-in-element.mdx +++ b/webchat/get-started/embed-in-element.mdx @@ -15,10 +15,10 @@ You can embed Webchat inside a specific HTML element on your website. This hides - First, get your Webchat element ID from the [Dashboard](/get-started/dashboard/bot/webchat): + First, get your Webchat element ID: - 1. Select your bot from your Workspace. - 2. Go to the **Webchat** section, then scroll to **Settings**. + 1. Select your bot from your workspace. + 2. Go to **Webchat > Deploy Settings**. 3. Under **Chat interface**, select **Embedded**. 4. Copy the contents of the **Element ID** field. diff --git a/webchat/interact/error-handling.mdx b/webchat/interact/error-handling.mdx index 49a1e21d..d612b919 100644 --- a/webchat/interact/error-handling.mdx +++ b/webchat/interact/error-handling.mdx @@ -108,7 +108,7 @@ When Webchat encounters an error, it displays a dedicated error screen instead o - **Cause**: Bot has been temporarily paused -- **Solution**: Check bot status in [Dashboard](/get-started/dashboard/) +- **Solution**: Check your bot's [status](/get-started/manage-your-agent/inspect) ### Quota exceeded @@ -118,7 +118,7 @@ When Webchat encounters an error, it displays a dedicated error screen instead o - **Cause**: Bot has reached usage limits -- **Solution**: Check usage quotas and limits in [Dashboard](/get-started/dashboard/bot/) +- **Solution**: Check usage quotas and limits in [Dashboard](/get-started/configure-your-workspace#manage-usage-quotas) ### Not a participant diff --git a/webchat/interact/use-custom-toggle.mdx b/webchat/interact/use-custom-toggle.mdx index 3128c1d9..e57217c0 100644 --- a/webchat/interact/use-custom-toggle.mdx +++ b/webchat/interact/use-custom-toggle.mdx @@ -18,16 +18,16 @@ You can toggle Webchat open/closed using a custom HTML element. This hides the d - First, get your Webchat element ID from the [Dashboard](/get-started/dashboard/bot/webchat): + First, get your Webchat element ID: 1. Select your bot from your Workspace. - 2. Go to the **Webchat** section, then scroll to **Settings**. - 3. Under **Button style**, select **Custom element**. - 4. Copy the contents of the **Element ID** field. + 2. Go to **Webchat > Deploy Settings**. + 3. Under **Chat Launcher**, select **Custom element**. + 4. Copy the contents of the **Element Selector** field. You can also set a custom element ID in the field. - 5. Scroll to the bottom of the page, then select **Save configuration**. + 5. Select **Publish Changes**. Next, add an element to your website's HTML. Set the `id` attribute to the ID you copied earlier: diff --git a/webchat/react-library/get-started.mdx b/webchat/react-library/get-started.mdx index c9f86741..b33ea083 100644 --- a/webchat/react-library/get-started.mdx +++ b/webchat/react-library/get-started.mdx @@ -46,8 +46,8 @@ This ID identifies your bot and enables communication with the Webchat service. To get your bot's Client ID: -1. From the [Dashboard](/get-started/dashboard/), select your bot. -2. In the left sidebar, go to **Webchat > Features**. +1. From your bot's Dashboard, select your bot. +2. In the left sidebar, go to **Webchat > Features > Advanced Settings**. 3. Select the **Advanced Settings** tab. 4. Copy the **Client ID**.