AI/ragflow
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/infiniflow/ragflow.git synced 2025-08-14 17:55:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated descriptions for knowledge graph (#3154)

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



### Type of change


- [x] Documentation Update
This commit is contained in:
writinwaters 2024-11-01 18:57:58 +08:00 committed by GitHub
parent b42d24575c
commit 7eafccf78a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 20 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/references/http_api_reference.md
View File

@ -1,5 +1,5 @@
---
sidebar_position: 0 sidebar_position: 0
slug: /http_api_reference slug: /http_api_reference
--- ---
@ -92,7 +92,7 @@ curl --request POST \
- `"picture"`: Picture - `"picture"`: Picture
- `"one"`: One - `"one"`: One
- `"knowledge_graph"`: Knowledge Graph - `"knowledge_graph"`: Knowledge Graph
Ensure that you have your LLM properly set in Ensure your LLM is properly configured on the **Settings** page before selecting this. Please note that Knowledge Graph consumes a large number of Tokens!
- `"email"`: Email - `"email"`: Email
- `"parser_config"`: (*Body parameter*), `object` - `"parser_config"`: (*Body parameter*), `object`
@ -523,6 +523,7 @@ curl --request PUT \
- `"picture"`: Picture - `"picture"`: Picture
- `"one"`: One - `"one"`: One
- `"knowledge_graph"`: Knowledge Graph - `"knowledge_graph"`: Knowledge Graph
Ensure your LLM is properly configured on the **Settings** page before selecting this. Please note that Knowledge Graph consumes a large number of Tokens!
- `"email"`: Email - `"email"`: Email
- `"parser_config"`: (*Body parameter*), `object` - `"parser_config"`: (*Body parameter*), `object`
The configuration settings for the dataset parser. The attributes in this JSON object vary with the selected `"chunk_method"`: The configuration settings for the dataset parser. The attributes in this JSON object vary with the selected `"chunk_method"`:
@ -1388,6 +1389,7 @@ curl --request POST \
- `"opener"`: `string` The opening greeting for the user. Defaults to `"Hi! I am your assistant, can I help you?"`. - `"opener"`: `string` The opening greeting for the user. Defaults to `"Hi! I am your assistant, can I help you?"`.
- `"show_quote`: `boolean` Indicates whether the source of text should be displayed. Defaults to `true`. - `"show_quote`: `boolean` Indicates whether the source of text should be displayed. Defaults to `true`.
- `"prompt"`: `string` The prompt content. - `"prompt"`: `string` The prompt content.
### Response ### Response
Success: Success:

5
docs/references/python_api_reference.md
View File

@ -1,5 +1,5 @@
---
sidebar_position: 1 sidebar_position: 1
slug: /python_api_reference slug: /python_api_reference
--- ---
@ -80,6 +80,7 @@ The chunking method of the dataset to create. Available options:
- `"picture"`: Picture - `"picture"`: Picture
- `"one"`: One - `"one"`: One
- `"knowledge_graph"`: Knowledge Graph - `"knowledge_graph"`: Knowledge Graph
Ensure your LLM is properly configured on the **Settings** page before selecting this. Please note that Knowledge Graph consumes a large number of Tokens!
- `"email"`: Email - `"email"`: Email
#### parser_config #### parser_config
@ -250,6 +251,7 @@ A dictionary representing the attributes to update, with the following keys:
- `"picture"`: Picture - `"picture"`: Picture
- `"one"`: One - `"one"`: One
- `"knowledge_graph"`: Knowledge Graph - `"knowledge_graph"`: Knowledge Graph
Ensure your LLM is properly configured on the **Settings** page before selecting this. Please note that Knowledge Graph consumes a large number of Tokens!
### Returns ### Returns
@ -332,6 +334,7 @@ A dictionary representing the attributes to update, with the following keys:
- `"picture"`: Picture - `"picture"`: Picture
- `"one"`: One - `"one"`: One
- `"knowledge_graph"`: Knowledge Graph - `"knowledge_graph"`: Knowledge Graph
Ensure your LLM is properly configured on the **Settings** page before selecting this. Please note that Knowledge Graph consumes a large number of Tokens!
- `"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"`: