pengjunjie/ragflow
1
0
Fork 1
mirror of https://github.com/infiniflow/ragflow.git synced 2025-12-08 20:42:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

Miscellaneous editorial updates (#6805)

Browse Source 
### What problem does this PR solve?



### Type of change

- [x] Documentation Update
This commit is contained in:
writinwaters
2025-04-07 09:33:55 +08:00
committed by GitHub
parent c6b26a3159
commit 5a8c479ff3
17 changed files with 54 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/guides/agent/agent_component_reference/begin.mdx
View File

@ -31,10 +31,6 @@ An opening greeting is the agent's first message to the user. It can be a welcom
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:
:::caution WARNING
If your agent's **Begin** component takes a variable, you *cannot* embed it into a webpage.
:::
- **Key**: *Required*
The unique variable name.
- **Name**: *Required*
@ -50,8 +46,15 @@ If your agent's **Begin** component takes a variable, you *cannot* embed it into
- **boolean**: Requires the user to toggle between on and off.
- **Optional**: A toggle indicating whether the variable is optional.
:::danger IMPORTAN
If you set the key type as **file**, ensure the token count of the uploaded file does not exceed your model provider's maximum token limit; otherwise, the plain text in your file will be truncated and incomplete.
:::tip NOTE
To pass in parameters from a client, call:
- HTTP method [Converse with agent](../../references/http_api_reference.md#converse-with-agent), or
- Python method [Converse with agent](../../referencespython_api_reference.md#converse-with-agent).
:::
:::danger IMPORTANT
- If you set the key type as **file**, ensure the token count of the uploaded file does not exceed your model provider's maximum token limit; otherwise, the plain text in your file will be truncated and incomplete.
- If your agent's **Begin** component takes a variable, you *cannot* embed it into a webpage.
:::
## Examples