mirror of
https://github.com/infiniflow/ragflow.git
synced 2025-12-08 20:42:30 +08:00
Added a guide on setting chat variables (#6904)
### What problem does this PR solve? ### Type of change - [x] Documentation Update
This commit is contained in:
@ -403,7 +403,7 @@ curl --request POST \
|
||||
- `"chunk_token_count"`: Defaults to `128`.
|
||||
- `"layout_recognize"`: Defaults to `true`.
|
||||
- `"html4excel"`: Indicates whether to convert Excel documents into HTML format. Defaults to `false`.
|
||||
- `"delimiter"`: Defaults to `"\n!?。;!?"`.
|
||||
- `"delimiter"`: Defaults to `"\n"`.
|
||||
- `"task_page_size"`: Defaults to `12`. For PDF only.
|
||||
- `"raptor"`: Raptor-specific settings. Defaults to: `{"use_raptor": false}`.
|
||||
- If `"chunk_method"` is `"qa"`, `"manuel"`, `"paper"`, `"book"`, `"laws"`, or `"presentation"`, the `"parser_config"` object contains the following attribute:
|
||||
@ -411,7 +411,7 @@ curl --request POST \
|
||||
- If `"chunk_method"` is `"table"`, `"picture"`, `"one"`, or `"email"`, `"parser_config"` is an empty JSON object.
|
||||
- If `"chunk_method"` is `"knowledge_graph"`, the `"parser_config"` object contains the following attributes:
|
||||
- `"chunk_token_count"`: Defaults to `128`.
|
||||
- `"delimiter"`: Defaults to `"\n!?。;!?"`.
|
||||
- `"delimiter"`: Defaults to `"\n"`.
|
||||
- `"entity_types"`: Defaults to `["organization","person","location","event","time"]`
|
||||
|
||||
#### Response
|
||||
@ -436,7 +436,7 @@ Success:
|
||||
"name": "test_1",
|
||||
"parser_config": {
|
||||
"chunk_token_num": 128,
|
||||
"delimiter": "\\n!?;。;!?",
|
||||
"delimiter": "\\n",
|
||||
"html4excel": false,
|
||||
"layout_recognize": true,
|
||||
"raptor": {
|
||||
@ -658,7 +658,7 @@ Success:
|
||||
"chunk_method": "knowledge_graph",
|
||||
"parser_config": {
|
||||
"chunk_token_num": 8192,
|
||||
"delimiter": "\\n!?;。;!?",
|
||||
"delimiter": "\\n",
|
||||
"entity_types": [
|
||||
"organization",
|
||||
"person",
|
||||
@ -746,7 +746,7 @@ Success:
|
||||
"name": "1.txt",
|
||||
"parser_config": {
|
||||
"chunk_token_num": 128,
|
||||
"delimiter": "\\n!?;。;!?",
|
||||
"delimiter": "\\n",
|
||||
"html4excel": false,
|
||||
"layout_recognize": true,
|
||||
"raptor": {
|
||||
@ -835,7 +835,7 @@ curl --request PUT \
|
||||
- `"chunk_token_count"`: Defaults to `128`.
|
||||
- `"layout_recognize"`: Defaults to `true`.
|
||||
- `"html4excel"`: Indicates whether to convert Excel documents into HTML format. Defaults to `false`.
|
||||
- `"delimiter"`: Defaults to `"\n!?。;!?"`.
|
||||
- `"delimiter"`: Defaults to `"\n"`.
|
||||
- `"task_page_size"`: Defaults to `12`. For PDF only.
|
||||
- `"raptor"`: Raptor-specific settings. Defaults to: `{"use_raptor": false}`.
|
||||
- If `"chunk_method"` is `"qa"`, `"manuel"`, `"paper"`, `"book"`, `"laws"`, or `"presentation"`, the `"parser_config"` object contains the following attribute:
|
||||
@ -843,7 +843,7 @@ curl --request PUT \
|
||||
- If `"chunk_method"` is `"table"`, `"picture"`, `"one"`, or `"email"`, `"parser_config"` is an empty JSON object.
|
||||
- If `"chunk_method"` is `"knowledge_graph"`, the `"parser_config"` object contains the following attributes:
|
||||
- `"chunk_token_count"`: Defaults to `128`.
|
||||
- `"delimiter"`: Defaults to `"\n!?。;!?"`.
|
||||
- `"delimiter"`: Defaults to `"\n"`.
|
||||
- `"entity_types"`: Defaults to `["organization","person","location","event","time"]`
|
||||
|
||||
#### Response
|
||||
@ -978,7 +978,7 @@ Success:
|
||||
"name": "Test_2.txt",
|
||||
"parser_config": {
|
||||
"chunk_token_count": 128,
|
||||
"delimiter": "\n!?。;!?",
|
||||
"delimiter": "\n",
|
||||
"layout_recognize": true,
|
||||
"task_page_size": 12
|
||||
},
|
||||
@ -1335,7 +1335,7 @@ Success:
|
||||
"name": "1.txt",
|
||||
"parser_config": {
|
||||
"chunk_token_num": 128,
|
||||
"delimiter": "\\n!?;。;!?",
|
||||
"delimiter": "\\n",
|
||||
"html4excel": false,
|
||||
"layout_recognize": true,
|
||||
"raptor": {
|
||||
|
||||
@ -154,7 +154,7 @@ The chunking method of the dataset to create. Available options:
|
||||
The parser configuration of the dataset. A `ParserConfig` object's attributes vary based on the selected `chunk_method`:
|
||||
|
||||
- `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":{"user_raptor":False}}`.
|
||||
- `chunk_method`=`"qa"`:
|
||||
`{"raptor": {"user_raptor": False}}`
|
||||
- `chunk_method`=`"manuel"`:
|
||||
@ -174,7 +174,7 @@ The parser configuration of the dataset. A `ParserConfig` object's attributes va
|
||||
- `chunk_method`=`"one"`:
|
||||
`None`
|
||||
- `chunk_method`=`"knowledge-graph"`:
|
||||
`{"chunk_token_num":128,"delimiter":"\\n!?;。;!?","entity_types":["organization","person","location","event","time"]}`
|
||||
`{"chunk_token_num":128,"delimiter":"\\n","entity_types":["organization","person","location","event","time"]}`
|
||||
- `chunk_method`=`"email"`:
|
||||
`None`
|
||||
|
||||
@ -403,7 +403,7 @@ A dictionary representing the attributes to update, with the following keys:
|
||||
- `"email"`: Email
|
||||
- `"parser_config"`: `dict[str, Any]` The parsing configuration for the document. Its attributes vary based on the selected `"chunk_method"`:
|
||||
- `"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":{"user_raptor":False}}`.
|
||||
- `chunk_method`=`"qa"`:
|
||||
`{"raptor": {"user_raptor": False}}`
|
||||
- `chunk_method`=`"manuel"`:
|
||||
@ -423,7 +423,7 @@ A dictionary representing the attributes to update, with the following keys:
|
||||
- `chunk_method`=`"one"`:
|
||||
`None`
|
||||
- `chunk_method`=`"knowledge-graph"`:
|
||||
`{"chunk_token_num":128,"delimiter":"\\n!?;。;!?","entity_types":["organization","person","location","event","time"]}`
|
||||
`{"chunk_token_num":128,"delimiter":"\\n","entity_types":["organization","person","location","event","time"]}`
|
||||
- `chunk_method`=`"email"`:
|
||||
`None`
|
||||
|
||||
@ -543,7 +543,7 @@ A `Document` object contains the following attributes:
|
||||
- `status`: `str` Reserved for future use.
|
||||
- `parser_config`: `ParserConfig` Configuration object for the parser. Its attributes vary based on the selected `chunk_method`:
|
||||
- `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":{"user_raptor":False}}`.
|
||||
- `chunk_method`=`"qa"`:
|
||||
`{"raptor": {"user_raptor": False}}`
|
||||
- `chunk_method`=`"manuel"`:
|
||||
@ -563,7 +563,7 @@ A `Document` object contains the following attributes:
|
||||
- `chunk_method`=`"one"`:
|
||||
`None`
|
||||
- `chunk_method`=`"knowledge-graph"`:
|
||||
`{"chunk_token_num":128,"delimiter": "\\n!?;。;!?","entity_types":["organization","person","location","event","time"]}`
|
||||
`{"chunk_token_num":128,"delimiter": "\\n","entity_types":["organization","person","location","event","time"]}`
|
||||
- `chunk_method`=`"email"`:
|
||||
`None`
|
||||
|
||||
|
||||
Reference in New Issue
Block a user