File size: 9,095 Bytes
5a13721 8227469 acec9a8 8227469 acec9a8 8227469 b2dbbc3 8227469 acec9a8 8227469 acec9a8 8227469 acec9a8 8227469 acec9a8 8227469 acec9a8 8227469 acec9a8 8227469 acec9a8 8227469 acec9a8 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 |
---
sidebar_class_name: hidden
---
# API reference
RAGFlow offers RESTful APIs for you to integrate its capabilities into third-party applications.
## Base URL
```
http://<host_address>/api/v1/
```
## Dataset URL
```
http://<host_address>/api/v1/dataset
```
## Authorization
All of RAGFlow's RESTFul APIs use API key for authorization, so keep it safe and do not expose it to the front end.
Put your API key in the request header.
```buildoutcfg
Authorization: Bearer {API_KEY}
```
To get your API key:
1. In RAGFlow, click **Chat** tab in the middle top of the page.
2. Hover over the corresponding dialogue **>** **Chat Bot API** to show the chatbot API configuration page.
3. Click **Api Key** **>** **Create new key** to create your API key.
4. Copy and keep your API key safe.
## Create dataset
This method creates (news) a dataset for a specific user.
### Request
#### Request URI
| Method | Request URI |
|--------|-------------|
| POST | `/dataset` |
:::note
You are *required* to save the `data.dataset_id` value returned in the response data, which is the session ID for all upcoming conversations.
:::
#### Request parameter
| Name | Type | Required | Description |
|----------------|--------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `dataset_name` | string | Yes | The unique identifier assigned to each newly created dataset. `dataset_name` must be less than 2 ** 10 characters and cannot be empty. The following character sets are supported: <br />- 26 lowercase English letters (a-z)<br />- 26 uppercase English letters (A-Z)<br />- 10 digits (0-9)<br />- "_", "-", "." |
### Response
```json
{
"code": 0,
"data": {
"dataset_name": "kb1",
"dataset_id": "375e8ada2d3c11ef98f93043d7ee537e"
},
"message": "success"
}
```
## Get dataset list
This method lists the created datasets for a specific user.
### Request
#### Request URI
| Method | Request URI |
|----------|-------------|
| GET | `/dataset` |
### Response
#### Response parameter
```json
{
"code": 0,
"data": [
{
"avatar": null,
"chunk_num": 0,
"create_date": "Mon, 17 Jun 2024 16:00:05 GMT",
"create_time": 1718611205876,
"created_by": "b48110a0286411ef994a3043d7ee537e",
"description": null,
"doc_num": 0,
"embd_id": "BAAI/bge-large-zh-v1.5",
"id": "9bd6424a2c7f11ef81b83043d7ee537e",
"language": "Chinese",
"name": "dataset3(23)",
"parser_config": {
"pages": [
[
1,
1000000
]
]
},
"parser_id": "naive",
"permission": "me",
"similarity_threshold": 0.2,
"status": "1",
"tenant_id": "b48110a0286411ef994a3043d7ee537e",
"token_num": 0,
"update_date": "Mon, 17 Jun 2024 16:00:05 GMT",
"update_time": 1718611205876,
"vector_similarity_weight": 0.3
}
],
"message": "List datasets successfully!"
}
```
## Delete dataset
This method deletes a dataset for a specific user.
### Request
#### Request URI
| Method | Request URI |
|--------|-------------------------|
| DELETE | `/dataset/{dataset_id}` |
#### Request parameter
| Name | Type | Required | Description |
|--------------|--------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `dataset_id` | string | Yes | The ID of the dataset. Call ['GET' /dataset](#create-dataset) to retrieve the ID. |
### Response
```json
{
"code": 0,
"message": "Remove dataset: 9cefaefc2e2611ef916b3043d7ee537e successfully"
}
```
### Get the details of the specific dataset
This method gets the details of the specific dataset.
### Request
#### Request URI
| Method | Request URI |
|----------|-------------------------|
| GET | `/dataset/{dataset_id}` |
#### Request parameter
| Name | Type | Required | Description |
|--------------|--------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `dataset_id` | string | Yes | The ID of the dataset. Call ['GET' /dataset](#create-dataset) to retrieve the ID. |
### Response
```json
{
"code": 0,
"data": {
"avatar": null,
"chunk_num": 0,
"description": null,
"doc_num": 0,
"embd_id": "BAAI/bge-large-zh-v1.5",
"id": "060323022e3511efa8263043d7ee537e",
"language": "Chinese",
"name": "test(1)",
"parser_config":
{
"pages": [[1, 1000000]]
},
"parser_id": "naive",
"permission": "me",
"token_num": 0
},
"message": "success"
}
```
### Update the details of the specific dataset
This method updates the details of the specific dataset.
### Request
#### Request URI
| Method | Request URI |
|--------|-------------------------|
| PUT | `/dataset/{dataset_id}` |
#### Request parameter
You are required to input at least one parameter.
| Name | Type | Required | Description |
|----------------------|--------|----------|-----------------------------------------------------------------------|
| `name` | string | No | The name of the knowledge base, from which you get the document list. |
| `description` | string | No | The description of the knowledge base. |
| `permission` | string | No | The permission for the knowledge base, default:me. |
| `language` | string | No | The language of the knowledge base. |
| `chunk_method` | string | No | The chunk method of the knowledge base. |
| `embedding_model_id` | string | No | The embedding model id of the knowledge base. |
| `photo` | string | No | The photo of the knowledge base. |
| `layout_recognize` | bool | No | The layout recognize of the knowledge base. |
| `token_num` | int | No | The token number of the knowledge base. |
| `id` | string | No | The id of the knowledge base. |
### Response
### Successful response
```json
{
"code": 0,
"data": {
"avatar": null,
"chunk_num": 0,
"create_date": "Wed, 19 Jun 2024 20:33:34 GMT",
"create_time": 1718800414518,
"created_by": "b48110a0286411ef994a3043d7ee537e",
"description": "new_description1",
"doc_num": 0,
"embd_id": "BAAI/bge-large-zh-v1.5",
"id": "24f9f17a2e3811ef820e3043d7ee537e",
"language": "English",
"name": "new_name",
"parser_config":
{
"pages": [[1, 1000000]]
},
"parser_id": "naive",
"permission": "me",
"similarity_threshold": 0.2,
"status": "1",
"tenant_id": "b48110a0286411ef994a3043d7ee537e",
"token_num": 0,
"update_date": "Wed, 19 Jun 2024 20:33:34 GMT",
"update_time": 1718800414529,
"vector_similarity_weight": 0.3
},
"message": "success"
}
```
### Response for the operating error
```json
{
"code": 103,
"message": "Only the owner of knowledgebase is authorized for this operation!"
}
```
### Response for no parameter
```json
{
"code": 102,
"message": "Please input at least one parameter that you want to update!"
}
``` |