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

Updated HTTP API reference and Python API reference based on test results (#3090)

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



### Type of change


- [x] Documentation Update
This commit is contained in:
writinwaters
2024-10-29 19:56:46 +08:00
committed by GitHub
parent d868c283c4
commit f4cb939317
2 changed files with 13 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
api/http_api_reference.md
View File

@ -94,8 +94,10 @@ curl --request POST \
The configuration settings for the dataset parser, a JSON object containing the following attributes:
- `"chunk_token_count"`: Defaults to `128`.
- `"layout_recognize"`: Defaults to `true`.
- `"html4excel"`: Indicates whether to convert Excel documents into HTML format. Defaults to `false`.
- `"delimiter"`: Defaults to `"\n!?。；！？"`.
- `"task_page_size"`: Defaults to `12`.
- `"task_page_size"`: Defaults to `12`. For PDF only.
- `"raptor"`: Raptor-specific settings. Defaults to: `{"use_raptor": false}`.
### Response
@ -177,7 +179,7 @@ curl --request DELETE \
#### Request parameters
- `"ids"`: (*Body parameter*), `list[string]`
- `"ids"`: (*Body parameter*), `list[string]`
The IDs of the datasets to delete. If it is not specified, all datasets will be deleted.
### Response
@ -241,7 +243,7 @@ curl --request PUT \
- `"embedding_model"`: (*Body parameter*), `string`
The updated embedding model name.
- Ensure that `"chunk_count"` is `0` before updating `"embedding_model"`.
- `"chunk_method"`: (*Body parameter*), `enum<string>`
- `"chunk_method"`: (*Body parameter*), `enum<string>`
The chunking method for the dataset. Available options:
- `"naive"`: General
- `"manual`: Manual
@ -510,12 +512,12 @@ curl --request PUT \
- `"one"`: One
- `"knowledge_graph"`: Knowledge Graph
- `"email"`: Email
- `"parser_config"`: (*Body parameter*), `object`
- `"parser_config"`: (*Body parameter*), `object`
The parsing configuration for the document:
- `"chunk_token_count"`: Defaults to `128`.
- `"layout_recognize"`: Defaults to `true`.
- `"delimiter"`: Defaults to `"\n!?。；！？"`.
- `"task_page_size"`: Defaults to `12`.
- `"task_page_size"`: Defaults to `12`. For PDF only.
### Response
@ -718,7 +720,7 @@ curl --request DELETE \
- `dataset_id`: (*Path parameter*)
The associated dataset ID.
- `"ids"`: (*Body parameter*), `list[string]`
- `"ids"`: (*Body parameter*), `list[string]`
The IDs of the documents to delete. If it is not specified, all documents in the specified dataset will be deleted.
### Response
@ -1169,7 +1171,7 @@ Failure:
## Retrieve chunks
**GET** `/api/v1/retrieval`
**POST** `/api/v1/retrieval`
Retrieves chunks from specified datasets.