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 Rewrite and Switch components. To be continued #4526

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 1 commit
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
3 changes: 1 addition & 2 deletions docs/guides/agent/agent_introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,7 @@ Please review the flowing description of the RAG-specific components before you
| **Interact** | A component that serves as the interface between human and the bot, receiving user inputs and displaying the agent's responses. |
| **Categorize** | A component that uses the LLM to classify user inputs into predefined categories. Ensure you specify the name, description, and examples for each category, along with the corresponding next component. |
| **Message** | A component that sends out a static message. If multiple messages are supplied, it randomly selects one to send. Ensure its downstream is **Interact**, the interface component. |
| **Relevant** | A component that uses the LLM to assess whether the upstream output is relevant to the user's latest query. Ensure you specify the next component for each judge result. |
| **Rewrite** | A component that refines a user query if it fails to retrieve relevant information from the knowledge base. It repeats this process until the predefined looping upper limit is reached. Ensure its upstream is **Relevant** and downstream is **Retrieval**. |
| **Rewrite** | A component that edits, corrects, expands, or rewrites a user query from user-agent interaction, based on the context of previous dialogues. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LLM and only rewrite

| **Keyword** | A component that extracts keywords from a user query, with TopN specifying the number of keywords to extract. |

:::caution NOTE
Expand Down
80 changes: 80 additions & 0 deletions docs/references/agent_component_reference/rewrite.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
sidebar_position: 8
slug: /rewrite_component
---

# Rewrite component

A component that edits, corrects, expands, or rewrites a user query.

---

A **Rewrite** component edits, corrects, expands, or rewrites a user query from user-agent interaction, based on the context of previous dialogues.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From interaction component.


## Scenarios

A **Rewrite** component is essential when you need to optimize a user query based on the context of previous conversations. It is usually used in conjunction with a **Retrieval** component.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Input node of retrieval component.


See also the [Keyword](https://ragflow.io/docs/dev/keyword_component) component, a similar component used for multi-turn optimization.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A guide for multi-turn optimization, consists of retrieval / rewrite / keyword node.


## Configurations

:::tip NOTE
The **Rewrite** component uses the user-agent interaction from the **Interact** component as its data input. Therefore, there is no need to specify its data inputs in the Configurations.
:::

### Model

Click the dropdown menu of **Model** to show the model configuration window.

- **Model**: The chat model to use.
- Ensure you set the chat model correctly on the **Model providers** page.
- You can use different models for different components to increase flexibility or improve overall performance.
- **Freedom**: A shortcut to **Temperature**, **Top P**, **Presence penalty**, and **Frequency penalty** settings, indicating the freedom level of the model.
This parameter has three options:
- **Improvise**: Produces more creative responses.
- **Precise**: (Default) Produces more conservative responses.
- **Balance**: A middle ground between **Improvise** and **Precise**.
- **Temperature**: The randomness level of the model's output.
Defaults to 0.1.
- Lower values lead to more deterministic and predictable outputs.
- Higher values lead to more creative and varied outputs.
- A temperature of zero results in the same output for the same prompt.
- **Top P**: Nucleus sampling.
- Reduces the likelihood of generating repetitive or unnatural text by setting a threshold *P* and restricting the sampling to tokens with a cumulative probability exceeding *P*.
- Defaults to 0.3.
- **Presence penalty**: Encourages the model to include a more diverse range of tokens in the response.
- A higher **presence penalty** value results in the model being more likely to generate tokens not yet been included in the generated text.
- Defaults to 0.4.
- **Frequency penalty**: Discourages the model from repeating the same words or phrases too frequently in the generated text.
- A higher **frequency penalty** value results in the model being more conservative in its use of repeated tokens.
- Defaults to 0.7.
- **Max tokens**: Sets the maximum length of the model's output, measured in the number of tokens.
- Defaults to 512.
- If disabled, you lift the maximum token limit, allowing the model to determine the number of tokens in its responses.

:::tip NOTE
- It is not necessary to stick with the same model for all components. If a specific model is not performing well for a particular task, consider using a different one.
- If you are uncertain about the mechanism behind **Temperature**, **Top P**, **Presence penalty**, and **Frequency penalty**, you can simply choose one of the three options of **Freedom**.
:::


### Message window size

An integer specifying the number of previous dialogue rounds to input into the LLM. For example, if it is set to 12, the tokens from the last 12 dialogue rounds will be fed to the LLM. This feature consumes additional tokens.

Defaults to 1.

:::tip IMPORTANT
This feature is used for multi-turn dialogue *only*. If your **Categorize** component is not part of a multi-turn dialogue (i.e., it is not in a loop), leave this field as-is.
:::

## Examples

Explore our customer service agent template, where the **Rewrite** component (component ID: **Refine Question**) is used to optimize a product-specific user query based on context of previous dialogues before passing it on to the **Retrieval** component.

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 **Rewrite** component to display its **Configuration** window.
69 changes: 69 additions & 0 deletions docs/references/agent_component_reference/switch.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
sidebar_position: 9
slug: /switch_component
---

# Switch component

The component that evaluates whether specified conditions are met and applies strategies accordingly.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

route to corresponding branch


---

A **Switch** component evaluates conditions based on the output of specific components and directs the flow of execution accordingly. It allows for complex branching logic by defining cases and specifying actions for each case or default action if no conditions are met.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No action, only route to different branch


## Scenarios

A **Switch** component is essential for condition-based flow of execution. It is somewhat similar to the [Categorize](https://ragflow.io/docs/dev/categorize_component) component, which is also used for multi-pronged strategies. The difference is that it does not involve an LLM and that there is a *clearer* line between the conditions it defines.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rule based and LLM based.


## Configurations

TO BE CONTINUED.

### Input

The **Switch** component relies on input variables to specify its data inputs (queries). Click **+ Add variable** in the **Input** section to add the desired input variables. There are two types of input variables: **Reference** and **Text**.

- **Reference**: Uses a component's output or a user input as the data source. You are required to select from the dropdown menu:
- A component ID under **Component Output**, or
- A global variable under **Begin input**, which is defined in the **Begin** component.
- **Text**: Uses fixed text as the query. You are required to enter static text.

### Case n

A **Switch** component must have at least one case. This field sets the conditions and the corresponding downstream component.

#### Condition

- **Component ID**
- **Operator**
- Equals
- Not equal
- Greater than
- Greater equal
- Less than
- Less equal
- Contains
- Not contains
- Starts with
- Ends with
- Is empty
- Not empty
- **Value**

#### Next step

Specifies the downstream component of this case.

- Once you specify the ID of the downstream component, a link is established between this case and the corresponding component.
- If you manually link this category to a downstream component on the canvas, the ID of that component is auto-populated.


### ELSE

Optional

## Frequently asked questions

### Where to specify the data inputs for this component?

The **Switch** component evaluates only whether specific conditions are met and directs the flow of execution accordingly. It does not accept data input, so there is no need to specify data inputs.
4 changes: 2 additions & 2 deletions web/src/locales/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -751,7 +751,7 @@ This procedure will improve precision of retrieval by adding more information to
generateDescription: `A component that prompts the LLM to generate responses. Ensure the prompt is set correctly.`,
categorizeDescription: `A component that uses the LLM to classify user inputs into predefined categories. Ensure you specify the name, description, and examples for each category, along with the corresponding next component.`,
relevantDescription: `A component that uses the LLM to assess whether the upstream output is relevant to the user's latest query. Ensure you specify the next component for each judge result.`,
rewriteQuestionDescription: `A component that refines a user query if it fails to retrieve relevant information from the knowledge base. It repeats this process until the predefined looping upper limit is reached.`,
rewriteQuestionDescription: `A component that edits, corrects, expands, or rewrites a user query from user-agent interaction, based on the context of previous dialogues.`,
messageDescription:
"A component that sends out a static message. If multiple messages are supplied, it randomly selects one to send. Ensure its downstream is 'Interact', the interface component.",
keywordDescription: `A component that retrieves top N search results from user's input. Ensure the TopN value is set properly before use.`,
Expand Down Expand Up @@ -1103,7 +1103,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 another component.',
'A component that formats the output of other components.',
emailComponent: 'Email',
emailDescription: 'Send an email to a specified address.',
smtpServer: 'SMTP Server',
Expand Down