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: Updated parse_documents (#10536)

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

### Type of change

- [x] Documentation Update
This commit is contained in:
writinwaters
2025-10-14 13:40:56 +08:00
committed by GitHub
parent 113851a692
commit 6fd9508017
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/references/python_api_reference.md
View File

@ -704,10 +704,9 @@ print("Async bulk parsing initiated.")
DataSet.parse_documents(document_ids: list[str]) -> list[tuple[str, str, int, int]] DataSet.parse_documents(document_ids: list[str]) -> list[tuple[str, str, int, int]]
``` ```
Parses documents **synchronously** in the current dataset. *Asynchronously* parses documents in the current dataset.
This method wraps `async_parse_documents()` and automatically waits for all parsing tasks to complete.
It returns detailed parsing results, including the status and statistics for each document. This method encapsulates `async_parse_documents()`. It awaits the completion of all parsing tasks before returning detailed results, including the parsing status and statistics for each document. If a keyboard interruption occurs (e.g., `Ctrl+C`), all pending parsing tasks will be cancelled gracefully.
If interrupted by the user (e.g. `Ctrl+C`), all pending parsing jobs will be cancelled gracefully.
#### Parameters #### Parameters
@ -718,15 +717,16 @@ The IDs of the documents to parse.
#### Returns #### Returns
A list of tuples with detailed parsing results: A list of tuples with detailed parsing results:
```python ```python
[ [
(document_id: str, status: str, chunk_count: int, token_count: int), (document_id: str, status: str, chunk_count: int, token_count: int),
... ...
] ]
``` ```
- **status** — Final parsing state (`success`, `failed`, `cancelled`, etc.) - `status`: The final parsing state (e.g., `success`, `failed`, `cancelled`).
- **chunk_count** — Number of content chunks created for the document. - `chunk_count`: The number of content chunks created from the document.
- **token_count** — Total number of tokens processed. - `token_count`: The total number of tokens processed.
--- ---