Skip to content

Commit 171745b

Browse files
authored
ENG-8219: Update some ai builder docs (#1685)
1 parent 2010b06 commit 171745b

File tree

8 files changed

+16
-90
lines changed

8 files changed

+16
-90
lines changed
484 KB
Loading
-74 KB
Loading
-9.55 KB
Loading
-20.3 KB
Loading

docs/ai_builder/features/integration_shortcut.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
Reflex Build supports powerful integrations like databases, OpenAI, and Databricks, allowing you to connect external services to your app without complex setup. These integrations help you add advanced functionality—like AI-powered features, data analytics, or persistent storage—while speeding up development.
44

5-
The **@** feature makes it easy to reference integrations directly while chatting with the AI Builder. By typing **@**, you can quickly insert integrations into your prompts without needing to configure them manually first.
5+
The **Add Integrations** button makes it easy to connect external services to your app while chatting with the AI Builder. A panel with a list of available integrations will appear, you can quickly add integrations that your app can reference and connect to.
6+
7+
Once in your app, you can access your integrations by clicking the flow or cog icon in the bottom left inside the chat area.
68

79
```python exec
810
import reflex as rx
@@ -28,22 +30,22 @@ rx.el.div(
2830

2931
## How to Use
3032

31-
1. In the AI Builder chat, type **@**.
32-
2. A **popover list** of available integrations will appear (e.g. Database, Databricks, OpenAI).
33-
3. Select an integration from the list.
34-
4. The integration will be inserted into your message as **@IntegrationName**.
35-
5. Continue typing your request, and the AI Builder will use that integration context when generating.
33+
1. In the AI Builder home, click the **Add Integrations** button. And if you're already in an app, click the flow or cog icon in the bottom left inside the chat area.
34+
2. A list of available integrations will appear (e.g. Database, Databricks, OpenAI, etc.).
35+
3. Click the Add button next to an integration to select it.
36+
4. The integration will be added to your app and becomes available for connection. Then you can fill the required fields for the integration.
37+
5. The AI Builder now knows your app has access to this integration and can generate code that uses it.
3638

3739
## What It Does
3840

39-
- **Quick Access**No need to remember integration names.
40-
- **Context-Aware**The AI Builder understands that `@Database` or `@OpenAI` refers to the actual integration.
41-
- **Faster Building**Jump directly into using integrations in your prompts.
41+
- **Quick Access**Easily browse and select from available integrations.
42+
- **Automatic Connection**Integrations are added to your app and become available for the AI to use in generated code.
43+
- **No Manual Setup**Skip complex configuration—the AI Builder handles the integration setup for you.
4244

4345
## Common Use Cases
4446

45-
- **Query Data**
46-
"Show me the top 10 users from **@Database** ordered by signup date."
47+
- **Database Queries**
48+
Show me the top 10 users ordered by signup date from my database.
4749

48-
- **Generate with AI**
49-
"Use **@OpenAI** to summarize the user feedback table."
50+
- **AI Features**
51+
Create a chat application that uses OpenAI to generate responses.

docs/ai_builder/features/interaction_modes.md

Lines changed: 0 additions & 75 deletions
This file was deleted.

docs/ai_builder/features/knowledge.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ rx.el.div(render_image())
3131

3232
## How to Add Knowledge
3333

34-
1. In the AI Builder workspace, go to the **Knowledge** section by clicking the **`@`** symbol in the bottom-left corner inside the chat area, and selecting the **Knowledge** tab. If you haven't submitted a prompt yet, you can click the **`@ Integrations`** button in the prompt area.
34+
1. In the AI Builder workspace, go to the **Knowledge** section by clicking the **`Context`** button in the bottom bar, and then on the top bar click the **`Knowledge`** tab.
3535
2. Enter your rule, guideline, or context description.
3636
3. Save the entry. The AI Builder will automatically use it when generating apps.
3737

pcweb/components/docpage/sidebar/sidebar_items/ai.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ def get_sidebar_items_ai_builder_overview():
2727
ai_builder.features.connect_to_github,
2828
ai_builder.features.knowledge,
2929
ai_builder.features.image_as_prompt,
30-
ai_builder.features.interaction_modes,
3130
ai_builder.features.automated_testing,
3231
ai_builder.features.customization,
3332
],

0 commit comments

Comments
 (0)