diff --git a/docs/references/agent_component_reference/_category_.json b/docs/guides/agent/agent_component_reference/_category_.json similarity index 89% rename from docs/references/agent_component_reference/_category_.json rename to docs/guides/agent/agent_component_reference/_category_.json index e497bd0ba..7548ec803 100644 --- a/docs/references/agent_component_reference/_category_.json +++ b/docs/guides/agent/agent_component_reference/_category_.json @@ -1,6 +1,6 @@ { "label": "Agent Components", - "position": 3, + "position": 20, "link": { "type": "generated-index", "description": "A complete reference for RAGFlow's agent components." diff --git a/docs/references/agent_component_reference/begin.mdx b/docs/guides/agent/agent_component_reference/begin.mdx similarity index 100% rename from docs/references/agent_component_reference/begin.mdx rename to docs/guides/agent/agent_component_reference/begin.mdx diff --git a/docs/references/agent_component_reference/categorize.mdx b/docs/guides/agent/agent_component_reference/categorize.mdx similarity index 100% rename from docs/references/agent_component_reference/categorize.mdx rename to docs/guides/agent/agent_component_reference/categorize.mdx diff --git a/docs/references/agent_component_reference/concentrator.mdx b/docs/guides/agent/agent_component_reference/concentrator.mdx similarity index 100% rename from docs/references/agent_component_reference/concentrator.mdx rename to docs/guides/agent/agent_component_reference/concentrator.mdx diff --git a/docs/references/agent_component_reference/generate.mdx b/docs/guides/agent/agent_component_reference/generate.mdx similarity index 94% rename from docs/references/agent_component_reference/generate.mdx rename to docs/guides/agent/agent_component_reference/generate.mdx index 7656b00a2..f45c76f9d 100644 --- a/docs/references/agent_component_reference/generate.mdx +++ b/docs/guides/agent/agent_component_reference/generate.mdx @@ -76,6 +76,15 @@ When writing suggestions, pay attention to whether there are ways to improve the Where `{source_text}` and `{target_lang}` are global variables defined by the **Begin** component, while `{translation_1}` is the output of another **Generate** component with the component ID **Translate directly**. + +:::danger IMPORTANT +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) + +Keys in a **Generate** component are used in conjunction with the system prompt to specify data inputs for the LLM. Use a forward slash `/` to show the keys to use. + ### Cite This toggle sets whether to cite the original text as reference. @@ -95,19 +104,6 @@ This feature is used for multi-turn dialogue *only*. ::: -### Key (Variable) - -:::danger IMPORTANT -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) - -Keys in a **Generate** component are used in conjunction with the system prompt to specify data inputs for the LLM. As shown in the above screenshot, the values 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 You can explore our three-step interpreter agent template, where a **Generate** component (component ID: **Reflect**) takes three global variables: diff --git a/docs/references/agent_component_reference/interact.mdx b/docs/guides/agent/agent_component_reference/interact.mdx similarity index 100% rename from docs/references/agent_component_reference/interact.mdx rename to docs/guides/agent/agent_component_reference/interact.mdx diff --git a/docs/references/agent_component_reference/iteration.mdx b/docs/guides/agent/agent_component_reference/iteration.mdx similarity index 100% rename from docs/references/agent_component_reference/iteration.mdx rename to docs/guides/agent/agent_component_reference/iteration.mdx diff --git a/docs/references/agent_component_reference/keyword.mdx b/docs/guides/agent/agent_component_reference/keyword.mdx similarity index 100% rename from docs/references/agent_component_reference/keyword.mdx rename to docs/guides/agent/agent_component_reference/keyword.mdx diff --git a/docs/references/agent_component_reference/message.mdx b/docs/guides/agent/agent_component_reference/message.mdx similarity index 100% rename from docs/references/agent_component_reference/message.mdx rename to docs/guides/agent/agent_component_reference/message.mdx diff --git a/docs/references/agent_component_reference/note.mdx b/docs/guides/agent/agent_component_reference/note.mdx similarity index 100% rename from docs/references/agent_component_reference/note.mdx rename to docs/guides/agent/agent_component_reference/note.mdx diff --git a/docs/references/agent_component_reference/retrieval.mdx b/docs/guides/agent/agent_component_reference/retrieval.mdx similarity index 100% rename from docs/references/agent_component_reference/retrieval.mdx rename to docs/guides/agent/agent_component_reference/retrieval.mdx diff --git a/docs/references/agent_component_reference/rewrite.mdx b/docs/guides/agent/agent_component_reference/rewrite.mdx similarity index 97% rename from docs/references/agent_component_reference/rewrite.mdx rename to docs/guides/agent/agent_component_reference/rewrite.mdx index 27c9a8e03..b89c5a9a7 100644 --- a/docs/references/agent_component_reference/rewrite.mdx +++ b/docs/guides/agent/agent_component_reference/rewrite.mdx @@ -16,7 +16,7 @@ A **Rewrite** component uses a specified LLM to rewrite a user query from the ** A **Rewrite** component is essential when you need to optimize a user query based on the context of previous conversations. It is usually the upstream component of a **Retrieval** component. :::tip NOTE -See also the [Keyword](https://ragflow.io/docs/dev/keyword_component) component, a similar component used for multi-turn optimization. +See also the [Keyword](./keyword.mdx) component, a similar component used for multi-turn optimization. ::: ## Configurations diff --git a/docs/references/agent_component_reference/switch.mdx b/docs/guides/agent/agent_component_reference/switch.mdx similarity index 88% rename from docs/references/agent_component_reference/switch.mdx rename to docs/guides/agent/agent_component_reference/switch.mdx index 085f35bf0..7f81e99db 100644 --- a/docs/references/agent_component_reference/switch.mdx +++ b/docs/guides/agent/agent_component_reference/switch.mdx @@ -13,7 +13,7 @@ A **Switch** component evaluates conditions based on the output of specific comp ## Scenarios -A **Switch** component is essential for condition-based direction of execution flow. While it shares similarities with the [Categorize](https://ragflow.io/docs/dev/categorize_component) component, which is also used in multi-pronged strategies, the key distinction lies in their approach: the evaluation of the **Switch** component is rule-based, whereas the **Categorize** component involves AI and uses an LLM for decision-making. +A **Switch** component is essential for condition-based direction of execution flow. While it shares similarities with the [Categorize](./categorize.mdx) component, which is also used in multi-pronged strategies, the key distinction lies in their approach: the evaluation of the **Switch** component is rule-based, whereas the **Categorize** component involves AI and uses an LLM for decision-making. ## Configurations diff --git a/docs/references/agent_component_reference/template.mdx b/docs/guides/agent/agent_component_reference/template.mdx similarity index 100% rename from docs/references/agent_component_reference/template.mdx rename to docs/guides/agent/agent_component_reference/template.mdx diff --git a/docs/release_notes.md b/docs/release_notes.md index 746ca38b3..b99800e75 100644 --- a/docs/release_notes.md +++ b/docs/release_notes.md @@ -15,7 +15,7 @@ Released on February 6, 2025. - Supports DeepSeek R1 and DeepSeek V3. - GraphRAG refactor: Knowledge graph is dynamically built on an entire knowledge base (dataset) rather than on an individual file, and automatically updated when a newly uploaded file starts parsing. See [here](https://ragflow.io/docs/dev/construct_knowledge_graph). -- Adds an **Iteration** agent component and a **Research report generator** agent template. See [here](./references/agent_component_reference/iteration.mdx). +- Adds an **Iteration** agent component and a **Research report generator** agent template. See [here](./guides/agent/agent_component_reference/iteration.mdx). - New UI language: Portuguese. - Allows setting metadata for a specific file in a knowledge base to enhance AI-powered chats. See [here](./guides/configure_knowledge_base/set_metadata.md). - Upgrades RAGFlow's document engine [Infinity](https://github.com/infiniflow/infinity) to v0.6.0.dev3. @@ -32,19 +32,19 @@ The **Tag knowledge base** feature is *unavailable* on the [Infinity](https://gi - [Construct knowledge graph](./guides/configure_knowledge_base/construct_knowledge_graph.md) - [Set metadata](./guides/configure_knowledge_base/set_metadata.md) -- [Begin component](./references/agent_component_reference/begin.mdx) -- [Generate component](./references/agent_component_reference/generate.mdx) -- [Interact component](./references/agent_component_reference/interact.mdx) -- [Retrieval component](./references/agent_component_reference/retrieval.mdx) -- [Categorize component](./references/agent_component_reference/categorize.mdx) -- [Keyword component](./references/agent_component_reference/keyword.mdx) -- [Message component](./references/agent_component_reference/message.mdx) -- [Rewrite component](./references/agent_component_reference/rewrite.mdx) -- [Switch component](./references/agent_component_reference/switch.mdx) -- [Concentrator component](./references/agent_component_reference/concentrator.mdx) -- [Template component](./references/agent_component_reference/template.mdx) -- [Iteration component](./references/agent_component_reference/iteration.mdx) -- [Note component](./references/agent_component_reference/note.mdx) +- [Begin component](./guides/agent/agent_component_reference/begin.mdx) +- [Generate component](./guides/agent/agent_component_reference/generate.mdx) +- [Interact component](./guides/agent/agent_component_reference/interact.mdx) +- [Retrieval component](./guides/agent/agent_component_reference/retrieval.mdx) +- [Categorize component](./guides/agent/agent_component_reference/categorize.mdx) +- [Keyword component](./guides/agent/agent_component_reference/keyword.mdx) +- [Message component](./guides/agent/agent_component_reference/message.mdx) +- [Rewrite component](./guides/agent/agent_component_reference/rewrite.mdx) +- [Switch component](./guides/agent/agent_component_reference/switch.mdx) +- [Concentrator component](./guides/agent/agent_component_reference/concentrator.mdx) +- [Template component](./guides/agent/agent_component_reference/template.mdx) +- [Iteration component](./guides/agent/agent_component_reference/iteration.mdx) +- [Note component](./guides/agent/agent_component_reference/note.mdx) ## v0.15.1