writinwaters
commited on
Commit
·
7336909
1
Parent(s):
6fb2244
Added descriptions of the Note and Template components (#4560)
Browse files### What problem does this PR solve?
### Type of change
- [x] Documentation Update
docs/references/agent_component_reference/generate.mdx
CHANGED
|
@@ -9,7 +9,7 @@ The component that prompts the LLM to respond appropriately.
|
|
| 9 |
|
| 10 |
---
|
| 11 |
|
| 12 |
-
|
| 13 |
|
| 14 |
## Scenarios
|
| 15 |
|
|
@@ -98,7 +98,7 @@ This feature is used for multi-turn dialogue *only*.
|
|
| 98 |
### Key (Variable)
|
| 99 |
|
| 100 |
:::danger IMPORTANT
|
| 101 |
-
A **Generate** component relies on
|
| 102 |
:::
|
| 103 |
|
| 104 |

|
|
|
|
| 9 |
|
| 10 |
---
|
| 11 |
|
| 12 |
+
A **Generate** component fine-tunes the LLM and sets its prompt.
|
| 13 |
|
| 14 |
## Scenarios
|
| 15 |
|
|
|
|
| 98 |
### Key (Variable)
|
| 99 |
|
| 100 |
:::danger IMPORTANT
|
| 101 |
+
A **Generate** component relies on keys (variables) to specify its data inputs. Its immediate upstream component is *not* necessarily its data input, and the arrows in the workflow indicate *only* the processing sequence.
|
| 102 |
:::
|
| 103 |
|
| 104 |

|
docs/references/agent_component_reference/note.mdx
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
sidebar_position: 13
|
| 3 |
+
slug: /note_component
|
| 4 |
+
---
|
| 5 |
+
|
| 6 |
+
# Interact component
|
| 7 |
+
|
| 8 |
+
The component that keeps design notes.
|
| 9 |
+
|
| 10 |
+
---
|
| 11 |
+
|
| 12 |
+
A **note** component allows you to keep design notes, including details about an agent, the output of specific components, the rationale of a particular design, or any information that may assist you, your users, or your fellow developers understand the agent.
|
| 13 |
+
|
| 14 |
+
## Examples
|
| 15 |
+
|
| 16 |
+
Explore our customer service agent template, which has five **Note** components:
|
| 17 |
+
|
| 18 |
+
1. Click the **Agent** tab at the top center of the page to access the **Agent** page.
|
| 19 |
+
2. Click **+ Create agent** on the top right of the page to open the **agent template** page.
|
| 20 |
+
3. On the **agent template** page, hover over the **Customer service** card and click **Use this template**.
|
| 21 |
+
4. Name your new agent and click **OK** to enter the workflow editor.
|
| 22 |
+
5. Click on the **note** component to add or update notes.
|
docs/references/agent_component_reference/template.mdx
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
sidebar_position: 11
|
| 3 |
+
slug: /template_component
|
| 4 |
+
---
|
| 5 |
+
|
| 6 |
+
# Template component
|
| 7 |
+
|
| 8 |
+
The component that formats user inputs or the outputs of other components.
|
| 9 |
+
|
| 10 |
+
---
|
| 11 |
+
|
| 12 |
+
A **Template** component acts as a content formatter. It is usually the upstream component of an **Interact** component.
|
| 13 |
+
|
| 14 |
+
|
| 15 |
+
## Scenarios
|
| 16 |
+
|
| 17 |
+
A **Template** component is useful for organizing various sources of data or information into specific formats.
|
| 18 |
+
|
| 19 |
+
## Configurations
|
| 20 |
+
|
| 21 |
+
### Content
|
| 22 |
+
|
| 23 |
+
Used together with Keys to organize various data or information sources into desired formats. Example:
|
| 24 |
+
|
| 25 |
+
```text
|
| 26 |
+
<h2>{subtitle}</h2>
|
| 27 |
+
<div>{content}</div>
|
| 28 |
+
```
|
| 29 |
+
|
| 30 |
+
Where `{subtitle}` and `{content}` are defined keys.
|
| 31 |
+
|
| 32 |
+
### Key
|
| 33 |
+
|
| 34 |
+
A **Template** component relies on keys (variables) to specify its data or information sources. Its immediate upstream component is *not* necessarily its input, and the arrows in the workflow indicate *only* the processing sequence.
|
| 35 |
+
|
| 36 |
+
Values of keys are categorized into two groups:
|
| 37 |
+
|
| 38 |
+
- **Component Output**: The value of the key should be a component ID.
|
| 39 |
+
- **Begin Input**: The value of the key should be the name of a global variable defined in the **Begin** component.
|
| 40 |
+
|
| 41 |
+
## Examples
|
| 42 |
+
|
| 43 |
+
Explore our research report generator agent template, where the **Template** component (component ID: **Article**) organizes user input and the outputs of the **Sections** component into HTML format:
|
| 44 |
+
|
| 45 |
+
1. Click the **Agent** tab at the top center of the page to access the **Agent** page.
|
| 46 |
+
2. Click **+ Create agent** on the top right of the page to open the **agent template** page.
|
| 47 |
+
3. On the **agent template** page, hover over the **Research report generator** card and click **Use this template**.
|
| 48 |
+
4. Name your new agent and click **OK** to enter the workflow editor.
|
| 49 |
+
5. Click on the **Template** component to display its **Configuration** window
|
web/src/locales/en.ts
CHANGED
|
@@ -1104,7 +1104,7 @@ This procedure will improve precision of retrieval by adding more information to
|
|
| 1104 |
testRun: 'Test Run',
|
| 1105 |
template: 'Template',
|
| 1106 |
templateDescription:
|
| 1107 |
-
'A component that formats the
|
| 1108 |
emailComponent: 'Email',
|
| 1109 |
emailDescription: 'Send an email to a specified address.',
|
| 1110 |
smtpServer: 'SMTP Server',
|
|
|
|
| 1104 |
testRun: 'Test Run',
|
| 1105 |
template: 'Template',
|
| 1106 |
templateDescription:
|
| 1107 |
+
'A component that formats user inputs or the outputs of other components.',
|
| 1108 |
emailComponent: 'Email',
|
| 1109 |
emailDescription: 'Send an email to a specified address.',
|
| 1110 |
smtpServer: 'SMTP Server',
|