pengjunjie/ragflow
1
0
Fork 1
mirror of https://github.com/infiniflow/ragflow.git synced 2025-12-08 20:42:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated dataset APIs (#2820)

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


### Type of change


- [x] Documentation Update
This commit is contained in:
writinwaters
2024-10-12 20:07:21 +08:00
committed by GitHub
parent 6eed115723
commit 8e5efcc47f
2 changed files with 175 additions and 157 deletions
Download Patch File Download Diff File Expand all files Collapse all files

108
api/http_api.md
View File

@ -5,7 +5,7 @@
**POST** `/api/v1/dataset`
Creates a dataset.
Creates a knowledge base (dataset).
### Request
@ -31,11 +31,11 @@ Creates a dataset.
#### Request example
```bash
# "id": id must not be provided.
# "name": name is required and can't be duplicated.
# "id": "id" must not be provided.
# "name": name is required and cannot be duplicated.
# "tenant_id": tenant_id must not be provided.
# "embedding_model": embedding_model must not be provided.
# "navie" means general.
# "embedding_model": REQUIRED.
# "naive": general.
curl --request POST \
--url http://{address}/api/v1/dataset \
--header 'Content-Type: application/json' \
@ -51,21 +51,21 @@ curl --request POST \
#### Request parameters
- `"id"`: (*Body parameter*)
The ID of the created dataset used to uniquely identify different datasets.
- If creating a dataset, `id` must not be provided.
The unique identifier of each created dataset.
- When creating a dataset, `id` must not be provided.
- `"name"`: (*Body parameter*)
The name of the dataset, which must adhere to the following requirements:
- Required when creating a dataset and must be unique.
- If updating a dataset, `name` must still be unique.
- When updating a dataset, `name` must still be unique.
- `"avatar"`: (*Body parameter*)
Base64 encoding of the avatar.
- `"tenant_id"`: (*Body parameter*)
The ID of the tenant associated with the dataset, used to link it with specific users.
- If creating a dataset, `tenant_id` must not be provided.
- If updating a dataset, `tenant_id` cannot be changed.
- When creating a dataset, `tenant_id` must not be provided.
- When updating a dataset, `tenant_id` cannot be changed.
- `"description"`: (*Body parameter*)
The description of the dataset.
@ -74,31 +74,31 @@ curl --request POST \
The language setting for the dataset.
- `"embedding_model"`: (*Body parameter*)
Embedding model used in the dataset to generate vector embeddings.
- If creating a dataset, `embedding_model` must not be provided.
- If updating a dataset, `embedding_model` cannot be changed.
Embedding model used in the dataset for generating vector embeddings.
- When creating a dataset, `embedding_model` must not be provided.
- When updating a dataset, `embedding_model` cannot be changed.
- `"permission"`: (*Body parameter*)
Specifies who can manipulate the dataset.
- `"document_count"`: (*Body parameter*)
Document count of the dataset.
- If updating a dataset, `document_count` cannot be changed.
- When updating a dataset, `document_count` cannot be changed.
- `"chunk_count"`: (*Body parameter*)
Chunk count of the dataset.
- If updating a dataset, `chunk_count` cannot be changed.
- When updating a dataset, `chunk_count` cannot be changed.
- `"parse_method"`: (*Body parameter*)
Parsing method of the dataset.
- If updating `parse_method`, `chunk_count` must be greater than 0.
- When updating `parse_method`, `chunk_count` must be greater than 0.
- `"parser_config"`: (*Body parameter*)
The configuration settings for the dataset parser.
### Response
The successful response includes a JSON object like the following:
A successful response includes a JSON object like the following:
```json
{
@ -139,8 +139,7 @@ The successful response includes a JSON object like the following:
- `"error_code"`: `integer`
`0`: The operation succeeds.
The error response includes a JSON object like the following:
An error response includes a JSON object like the following:
```json
{
@ -153,7 +152,7 @@ The error response includes a JSON object like the following:
**DELETE** `/api/v1/dataset`
Deletes datasets by ids.
Deletes datasets by their IDs.
### Request
@ -169,7 +168,7 @@ Deletes datasets by ids.
#### Request example
```bash
# Either id or name must be provided, but not both.
# Specify either "ids" or "names", NOT both.
curl --request DELETE \
--url http://{address}/api/v1/dataset \
--header 'Content-Type: application/json' \
@ -181,13 +180,13 @@ curl --request DELETE \
#### Request parameters
- `"ids"`: (*Body parameter*)
Dataset IDs to delete.
- `"ids"`: (*Body parameter*)
IDs of the datasets to delete.
### Response
The successful response includes a JSON object like the following:
A successful response includes a JSON object like the following:
```json
{
@ -199,7 +198,7 @@ The successful response includes a JSON object like the following:
`0`: The operation succeeds.
The error response includes a JSON object like the following:
An error response includes a JSON object like the following:
```json
{
@ -212,7 +211,7 @@ The error response includes a JSON object like the following:
**PUT** `/api/v1/dataset/{dataset_id}`
Updates a dataset by its id.
Updates a dataset by its ID.
### Request
@ -227,14 +226,14 @@ Updates a dataset by its id.
#### Request example
```bash
# "id": id is required.
# "name": If you update name, it can't be duplicated.
# "tenant_id": If you update tenant_id, it can't be changed
# "embedding_model": If you update embedding_model, it can't be changed.
# "chunk_count": If you update chunk_count, it can't be changed.
# "document_count": If you update document_count, it can't be changed.
# "parse_method": If you update parse_method, chunk_count must be 0.
# "navie" means general.
# "id": REQUIRED
# "name": If you update "name", it cannot be duplicated.
# "tenant_id": If you update "tenant_id", it cannot be changed
# "embedding_model": If you update "embedding_model", it cannot be changed.
# "chunk_count": If you update "chunk_count", it cannot be changed.
# "document_count": If you update "document_count", it cannot be changed.
# "parse_method": If you update "parse_method", "chunk_count" must be 0.
# "naive": General.
curl --request PUT \
--url http://{address}/api/v1/dataset/{dataset_id} \
--header 'Content-Type: application/json' \
@ -245,17 +244,18 @@ curl --request PUT \
"embedding_model": "BAAI/bge-zh-v1.5",
"chunk_count": 0,
"document_count": 0,
"parse_method": "navie"
"parse_method": "naive"
}'
```
#### Request parameters
(Refer to the "Create Dataset" for the complete structure of the request parameters.)
See the "Create Dataset" for the complete structure of the request parameters.
### Response
The successful response includes a JSON object like the following:
A successful response includes a JSON object like the following:
```json
{
@ -267,7 +267,7 @@ The successful response includes a JSON object like the following:
`0`: The operation succeeds.
The error response includes a JSON object like the following:
An error response includes a JSON object like the following:
```json
{
@ -321,7 +321,7 @@ curl --request GET \
### Response
The successful response includes a JSON object like the following:
A successful response includes a JSON object like the following:
```json
{
@ -365,7 +365,7 @@ The successful response includes a JSON object like the following:
```
The error response includes a JSON object like the following:
An error response includes a JSON object like the following:
```json
{
@ -409,7 +409,7 @@ curl --request POST \
### Response
The successful response includes a JSON object like the following:
A successful response includes a JSON object like the following:
```shell
{
@ -421,7 +421,7 @@ The successful response includes a JSON object like the following:
`0`: The operation succeeds.
The error response includes a JSON object like the following:
An error response includes a JSON object like the following:
```shell
{
@ -464,7 +464,7 @@ curl --request GET \
### Response
The successful response includes a JSON object like the following:
A successful response includes a JSON object like the following:
```shell
{
@ -476,7 +476,7 @@ The successful response includes a JSON object like the following:
`0`: The operation succeeds.
The error response includes a JSON object like the following:
An error response includes a JSON object like the following:
```shell
{
@ -528,7 +528,7 @@ curl --request GET \
### Response
The successful response includes a JSON object like the following:
A successful response includes a JSON object like the following:
```shell
{
@ -605,7 +605,7 @@ The successful response includes a JSON object like the following:
`0`: The operation succeeds.
The error response includes a JSON object like the following:
An error response includes a JSON object like the following:
```shell
{
@ -659,7 +659,7 @@ curl --request PUT \
### Response
The successful response includes a JSON object like the following:
A successful response includes a JSON object like the following:
```shell
{
@ -667,7 +667,7 @@ The successful response includes a JSON object like the following:
}
```
The error response includes a JSON object like the following:
An error response includes a JSON object like the following:
```shell
{
@ -710,7 +710,7 @@ curl --request POST \
### Response
The successful response includes a JSON object like the following:
A successful response includes a JSON object like the following:
```shell
{
@ -718,7 +718,7 @@ The successful response includes a JSON object like the following:
}
```
The error response includes a JSON object like the following:
An error response includes a JSON object like the following:
```shell
{
@ -761,7 +761,7 @@ curl --request DELETE \
### Response
The successful response includes a JSON object like the following:
A successful response includes a JSON object like the following:
```shell
{
@ -769,7 +769,7 @@ The successful response includes a JSON object like the following:
}
```
The error response includes a JSON object like the following:
An error response includes a JSON object like the following:
```shell
{
@ -808,7 +808,7 @@ curl --request GET \
### Response
The successful response includes a JSON object like the following:
A successful response includes a JSON object like the following:
```shell
{
@ -863,7 +863,7 @@ The successful response includes a JSON object like the following:
}
```
The error response includes a JSON object like the following:
An error response includes a JSON object like the following:
```shell
{