zlei6/ragflow
1
0
Fork 0
mirror of https://github.com/infiniflow/ragflow.git synced 2026-07-24 01:16:43 +08:00
Code Issues Packages Projects Releases Wiki Activity

Doc: fix typo and format (#17249)

Browse Source 
### Summary

As title.

Signed-off-by: Jin Hai <haijin.chn@gmail.com>
This commit is contained in:
Jin Hai
2026-07-22 17:14:32 +08:00
committed by GitHub
parent d5ff75746c
commit df963cf4a1
2 changed files with 29 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/references/python_api_reference.md
View File

@@ -309,7 +309,7 @@ Whether to include document parsing status counts in each returned `DataSet` obj
- `unstart_count`: `int` Number of documents not yet started parsing.
- `running_count`: `int` Number of documents currently being parsed.
- `cancel_count`: `int` Number of documents whose parsing was cancelled.
- `cancel_count`: `int` Number of documents whose parsing was canceled.
- `done_count`: `int` Number of documents that have been successfully parsed.
- `fail_count`: `int` Number of documents whose parsing failed.
@@ -758,7 +758,7 @@ DataSet.parse_documents(document_ids: list[str]) -> list[tuple[str, str, int, in
*Asynchronously* parses documents in the current dataset.
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.
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 canceled gracefully.
#### Parameters
@@ -1177,7 +1177,7 @@ Base64 encoding of the avatar. Defaults to `""`.
##### dataset_ids: `list[str]`
The IDs of the associated datasets. Defaults to `[]`. When omitted or empty, the SDK creates an empty chat assistant and you can attach datasets later.
The IDs of the associated datasets. Defaults to `[]`. When omitted or empty, the SDK creates an empty chat assistant, and you can attach datasets later.
##### llm_id: `str | None`
@@ -1586,7 +1586,7 @@ Session.ask(question: str = "", stream: bool = False, **kwargs) -> Optional[Mess
Asks a specified chat assistant a question to start an AI-powered conversation.
:::tip NOTE
In streaming mode, not all responses include a reference, as this depends on the system's judgement.
In streaming mode, not all responses include a reference, as this depends on the system's judgment.
:::
#### Parameters
@@ -1723,7 +1723,7 @@ Session.ask(question: str = "", stream: bool = False, **kwargs) -> Optional[Mess
Asks a specified agent through the unified completion endpoint.
:::tip NOTE
In streaming mode, not all responses include a reference, as this depends on the system's judgement.
In streaming mode, not all responses include a reference, as this depends on the system's judgment.
:::
#### Parameters
@@ -2726,7 +2726,7 @@ Ragflow.get_recent_messages(
) -> list[dict]
```
Retrieves the most recent messages from specified memories. Typically accepts a `limit` parameter to control the number of messages returned.
Retrieves the most recent messages from specified memories. Typically, accepts a `limit` parameter to control the number of messages returned.
#### Parameters