writinwaters
commited on
Commit
·
8d1baac
1
Parent(s):
8c28496
Updated descriptions for knowledge graph (#3154)
Browse files### What problem does this PR solve?
### Type of change
- [x] Documentation Update
docs/references/http_api_reference.md
CHANGED
@@ -1,5 +1,5 @@
|
|
1 |
-
---
|
2 |
sidebar_position: 0
|
|
|
3 |
slug: /http_api_reference
|
4 |
---
|
5 |
|
@@ -63,7 +63,7 @@ curl --request POST \
|
|
63 |
- Case-insensitive.
|
64 |
|
65 |
- `"avatar"`: (*Body parameter*), `string`
|
66 |
-
|
67 |
|
68 |
- `"description"`: (*Body parameter*), `string`
|
69 |
A brief description of the dataset to create.
|
@@ -92,7 +92,7 @@ curl --request POST \
|
|
92 |
- `"picture"`: Picture
|
93 |
- `"one"`: One
|
94 |
- `"knowledge_graph"`: Knowledge Graph
|
95 |
-
Ensure that
|
96 |
- `"email"`: Email
|
97 |
|
98 |
- `"parser_config"`: (*Body parameter*), `object`
|
@@ -373,7 +373,7 @@ Success:
|
|
373 |
]
|
374 |
}
|
375 |
```
|
376 |
-
|
377 |
Failure:
|
378 |
|
379 |
```json
|
@@ -522,7 +522,8 @@ curl --request PUT \
|
|
522 |
- `"presentation"`: Presentation
|
523 |
- `"picture"`: Picture
|
524 |
- `"one"`: One
|
525 |
-
- `"knowledge_graph"`: Knowledge Graph
|
|
|
526 |
- `"email"`: Email
|
527 |
- `"parser_config"`: (*Body parameter*), `object`
|
528 |
The configuration settings for the dataset parser. The attributes in this JSON object vary with the selected `"chunk_method"`:
|
@@ -550,7 +551,7 @@ Success:
|
|
550 |
"code": 0
|
551 |
}
|
552 |
```
|
553 |
-
|
554 |
Failure:
|
555 |
|
556 |
```json
|
@@ -811,7 +812,7 @@ Success:
|
|
811 |
"code": 0
|
812 |
}
|
813 |
```
|
814 |
-
|
815 |
Failure:
|
816 |
|
817 |
```json
|
@@ -868,7 +869,7 @@ Success:
|
|
868 |
"code": 0
|
869 |
}
|
870 |
```
|
871 |
-
|
872 |
Failure:
|
873 |
|
874 |
```json
|
@@ -1050,7 +1051,7 @@ Success:
|
|
1050 |
}
|
1051 |
}
|
1052 |
```
|
1053 |
-
|
1054 |
Failure:
|
1055 |
|
1056 |
```json
|
@@ -1388,6 +1389,7 @@ curl --request POST \
|
|
1388 |
- `"opener"`: `string` The opening greeting for the user. Defaults to `"Hi! I am your assistant, can I help you?"`.
|
1389 |
- `"show_quote`: `boolean` Indicates whether the source of text should be displayed. Defaults to `true`.
|
1390 |
- `"prompt"`: `string` The prompt content.
|
|
|
1391 |
### Response
|
1392 |
|
1393 |
Success:
|
@@ -1470,7 +1472,7 @@ Updates configurations for a specified chat assistant.
|
|
1470 |
- `"dataset_ids"`: `list[string]`
|
1471 |
- `"llm"`: `object`
|
1472 |
- `"prompt"`: `object`
|
1473 |
-
|
1474 |
#### Request example
|
1475 |
|
1476 |
```bash
|
@@ -2099,4 +2101,4 @@ Failure:
|
|
2099 |
"code": 102,
|
2100 |
"message": "Please input your question."
|
2101 |
}
|
2102 |
-
```
|
|
|
|
|
1 |
sidebar_position: 0
|
2 |
+
|
3 |
slug: /http_api_reference
|
4 |
---
|
5 |
|
|
|
63 |
- Case-insensitive.
|
64 |
|
65 |
- `"avatar"`: (*Body parameter*), `string`
|
66 |
+
Base64 encoding of the avatar.
|
67 |
|
68 |
- `"description"`: (*Body parameter*), `string`
|
69 |
A brief description of the dataset to create.
|
|
|
92 |
- `"picture"`: Picture
|
93 |
- `"one"`: One
|
94 |
- `"knowledge_graph"`: Knowledge Graph
|
95 |
+
Ensure your LLM is properly configured on the **Settings** page before selecting this. Please note that Knowledge Graph consumes a large number of Tokens!
|
96 |
- `"email"`: Email
|
97 |
|
98 |
- `"parser_config"`: (*Body parameter*), `object`
|
|
|
373 |
]
|
374 |
}
|
375 |
```
|
376 |
+
|
377 |
Failure:
|
378 |
|
379 |
```json
|
|
|
522 |
- `"presentation"`: Presentation
|
523 |
- `"picture"`: Picture
|
524 |
- `"one"`: One
|
525 |
+
- `"knowledge_graph"`: Knowledge Graph
|
526 |
+
Ensure your LLM is properly configured on the **Settings** page before selecting this. Please note that Knowledge Graph consumes a large number of Tokens!
|
527 |
- `"email"`: Email
|
528 |
- `"parser_config"`: (*Body parameter*), `object`
|
529 |
The configuration settings for the dataset parser. The attributes in this JSON object vary with the selected `"chunk_method"`:
|
|
|
551 |
"code": 0
|
552 |
}
|
553 |
```
|
554 |
+
|
555 |
Failure:
|
556 |
|
557 |
```json
|
|
|
812 |
"code": 0
|
813 |
}
|
814 |
```
|
815 |
+
|
816 |
Failure:
|
817 |
|
818 |
```json
|
|
|
869 |
"code": 0
|
870 |
}
|
871 |
```
|
872 |
+
|
873 |
Failure:
|
874 |
|
875 |
```json
|
|
|
1051 |
}
|
1052 |
}
|
1053 |
```
|
1054 |
+
|
1055 |
Failure:
|
1056 |
|
1057 |
```json
|
|
|
1389 |
- `"opener"`: `string` The opening greeting for the user. Defaults to `"Hi! I am your assistant, can I help you?"`.
|
1390 |
- `"show_quote`: `boolean` Indicates whether the source of text should be displayed. Defaults to `true`.
|
1391 |
- `"prompt"`: `string` The prompt content.
|
1392 |
+
|
1393 |
### Response
|
1394 |
|
1395 |
Success:
|
|
|
1472 |
- `"dataset_ids"`: `list[string]`
|
1473 |
- `"llm"`: `object`
|
1474 |
- `"prompt"`: `object`
|
1475 |
+
|
1476 |
#### Request example
|
1477 |
|
1478 |
```bash
|
|
|
2101 |
"code": 102,
|
2102 |
"message": "Please input your question."
|
2103 |
}
|
2104 |
+
```
|
docs/references/python_api_reference.md
CHANGED
@@ -1,5 +1,5 @@
|
|
1 |
-
---
|
2 |
sidebar_position: 1
|
|
|
3 |
slug: /python_api_reference
|
4 |
---
|
5 |
|
@@ -79,7 +79,8 @@ The chunking method of the dataset to create. Available options:
|
|
79 |
- `"presentation"`: Presentation
|
80 |
- `"picture"`: Picture
|
81 |
- `"one"`: One
|
82 |
-
- `"knowledge_graph"`: Knowledge Graph
|
|
|
83 |
- `"email"`: Email
|
84 |
|
85 |
#### parser_config
|
@@ -249,7 +250,8 @@ A dictionary representing the attributes to update, with the following keys:
|
|
249 |
- `"presentation"`: Presentation
|
250 |
- `"picture"`: Picture
|
251 |
- `"one"`: One
|
252 |
-
- `"knowledge_graph"`: Knowledge Graph
|
|
|
253 |
|
254 |
### Returns
|
255 |
|
@@ -331,7 +333,8 @@ A dictionary representing the attributes to update, with the following keys:
|
|
331 |
- `"presentation"`: Presentation
|
332 |
- `"picture"`: Picture
|
333 |
- `"one"`: One
|
334 |
-
- `"knowledge_graph"`: Knowledge Graph
|
|
|
335 |
- `"email"`: Email
|
336 |
- `"parser_config"`: `dict[str, Any]` The parsing configuration for the document. Its attributes vary based on the selected `"chunk_method"`:
|
337 |
- `"chunk_method"`=`"naive"`:
|
|
|
|
|
1 |
sidebar_position: 1
|
2 |
+
|
3 |
slug: /python_api_reference
|
4 |
---
|
5 |
|
|
|
79 |
- `"presentation"`: Presentation
|
80 |
- `"picture"`: Picture
|
81 |
- `"one"`: One
|
82 |
+
- `"knowledge_graph"`: Knowledge Graph
|
83 |
+
Ensure your LLM is properly configured on the **Settings** page before selecting this. Please note that Knowledge Graph consumes a large number of Tokens!
|
84 |
- `"email"`: Email
|
85 |
|
86 |
#### parser_config
|
|
|
250 |
- `"presentation"`: Presentation
|
251 |
- `"picture"`: Picture
|
252 |
- `"one"`: One
|
253 |
+
- `"knowledge_graph"`: Knowledge Graph
|
254 |
+
Ensure your LLM is properly configured on the **Settings** page before selecting this. Please note that Knowledge Graph consumes a large number of Tokens!
|
255 |
|
256 |
### Returns
|
257 |
|
|
|
333 |
- `"presentation"`: Presentation
|
334 |
- `"picture"`: Picture
|
335 |
- `"one"`: One
|
336 |
+
- `"knowledge_graph"`: Knowledge Graph
|
337 |
+
Ensure your LLM is properly configured on the **Settings** page before selecting this. Please note that Knowledge Graph consumes a large number of Tokens!
|
338 |
- `"email"`: Email
|
339 |
- `"parser_config"`: `dict[str, Any]` The parsing configuration for the document. Its attributes vary based on the selected `"chunk_method"`:
|
340 |
- `"chunk_method"`=`"naive"`:
|