Skip to content

Commit b3ff9a6

Browse files
Add info on Box Hubs AI Chat
1 parent fd6008a commit b3ff9a6

File tree

2 files changed

+51
-5
lines changed

2 files changed

+51
-5
lines changed

.spelling

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,7 @@ invocable
300300
analytics
301301
ClientID
302302
chatbot
303+
chatbots
303304
OAuth2
304305
LLMs
305306
npm

content/guides/embed/box-embed.md

Lines changed: 50 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ alias_paths:
1111
# Box Embed
1212

1313
Box Embed is a HTML-based framework that allows embedding the entire
14-
Box Web App experience in a custom-made application. Box Embed provides the ability to upload, search, comment, share, tag, and edit files using Box Edit.
14+
Box Web App experience in a custom-made application. Box Embed provides the ability to upload, search, comment, share, tag, and edit files using Box Edit. You can also embed Box Hubs AI Chat for a focused chatbot experience.
1515

1616
## Before you start
1717

@@ -33,9 +33,13 @@ To fetch the Box Embed widget code from the Box web app, perform the following s
3333
### Hubs
3434

3535
1. Navigate to the chosen Hub.
36-
2. Click on the ellipsis menu in the top right corner.
36+
2. Click on the ellipsis menu in the upper-right corner.
3737
3. Click **Embed Hub**.
3838

39+
<Message type='notice'>
40+
You can also embed only the AI chat interface from a Box Hub. Users can ask questions and get AI-powered answers based on the hub's files, without accessing navigation or file browsing features. For more information, see the [Box Hubs AI Chat embedding][6] section.
41+
</Message>
42+
3943
### Notes
4044

4145
1. Navigate to the chosen Box Note.
@@ -54,9 +58,14 @@ To fetch the Box Embed widget code from the Box web app, perform the following s
5458

5559
In the next step, configure the parameters of an embeddable element.
5660

57-
| Files | Folders | Hubs | Notes | Apps |
58-
|----------|----------|------------------------| --- | --- |
59-
| Size of the widget.| Size of the widget, sorting of the files in a folder, hiding the navigation path and sidebar. | Size of the widget, hiding the parent navigation path and sidebar. | Size of the widget, skipping cloud game (results in note being in read only mode), hiding notes navigation. | Size of the widget. |
61+
| Element Type | Configuration Options |
62+
|--------------|----------------------|
63+
| Files | Size of the widget. |
64+
| Folders | Size of the widget, sorting of the files in a folder, hiding the navigation path and sidebar. |
65+
| Hubs | Size of the widget, hiding the parent navigation path and sidebar. |
66+
| Hubs AI Chat | Chat mode: button or widget. |
67+
| Notes | Size of the widget, skipping cloud game (results in note being in read only mode), hiding notes navigation. |
68+
| Apps | Size of the widget. |
6069

6170
<ImageFrame border>
6271
![Box Embed Configuration](./embed-configuration.png)
@@ -161,6 +170,41 @@ within an `<iframe>`:
161170
* `oallowfullscreen`
162171
* `msallowfullscreen`
163172

173+
## Box Hubs AI Chat embedding
174+
175+
In addition to embedding the complete Box Hub experience, you can embed only the AI-powered chat interface. This mode provides a focused chatbot experience powered by the files within a specific hub, without navigation or content browsing options.
176+
177+
### Prerequisites
178+
179+
To embed a hub in AI Chat mode:
180+
181+
* The hub must have Box AI enabled.
182+
* Users must be authenticated to interact with the chatbot.
183+
* Users need at least Viewer [permissions][5] on the hub.
184+
185+
### Creating an AI Chat embed
186+
187+
1. Navigate to the hub that will serve as the knowledge source for the AI Chat.
188+
2. Click the ellipsis menu in the upper-right corner.
189+
3. Click **Embed Hub**.
190+
4. Select the **Hub AI Chat** tab.
191+
5. Select chat mode:
192+
193+
* **Chat button**: The AI chat widget opens after the user clicks the button.
194+
* **Chat widget**: The AI chat widget is embedded directly on page load.
195+
196+
6. Copy the embed code.
197+
198+
### Parameters
199+
200+
The AI Chat embed mode supports the following URL parameters:
201+
202+
| Parameter | Description |
203+
|-----------|-------------|
204+
| `hub-id` | The ID of the hub that powers the chatbot. |
205+
| `custom-box-domain` | For Box instances with custom domains. |
206+
| `button-text` | Custom text to display on the chat button (chat button mode only). |
207+
164208
## Expiring embed links
165209

166210
For files, another option is to call the [`GET /files/:id`][1]
@@ -278,3 +322,4 @@ and **print** options might not show in mobile browsers.
278322
[4]: e://put-folders-id--add-shared-link
279323
[5]: https://support.box.com/hc/en-us/articles/360044196413-Understanding-Collaborator-Permission-Levels
280324
[cloud-game]: https://support.box.com/hc/en-us/articles/360043691034-How-Does-Box-Prevent-Clickjacking
325+
[6]: g://embed/box-embed/#box-hubs-ai-chat-embedding

0 commit comments

Comments
 (0)