mirror of
https://git.mirrors.martin98.com/https://github.com/infiniflow/ragflow.git
synced 2025-08-02 05:40:39 +08:00
API: start parsing (#1377)
### What problem does this PR solve? Make the document start parsing. ### Type of change - [x] New Feature (non-breaking change which adds functionality)
This commit is contained in:
parent
8d7fb12305
commit
2c2b2e0779
@ -18,30 +18,35 @@ import re
|
|||||||
import warnings
|
import warnings
|
||||||
from io import BytesIO
|
from io import BytesIO
|
||||||
|
|
||||||
|
from elasticsearch_dsl import Q
|
||||||
from flask import request, send_file
|
from flask import request, send_file
|
||||||
from flask_login import login_required, current_user
|
from flask_login import login_required, current_user
|
||||||
from httpx import HTTPError
|
from httpx import HTTPError
|
||||||
from minio import S3Error
|
|
||||||
|
|
||||||
from api.contants import NAME_LENGTH_LIMIT
|
from api.contants import NAME_LENGTH_LIMIT
|
||||||
from api.db import FileType, ParserType, FileSource
|
from api.db import FileType, ParserType, FileSource, TaskStatus
|
||||||
from api.db import StatusEnum
|
from api.db import StatusEnum
|
||||||
from api.db.db_models import File
|
from api.db.db_models import File, Task
|
||||||
from api.db.services import duplicate_name
|
from api.db.services import duplicate_name
|
||||||
from api.db.services.document_service import DocumentService
|
from api.db.services.document_service import DocumentService
|
||||||
from api.db.services.file2document_service import File2DocumentService
|
from api.db.services.file2document_service import File2DocumentService
|
||||||
from api.db.services.file_service import FileService
|
from api.db.services.file_service import FileService
|
||||||
from api.db.services.knowledgebase_service import KnowledgebaseService
|
from api.db.services.knowledgebase_service import KnowledgebaseService
|
||||||
|
from api.db.services.task_service import TaskService
|
||||||
from api.db.services.user_service import TenantService
|
from api.db.services.user_service import TenantService
|
||||||
from api.settings import RetCode
|
from api.settings import RetCode
|
||||||
from api.utils import get_uuid
|
from api.utils import get_uuid
|
||||||
from api.utils.api_utils import construct_json_result, construct_error_response
|
from api.utils.api_utils import construct_json_result, construct_error_response
|
||||||
from api.utils.api_utils import construct_result, validate_request
|
from api.utils.api_utils import construct_result, validate_request
|
||||||
from api.utils.file_utils import filename_type, thumbnail
|
from api.utils.file_utils import filename_type, thumbnail
|
||||||
|
from rag.app import book, laws, manual, naive, one, paper, presentation, qa, resume, table, picture
|
||||||
|
from rag.nlp import search
|
||||||
|
from rag.utils.es_conn import ELASTICSEARCH
|
||||||
from rag.utils.minio_conn import MINIO
|
from rag.utils.minio_conn import MINIO
|
||||||
|
|
||||||
MAXIMUM_OF_UPLOADING_FILES = 256
|
MAXIMUM_OF_UPLOADING_FILES = 256
|
||||||
|
|
||||||
|
|
||||||
# ------------------------------ create a dataset ---------------------------------------
|
# ------------------------------ create a dataset ---------------------------------------
|
||||||
|
|
||||||
@manager.route("/", methods=["POST"])
|
@manager.route("/", methods=["POST"])
|
||||||
@ -116,6 +121,7 @@ def create_dataset():
|
|||||||
except Exception as e:
|
except Exception as e:
|
||||||
return construct_error_response(e)
|
return construct_error_response(e)
|
||||||
|
|
||||||
|
|
||||||
# -----------------------------list datasets-------------------------------------------------------
|
# -----------------------------list datasets-------------------------------------------------------
|
||||||
|
|
||||||
@manager.route("/", methods=["GET"])
|
@manager.route("/", methods=["GET"])
|
||||||
@ -135,6 +141,7 @@ def list_datasets():
|
|||||||
except HTTPError as http_err:
|
except HTTPError as http_err:
|
||||||
return construct_json_result(http_err)
|
return construct_json_result(http_err)
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------delete a dataset ----------------------------
|
# ---------------------------------delete a dataset ----------------------------
|
||||||
|
|
||||||
@manager.route("/<dataset_id>", methods=["DELETE"])
|
@manager.route("/<dataset_id>", methods=["DELETE"])
|
||||||
@ -162,13 +169,15 @@ def remove_dataset(dataset_id):
|
|||||||
|
|
||||||
# delete the dataset
|
# delete the dataset
|
||||||
if not KnowledgebaseService.delete_by_id(dataset_id):
|
if not KnowledgebaseService.delete_by_id(dataset_id):
|
||||||
return construct_json_result(code=RetCode.DATA_ERROR, message="There was an error during the dataset removal process. "
|
return construct_json_result(code=RetCode.DATA_ERROR,
|
||||||
"Please check the status of the RAGFlow server and try the removal again.")
|
message="There was an error during the dataset removal process. "
|
||||||
|
"Please check the status of the RAGFlow server and try the removal again.")
|
||||||
# success
|
# success
|
||||||
return construct_json_result(code=RetCode.SUCCESS, message=f"Remove dataset: {dataset_id} successfully")
|
return construct_json_result(code=RetCode.SUCCESS, message=f"Remove dataset: {dataset_id} successfully")
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
return construct_error_response(e)
|
return construct_error_response(e)
|
||||||
|
|
||||||
|
|
||||||
# ------------------------------ get details of a dataset ----------------------------------------
|
# ------------------------------ get details of a dataset ----------------------------------------
|
||||||
|
|
||||||
@manager.route("/<dataset_id>", methods=["GET"])
|
@manager.route("/<dataset_id>", methods=["GET"])
|
||||||
@ -182,6 +191,7 @@ def get_dataset(dataset_id):
|
|||||||
except Exception as e:
|
except Exception as e:
|
||||||
return construct_json_result(e)
|
return construct_json_result(e)
|
||||||
|
|
||||||
|
|
||||||
# ------------------------------ update a dataset --------------------------------------------
|
# ------------------------------ update a dataset --------------------------------------------
|
||||||
|
|
||||||
@manager.route("/<dataset_id>", methods=["PUT"])
|
@manager.route("/<dataset_id>", methods=["PUT"])
|
||||||
@ -209,8 +219,9 @@ def update_dataset(dataset_id):
|
|||||||
if name.lower() != dataset.name.lower() \
|
if name.lower() != dataset.name.lower() \
|
||||||
and len(KnowledgebaseService.query(name=name, tenant_id=current_user.id,
|
and len(KnowledgebaseService.query(name=name, tenant_id=current_user.id,
|
||||||
status=StatusEnum.VALID.value)) > 1:
|
status=StatusEnum.VALID.value)) > 1:
|
||||||
return construct_json_result(code=RetCode.DATA_ERROR, message=f"The name: {name.lower()} is already used by other "
|
return construct_json_result(code=RetCode.DATA_ERROR,
|
||||||
f"datasets. Please choose a different name.")
|
message=f"The name: {name.lower()} is already used by other "
|
||||||
|
f"datasets. Please choose a different name.")
|
||||||
|
|
||||||
dataset_updating_data = {}
|
dataset_updating_data = {}
|
||||||
chunk_num = req.get("chunk_num")
|
chunk_num = req.get("chunk_num")
|
||||||
@ -222,17 +233,21 @@ def update_dataset(dataset_id):
|
|||||||
if chunk_num == 0:
|
if chunk_num == 0:
|
||||||
dataset_updating_data["embd_id"] = req["embedding_model_id"]
|
dataset_updating_data["embd_id"] = req["embedding_model_id"]
|
||||||
else:
|
else:
|
||||||
construct_json_result(code=RetCode.DATA_ERROR, message="You have already parsed the document in this "
|
return construct_json_result(code=RetCode.DATA_ERROR, message="You have already parsed the document in this "
|
||||||
"dataset, so you cannot change the embedding "
|
"dataset, so you cannot change the embedding "
|
||||||
"model.")
|
"model.")
|
||||||
# only if chunk_num is 0, the user can update the chunk_method
|
# only if chunk_num is 0, the user can update the chunk_method
|
||||||
if req.get("chunk_method"):
|
if "chunk_method" in req:
|
||||||
if chunk_num == 0:
|
type_value = req["chunk_method"]
|
||||||
dataset_updating_data['parser_id'] = req["chunk_method"]
|
if is_illegal_value_for_enum(type_value, ParserType):
|
||||||
else:
|
return construct_json_result(message=f"Illegal value {type_value} for 'chunk_method' field.",
|
||||||
|
code=RetCode.DATA_ERROR)
|
||||||
|
if chunk_num != 0:
|
||||||
construct_json_result(code=RetCode.DATA_ERROR, message="You have already parsed the document "
|
construct_json_result(code=RetCode.DATA_ERROR, message="You have already parsed the document "
|
||||||
"in this dataset, so you cannot "
|
"in this dataset, so you cannot "
|
||||||
"change the chunk method.")
|
"change the chunk method.")
|
||||||
|
dataset_updating_data["parser_id"] = req["template_type"]
|
||||||
|
|
||||||
# convert the photo parameter to avatar
|
# convert the photo parameter to avatar
|
||||||
if req.get("photo"):
|
if req.get("photo"):
|
||||||
dataset_updating_data["avatar"] = req["photo"]
|
dataset_updating_data["avatar"] = req["photo"]
|
||||||
@ -265,6 +280,7 @@ def update_dataset(dataset_id):
|
|||||||
except Exception as e:
|
except Exception as e:
|
||||||
return construct_error_response(e)
|
return construct_error_response(e)
|
||||||
|
|
||||||
|
|
||||||
# --------------------------------content management ----------------------------------------------
|
# --------------------------------content management ----------------------------------------------
|
||||||
|
|
||||||
# ----------------------------upload files-----------------------------------------------------
|
# ----------------------------upload files-----------------------------------------------------
|
||||||
@ -339,9 +355,10 @@ def upload_documents(dataset_id):
|
|||||||
location += "_"
|
location += "_"
|
||||||
|
|
||||||
blob = file.read()
|
blob = file.read()
|
||||||
|
|
||||||
# the content is empty, raising a warning
|
# the content is empty, raising a warning
|
||||||
if blob == b'':
|
if blob == b'':
|
||||||
warnings.warn(f"[WARNING]: The file {filename} is empty.")
|
warnings.warn(f"[WARNING]: The content of the file {filename} is empty.")
|
||||||
|
|
||||||
MINIO.put(dataset_id, location, blob)
|
MINIO.put(dataset_id, location, blob)
|
||||||
|
|
||||||
@ -453,6 +470,7 @@ def list_documents(dataset_id):
|
|||||||
except Exception as e:
|
except Exception as e:
|
||||||
return construct_error_response(e)
|
return construct_error_response(e)
|
||||||
|
|
||||||
|
|
||||||
# ----------------------------update: enable rename-----------------------------------------------------
|
# ----------------------------update: enable rename-----------------------------------------------------
|
||||||
@manager.route("/<dataset_id>/documents/<document_id>", methods=["PUT"])
|
@manager.route("/<dataset_id>/documents/<document_id>", methods=["PUT"])
|
||||||
@login_required
|
@login_required
|
||||||
@ -555,6 +573,7 @@ def update_document(dataset_id, document_id):
|
|||||||
def is_illegal_value_for_enum(value, enum_class):
|
def is_illegal_value_for_enum(value, enum_class):
|
||||||
return value not in enum_class.__members__.values()
|
return value not in enum_class.__members__.values()
|
||||||
|
|
||||||
|
|
||||||
# ----------------------------download a file-----------------------------------------------------
|
# ----------------------------download a file-----------------------------------------------------
|
||||||
@manager.route("/<dataset_id>/documents/<document_id>", methods=["GET"])
|
@manager.route("/<dataset_id>/documents/<document_id>", methods=["GET"])
|
||||||
@login_required
|
@login_required
|
||||||
@ -563,7 +582,8 @@ def download_document(dataset_id, document_id):
|
|||||||
# Check whether there is this dataset
|
# Check whether there is this dataset
|
||||||
exist, _ = KnowledgebaseService.get_by_id(dataset_id)
|
exist, _ = KnowledgebaseService.get_by_id(dataset_id)
|
||||||
if not exist:
|
if not exist:
|
||||||
return construct_json_result(code=RetCode.DATA_ERROR, message=f"This dataset '{dataset_id}' cannot be found!")
|
return construct_json_result(code=RetCode.DATA_ERROR,
|
||||||
|
message=f"This dataset '{dataset_id}' cannot be found!")
|
||||||
|
|
||||||
# Check whether there is this document
|
# Check whether there is this document
|
||||||
exist, document = DocumentService.get_by_id(document_id)
|
exist, document = DocumentService.get_by_id(document_id)
|
||||||
@ -591,8 +611,142 @@ def download_document(dataset_id, document_id):
|
|||||||
except Exception as e:
|
except Exception as e:
|
||||||
return construct_error_response(e)
|
return construct_error_response(e)
|
||||||
|
|
||||||
# ----------------------------start parsing-----------------------------------------------------
|
|
||||||
|
|
||||||
|
# ----------------------------start parsing a document-----------------------------------------------------
|
||||||
|
# helper method for parsing
|
||||||
|
def dummy(prog=None, msg=""):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def doc_parse(binary, doc_name, parser_name, tenant_id):
|
||||||
|
match parser_name:
|
||||||
|
case "book":
|
||||||
|
book.chunk(doc_name, binary=binary, callback=dummy)
|
||||||
|
case "laws":
|
||||||
|
laws.chunk(doc_name, binary=binary, callback=dummy)
|
||||||
|
case "manual":
|
||||||
|
manual.chunk(doc_name, binary=binary, callback=dummy)
|
||||||
|
case "naive":
|
||||||
|
# It's the mode by default, which is general in the front-end
|
||||||
|
naive.chunk(doc_name, binary=binary, callback=dummy)
|
||||||
|
case "one":
|
||||||
|
one.chunk(doc_name, binary=binary, callback=dummy)
|
||||||
|
case "paper":
|
||||||
|
paper.chunk(doc_name, binary=binary, callback=dummy)
|
||||||
|
case "picture":
|
||||||
|
picture.chunk(doc_name, binary=binary, tenant_id=tenant_id, lang="Chinese", callback=dummy)
|
||||||
|
case "presentation":
|
||||||
|
presentation.chunk(doc_name, binary=binary, callback=dummy)
|
||||||
|
case "qa":
|
||||||
|
qa.chunk(doc_name, binary=binary, callback=dummy)
|
||||||
|
case "resume":
|
||||||
|
resume.chunk(doc_name, binary=binary, callback=dummy)
|
||||||
|
case "table":
|
||||||
|
table.chunk(doc_name, binary=binary, callback=dummy)
|
||||||
|
case _:
|
||||||
|
return False
|
||||||
|
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
@manager.route("/<dataset_id>/documents/<document_id>/status", methods=["POST"])
|
||||||
|
@login_required
|
||||||
|
def parse_document(dataset_id, document_id):
|
||||||
|
try:
|
||||||
|
# valid dataset
|
||||||
|
exist, _ = KnowledgebaseService.get_by_id(dataset_id)
|
||||||
|
if not exist:
|
||||||
|
return construct_json_result(code=RetCode.DATA_ERROR,
|
||||||
|
message=f"This dataset '{dataset_id}' cannot be found!")
|
||||||
|
message = ""
|
||||||
|
res = get_message_during_parsing_document(document_id, message)
|
||||||
|
if isinstance(res, str):
|
||||||
|
message += res
|
||||||
|
return construct_json_result(code=RetCode.SUCCESS, message=message)
|
||||||
|
else:
|
||||||
|
return res
|
||||||
|
|
||||||
|
except Exception as e:
|
||||||
|
return construct_error_response(e)
|
||||||
|
|
||||||
|
|
||||||
|
# ----------------------------start parsing documents-----------------------------------------------------
|
||||||
|
@manager.route("/<dataset_id>/documents/status", methods=["POST"])
|
||||||
|
@login_required
|
||||||
|
def parse_documents(dataset_id):
|
||||||
|
doc_ids = request.json["doc_ids"]
|
||||||
|
try:
|
||||||
|
exist, _ = KnowledgebaseService.get_by_id(dataset_id)
|
||||||
|
if not exist:
|
||||||
|
return construct_json_result(code=RetCode.DATA_ERROR,
|
||||||
|
message=f"This dataset '{dataset_id}' cannot be found!")
|
||||||
|
|
||||||
|
def process(doc_ids):
|
||||||
|
message = ""
|
||||||
|
# for loop
|
||||||
|
for id in doc_ids:
|
||||||
|
res = get_message_during_parsing_document(id, message)
|
||||||
|
if isinstance(res, str):
|
||||||
|
message += res
|
||||||
|
else:
|
||||||
|
return res
|
||||||
|
return construct_json_result(data=True, code=RetCode.SUCCESS, message=message)
|
||||||
|
|
||||||
|
# two conditions
|
||||||
|
if doc_ids:
|
||||||
|
return process(doc_ids)
|
||||||
|
else:
|
||||||
|
# documents inside the dataset
|
||||||
|
docs, total = DocumentService.list_documents_in_dataset(dataset_id, 0, -1, "create_time",
|
||||||
|
True, "")
|
||||||
|
doc_ids = [doc["id"] for doc in docs]
|
||||||
|
return process(doc_ids)
|
||||||
|
|
||||||
|
except Exception as e:
|
||||||
|
return construct_error_response(e)
|
||||||
|
|
||||||
|
|
||||||
|
# helper method for getting message or response when parsing the document
|
||||||
|
def get_message_during_parsing_document(id, message):
|
||||||
|
try:
|
||||||
|
# Check whether there is this document
|
||||||
|
exist, document = DocumentService.get_by_id(id)
|
||||||
|
if not exist:
|
||||||
|
return construct_json_result(message=f"This document '{id}' cannot be found!",
|
||||||
|
code=RetCode.ARGUMENT_ERROR)
|
||||||
|
|
||||||
|
tenant_id = DocumentService.get_tenant_id(id)
|
||||||
|
if not tenant_id:
|
||||||
|
return construct_json_result(message="Tenant not found!", code=RetCode.AUTHENTICATION_ERROR)
|
||||||
|
|
||||||
|
info = {"run": "1", "progress": 0}
|
||||||
|
info["progress_msg"] = ""
|
||||||
|
info["chunk_num"] = 0
|
||||||
|
info["token_num"] = 0
|
||||||
|
|
||||||
|
DocumentService.update_by_id(id, info)
|
||||||
|
|
||||||
|
ELASTICSEARCH.deleteByQuery(Q("match", doc_id=id), idxnm=search.index_name(tenant_id))
|
||||||
|
|
||||||
|
_, doc_attributes = DocumentService.get_by_id(id)
|
||||||
|
doc_attributes = doc_attributes.to_dict()
|
||||||
|
doc_id = doc_attributes["id"]
|
||||||
|
|
||||||
|
bucket, doc_name = File2DocumentService.get_minio_address(doc_id=doc_id)
|
||||||
|
binary = MINIO.get(bucket, doc_name)
|
||||||
|
parser_name = doc_attributes["parser_id"]
|
||||||
|
if binary:
|
||||||
|
res = doc_parse(binary, doc_name, parser_name, tenant_id)
|
||||||
|
if res is False:
|
||||||
|
message += f"The parser id: {parser_name} of the document {doc_id} is not supported; "
|
||||||
|
else:
|
||||||
|
message += f"Empty data in the document: {doc_name}; "
|
||||||
|
# failed in parsing
|
||||||
|
if doc_attributes["status"] == TaskStatus.FAIL.value:
|
||||||
|
message += f"Failed in parsing the document: {doc_id}; "
|
||||||
|
return message
|
||||||
|
except Exception as e:
|
||||||
|
return construct_error_response(e)
|
||||||
# ----------------------------stop parsing-----------------------------------------------------
|
# ----------------------------stop parsing-----------------------------------------------------
|
||||||
|
|
||||||
# ----------------------------show the status of the file-----------------------------------------------------
|
# ----------------------------show the status of the file-----------------------------------------------------
|
||||||
@ -610,6 +764,3 @@ def download_document(dataset_id, document_id):
|
|||||||
# ----------------------------get a specific chunk-----------------------------------------------------
|
# ----------------------------get a specific chunk-----------------------------------------------------
|
||||||
|
|
||||||
# ----------------------------retrieval test-----------------------------------------------------
|
# ----------------------------retrieval test-----------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@ -142,7 +142,19 @@ class RAGFlow:
|
|||||||
with open(file_path, "wb") as file:
|
with open(file_path, "wb") as file:
|
||||||
file.write(content)
|
file.write(content)
|
||||||
return {"code": RetCode.SUCCESS, "data": content}
|
return {"code": RetCode.SUCCESS, "data": content}
|
||||||
|
|
||||||
# ----------------------------start parsing-----------------------------------------------------
|
# ----------------------------start parsing-----------------------------------------------------
|
||||||
|
def start_parsing_document(self, dataset_id, document_id):
|
||||||
|
endpoint = f"{self.dataset_url}/{dataset_id}/documents/{document_id}/status"
|
||||||
|
res = requests.post(endpoint, headers=self.authorization_header)
|
||||||
|
|
||||||
|
return res.json()
|
||||||
|
|
||||||
|
def start_parsing_documents(self, dataset_id, doc_ids=None):
|
||||||
|
endpoint = f"{self.dataset_url}/{dataset_id}/documents/status"
|
||||||
|
res = requests.post(endpoint, headers=self.authorization_header, json={"doc_ids": doc_ids})
|
||||||
|
|
||||||
|
return res.json()
|
||||||
|
|
||||||
# ----------------------------stop parsing-----------------------------------------------------
|
# ----------------------------stop parsing-----------------------------------------------------
|
||||||
|
|
||||||
|
3
sdk/python/test/test_data/lol.txt
Normal file
3
sdk/python/test/test_data/lol.txt
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
llll
|
||||||
|
ooooo
|
||||||
|
llll
|
@ -695,7 +695,261 @@ class TestFile(TestSdk):
|
|||||||
assert res["code"] == RetCode.DATA_ERROR and res["message"] == "This file is empty."
|
assert res["code"] == RetCode.DATA_ERROR and res["message"] == "This file is empty."
|
||||||
|
|
||||||
# ----------------------------start parsing-----------------------------------------------------
|
# ----------------------------start parsing-----------------------------------------------------
|
||||||
|
def test_start_parsing_document_with_success(self):
|
||||||
|
"""
|
||||||
|
Test the parsing of a document with success.
|
||||||
|
"""
|
||||||
|
# create a dataset
|
||||||
|
ragflow = RAGFlow(API_KEY, HOST_ADDRESS)
|
||||||
|
created_res = ragflow.create_dataset("test_start_parsing_document_with_success")
|
||||||
|
created_res_id = created_res["data"]["dataset_id"]
|
||||||
|
# upload files
|
||||||
|
file_paths = ["test_data/lol.txt"]
|
||||||
|
uploading_res = ragflow.upload_local_file(created_res_id, file_paths)
|
||||||
|
# get the doc_id
|
||||||
|
data = uploading_res["data"][0]
|
||||||
|
doc_id = data["id"]
|
||||||
|
# parse file
|
||||||
|
res = ragflow.start_parsing_document(created_res_id, doc_id)
|
||||||
|
assert res["code"] == RetCode.SUCCESS and res["message"] == ""
|
||||||
|
|
||||||
|
def test_start_parsing_nonexistent_document(self):
|
||||||
|
"""
|
||||||
|
Test the parsing a document which does not exist.
|
||||||
|
"""
|
||||||
|
# create a dataset
|
||||||
|
ragflow = RAGFlow(API_KEY, HOST_ADDRESS)
|
||||||
|
created_res = ragflow.create_dataset("test_start_parsing_nonexistent_document")
|
||||||
|
created_res_id = created_res["data"]["dataset_id"]
|
||||||
|
res = ragflow.start_parsing_document(created_res_id, "imagination")
|
||||||
|
assert res["code"] == RetCode.ARGUMENT_ERROR and res["message"] == "This document 'imagination' cannot be found!"
|
||||||
|
|
||||||
|
def test_start_parsing_document_in_nonexistent_dataset(self):
|
||||||
|
"""
|
||||||
|
Test the parsing a document whose dataset is nonexistent.
|
||||||
|
"""
|
||||||
|
# create a dataset
|
||||||
|
ragflow = RAGFlow(API_KEY, HOST_ADDRESS)
|
||||||
|
created_res = ragflow.create_dataset("test_download_nonexistent_document")
|
||||||
|
created_res_id = created_res["data"]["dataset_id"]
|
||||||
|
# upload files
|
||||||
|
file_paths = ["test_data/test.txt"]
|
||||||
|
uploading_res = ragflow.upload_local_file(created_res_id, file_paths)
|
||||||
|
# get the doc_id
|
||||||
|
data = uploading_res["data"][0]
|
||||||
|
doc_id = data["id"]
|
||||||
|
# parse
|
||||||
|
res = ragflow.start_parsing_document("imagination", doc_id)
|
||||||
|
assert res["code"] == RetCode.DATA_ERROR and res["message"] == "This dataset 'imagination' cannot be found!"
|
||||||
|
|
||||||
|
def test_start_parsing_an_empty_document(self):
|
||||||
|
"""
|
||||||
|
Test the parsing of an empty document.
|
||||||
|
"""
|
||||||
|
# create a dataset
|
||||||
|
ragflow = RAGFlow(API_KEY, HOST_ADDRESS)
|
||||||
|
created_res = ragflow.create_dataset("test_download_nonexistent_document")
|
||||||
|
created_res_id = created_res["data"]["dataset_id"]
|
||||||
|
# upload files
|
||||||
|
file_paths = ["test_data/empty.txt"]
|
||||||
|
uploading_res = ragflow.upload_local_file(created_res_id, file_paths)
|
||||||
|
# get the doc_id
|
||||||
|
data = uploading_res["data"][0]
|
||||||
|
doc_id = data["id"]
|
||||||
|
res = ragflow.start_parsing_document(created_res_id, doc_id)
|
||||||
|
assert res["code"] == RetCode.SUCCESS and res["message"] == "Empty data in the document: empty.txt; "
|
||||||
|
|
||||||
|
# ------------------------parsing multiple documents----------------------------
|
||||||
|
def test_start_parsing_documents_in_nonexistent_dataset(self):
|
||||||
|
"""
|
||||||
|
Test the parsing documents whose dataset is nonexistent.
|
||||||
|
"""
|
||||||
|
# create a dataset
|
||||||
|
ragflow = RAGFlow(API_KEY, HOST_ADDRESS)
|
||||||
|
created_res = ragflow.create_dataset("test_download_nonexistent_document")
|
||||||
|
created_res_id = created_res["data"]["dataset_id"]
|
||||||
|
# upload files
|
||||||
|
file_paths = ["test_data/test.txt"]
|
||||||
|
uploading_res = ragflow.upload_local_file(created_res_id, file_paths)
|
||||||
|
# parse
|
||||||
|
res = ragflow.start_parsing_documents("imagination")
|
||||||
|
assert res["code"] == RetCode.DATA_ERROR and res["message"] == "This dataset 'imagination' cannot be found!"
|
||||||
|
|
||||||
|
def test_start_parsing_multiple_documents(self):
|
||||||
|
"""
|
||||||
|
Test the parsing documents with a success.
|
||||||
|
"""
|
||||||
|
# create a dataset
|
||||||
|
ragflow = RAGFlow(API_KEY, HOST_ADDRESS)
|
||||||
|
created_res = ragflow.create_dataset(" test_start_parsing_multiple_documents")
|
||||||
|
created_res_id = created_res["data"]["dataset_id"]
|
||||||
|
# upload files
|
||||||
|
file_paths = ["test_data/test.txt", "test_data/test1.txt"]
|
||||||
|
ragflow.upload_local_file(created_res_id, file_paths)
|
||||||
|
res = ragflow.start_parsing_documents(created_res_id)
|
||||||
|
assert res["code"] == RetCode.SUCCESS and res["data"] is True and res["message"] == ""
|
||||||
|
|
||||||
|
def test_start_parsing_multiple_documents_with_one_empty_file(self):
|
||||||
|
"""
|
||||||
|
Test the parsing documents, one of which is empty.
|
||||||
|
"""
|
||||||
|
# create a dataset
|
||||||
|
ragflow = RAGFlow(API_KEY, HOST_ADDRESS)
|
||||||
|
created_res = ragflow.create_dataset(" test_start_parsing_multiple_documents")
|
||||||
|
created_res_id = created_res["data"]["dataset_id"]
|
||||||
|
# upload files
|
||||||
|
file_paths = ["test_data/test.txt", "test_data/test1.txt", "test_data/empty.txt"]
|
||||||
|
ragflow.upload_local_file(created_res_id, file_paths)
|
||||||
|
res = ragflow.start_parsing_documents(created_res_id)
|
||||||
|
assert res["code"] == RetCode.SUCCESS and res["message"] == "Empty data in the document: empty.txt; "
|
||||||
|
|
||||||
|
def test_start_parsing_multiple_specific_documents(self):
|
||||||
|
"""
|
||||||
|
Test the parsing documents whose document ids are specified.
|
||||||
|
"""
|
||||||
|
# create a dataset
|
||||||
|
ragflow = RAGFlow(API_KEY, HOST_ADDRESS)
|
||||||
|
created_res = ragflow.create_dataset(" test_start_parsing_multiple_documents")
|
||||||
|
created_res_id = created_res["data"]["dataset_id"]
|
||||||
|
# upload files
|
||||||
|
file_paths = ["test_data/test.txt", "test_data/test1.txt"]
|
||||||
|
uploading_res = ragflow.upload_local_file(created_res_id, file_paths)
|
||||||
|
# get the doc_id
|
||||||
|
data = uploading_res["data"]
|
||||||
|
doc_ids = []
|
||||||
|
for d in data:
|
||||||
|
doc_ids.append(d["id"])
|
||||||
|
res = ragflow.start_parsing_documents(created_res_id, doc_ids)
|
||||||
|
assert res["code"] == RetCode.SUCCESS and res["message"] == ""
|
||||||
|
|
||||||
|
def test_start_re_parsing_multiple_specific_documents(self):
|
||||||
|
"""
|
||||||
|
Test the re-parsing documents.
|
||||||
|
"""
|
||||||
|
# create a dataset
|
||||||
|
ragflow = RAGFlow(API_KEY, HOST_ADDRESS)
|
||||||
|
created_res = ragflow.create_dataset(" test_start_parsing_multiple_documents")
|
||||||
|
created_res_id = created_res["data"]["dataset_id"]
|
||||||
|
# upload files
|
||||||
|
file_paths = ["test_data/test.txt", "test_data/test1.txt"]
|
||||||
|
uploading_res = ragflow.upload_local_file(created_res_id, file_paths)
|
||||||
|
# get the doc_id
|
||||||
|
data = uploading_res["data"]
|
||||||
|
doc_ids = []
|
||||||
|
for d in data:
|
||||||
|
doc_ids.append(d["id"])
|
||||||
|
res = ragflow.start_parsing_documents(created_res_id, doc_ids)
|
||||||
|
assert res["code"] == RetCode.SUCCESS and res["message"] == ""
|
||||||
|
# re-parse
|
||||||
|
res = ragflow.start_parsing_documents(created_res_id, doc_ids)
|
||||||
|
assert res["code"] == RetCode.SUCCESS and res["message"] == ""
|
||||||
|
|
||||||
|
def test_start_re_parsing_multiple_specific_documents_with_changing_parser_id(self):
|
||||||
|
"""
|
||||||
|
Test the re-parsing documents after changing the parser id.
|
||||||
|
"""
|
||||||
|
# create a dataset
|
||||||
|
ragflow = RAGFlow(API_KEY, HOST_ADDRESS)
|
||||||
|
created_res = ragflow.create_dataset(" test_start_parsing_multiple_documents")
|
||||||
|
created_res_id = created_res["data"]["dataset_id"]
|
||||||
|
# upload files
|
||||||
|
file_paths = ["test_data/test.txt", "test_data/test1.txt"]
|
||||||
|
uploading_res = ragflow.upload_local_file(created_res_id, file_paths)
|
||||||
|
# get the doc_id
|
||||||
|
data = uploading_res["data"]
|
||||||
|
doc_ids = []
|
||||||
|
for d in data:
|
||||||
|
doc_ids.append(d["id"])
|
||||||
|
res = ragflow.start_parsing_documents(created_res_id, doc_ids)
|
||||||
|
assert res["code"] == RetCode.SUCCESS and res["message"] == ""
|
||||||
|
# general -> laws
|
||||||
|
params = {
|
||||||
|
"template_type": "laws"
|
||||||
|
}
|
||||||
|
ragflow.update_file(created_res_id, doc_ids[0], **params)
|
||||||
|
# re-parse
|
||||||
|
res = ragflow.start_parsing_documents(created_res_id, doc_ids)
|
||||||
|
assert res["code"] == RetCode.SUCCESS and res["message"] == ""
|
||||||
|
|
||||||
|
def test_start_re_parsing_multiple_specific_documents_with_changing_illegal_parser_id(self):
|
||||||
|
"""
|
||||||
|
Test the re-parsing documents after changing an illegal parser id.
|
||||||
|
"""
|
||||||
|
# create a dataset
|
||||||
|
ragflow = RAGFlow(API_KEY, HOST_ADDRESS)
|
||||||
|
created_res = ragflow.create_dataset(" test_start_parsing_multiple_documents")
|
||||||
|
created_res_id = created_res["data"]["dataset_id"]
|
||||||
|
# upload files
|
||||||
|
file_paths = ["test_data/test.txt", "test_data/test1.txt"]
|
||||||
|
uploading_res = ragflow.upload_local_file(created_res_id, file_paths)
|
||||||
|
# get the doc_id
|
||||||
|
data = uploading_res["data"]
|
||||||
|
doc_ids = []
|
||||||
|
for d in data:
|
||||||
|
doc_ids.append(d["id"])
|
||||||
|
res = ragflow.start_parsing_documents(created_res_id, doc_ids)
|
||||||
|
assert res["code"] == RetCode.SUCCESS and res["message"] == ""
|
||||||
|
# general -> illegal
|
||||||
|
params = {
|
||||||
|
"template_type": "illegal"
|
||||||
|
}
|
||||||
|
res = ragflow.update_file(created_res_id, doc_ids[0], **params)
|
||||||
|
assert res["code"] == RetCode.DATA_ERROR and res["message"] == "Illegal value illegal for 'template_type' field."
|
||||||
|
# re-parse
|
||||||
|
res = ragflow.start_parsing_documents(created_res_id, doc_ids)
|
||||||
|
assert res["code"] == RetCode.SUCCESS and res["message"] == ""
|
||||||
|
|
||||||
|
def test_start_parsing_multiple_specific_documents_with_changing_illegal_parser_id(self):
|
||||||
|
"""
|
||||||
|
Test the parsing documents after changing an illegal parser id.
|
||||||
|
"""
|
||||||
|
# create a dataset
|
||||||
|
ragflow = RAGFlow(API_KEY, HOST_ADDRESS)
|
||||||
|
created_res = ragflow.create_dataset(" test_start_parsing_multiple_documents")
|
||||||
|
created_res_id = created_res["data"]["dataset_id"]
|
||||||
|
# upload files
|
||||||
|
file_paths = ["test_data/test.txt", "test_data/test1.txt"]
|
||||||
|
uploading_res = ragflow.upload_local_file(created_res_id, file_paths)
|
||||||
|
# get the doc_id
|
||||||
|
data = uploading_res["data"]
|
||||||
|
doc_ids = []
|
||||||
|
for d in data:
|
||||||
|
doc_ids.append(d["id"])
|
||||||
|
# general -> illegal
|
||||||
|
params = {
|
||||||
|
"template_type": "illegal"
|
||||||
|
}
|
||||||
|
res = ragflow.update_file(created_res_id, doc_ids[0], **params)
|
||||||
|
assert res["code"] == RetCode.DATA_ERROR and res["message"] == "Illegal value illegal for 'template_type' field."
|
||||||
|
# re-parse
|
||||||
|
res = ragflow.start_parsing_documents(created_res_id, doc_ids)
|
||||||
|
assert res["code"] == RetCode.SUCCESS and res["message"] == ""
|
||||||
|
|
||||||
|
def test_start_parsing_multiple_documents_in_the_dataset_whose_parser_id_is_illegal(self):
|
||||||
|
"""
|
||||||
|
Test the parsing documents whose dataset's parser id is illegal.
|
||||||
|
"""
|
||||||
|
# create a dataset
|
||||||
|
ragflow = RAGFlow(API_KEY, HOST_ADDRESS)
|
||||||
|
created_res = ragflow.create_dataset("test_start_parsing_multiple_documents_in_the_dataset_whose_parser_id_is_illegal")
|
||||||
|
created_res_id = created_res["data"]["dataset_id"]
|
||||||
|
# update the parser id
|
||||||
|
params = {
|
||||||
|
"chunk_method": "illegal"
|
||||||
|
}
|
||||||
|
res = ragflow.update_dataset("test_start_parsing_multiple_documents_in_the_dataset_whose_parser_id_is_illegal", **params)
|
||||||
|
assert res["code"] == RetCode.DATA_ERROR and res["message"] == "Illegal value illegal for 'chunk_method' field."
|
||||||
|
# upload files
|
||||||
|
file_paths = ["test_data/test.txt", "test_data/test1.txt"]
|
||||||
|
uploading_res = ragflow.upload_local_file(created_res_id, file_paths)
|
||||||
|
# get the doc_id
|
||||||
|
data = uploading_res["data"]
|
||||||
|
doc_ids = []
|
||||||
|
for d in data:
|
||||||
|
doc_ids.append(d["id"])
|
||||||
|
# parse
|
||||||
|
res = ragflow.start_parsing_documents(created_res_id, doc_ids)
|
||||||
|
assert res["code"] == RetCode.SUCCESS and res["message"] == ""
|
||||||
# ----------------------------stop parsing-----------------------------------------------------
|
# ----------------------------stop parsing-----------------------------------------------------
|
||||||
|
|
||||||
# ----------------------------show the status of the file-----------------------------------------------------
|
# ----------------------------show the status of the file-----------------------------------------------------
|
||||||
|
Loading…
x
Reference in New Issue
Block a user