Updated outdated descriptions and added multi-turn optimization (#4362)

### What problem does this PR solve?

_Briefly describe what this PR aims to solve. Include background context
that will help reviewers understand the purpose of the PR._

### Type of change

- [x] Documentation Update
This commit is contained in:
writinwaters
2025-01-06 16:54:22 +08:00
committed by GitHub
parent b93c136797
commit 45619702ff
7 changed files with 48 additions and 12 deletions

View File

@ -1,5 +1,5 @@
{
"label": "Agent Component Reference",
"label": "Agent Components",
"position": 3,
"link": {
"type": "generated-index",

View File

@ -29,7 +29,7 @@ An opening greeting is the agent's first message to the user. It can be a welcom
### Global variables
You can set global variables within the **Begin** component, which can be either required or optional. Once established, users will need to provide values for these variables when interacting or with the agent. Click **+ Add variable** to add a global variable, each with the following attributes:
You can set global variables within the **Begin** component, which can be either required or optional. Once established, users will need to provide values for these variables when interacting or chatting with the agent. Click **+ Add variable** to add a global variable, each with the following attributes:
- **Key**: *Required*
The unique variable name.
@ -41,7 +41,7 @@ You can set global variables within the **Begin** component, which can be either
- **line**: Accepts a single line of text without line breaks.
- **paragraph**: Accepts multiple lines of text, including line breaks.
- **options**: Requires the user to select a value for this variable from a dropdown menu. And you are required to set *at least* one option for the dropdown menu.
- **file**: Requires the user to upload a file from their device.
- **file**: Requires the user to upload one or multiple files from their device.
- **integer**: Accepts an integer as input.
- **boolean**: Requires the user to toggle between on and off.
- **Optional**: A toggle indicating whether the variable is optional.

View File

@ -81,9 +81,13 @@ No, this feature is not supported.
---
### Do you support multiple rounds of dialogues, i.e., referencing previous dialogues as context for the current dialogue?
### Do you support multiple rounds of dialogues, referencing previous dialogues as context for the current query?
This feature and the related APIs are still in development. Contributions are welcome.
Yes, we support enhancing user queries based on existing context of an ongoing conversation:
1. On the **Chat** page, hover over the desired assistant and select **Edit**.
2. In the **Chat Configuration** popup, click the **Prompt Engine** tab.
3. Toggle on **Multi-turn optimization** to enable this feature.
---
@ -388,6 +392,14 @@ You can use Ollama or Xinference to deploy local LLM. See [here](../guides/deplo
---
### Is it possible to add an LLM that is not supported?
If your model is not currently supported but has APIs compatible with those of OpenAI, click **OpenAI-API-Compatible** on the **Model providers** page to configure your model:
![openai-api-compatible](https://github.com/user-attachments/assets/b1e964f2-b86e-41af-8528-fd8a96dc5f6f)
---
### How to interconnect RAGFlow with Ollama?
- If RAGFlow is locally deployed, ensure that your RAGFlow and Ollama are in the same LAN.

View File

@ -3,7 +3,7 @@ sidebar_position: 1
slug: /http_api_reference
---
# HTTP API Reference
# HTTP API
A complete reference for RAGFlow's RESTful API. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](https://ragflow.io/docs/dev/acquire_ragflow_api_key).

View File

@ -3,7 +3,7 @@ sidebar_position: 2
slug: /python_api_reference
---
# Python API Reference
# Python API
A complete reference for RAGFlow's Python APIs. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](https://ragflow.io/docs/dev/acquire_ragflow_api_key).

View File

@ -62,6 +62,10 @@ A complete list of models supported by RAGFlow, which will continue to expand.
</APITable>
```
:::danger IMPORTANT
If your model is not listed here but has APIs compatible with those of OpenAI, click **OpenAI-API-Compatible** on the **Model providers** page to configure your model.
:::
:::note
The list of supported models is extracted from [this source](https://github.com/infiniflow/ragflow/blob/main/rag/llm/__init__.py) and may not be the most current. For the latest supported model list, please refer to the Python file.
:::