AI/ragflow
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/infiniflow/ragflow.git synced 2025-08-12 03:29:02 +08:00
Code Issues Packages Projects Releases Wiki Activity

DRAFT: Miscellaneous updates to HTTP API reference (#2923)

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


### Type of change


- [x] Documentation Update
This commit is contained in:
writinwaters 2024-10-21 19:50:45 +08:00 committed by GitHub
parent bfc07fe4f9
commit 1a623df849
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 385 additions and 353 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

719
api/http_api.md → api/http_api_reference.md
View File

File diff suppressed because it is too large Load Diff

15
api/python_api_reference.md
View File

@ -415,7 +415,7 @@ A `Document` object contains the following attributes:
- `chunk_method` The chunk method name. Defaults to `""`. ?????naive??????
- `parser_config`: `ParserConfig` Configuration object for the parser. Defaults to `{"pages": [[1, 1000000]]}`.
- `source_type`: The source type of the document. Defaults to `"local"`.
- `type`: Type or category of the document???????????. Defaults to `""`.
- `type`: Type or category of the document. Defaults to `""`. Reserved for future use.
- `created_by`: `str` The creator of the document. Defaults to `""`.
- `size`: `int` The document size in bytes. Defaults to `0`.
- `token_count`: `int` The number of tokens in the document. Defaults to `0`.
@ -423,9 +423,14 @@ A `Document` object contains the following attributes:
- `progress`: `float` The current processing progress as a percentage. Defaults to `0.0`.
- `progress_msg`: `str` A message indicating the current progress status. Defaults to `""`.
- `process_begin_at`: `datetime` The start time of document processing. Defaults to `None`.
- `process_duation`: `float` Duration of the processing in seconds or minutes.??????? Defaults to `0.0`.
- `run`: `str` ?????????????????? Defaults to `"0"`.
- `status`: `str` ??????????????????? Defaults to `"1"`.
- `process_duation`: `float` Duration of the processing in seconds. Defaults to `0.0`.
- `run`: `str` The document's processing status:
- `"0"`: UNSTART (default)
- `"1"`: RUNNING
- `"2"`: CANCEL
- `"3"`: DONE
- `"4"`: FAIL
- `status`: `str` Reserved for future use.
### Examples
@ -492,7 +497,7 @@ The IDs of the documents to parse.
### Returns
- Success: No value is returned.????????????????????
- Success: No value is returned.
- Failure: `Exception`
### Examples

4
web/src/components/api-service/chat-overview-modal/api-content.tsx
View File

@ -1,8 +1,8 @@
import HightLightMarkdown from '@/components/highlight-markdown';
import { useSetModalState, useTranslate } from '@/hooks/common-hooks';
import { Button, Card, Flex, Space } from 'antd';
// import apiDoc from '../../../../../api/http_api.md';
import apiDoc from '@parent/api/http_api.md';
// import apiDoc from '../../../../../api/http_api_reference.md';
import apiDoc from '@parent/api/http_api_reference.md';
import ChatApiKeyModal from '../chat-api-key-modal';
import EmbedModal from '../embed-modal';
import { usePreviewChat, useShowEmbedModal } from '../hooks';