|
|
|
@@ -1,5 +1,5 @@ |
|
|
|
--- |
|
|
|
sidebar_position: 0 |
|
|
|
|
|
|
|
slug: /http_api_reference |
|
|
|
--- |
|
|
|
|
|
|
|
@@ -63,7 +63,7 @@ curl --request POST \ |
|
|
|
- Case-insensitive. |
|
|
|
|
|
|
|
- `"avatar"`: (*Body parameter*), `string` |
|
|
|
Base64 encoding of the avatar. |
|
|
|
Base64 encoding of the avatar. |
|
|
|
|
|
|
|
- `"description"`: (*Body parameter*), `string` |
|
|
|
A brief description of the dataset to create. |
|
|
|
@@ -92,7 +92,7 @@ curl --request POST \ |
|
|
|
- `"picture"`: Picture |
|
|
|
- `"one"`: One |
|
|
|
- `"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 |
|
|
|
|
|
|
|
- `"parser_config"`: (*Body parameter*), `object` |
|
|
|
@@ -373,7 +373,7 @@ Success: |
|
|
|
] |
|
|
|
} |
|
|
|
``` |
|
|
|
|
|
|
|
|
|
|
|
Failure: |
|
|
|
|
|
|
|
```json |
|
|
|
@@ -522,7 +522,8 @@ curl --request PUT \ |
|
|
|
- `"presentation"`: Presentation |
|
|
|
- `"picture"`: Picture |
|
|
|
- `"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 |
|
|
|
- `"parser_config"`: (*Body parameter*), `object` |
|
|
|
The configuration settings for the dataset parser. The attributes in this JSON object vary with the selected `"chunk_method"`: |
|
|
|
@@ -550,7 +551,7 @@ Success: |
|
|
|
"code": 0 |
|
|
|
} |
|
|
|
``` |
|
|
|
|
|
|
|
|
|
|
|
Failure: |
|
|
|
|
|
|
|
```json |
|
|
|
@@ -811,7 +812,7 @@ Success: |
|
|
|
"code": 0 |
|
|
|
} |
|
|
|
``` |
|
|
|
|
|
|
|
|
|
|
|
Failure: |
|
|
|
|
|
|
|
```json |
|
|
|
@@ -868,7 +869,7 @@ Success: |
|
|
|
"code": 0 |
|
|
|
} |
|
|
|
``` |
|
|
|
|
|
|
|
|
|
|
|
Failure: |
|
|
|
|
|
|
|
```json |
|
|
|
@@ -1050,7 +1051,7 @@ Success: |
|
|
|
} |
|
|
|
} |
|
|
|
``` |
|
|
|
|
|
|
|
|
|
|
|
Failure: |
|
|
|
|
|
|
|
```json |
|
|
|
@@ -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?"`. |
|
|
|
- `"show_quote`: `boolean` Indicates whether the source of text should be displayed. Defaults to `true`. |
|
|
|
- `"prompt"`: `string` The prompt content. |
|
|
|
|
|
|
|
### Response |
|
|
|
|
|
|
|
Success: |
|
|
|
@@ -1470,7 +1472,7 @@ Updates configurations for a specified chat assistant. |
|
|
|
- `"dataset_ids"`: `list[string]` |
|
|
|
- `"llm"`: `object` |
|
|
|
- `"prompt"`: `object` |
|
|
|
|
|
|
|
|
|
|
|
#### Request example |
|
|
|
|
|
|
|
```bash |
|
|
|
@@ -2099,4 +2101,4 @@ Failure: |
|
|
|
"code": 102, |
|
|
|
"message": "Please input your question." |
|
|
|
} |
|
|
|
``` |
|
|
|
``` |