Browse Source

Docs: updates. (#7042)

### What problem does this PR solve?

#7019

### Type of change

- [x] Documentation Update
tags/v0.18.0
Kevin Hu 6 months ago
parent
commit
48730e00a8
No account linked to committer's email address
2 changed files with 24 additions and 24 deletions
  1. 3
    3
      docs/references/http_api_reference.md
  2. 21
    21
      docs/references/python_api_reference.md

+ 3
- 3
docs/references/http_api_reference.md View File

"html4excel": false, "html4excel": false,
"layout_recognize": true, "layout_recognize": true,
"raptor": { "raptor": {
"user_raptor": false
"use_raptor": false
} }
}, },
"permission": "me", "permission": "me",
"html4excel": false, "html4excel": false,
"layout_recognize": true, "layout_recognize": true,
"raptor": { "raptor": {
"user_raptor": false
"use_raptor": false
} }
}, },
"run": "UNSTART", "run": "UNSTART",
"html4excel": false, "html4excel": false,
"layout_recognize": true, "layout_recognize": true,
"raptor": { "raptor": {
"user_raptor": false
"use_raptor": false
} }
}, },
"process_begin_at": "Thu, 24 Oct 2024 09:56:44 GMT", "process_begin_at": "Thu, 24 Oct 2024 09:56:44 GMT",

+ 21
- 21
docs/references/python_api_reference.md View File

The parser configuration of the dataset. A `ParserConfig` object's attributes vary based on the selected `chunk_method`: The parser configuration of the dataset. A `ParserConfig` object's attributes vary based on the selected `chunk_method`:


- `chunk_method`=`"naive"`: - `chunk_method`=`"naive"`:
`{"chunk_token_num":128,"delimiter":"\\n","html4excel":False,"layout_recognize":True,"raptor":{"user_raptor":False}}`.
`{"chunk_token_num":128,"delimiter":"\\n","html4excel":False,"layout_recognize":True,"raptor":{"use_raptor":False}}`.
- `chunk_method`=`"qa"`: - `chunk_method`=`"qa"`:
`{"raptor": {"user_raptor": False}}`
`{"raptor": {"use_raptor": False}}`
- `chunk_method`=`"manuel"`: - `chunk_method`=`"manuel"`:
`{"raptor": {"user_raptor": False}}`
`{"raptor": {"use_raptor": False}}`
- `chunk_method`=`"table"`: - `chunk_method`=`"table"`:
`None` `None`
- `chunk_method`=`"paper"`: - `chunk_method`=`"paper"`:
`{"raptor": {"user_raptor": False}}`
`{"raptor": {"use_raptor": False}}`
- `chunk_method`=`"book"`: - `chunk_method`=`"book"`:
`{"raptor": {"user_raptor": False}}`
`{"raptor": {"use_raptor": False}}`
- `chunk_method`=`"laws"`: - `chunk_method`=`"laws"`:
`{"raptor": {"user_raptor": False}}`
`{"raptor": {"use_raptor": False}}`
- `chunk_method`=`"picture"`: - `chunk_method`=`"picture"`:
`None` `None`
- `chunk_method`=`"presentation"`: - `chunk_method`=`"presentation"`:
`{"raptor": {"user_raptor": False}}`
`{"raptor": {"use_raptor": False}}`
- `chunk_method`=`"one"`: - `chunk_method`=`"one"`:
`None` `None`
- `chunk_method`=`"knowledge-graph"`: - `chunk_method`=`"knowledge-graph"`:
- `"email"`: Email - `"email"`: Email
- `"parser_config"`: `dict[str, Any]` The parsing configuration for the document. Its attributes vary based on the selected `"chunk_method"`: - `"parser_config"`: `dict[str, Any]` The parsing configuration for the document. Its attributes vary based on the selected `"chunk_method"`:
- `"chunk_method"`=`"naive"`: - `"chunk_method"`=`"naive"`:
`{"chunk_token_num":128,"delimiter":"\\n","html4excel":False,"layout_recognize":True,"raptor":{"user_raptor":False}}`.
`{"chunk_token_num":128,"delimiter":"\\n","html4excel":False,"layout_recognize":True,"raptor":{"use_raptor":False}}`.
- `chunk_method`=`"qa"`: - `chunk_method`=`"qa"`:
`{"raptor": {"user_raptor": False}}`
`{"raptor": {"use_raptor": False}}`
- `chunk_method`=`"manuel"`: - `chunk_method`=`"manuel"`:
`{"raptor": {"user_raptor": False}}`
`{"raptor": {"use_raptor": False}}`
- `chunk_method`=`"table"`: - `chunk_method`=`"table"`:
`None` `None`
- `chunk_method`=`"paper"`: - `chunk_method`=`"paper"`:
`{"raptor": {"user_raptor": False}}`
`{"raptor": {"use_raptor": False}}`
- `chunk_method`=`"book"`: - `chunk_method`=`"book"`:
`{"raptor": {"user_raptor": False}}`
`{"raptor": {"use_raptor": False}}`
- `chunk_method`=`"laws"`: - `chunk_method`=`"laws"`:
`{"raptor": {"user_raptor": False}}`
`{"raptor": {"use_raptor": False}}`
- `chunk_method`=`"presentation"`: - `chunk_method`=`"presentation"`:
`{"raptor": {"user_raptor": False}}`
`{"raptor": {"use_raptor": False}}`
- `chunk_method`=`"picture"`: - `chunk_method`=`"picture"`:
`None` `None`
- `chunk_method`=`"one"`: - `chunk_method`=`"one"`:
- `status`: `str` Reserved for future use. - `status`: `str` Reserved for future use.
- `parser_config`: `ParserConfig` Configuration object for the parser. Its attributes vary based on the selected `chunk_method`: - `parser_config`: `ParserConfig` Configuration object for the parser. Its attributes vary based on the selected `chunk_method`:
- `chunk_method`=`"naive"`: - `chunk_method`=`"naive"`:
`{"chunk_token_num":128,"delimiter":"\\n","html4excel":False,"layout_recognize":True,"raptor":{"user_raptor":False}}`.
`{"chunk_token_num":128,"delimiter":"\\n","html4excel":False,"layout_recognize":True,"raptor":{"use_raptor":False}}`.
- `chunk_method`=`"qa"`: - `chunk_method`=`"qa"`:
`{"raptor": {"user_raptor": False}}`
`{"raptor": {"use_raptor": False}}`
- `chunk_method`=`"manuel"`: - `chunk_method`=`"manuel"`:
`{"raptor": {"user_raptor": False}}`
`{"raptor": {"use_raptor": False}}`
- `chunk_method`=`"table"`: - `chunk_method`=`"table"`:
`None` `None`
- `chunk_method`=`"paper"`: - `chunk_method`=`"paper"`:
`{"raptor": {"user_raptor": False}}`
`{"raptor": {"use_raptor": False}}`
- `chunk_method`=`"book"`: - `chunk_method`=`"book"`:
`{"raptor": {"user_raptor": False}}`
`{"raptor": {"use_raptor": False}}`
- `chunk_method`=`"laws"`: - `chunk_method`=`"laws"`:
`{"raptor": {"user_raptor": False}}`
`{"raptor": {"use_raptor": False}}`
- `chunk_method`=`"presentation"`: - `chunk_method`=`"presentation"`:
`{"raptor": {"user_raptor": False}}`
`{"raptor": {"use_raptor": False}}`
- `chunk_method`=`"picure"`: - `chunk_method`=`"picure"`:
`None` `None`
- `chunk_method`=`"one"`: - `chunk_method`=`"one"`:

Loading…
Cancel
Save