Added descriptions of Rewrite and Switch components. To be continued #4526
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
KevinHuSh
approved these changes
Jan 17, 2025
JinHai-CN
reviewed
Jan 17, 2025
| @@ -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. | | |||
JinHai-CN
reviewed
Jan 17, 2025
|
|
||
| --- | ||
|
|
||
| A **Rewrite** component edits, corrects, expands, or rewrites a user query from user-agent interaction, based on the context of previous dialogues. |
There was a problem hiding this comment.
From interaction component.
JinHai-CN
reviewed
Jan 17, 2025
|
|
||
| ## 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. |
There was a problem hiding this comment.
Input node of retrieval component.
JinHai-CN
reviewed
Jan 17, 2025
|
|
||
| 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. | ||
|
|
||
| See also the [Keyword](https://ragflow.io/docs/dev/keyword_component) component, a similar component used for multi-turn optimization. |
There was a problem hiding this comment.
A guide for multi-turn optimization, consists of retrieval / rewrite / keyword node.
JinHai-CN
reviewed
Jan 17, 2025
|
|
||
| # Switch component | ||
|
|
||
| The component that evaluates whether specified conditions are met and applies strategies accordingly. |
There was a problem hiding this comment.
route to corresponding branch
JinHai-CN
reviewed
Jan 17, 2025
|
|
||
| --- | ||
|
|
||
| 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. |
There was a problem hiding this comment.
No action, only route to different branch
JinHai-CN
reviewed
Jan 17, 2025
|
|
||
| ## 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. |
There was a problem hiding this comment.
Rule based and LLM based.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What problem does this PR solve?
Type of change