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

Turn resource to plural form (#3059)

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

Turn resource to plural form

### Type of change

- [x] Refactoring

Co-authored-by: liuhua <10215101452@stu.ecun.edu.cn>
This commit is contained in:
liuhua
2024-10-28 14:15:36 +08:00
committed by GitHub
parent a813736194
commit f93f485696
6 changed files with 102 additions and 102 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
api/apps/sdk/chat.py
View File

@ -26,7 +26,7 @@ from api.utils.api_utils import get_result
@manager.route('/chat', methods=['POST'])
@manager.route('/chats', methods=['POST'])
@token_required
def create(tenant_id):
req=request.json
@ -142,7 +142,7 @@ def create(tenant_id):
res["avatar"] = res.pop("icon")
return get_result(data=res)
@manager.route('/chat/<chat_id>', methods=['PUT'])
@manager.route('/chats/<chat_id>', methods=['PUT'])
@token_required
def update(tenant_id,chat_id):
if not DialogService.query(tenant_id=tenant_id, id=chat_id, status=StatusEnum.VALID.value):
@ -221,7 +221,7 @@ def update(tenant_id,chat_id):
return get_result()
@manager.route('/chat', methods=['DELETE'])
@manager.route('/chats', methods=['DELETE'])
@token_required
def delete(tenant_id):
req = request.json
@ -235,7 +235,7 @@ def delete(tenant_id):
DialogService.update_by_id(id, temp_dict)
return get_result()
@manager.route('/chat', methods=['GET'])
@manager.route('/chats', methods=['GET'])
@token_required
def list_chat(tenant_id):
id = request.args.get("id")

8
api/apps/sdk/dataset.py
View File

@ -28,7 +28,7 @@ from api.utils import get_uuid
from api.utils.api_utils import get_result, token_required, get_error_data_result, valid,get_parser_config
@manager.route('/dataset', methods=['POST'])
@manager.route('/datasets', methods=['POST'])
@token_required
def create(tenant_id):
req = request.json
@ -88,7 +88,7 @@ def create(tenant_id):
renamed_data[new_key] = value
return get_result(data=renamed_data)
@manager.route('/dataset', methods=['DELETE'])
@manager.route('/datasets', methods=['DELETE'])
@token_required
def delete(tenant_id):
req = request.json
@ -112,7 +112,7 @@ def delete(tenant_id):
retmsg="Delete dataset error.(Database error)")
return get_result(retcode=RetCode.SUCCESS)
@manager.route('/dataset/<dataset_id>', methods=['PUT'])
@manager.route('/datasets/<dataset_id>', methods=['PUT'])
@token_required
def update(tenant_id,dataset_id):
if not KnowledgebaseService.query(id=dataset_id,tenant_id=tenant_id):
@ -183,7 +183,7 @@ def update(tenant_id,dataset_id):
return get_error_data_result(retmsg="Update dataset error.(Database error)")
return get_result(retcode=RetCode.SUCCESS)
@manager.route('/dataset', methods=['GET'])
@manager.route('/datasets', methods=['GET'])
@token_required
def list(tenant_id):
id = request.args.get("id")

2
api/apps/sdk/dify_retrieval.py
View File

@ -22,7 +22,7 @@ from api.settings import retrievaler, kg_retrievaler, RetCode
from api.utils.api_utils import validate_request, build_error_result, apikey_required
@manager.route('/dify/retrieval', methods=['POST'])
@manager.route('/dify/retrievals', methods=['POST'])
@apikey_required
@validate_request("knowledge_id", "query")
def retrieval(tenant_id):

24
api/apps/sdk/doc.py
View File

@ -55,7 +55,7 @@ MAXIMUM_OF_UPLOADING_FILES = 256
MAXIMUM_OF_UPLOADING_FILES = 256
@manager.route('/dataset/<dataset_id>/document', methods=['POST'])
@manager.route('/datasets/<dataset_id>/documents', methods=['POST'])
@token_required
def upload(dataset_id, tenant_id):
if 'file' not in request.files:
@ -103,7 +103,7 @@ def upload(dataset_id, tenant_id):
return get_result(data=renamed_doc_list)
@manager.route('/dataset/<dataset_id>/info/<document_id>', methods=['PUT'])
@manager.route('/datasets/<dataset_id>/documents/<document_id>', methods=['PUT'])
@token_required
def update_doc(tenant_id, dataset_id, document_id):
req = request.json
@ -169,7 +169,7 @@ def update_doc(tenant_id, dataset_id, document_id):
return get_result()
@manager.route('/dataset/<dataset_id>/document/<document_id>', methods=['GET'])
@manager.route('/datasets/<dataset_id>/documents/<document_id>', methods=['GET'])
@token_required
def download(tenant_id, dataset_id, document_id):
if not KnowledgebaseService.query(id=dataset_id, tenant_id=tenant_id):
@ -192,7 +192,7 @@ def download(tenant_id, dataset_id, document_id):
)
@manager.route('/dataset/<dataset_id>/info', methods=['GET'])
@manager.route('/datasets/<dataset_id>/documents', methods=['GET'])
@token_required
def list_docs(dataset_id, tenant_id):
if not KnowledgebaseService.query(id=dataset_id, tenant_id=tenant_id):
@ -236,7 +236,7 @@ def list_docs(dataset_id, tenant_id):
return get_result(data={"total": tol, "docs": renamed_doc_list})
@manager.route('/dataset/<dataset_id>/document', methods=['DELETE'])
@manager.route('/datasets/<dataset_id>/documents', methods=['DELETE'])
@token_required
def delete(tenant_id,dataset_id):
if not KnowledgebaseService.query(id=dataset_id, tenant_id=tenant_id):
@ -286,7 +286,7 @@ def delete(tenant_id,dataset_id):
return get_result()
@manager.route('/dataset/<dataset_id>/chunk', methods=['POST'])
@manager.route('/datasets/<dataset_id>/chunks', methods=['POST'])
@token_required
def parse(tenant_id,dataset_id):
if not KnowledgebaseService.query(id=dataset_id, tenant_id=tenant_id):
@ -316,7 +316,7 @@ def parse(tenant_id,dataset_id):
queue_tasks(doc, bucket, name)
return get_result()
@manager.route('/dataset/<dataset_id>/chunk', methods=['DELETE'])
@manager.route('/datasets/<dataset_id>/chunks', methods=['DELETE'])
@token_required
def stop_parsing(tenant_id,dataset_id):
if not KnowledgebaseService.query(id=dataset_id, tenant_id=tenant_id):
@ -339,7 +339,7 @@ def stop_parsing(tenant_id,dataset_id):
return get_result()
@manager.route('/dataset/<dataset_id>/document/<document_id>/chunk', methods=['GET'])
@manager.route('/datasets/<dataset_id>/documents/<document_id>/chunks', methods=['GET'])
@token_required
def list_chunks(tenant_id,dataset_id,document_id):
if not KnowledgebaseService.query(id=dataset_id, tenant_id=tenant_id):
@ -427,7 +427,7 @@ def list_chunks(tenant_id,dataset_id,document_id):
@manager.route('/dataset/<dataset_id>/document/<document_id>/chunk', methods=['POST'])
@manager.route('/datasets/<dataset_id>/documents/<document_id>/chunks', methods=['POST'])
@token_required
def add_chunk(tenant_id,dataset_id,document_id):
if not KnowledgebaseService.query(id=dataset_id, tenant_id=tenant_id):
@ -488,7 +488,7 @@ def add_chunk(tenant_id,dataset_id,document_id):
# return get_result(data={"chunk_id": chunk_id})
@manager.route('dataset/<dataset_id>/document/<document_id>/chunk', methods=['DELETE'])
@manager.route('datasets/<dataset_id>/documents/<document_id>/chunks', methods=['DELETE'])
@token_required
def rm_chunk(tenant_id,dataset_id,document_id):
if not KnowledgebaseService.query(id=dataset_id, tenant_id=tenant_id):
@ -516,7 +516,7 @@ def rm_chunk(tenant_id,dataset_id,document_id):
@manager.route('/dataset/<dataset_id>/document/<document_id>/chunk/<chunk_id>', methods=['PUT'])
@manager.route('/datasets/<dataset_id>/documents/<document_id>/chunks/<chunk_id>', methods=['PUT'])
@token_required
def update_chunk(tenant_id,dataset_id,document_id,chunk_id):
try:
@ -574,7 +574,7 @@ def update_chunk(tenant_id,dataset_id,document_id,chunk_id):
@manager.route('/retrieval', methods=['POST'])
@manager.route('/retrievals', methods=['POST'])
@token_required
def retrieval_test(tenant_id):
req = request.json

10
api/apps/sdk/session.py
View File

@ -24,7 +24,7 @@ from api.utils import get_uuid
from api.utils.api_utils import get_error_data_result
from api.utils.api_utils import get_result, token_required
@manager.route('/chat/<chat_id>/session', methods=['POST'])
@manager.route('/chats/<chat_id>/sessions', methods=['POST'])
@token_required
def create(tenant_id,chat_id):
req = request.json
@ -50,7 +50,7 @@ def create(tenant_id,chat_id):
del conv["reference"]
return get_result(data=conv)
@manager.route('/chat/<chat_id>/session/<session_id>', methods=['PUT'])
@manager.route('/chats/<chat_id>/sessions/<session_id>', methods=['PUT'])
@token_required
def update(tenant_id,chat_id,session_id):
req = request.json
@ -72,7 +72,7 @@ def update(tenant_id,chat_id,session_id):
return get_result()
@manager.route('/chat/<chat_id>/completion', methods=['POST'])
@manager.route('/chats/<chat_id>/completions', methods=['POST'])
@token_required
def completion(tenant_id,chat_id):
req = request.json
@ -161,7 +161,7 @@ def completion(tenant_id,chat_id):
break
return get_result(data=answer)
@manager.route('/chat/<chat_id>/session', methods=['GET'])
@manager.route('/chats/<chat_id>/sessions', methods=['GET'])
@token_required
def list(chat_id,tenant_id):
if not DialogService.query(tenant_id=tenant_id, id=chat_id, status=StatusEnum.VALID.value):
@ -213,7 +213,7 @@ def list(chat_id,tenant_id):
del conv["reference"]
return get_result(data=convs)
@manager.route('/chat/<chat_id>/session', methods=["DELETE"])
@manager.route('/chats/<chat_id>/sessions', methods=["DELETE"])
@token_required
def delete(tenant_id,chat_id):
if not DialogService.query(id=chat_id, tenant_id=tenant_id, status=StatusEnum.VALID.value):

152
api/http_api_reference.md
View File

@ -13,14 +13,14 @@ Dataset Management
## Create dataset
**POST** `/api/v1/dataset`
**POST** `/api/v1/datasets`
Creates a dataset.
### Request
- Method: POST
- URL: `/api/v1/dataset`
- URL: `/api/v1/datasets`
- Headers:
- `'content-Type: application/json'`
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -38,7 +38,7 @@ Creates a dataset.
```bash
curl --request POST \
--url http://{address}/api/v1/dataset \
--url http://{address}/api/v1/datasets \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {YOUR_API_KEY}' \
--data '{
@ -151,14 +151,14 @@ Failure:
## Delete datasets
**DELETE** `/api/v1/dataset`
**DELETE** `/api/v1/datasets`
Deletes datasets by ID.
### Request
- Method: DELETE
- URL: `/api/v1/dataset`
- URL: `/api/v1/datasets`
- Headers:
- `'content-Type: application/json'`
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -169,7 +169,7 @@ Deletes datasets by ID.
```bash
curl --request DELETE \
--url http://{address}/api/v1/dataset \
--url http://{address}/api/v1/datasets \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {YOUR_API_KEY}' \
--data '{"ids": ["test_1", "test_2"]}'
@ -203,14 +203,14 @@ Failure:
## Update dataset
**PUT** `/api/v1/dataset/{dataset_id}`
**PUT** `/api/v1/datasets/{dataset_id}`
Updates configurations for a specified dataset.
### Request
- Method: PUT
- URL: `/api/v1/dataset/{dataset_id}`
- URL: `/api/v1/datasets/{dataset_id}`
- Headers:
- `'content-Type: application/json'`
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -223,7 +223,7 @@ Updates configurations for a specified dataset.
```bash
curl --request PUT \
--url http://{address}/api/v1/dataset/{dataset_id} \
--url http://{address}/api/v1/datasets/{dataset_id} \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {YOUR_API_KEY}' \
--data '
@ -279,14 +279,14 @@ Failure:
## List datasets
**GET** `/api/v1/dataset?page={page}&page_size={page_size}&orderby={orderby}&desc={desc}&name={dataset_name}&id={dataset_id}`
**GET** `/api/v1/datasets?page={page}&page_size={page_size}&orderby={orderby}&desc={desc}&name={dataset_name}&id={dataset_id}`
Lists datasets.
### Request
- Method: GET
- URL: `/api/v1/dataset?page={page}&page_size={page_size}&orderby={orderby}&desc={desc}&name={dataset_name}&id={dataset_id}`
- URL: `/api/v1/datasets?page={page}&page_size={page_size}&orderby={orderby}&desc={desc}&name={dataset_name}&id={dataset_id}`
- Headers:
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -294,7 +294,7 @@ Lists datasets.
```bash
curl --request GET \
--url http://{address}/api/v1/dataset?page={page}&page_size={page_size}&orderby={orderby}&desc={desc}&name={dataset_name}&id={dataset_id} \
--url http://{address}/api/v1/datasets?page={page}&page_size={page_size}&orderby={orderby}&desc={desc}&name={dataset_name}&id={dataset_id} \
--header 'Authorization: Bearer {YOUR_API_KEY}'
```
@ -379,14 +379,14 @@ File Management within Dataset
## Upload documents
**POST** `/api/v1/dataset/{dataset_id}/document`
**POST** `/api/v1/datasets/{dataset_id}/documents`
Uploads documents to a specified dataset.
### Request
- Method: POST
- URL: `/api/v1/dataset/{dataset_id}/document`
- URL: `/api/v1/datasets/{dataset_id}/documents`
- Headers:
- `'Content-Type: multipart/form-data'`
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -397,7 +397,7 @@ Uploads documents to a specified dataset.
```bash
curl --request POST \
--url http://{address}/api/v1/dataset/{dataset_id}/document \
--url http://{address}/api/v1/datasets/{dataset_id}/documents \
--header 'Content-Type: multipart/form-data' \
--header 'Authorization: Bearer {YOUR_API_KEY}' \
--form 'file=@./test1.txt' \
@ -457,14 +457,14 @@ Failure:
## Update document
**PUT** `/api/v1/dataset/{dataset_id}/info/{document_id}`
**PUT** `/api/v1/datasets/{dataset_id}/documents/{document_id}`
Updates configurations for a specified document.
### Request
- Method: PUT
- URL: `/api/v1/dataset/{dataset_id}/document/{document_id}`
- URL: `/api/v1/datasets/{dataset_id}/documents/{document_id}`
- Headers:
- `'content-Type: application/json'`
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -477,7 +477,7 @@ Updates configurations for a specified document.
```bash
curl --request PUT \
--url http://{address}/api/v1/dataset/{dataset_id}/info/{document_id} \
--url http://{address}/api/v1/datasets/{dataset_id}/info/{document_id} \
--header 'Authorization: Bearer {YOUR_API_KEY}' \
--header 'Content-Type: application/json' \
--data '
@ -540,14 +540,14 @@ Failure:
## Download document
**GET** `/api/v1/dataset/{dataset_id}/document/{document_id}`
**GET** `/api/v1/datasets/{dataset_id}/documents/{document_id}`
Downloads a document from a specified dataset.
### Request
- Method: GET
- URL: `/api/v1/dataset/{dataset_id}/document/{document_id}`
- URL: `/api/v1/datasets/{dataset_id}/documents/{document_id}`
- Headers:
- `'Authorization: Bearer {YOUR_API_KEY}'`
- Output:
@ -557,7 +557,7 @@ Downloads a document from a specified dataset.
```bash
curl --request GET \
--url http://{address}/api/v1/dataset/{dataset_id}/document/{document_id} \
--url http://{address}/api/v1/datasets/{dataset_id}/documents/{document_id} \
--header 'Authorization: Bearer {YOUR_API_KEY}' \
--output ./ragflow.txt
```
@ -590,14 +590,14 @@ Failure:
## List documents
**GET** `/api/v1/dataset/{dataset_id}/info?offset={offset}&limit={limit}&orderby={orderby}&desc={desc}&keywords={keywords}&id={document_id}`
**GET** `/api/v1/datasets/{dataset_id}/documents?offset={offset}&limit={limit}&orderby={orderby}&desc={desc}&keywords={keywords}&id={document_id}`
Lists documents in a specified dataset.
### Request
- Method: GET
- URL: `/api/v1/dataset/{dataset_id}/info?keywords={keyword}&page={page}&page_size={limit}&orderby={orderby}&desc={desc}&name={name}`
- URL: `/api/v1/datasets/{dataset_id}/documents?keywords={keyword}&page={page}&page_size={limit}&orderby={orderby}&desc={desc}&name={name}`
- Headers:
- `'content-Type: application/json'`
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -606,7 +606,7 @@ Lists documents in a specified dataset.
```bash
curl --request GET \
--url http://{address}/api/v1/dataset/{dataset_id}/info?keywords={keywords}&offset={offset}&limit={limit}&orderby={orderby}&desc={desc}&id={document_id} \
--url http://{address}/api/v1/datasets/{dataset_id}/documents?keywords={keywords}&offset={offset}&limit={limit}&orderby={orderby}&desc={desc}&id={document_id} \
--header 'Authorization: Bearer {YOUR_API_KEY}'
```
@ -687,14 +687,14 @@ Failure:
## Delete documents
**DELETE** `/api/v1/dataset/{dataset_id}/document`
**DELETE** `/api/v1/datasets/{dataset_id}/documents`
Deletes documents by ID.
### Request
- Method: DELETE
- URL: `/api/v1/dataset/{dataset_id}/document`
- URL: `/api/v1/datasets/{dataset_id}/documents`
- Headers:
- `'Content-Type: application/json'`
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -705,7 +705,7 @@ Deletes documents by ID.
```bash
curl --request DELETE \
--url http://{address}/api/v1/dataset/{dataset_id}/document \
--url http://{address}/api/v1/datasets/{dataset_id}/documents \
--header 'Content-Type: application/json' \
--header 'Authorization: {YOUR_API_KEY}' \
--data '
@ -744,14 +744,14 @@ Failure:
## Parse documents
**POST** `/api/v1/dataset/{dataset_id}/chunk`
**POST** `/api/v1/datasets/{dataset_id}/chunks`
Parses documents in a specified dataset.
### Request
- Method: POST
- URL: `/api/v1/dataset/{dataset_id}/chunk`
- URL: `/api/v1/datasets/{dataset_id}/chunks`
- Headers:
- `'content-Type: application/json'`
- 'Authorization: Bearer {YOUR_API_KEY}'
@ -762,7 +762,7 @@ Parses documents in a specified dataset.
```bash
curl --request POST \
--url http://{address}/api/v1/dataset/{dataset_id}/chunk \
--url http://{address}/api/v1/datasets/{dataset_id}/chunks \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {YOUR_API_KEY}' \
--data '
@ -801,14 +801,14 @@ Failure:
## Stop parsing documents
**DELETE** `/api/v1/dataset/{dataset_id}/chunk`
**DELETE** `/api/v1/datasets/{dataset_id}/chunks`
Stops parsing specified documents.
### Request
- Method: DELETE
- URL: `/api/v1/dataset/{dataset_id}/chunk`
- URL: `/api/v1/datasets/{dataset_id}/chunks`
- Headers:
- `'content-Type: application/json'`
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -819,7 +819,7 @@ Stops parsing specified documents.
```bash
curl --request DELETE \
--url http://{address}/api/v1/dataset/{dataset_id}/chunk \
--url http://{address}/api/v1/datasets/{dataset_id}/chunks \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {YOUR_API_KEY}' \
--data '
@ -858,14 +858,14 @@ Failure:
## Add chunks
**POST** `/api/v1/dataset/{dataset_id}/document/{document_id}/chunk`
**POST** `/api/v1/datasets/{dataset_id}/documents/{document_id}/chunks`
Adds a chunk to a specified document in a specified dataset.
### Request
- Method: POST
- URL: `/api/v1/dataset/{dataset_id}/document/{document_id}/chunk`
- URL: `/api/v1/datasets/{dataset_id}/documents/{document_id}/chunks`
- Headers:
- `'content-Type: application/json'`
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -877,7 +877,7 @@ Adds a chunk to a specified document in a specified dataset.
```bash
curl --request POST \
--url http://{address}/api/v1/dataset/{dataset_id}/document/{document_id}/chunk \
--url http://{address}/api/v1/datasets/{dataset_id}/documents/{document_id}/chunks \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {YOUR_API_KEY}' \
--data '
@ -933,14 +933,14 @@ Failure:
## List chunks
**GET** `/api/v1/dataset/{dataset_id}/document/{document_id}/chunk?keywords={keywords}&offset={offset}&limit={limit}&id={id}`
**GET** `/api/v1/datasets/{dataset_id}/documents/{document_id}/chunks?keywords={keywords}&offset={offset}&limit={limit}&id={id}`
Lists chunks in a specified document.
### Request
- Method: GET
- URL: `/api/v1/dataset/{dataset_id}/document/{document_id}/chunk?keywords={keywords}&offset={offset}&limit={limit}&id={chunk_id}`
- URL: `/api/v1/datasets/{dataset_id}/documents/{document_id}/chunks?keywords={keywords}&offset={offset}&limit={limit}&id={chunk_id}`
- Headers:
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -948,7 +948,7 @@ Lists chunks in a specified document.
```bash
curl --request GET \
--url http://{address}/api/v1/dataset/{dataset_id}/document/{document_id}/chunk?keywords={keywords}&offset={offset}&limit={limit}&id={chunk_id} \
--url http://{address}/api/v1/datasets/{dataset_id}/documents/{document_id}/chunks?keywords={keywords}&offset={offset}&limit={limit}&id={chunk_id} \
--header 'Authorization: Bearer {YOUR_API_KEY}'
```
@ -1040,14 +1040,14 @@ Failure:
## Delete chunks
**DELETE** `/api/v1/dataset/{dataset_id}/document/{document_id}/chunk`
**DELETE** `/api/v1/datasets/{dataset_id}/documents/{document_id}/chunks`
Deletes chunks by ID.
### Request
- Method: DELETE
- URL: `/api/v1/dataset/{dataset_id}/document/{document_id}/chunk`
- URL: `/api/v1/datasets/{dataset_id}/documents/{document_id}/chunks`
- Headers:
- `'content-Type: application/json'`
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -1058,7 +1058,7 @@ Deletes chunks by ID.
```bash
curl --request DELETE \
--url http://{address}/api/v1/dataset/{dataset_id}/document/{document_id}/chunk \
--url http://{address}/api/v1/datasets/{dataset_id}/documents/{document_id}/chunks \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {YOUR_API_KEY}' \
--data '
@ -1099,14 +1099,14 @@ Failure:
## Update chunk
**PUT** `/api/v1/dataset/{dataset_id}/document/{document_id}/chunk/{chunk_id}`
**PUT** `/api/v1/datasets/{dataset_id}/documents/{document_id}/chunks/{chunk_id}`
Updates content or configurations for a specified chunk.
### Request
- Method: PUT
- URL: `/api/v1/dataset/{dataset_id}/document/{document_id}/chunk/{chunk_id}`
- URL: `/api/v1/datasets/{dataset_id}/documents/{document_id}/chunks/{chunk_id}`
- Headers:
- `'content-Type: application/json'`
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -1119,7 +1119,7 @@ Updates content or configurations for a specified chunk.
```bash
curl --request PUT \
--url http://{address}/api/v1/dataset/{dataset_id}/document/{document_id}/chunk/{chunk_id} \
--url http://{address}/api/v1/datasets/{dataset_id}/documents/{document_id}/chunks/{chunk_id} \
--header 'Content-Type: application/json' \
--header 'Authorization: {YOUR_API_KEY}' \
--data '
@ -1169,14 +1169,14 @@ Failure:
## Retrieve chunks
**GET** `/api/v1/retrieval`
**GET** `/api/v1/retrievals`
Retrieves chunks from specified datasets.
### Request
- Method: POST
- URL: `/api/v1/retrieval`
- URL: `/api/v1/retrievals`
- Headers:
- `'content-Type: application/json'`
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -1197,7 +1197,7 @@ Retrieves chunks from specified datasets.
```bash
curl --request POST \
--url http://{address}/api/v1/retrieval \
--url http://{address}/api/v1/retrievals \
--header 'Content-Type: application/json' \
--header 'Authorization: {YOUR_API_KEY}' \
--data '
@ -1223,7 +1223,7 @@ curl --request POST \
- `"similarity_threshold"`: (*Body parameter*)
The minimum similarity score. Defaults to `0.2`.
- `"vector_similarity_weight"`: (*Body parameter*), `float`
The weight of vector cosine similarity. Defaults to `0.3`. If x represents the vector cosine similarity, then (1 - x) is the term similarity weight.
The weight of vector cosine similarity. Defaults to `0.3`. If x represents the weight of vector cosine similarity, then (1 - x) is the term similarity weight.
- `"top_k"`: (*Body parameter*), `integer`
The number of chunks engaged in vector cosine computaton. Defaults to `1024`.
- `"rerank_id"`: (*Body parameter*), `integer`
@ -1297,14 +1297,14 @@ Chat Assistant Management
## Create chat assistant
**POST** `/api/v1/chat`
**POST** `/api/v1/chats`
Creates a chat assistant.
### Request
- Method: POST
- URL: `/api/v1/chat`
- URL: `/api/v1/chats`
- Headers:
- `'content-Type: application/json'`
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -1319,7 +1319,7 @@ Creates a chat assistant.
```shell
curl --request POST \
--url http://{address}/api/v1/chat \
--url http://{address}/api/v1/chats \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {YOUR_API_KEY}'
--data '{
@ -1433,14 +1433,14 @@ Failure:
## Update chat assistant
**PUT** `/api/v1/chat/{chat_id}`
**PUT** `/api/v1/chats/{chat_id}`
Updates configurations for a specified chat assistant.
### Request
- Method: PUT
- URL: `/api/v1/chat/{chat_id}`
- URL: `/api/v1/chats/{chat_id}`
- Headers:
- `'content-Type: application/json'`
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -1455,7 +1455,7 @@ Updates configurations for a specified chat assistant.
```bash
curl --request PUT \
--url http://{address}/api/v1/chat/{chat_id} \
--url http://{address}/api/v1/chats/{chat_id} \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {YOUR_API_KEY}' \
--data '
@ -1529,14 +1529,14 @@ Failure:
## Delete chat assistants
**DELETE** `/api/v1/chat`
**DELETE** `/api/v1/chats`
Deletes chat assistants by ID.
### Request
- Method: DELETE
- URL: `/api/v1/chat`
- URL: `/api/v1/chats`
- Headers:
- `'content-Type: application/json'`
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -1547,7 +1547,7 @@ Deletes chat assistants by ID.
```bash
curl --request DELETE \
--url http://{address}/api/v1/chat \
--url http://{address}/api/v1/chats \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {YOUR_API_KEY}' \
--data '
@ -1584,14 +1584,14 @@ Failure:
## List chat assistants
**GET** `/api/v1/chat?page={page}&page_size={page_size}&orderby={orderby}&desc={desc}&name={chat_name}&id={chat_id}`
**GET** `/api/v1/chats?page={page}&page_size={page_size}&orderby={orderby}&desc={desc}&name={chat_name}&id={chat_id}`
Lists chat assistants.
### Request
- Method: GET
- URL: `/api/v1/chat?page={page}&page_size={page_size}&orderby={orderby}&desc={desc}&name={dataset_name}&id={dataset_id}`
- URL: `/api/v1/chats?page={page}&page_size={page_size}&orderby={orderby}&desc={desc}&name={dataset_name}&id={dataset_id}`
- Headers:
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -1599,7 +1599,7 @@ Lists chat assistants.
```bash
curl --request GET \
--url http://{address}/api/v1/chat?page={page}&page_size={page_size}&orderby={orderby}&desc={desc}&name={dataset_name}&id={dataset_id} \
--url http://{address}/api/v1/chats?page={page}&page_size={page_size}&orderby={orderby}&desc={desc}&name={dataset_name}&id={dataset_id} \
--header 'Authorization: Bearer {YOUR_API_KEY}'
```
@ -1683,14 +1683,14 @@ Failure:
## Create session
**POST** `/api/v1/chat/{chat_id}/session`
**POST** `/api/v1/chats/{chat_id}/sessions`
Creates a chat session.
### Request
- Method: POST
- URL: `/api/v1/chat/{chat_id}/session`
- URL: `/api/v1/chats/{chat_id}/sessions`
- Headers:
- `'content-Type: application/json'`
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -1701,7 +1701,7 @@ Creates a chat session.
```bash
curl --request POST \
--url http://{address}/api/v1/chat/{chat_id}/session \
--url http://{address}/api/v1/chats/{chat_id}/sessions \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {YOUR_API_KEY}' \
--data '
@ -1755,14 +1755,14 @@ Failure:
## Update session
**PUT** `/api/v1/chat/{chat_id}/session/{session_id}`
**PUT** `/api/v1/chats/{chat_id}/sessions/{session_id}`
Updates a chat session.
### Request
- Method: PUT
- URL: `/api/v1/chat/{chat_id}/session/{session_id}`
- URL: `/api/v1/chats/{chat_id}/sessions/{session_id}`
- Headers:
- `'content-Type: application/json'`
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -1772,7 +1772,7 @@ Updates a chat session.
#### Request example
```bash
curl --request PUT \
--url http://{address}/api/v1/chat/{chat_id}/session/{session_id} \
--url http://{address}/api/v1/chats/{chat_id}/sessions/{session_id} \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {YOUR_API_KEY}' \
--data '
@ -1813,14 +1813,14 @@ Failure:
## List sessions
**GET** `/api/v1/chat/{chat_id}/session?page={page}&page_size={page_size}&orderby={orderby}&desc={desc}&name={session_name}&id={session_id}`
**GET** `/api/v1/chats/{chat_id}/sessions?page={page}&page_size={page_size}&orderby={orderby}&desc={desc}&name={session_name}&id={session_id}`
Lists sessions associated with a specified chat assistant.
### Request
- Method: GET
- URL: `/api/v1/chat/{chat_id}/session?page={page}&page_size={page_size}&orderby={orderby}&desc={desc}&name={session_name}&id={session_id}`
- URL: `/api/v1/chats/{chat_id}/sessions?page={page}&page_size={page_size}&orderby={orderby}&desc={desc}&name={session_name}&id={session_id}`
- Headers:
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -1828,7 +1828,7 @@ Lists sessions associated with a specified chat assistant.
```bash
curl --request GET \
--url http://{address}/api/v1/chat/{chat_id}/session?page={page}&page_size={page_size}&orderby={orderby}&desc={desc}&name={session_name}&id={session_id} \
--url http://{address}/api/v1/chats/{chat_id}/sessions?page={page}&page_size={page_size}&orderby={orderby}&desc={desc}&name={session_name}&id={session_id} \
--header 'Authorization: Bearer {YOUR_API_KEY}'
```
@ -1891,14 +1891,14 @@ Failure:
## Delete sessions
**DELETE** `/api/v1/chat/{chat_id}/session`
**DELETE** `/api/v1/chats/{chat_id}/sessions`
Deletes sessions by ID.
### Request
- Method: DELETE
- URL: `/api/v1/chat/{chat_id}/session`
- URL: `/api/v1/chats/{chat_id}/sessions`
- Headers:
- `'content-Type: application/json'`
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -1910,7 +1910,7 @@ Deletes sessions by ID.
```bash
# Either id or name must be provided, but not both.
curl --request DELETE \
--url http://{address}/api/v1/chat/{chat_id}/session \
--url http://{address}/api/v1/chats/{chat_id}/sessions \
--header 'Content-Type: application/json' \
--header 'Authorization: Bear {YOUR_API_KEY}' \
--data '
@ -1949,14 +1949,14 @@ Failure:
## Converse
**POST** `/api/v1/chat/{chat_id}/completion`
**POST** `/api/v1/chats/{chat_id}/completions`
Asks a question to start an AI-powered conversation.
### Request
- Method: POST
- URL: `/api/v1/chat/{chat_id}/completion`
- URL: `/api/v1/chats/{chat_id}/completions`
- Headers:
- `'content-Type: application/json'`
- `'Authorization: Bearer {YOUR_API_KEY}'`
@ -1969,7 +1969,7 @@ Asks a question to start an AI-powered conversation.
```bash
curl --request POST \
--url http://{address} /api/v1/chat/{chat_id}/completion \
--url http://{address}/api/v1/chats/{chat_id}/completions \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {YOUR_API_KEY}' \
--data-binary '