Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added descriptions of the Note and Template components #4560

Merged
merged 3 commits into from
Jan 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/references/agent_component_reference/generate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The component that prompts the LLM to respond appropriately.

---

The **Generate** component fine-tunes the LLM and sets its prompt.
A **Generate** component fine-tunes the LLM and sets its prompt.

## Scenarios

Expand Down Expand Up @@ -98,7 +98,7 @@ This feature is used for multi-turn dialogue *only*.
### Key (Variable)

:::danger IMPORTANT
A **Generate** component relies on variables (keys) 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.
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.
:::

![variable_settings](https://github.com/user-attachments/assets/cb024c9e-264a-43ff-9ee7-8649afd571b0)
Expand Down
22 changes: 22 additions & 0 deletions docs/references/agent_component_reference/note.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
sidebar_position: 13
slug: /note_component
---

# Interact component

The component that keeps design notes.

---

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.

## Examples

Explore our customer service agent template, which has five **Note** components:

1. Click the **Agent** tab at the top center of the page to access the **Agent** page.
2. Click **+ Create agent** on the top right of the page to open the **agent template** page.
3. On the **agent template** page, hover over the **Customer service** card and click **Use this template**.
4. Name your new agent and click **OK** to enter the workflow editor.
5. Click on the **note** component to add or update notes.
49 changes: 49 additions & 0 deletions docs/references/agent_component_reference/template.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
sidebar_position: 11
slug: /template_component
---

# Template component

The component that formats user inputs or the outputs of other components.

---

A **Template** component acts as a content formatter. It is usually the upstream component of an **Interact** component.


## Scenarios

A **Template** component is useful for organizing various sources of data or information into specific formats.

## Configurations

### Content

Used together with Keys to organize various data or information sources into desired formats. Example:

```text
<h2>{subtitle}</h2>
<div>{content}</div>
```

Where `{subtitle}` and `{content}` are defined keys.

### Key

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.

Values of keys are categorized into two groups:

- **Component Output**: The value of the key should be a component ID.
- **Begin Input**: The value of the key should be the name of a global variable defined in the **Begin** component.

## Examples

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:

1. Click the **Agent** tab at the top center of the page to access the **Agent** page.
2. Click **+ Create agent** on the top right of the page to open the **agent template** page.
3. On the **agent template** page, hover over the **Research report generator** card and click **Use this template**.
4. Name your new agent and click **OK** to enter the workflow editor.
5. Click on the **Template** component to display its **Configuration** window
2 changes: 1 addition & 1 deletion web/src/locales/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1104,7 +1104,7 @@ This procedure will improve precision of retrieval by adding more information to
testRun: 'Test Run',
template: 'Template',
templateDescription:
'A component that formats the output of other components.',
'A component that formats user inputs or the outputs of other components.',
emailComponent: 'Email',
emailDescription: 'Send an email to a specified address.',
smtpServer: 'SMTP Server',
Expand Down
Loading