Skip to content

Commit b90be0c

Browse files
authored
Merge branch 'main' into feat/skills
2 parents aeb8b04 + af693b5 commit b90be0c

12 files changed

Lines changed: 307 additions & 329 deletions

File tree

content/workspace/analysts/ai-features/copilot-context.md

Lines changed: 72 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -24,32 +24,54 @@ The agent prioritizes context in the following order:
2424

2525
| Priority | Context Type | Description |
2626
|---|---|---|
27-
| 1 | Explicit | Widgets added to context specifically. |
28-
| 2 | MCP tool | Active MCP tools connected to the Copilot |
29-
| 3 | Attached files | Files uploaded directly to the Copilot |
30-
| 4 | Dashboard | All widgets currently on your dashboard (in all tabs). |
31-
| 5 | Conversation | The history of your current conversation. |
32-
| 6 | Global | All widgets available within the OpenBB Workspace. If Global Data enabled. |
33-
| 7 | Web search | Retrieve infromation from the web. If Web Search enabled. |
27+
| 1 | Explicit | Widgets, skills, or MCP tools mentioned explicitly. |
28+
| 2 | Skill | Skills added under AI Library. |
29+
| 3 | MCP tool | Active MCP tools connected to the Copilot. |
30+
| 4 | Attached files | Files uploaded directly to the Copilot. |
31+
| 5 | Dashboard | All widgets currently on your dashboard (in all tabs). |
32+
| 6 | Conversation | The history of your current conversation. |
33+
| 7 | Global | All widgets available within the OpenBB Workspace, if Global Data is enabled. |
34+
| 8 | Web search | Retrieve information from the web, if Web Search is enabled. |
3435

3536
## Context Types
3637

3738
### Explicit Context
3839

39-
Explicit context represents the highest priority information source, allowing you to precisely direct the Copilot's attention to specific datasets or widgets. This mechanism is particularly powerful for ensuring accuracy when working with multiple similar datasets or when you need analysis focused on a specific dataset.
40+
Explicit context represents the highest priority information source, allowing you to precisely direct the Copilot's attention to specific datasets. This mechanism is particularly powerful for ensuring accuracy when working with multiple similar datasets or when you need analysis focused on a specific dataset.
4041

41-
When you click on the "Add to context" button on any widget you're creating a direct reference that the Copilot will prioritize above all other available information. After sending the prompt, that widget will remain in context.
42+
When you add any of the following explicit context types (widgets, skills, or MCP tools), Copilot prioritizes them above all other available information. After sending the prompt, the context remains active.
43+
44+
#### 1. Skills
45+
46+
When tagging a skill with the syntax `/skill:skill-name`, you are adding it explicitly to context.
4247

4348
<div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
4449
<img
4550
className="pro-border-gradient"
4651
alt="Explicit context"
47-
src="https://openbb-cms.directus.app/assets/24947294-2053-4efc-a68b-7ec90bf9875c.png"
52+
src="https://openbb-cms.directus.app/assets/e6ba8c6c-9b80-461a-afb1-edfc16675134.png"
4853
width="100%"
4954
/>
5055
</div>
5156

52-
When you use the "@" symbol followed by a widget name and the prompt is sent, the widget will disappear from context. This is meant to be a quick tag reference.
57+
58+
#### 2. MCP Tools
59+
60+
Similar to skills, MCP tools can be added to context using the `/` command. This displays a list of all available tools, allowing you to select exactly which one to trigger.
61+
62+
<div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
63+
<img
64+
className="pro-border-gradient"
65+
alt="Explicit context"
66+
src="https://openbb-cms.directus.app/assets/7424cad9-9bd0-4c76-944e-1231126e1a62.png"
67+
width="60%"
68+
/>
69+
</div>
70+
71+
72+
#### 3. Widgets
73+
74+
Click the "Add to context" button on any widget to create a direct reference that Copilot prioritizes. Alternatively, use the "@" symbol followed by a widget name for a quick tag reference. Once the prompt is sent, the widget is removed from context.
5375

5476
<div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
5577
<img
@@ -60,21 +82,36 @@ When you use the "@" symbol followed by a widget name and the prompt is sent, th
6082
/>
6183
</div>
6284

85+
86+
### Skills
87+
Skills added under AI Library are prioritized next. Skills are reusable instruction sets that extend what the OpenBB Copilot can do. This is particularly useful when you want to create custom workflows. Even if you don't explicitly tag a skill, the Copilot will try to match one of the available skills to your request when relevant.
88+
89+
<div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
90+
<img
91+
className="pro-border-gradient"
92+
alt="Skills overview"
93+
src="https://openbb-cms.directus.app/assets/b746c198-d732-4c01-8a31-18db1da89d17.png"
94+
width="100%"
95+
/>
96+
</div>
97+
98+
To see all available skills, navigate to the "Skills" tab under AI Library. An example skill called `openbb-html-report` is included by default. To add your own custom skill, see the [Skills](/workspace/analysts/ai-features/skills) page.
99+
63100
### MCP Tools
64101

65-
The second highest priority is active MCP tools connected to OpenBB Workspace. For more details, see the MCP tools documentation [here](/workspace/analysts/ai-features/mcp-tools).
102+
Active MCP tools connected to OpenBB Workspace are the next priority level. For more details, see the MCP tools documentation [here](/workspace/analysts/ai-features/mcp-tools).
66103

67-
Depending on your use case, MCP tools offer a powerful way to connect to third-party data providers or specialized financial tools using a standardized protocol. This would eliminate the need for custom development inside OpenBB Workspace.
104+
Depending on your use case, MCP tools offer a powerful way to connect to third-party data providers or specialized financial tools using a standardized protocol. This eliminates the need for custom development inside OpenBB Workspace.
68105

69-
To use MCP tools, make sure to configure it (see how to do it [here](/workspace/analysts/ai-features/mcp-tools#configure-your-mcp-servers), and then select all the desired MCP tools.
106+
To use MCP tools, first configure your servers (see [MCP Tools configuration](/workspace/analysts/ai-features/mcp-tools#configure-your-mcp-servers)), then select the desired tools.
70107

71108

72109
<div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
73110
<img
74111
className="pro-border-gradient"
75-
alt="Attached files"
112+
alt="MCP tools"
76113
src="https://openbb-cms.directus.app/assets/31809471-52b2-4dcb-a5f0-9276def2ae29.png"
77-
width="60%"
114+
width="100%"
78115
/>
79116
</div>
80117

@@ -83,9 +120,9 @@ When enabled, Copilot gains access to all active MCP tools. You can also explici
83120
<div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
84121
<img
85122
className="pro-border-gradient"
86-
alt="Attached files"
123+
alt="MCP tools"
87124
src="https://openbb-cms.directus.app/assets/0a77e58a-6c9f-4cc8-8983-ec8668ecc1c6.png"
88-
width="60%"
125+
width="100%"
89126
/>
90127
</div>
91128

@@ -109,13 +146,13 @@ Please note that for PDF files, text must be selectable as Optical Character Rec
109146

110147
### Dashboard Context
111148

112-
The dashboard context provides the Copilot with comprehensive awareness of your currently active dashboard. All widgets on your active dashboard become automatically available as data sources, allowing the Copilot to understand the broader context of your work session. It also has access to the widgets metadata and the current parameters selected.
149+
The dashboard context provides the Copilot with comprehensive awareness of your currently active dashboard. All widgets on your active dashboard become automatically available as data sources, allowing the Copilot to understand the broader context of your work session. It also has access to each widget's metadata and the currently selected parameters.
113150

114151
<div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
115152
<img
116153
className="pro-border-gradient"
117154
alt="Dashboard context"
118-
src="https://openbb-cms.directus.app/assets/2fc343e5-6eb2-4ef6-ba10-f687868bdff4.png"
155+
src="https://openbb-cms.directus.app/assets/e0c36999-e186-4ed9-87c7-9f47a50c2d34.png"
119156
width="100%"
120157
/>
121158
</div>
@@ -126,7 +163,7 @@ Conversational context enables natural, iterative analysis by maintaining awaren
126163

127164
The Copilot tracks your explicit questions and its responses. This memory allows for follow-up queries, refinement of analysis parameters, and building upon previous insights without needing to re-establish context.
128165

129-
The system understands references to "the previous chart", "that analysis", or "the data we discussed" and can seamlessly continue complex analytical workflows across multiple conversation turns.
166+
The Copilot understands references to "the previous chart", "that analysis", or "the data we discussed" and can seamlessly continue complex analytical workflows across multiple conversation turns.
130167

131168
<div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
132169
<img
@@ -137,9 +174,9 @@ The system understands references to "the previous chart", "that analysis", or "
137174
/>
138175
</div>
139176

140-
### Global Retrieval (ON/OFF flag)
177+
### Global Data (ON/OFF flag)
141178

142-
The global retrieval system provides the Copilot with access to the entire OpenBB Workspace widget library, extending far beyond your current dashboard widgets.
179+
The Global Data provides the Copilot with access to the entire OpenBB Workspace widget library, extending far beyond your current dashboard widgets.
143180

144181
When your current dashboard doesn't contain the specific data or analysis tool needed to answer a query, the Copilot can automatically identify and utilize the appropriate widgets from the entire widget library, effectively expanding your analytical capabilities on-demand without manual widget selection.
145182

@@ -149,25 +186,34 @@ This is only possible due to the metadata associated with each widget and is why
149186
<img
150187
className="pro-border-gradient"
151188
alt="Global retrieval"
152-
src="https://openbb-cms.directus.app/assets/f5661493-50ec-45c0-931a-8abd70d3bc9a.png"
189+
src="https://openbb-cms.directus.app/assets/97a9f197-2c91-4135-820b-7135eae6fad0.png"
153190
width="60%"
154191
/>
155192
</div>
156193

157194
### Web Search (ON/OFF flag)
158195

196+
<div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
197+
<img
198+
className="pro-border-gradient"
199+
alt="Web search"
200+
src="https://openbb-cms.directus.app/assets/339579b3-5ff6-456c-b4a5-2721096fbd5e.png"
201+
width="60%"
202+
/>
203+
</div>
204+
159205
The web search capability enables the Copilot to access real-time information from across the internet when:
160206

161207
- The available workspace data is insufficient to fully answer your query.
162-
- The user asks to look for the information on the web.
208+
- You ask to look for information on the web.
163209

164210
This feature automatically activates as a fallback mechanism, ensuring comprehensive responses even when dealing with breaking news, recent market developments, or information not available in your current workspace widgets.
165211

166212
<div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
167213
<img
168214
className="pro-border-gradient"
169215
alt="Web search"
170-
src="https://openbb-cms.directus.app/assets/3dffe668-2114-4c4c-b822-395da193f2a0.png"
216+
src="https://openbb-cms.directus.app/assets/17c4c6da-13f7-49db-8f20-82204abc7c21.png"
171217
width="100%"
172218
/>
173219
</div>
Lines changed: 49 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
---
2-
title: Generative UI (Beta)
2+
title: Generative UI
33
sidebar_position: 13
44
description: Understanding the Generative UI capabilities in OpenBB Copilot
55
keywords:
66
- generative ui
77
- widgets
88
- dynamic creation
99
- widget parameters
10-
- beta features
10+
- dashboard manipulation
1111
---
1212

1313
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
1414

15-
<HeadTitle title="Generative UI (Beta) | OpenBB Workspace Docs" />
15+
<HeadTitle title="Generative UI | OpenBB Workspace Docs" />
1616

17-
When this feature is turned ON, copilot can manipulate widgets on the dashboard.
17+
When Generative UI is enabled, the copilot can manipulate widgets directly on your dashboard.
1818

1919
## Update widget parameters
2020

21-
The system understands the parameter schemas of each widget and based on a user prompt it can automatically update the parameters used in widgets on the dashboard.
21+
The copilot understands the parameter schemas of each widget and, based on your prompt, can automatically update the parameters across widgets on the dashboard.
2222

2323
<div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
2424
<img
@@ -31,20 +31,20 @@ The system understands the parameter schemas of each widget and based on a user
3131

3232
## Add widgets from Global Data
3333

34-
If global data is turned on, and the user asks information that the copilot believes exists in one of the widgets in the widget library - then that widget gets automatically added to the dashboard.
34+
If Global Data is enabled and you ask for information that the copilot finds in the widget library, the matching widget is automatically added to your dashboard.
3535

3636
<div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
3737
<img
3838
className="pro-border-gradient"
3939
alt="Widget parameters"
40-
src="https://openbb-cms.directus.app/assets/b5798412-cba3-4deb-898c-dde7ccd636c1.png"
40+
src="https://openbb-cms.directus.app/assets/5e641714-20a7-4830-a82f-158a85259ec1.png"
4141
width="100%"
4242
/>
4343
</div>
4444

4545
## Add markdown note widget
4646

47-
The copilot can also add any type of text into a markdown widget automatically on-the-fly.
47+
The copilot can also add text content as a markdown note widget directly on your dashboard.
4848

4949
<div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
5050
<img
@@ -55,4 +55,44 @@ The copilot can also add any type of text into a markdown widget automatically o
5555
/>
5656
</div>
5757

58-
Support to add static artifacts (tables or charts) on-the-fly is still not supported.
58+
## Add and edit navigation bar
59+
60+
The copilot can add navigation bars to your dashboard, allowing you to organize widgets into separate tabs for a cleaner and more structured layout.
61+
62+
<div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
63+
<img
64+
className="pro-border-gradient"
65+
alt="Add navigation bar"
66+
src="https://openbb-cms.directus.app/assets/8939c838-c5b7-45e4-b543-c01e72a996cc.png"
67+
width="100%"
68+
/>
69+
</div>
70+
71+
72+
Beyond adding new tabs, you can also use this feature to edit existing tab names within the navigation bar.
73+
74+
<div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
75+
<img
76+
className="pro-border-gradient"
77+
alt="Add navigation bar"
78+
src="https://openbb-cms.directus.app/assets/b1acef02-c5e9-4275-8ee1-3de702165ebf.png"
79+
width="100%"
80+
/>
81+
</div>
82+
83+
As shown in the examples above, all of these actions can be performed across multiple widgets, navigation bars, or parameters at once. For example, you can ask the copilot to add multiple navigation tabs, each containing a different set of widgets, saving you from making one change at a time.
84+
85+
86+
## Create widgets on the fly
87+
88+
The copilot can take its own outputs, such as tables, charts, or markdown notes, and turn them directly into widgets on your dashboard. Instead of copying results manually, the Generative UI feature adds the copilot's response as a fully interactive widget that lives alongside the rest of your data.
89+
90+
<div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
91+
<img
92+
className="pro-border-gradient"
93+
alt="Create widget on the fly"
94+
src="https://openbb-cms.directus.app/assets/a8a40db3-2f11-48d1-a050-6be35bddb9c0.png"
95+
width="100%"
96+
/>
97+
</div>
98+

0 commit comments

Comments
 (0)