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

Docs: Miscellaneous updates. (#9506)

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

### Type of change

- [x] Documentation Update
This commit is contained in:
writinwaters
2025-08-15 18:10:11 +08:00
committed by GitHub
parent ffc095bd50
commit 3b50688228
3 changed files with 50 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/references/http_api_reference.md
View File

@ -5,7 +5,7 @@ slug: /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](../guides/models/llm_api_key_setup.md).
A complete reference for RAGFlow's RESTful API. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](../develop/acquire_ragflow_api_key.md).
---
@ -191,13 +191,13 @@ curl --request POST \
##### Request Parameters
- `model` (*Body parameter*) `string`, *Required*
- `model` (*Body parameter*) `string`, *Required*
The model used to generate the response. The server will parse this automatically, so you can set it to any value for now.
- `messages` (*Body parameter*) `list[object]`, *Required*
- `messages` (*Body parameter*) `list[object]`, *Required*
A list of historical chat messages used to generate the response. This must contain at least one message with the `user` role.
- `stream` (*Body parameter*) `boolean`
- `stream` (*Body parameter*) `boolean`
Whether to receive the response as a stream. Set this to `false` explicitly if you prefer to receive the entire response in one go instead of as a stream.
#### Response
@ -2675,7 +2675,7 @@ curl --request POST \
- `agent_id`: (*Path parameter*)
The ID of the associated agent.
- `user_id`: (*Filter parameter*)
- `user_id`: (*Filter parameter*)
The optional user-defined ID for parsing docs (especially images) when creating a session while uploading files.
#### Response
@ -2755,7 +2755,7 @@ Success:
"mode": "conversational",
"outputs": {},
"prologue": "Hi! I'm your assistant. What can I do for you?",
"tips": "Please fill up the form"
"tips": "Please fill in the form"
}
},
"upstream": []
@ -2912,17 +2912,17 @@ Asks a specified agent a question to start an AI-powered conversation.
- Body:
- `"question"`: `string`
- `"stream"`: `boolean`
- `"session_id"`: `string`(optional)
- `"inputs"`: `object`(optional)
- `"user_id"`: `string`(optional)
- `"session_id"`: `string` (optional)
- `"inputs"`: `object` (optional)
- `"user_id"`: `string` (optional)
:::info IMPORTANT
You can include custom parameters in the request body, but first ensure they are defined in the [Begin](../guides/agent/agent_component_reference/begin.mdx) agent component.
You can include custom parameters in the request body, but first ensure they are defined in the [Begin](../guides/agent/agent_component_reference/begin.mdx) component.
:::
##### Request example
- If the **Begin** component does not take parameters.
- If the **Begin** component does not take parameters:
```bash
curl --request POST \
@ -2936,7 +2936,7 @@ curl --request POST \
}'
```
- If the **Begin** component takes parameters.
- If the **Begin** component takes parameters, include their values in the body of `"inputs"` as follows:
```bash
curl --request POST \