AI/ragflow
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/infiniflow/ragflow.git synced 2025-08-14 18:55:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

Docs: about meta files in API reference. (#5594)

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

### Type of change

- [x] Documentation Update
This commit is contained in:
Kevin Hu 2025-03-04 15:43:09 +08:00 committed by GitHub
parent 6e828f0fcb
commit 9816b868f9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/references/http_api_reference.md
View File

@ -634,6 +634,7 @@ Updates configurations for a specified document.
- `'Authorization: Bearer <YOUR_API_KEY>'` - `'Authorization: Bearer <YOUR_API_KEY>'`
- Body: - Body:
- `"name"`:`string` - `"name"`:`string`
- `"meta_fields"`:`object`
- `"chunk_method"`:`string` - `"chunk_method"`:`string`
- `"parser_config"`:`object` - `"parser_config"`:`object`
@ -660,6 +661,7 @@ curl --request PUT \
- `document_id`: (*Path parameter*) - `document_id`: (*Path parameter*)
The ID of the document to update. The ID of the document to update.
- `"name"`: (*Body parameter*), `string` - `"name"`: (*Body parameter*), `string`
- `"meta_fields"`: (*Body parameter*)， `dict[str, Any]` The meta fields of the document.
- `"chunk_method"`: (*Body parameter*), `string` - `"chunk_method"`: (*Body parameter*), `string`
The parsing method to apply to the document: The parsing method to apply to the document:
- `"naive"`: General - `"naive"`: General
@ -672,8 +674,6 @@ curl --request PUT \
- `"presentation"`: Presentation - `"presentation"`: Presentation
- `"picture"`: Picture - `"picture"`: Picture
- `"one"`: One - `"one"`: One
- `"knowledge_graph"`: Knowledge Graph
Ensure your LLM is properly configured on the **Settings** page before selecting this. Please also note that Knowledge Graph consumes a large number of Tokens!
- `"email"`: Email - `"email"`: Email
- `"parser_config"`: (*Body parameter*), `object` - `"parser_config"`: (*Body parameter*), `object`
The configuration settings for the dataset parser. The attributes in this JSON object vary with the selected `"chunk_method"`: The configuration settings for the dataset parser. The attributes in this JSON object vary with the selected `"chunk_method"`:

4
docs/references/python_api_reference.md
View File

@ -313,9 +313,6 @@ A dictionary representing the attributes to update, with the following keys:
- `"picture"`: Picture - `"picture"`: Picture
- `"one"`: One - `"one"`: One
- `"email"`: Email - `"email"`: Email
- `"knowledge_graph"`: Knowledge Graph
Ensure your LLM is properly configured on the **Settings** page before selecting this. Please also note that Knowledge Graph consumes a large number of Tokens!
- `"meta_fields"`: `dict[str, Any]` The meta fields of the dataset.
#### Returns #### Returns
@ -384,6 +381,7 @@ Updates configurations for the current document.
A dictionary representing the attributes to update, with the following keys: A dictionary representing the attributes to update, with the following keys:
- `"display_name"`: `str` The name of the document to update. - `"display_name"`: `str` The name of the document to update.
- `"meta_fields"`: `dict[str, Any]` The meta fields of the document.
- `"chunk_method"`: `str` The parsing method to apply to the document. - `"chunk_method"`: `str` The parsing method to apply to the document.
- `"naive"`: General - `"naive"`: General
- `"manual`: Manual - `"manual`: Manual