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

Added a guide on running a retrieval test, with and without knowledge graph (#5200)

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



### Type of change


- [x] Documentation Update
This commit is contained in:
writinwaters
2025-02-21 19:36:20 +08:00
committed by GitHub
parent ef8847eda7
commit 217caecfda
9 changed files with 114 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/references/agent_component_reference/retrieval.mdx
View File

@ -30,7 +30,7 @@ RAGFlow employs a combination of weighted keyword similarity and weighted vector
Defaults to 0.2.
### Keywords similarity weight
### Keyword similarity weight
This parameter sets the weight of keyword similarity in the combined similarity score. The total of the two weights must equal 1.0. Its default value is 0.7, which means the weight of vector similarity in the combined search is 1 - 0.7 = 0.3.

22
docs/references/http_api_reference.md
View File

@ -2178,11 +2178,11 @@ Creates a session with an agent.
- Body:
- the required parameters:`str`
- other parameters:
The parameters set in the **Begin** component.
The parameters specified in the **Begin** component.
##### Request example
If the **Begin** component in your agent does not have required parameters:
If the **Begin** component in your agent does not take required parameters:
```bash
curl --request POST \
@ -2193,7 +2193,7 @@ curl --request POST \
}'
```
If the **Begin** component in your agent has required parameters:
If the **Begin** component in your agent takes required parameters:
```bash
curl --request POST \
@ -2206,7 +2206,7 @@ curl --request POST \
}'
```
If the **Begin** component in your agent has required file parameters:
If the **Begin** component in your agent takes required file parameters:
```bash
curl --request POST \
@ -2220,7 +2220,7 @@ curl --request POST \
- `agent_id`: (*Path parameter*)
The ID of the associated agent.
- `user_id`: (*Filter parameter*), string
- `user_id`: (*Filter parameter*)
The optional user-defined ID for parsing docs (especially images) when creating a session while uploading files.
#### Response
@ -2373,7 +2373,7 @@ Asks a specified agent a question to start an AI-powered conversation.
- `"user_id"`: `string`(optional)
- other parameters: `string`
##### Request example
Ifthe **Begin** component doesn't have parameters, the following code will create a session.
If the **Begin** component does not take parameters, the following code will create a session.
```bash
curl --request POST \
--url http://{address}/api/v1/agents/{agent_id}/completions \
@ -2383,7 +2383,7 @@ curl --request POST \
{
}'
```
Ifthe **Begin** component have parameters, the following code will create a session.
If the **Begin** component takes parameters, the following code will create a session.
```bash
curl --request POST \
--url http://{address}/api/v1/agents/{agent_id}/completions \
@ -2427,7 +2427,7 @@ curl --request POST \
Parameters specified in the **Begin** component.
#### Response
success without `session_id` provided and with no parameters inthe **Begin** component:
success without `session_id` provided and with no parameters specified in the **Begin** component:
```json
data:{
"code": 0,
@ -2445,7 +2445,8 @@ data:{
"data": true
}
```
Success without `session_id` provided and with parameters inthe **Begin** component:
Success without `session_id` provided and with parameters specified in the **Begin** component:
```json
data:{
@ -2481,7 +2482,7 @@ data:{
}
data:
```
Success with parameters inthe **Begin** component:
Success with parameters specified in the **Begin** component:
```json
data:{
"code": 0,
@ -2560,7 +2561,6 @@ data:{
}
```
Failure:
```json