Download ragflow-main/api/apps/kb_app.py from pandaall/ragflow: direct link, hf CLI and curl.
- Browser
- Download file 12.8 kB
-
https://huggingface.co/datasets/pandaall/ragflow/resolve/main/ragflow-main/api/apps/kb_app.py
- Command line
-
hf download hf://datasets/pandaall/ragflow/ragflow-main/api/apps/kb_app.py
-
curl -L -o kb_app.py https://huggingface.co/datasets/pandaall/ragflow/resolve/main/ragflow-main/api/apps/kb_app.py
12.8 kB
| # | |
| # Copyright 2024 The InfiniFlow Authors. All Rights Reserved. | |
| # | |
| # Licensed under the Apache License, Version 2.0 (the "License"); | |
| # you may not use this file except in compliance with the License. | |
| # You may obtain a copy of the License at | |
| # | |
| # http://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| # Unless required by applicable law or agreed to in writing, software | |
| # distributed under the License is distributed on an "AS IS" BASIS, | |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| # See the License for the specific language governing permissions and | |
| # limitations under the License. | |
| # | |
| import json | |
| import logging | |
| import os | |
| from flask import request | |
| from flask_login import login_required, current_user | |
| from api.db.services import duplicate_name | |
| from api.db.services.document_service import DocumentService | |
| from api.db.services.file2document_service import File2DocumentService | |
| from api.db.services.file_service import FileService | |
| from api.db.services.user_service import TenantService, UserTenantService | |
| from api.utils.api_utils import server_error_response, get_data_error_result, validate_request, not_allowed_parameters | |
| from api.utils import get_uuid | |
| from api.db import StatusEnum, FileSource | |
| from api.db.services.knowledgebase_service import KnowledgebaseService | |
| from api.db.db_models import File | |
| from api.utils.api_utils import get_json_result | |
| from api import settings | |
| from rag.nlp import search | |
| from api.constants import DATASET_NAME_LIMIT | |
| from rag.settings import PAGERANK_FLD | |
| # noqa: F821 | |
| def create(): | |
| req = request.json | |
| dataset_name = req["name"] | |
| if not isinstance(dataset_name, str): | |
| return get_data_error_result(message="Dataset name must be string.") | |
| if dataset_name == "": | |
| return get_data_error_result(message="Dataset name can't be empty.") | |
| if len(dataset_name) >= DATASET_NAME_LIMIT: | |
| return get_data_error_result( | |
| message=f"Dataset name length is {len(dataset_name)} which is large than {DATASET_NAME_LIMIT}") | |
| dataset_name = dataset_name.strip() | |
| dataset_name = duplicate_name( | |
| KnowledgebaseService.query, | |
| name=dataset_name, | |
| tenant_id=current_user.id, | |
| status=StatusEnum.VALID.value) | |
| try: | |
| req["id"] = get_uuid() | |
| req["tenant_id"] = current_user.id | |
| req["created_by"] = current_user.id | |
| e, t = TenantService.get_by_id(current_user.id) | |
| if not e: | |
| return get_data_error_result(message="Tenant not found.") | |
| req["embd_id"] = t.embd_id | |
| if not KnowledgebaseService.save(**req): | |
| return get_data_error_result() | |
| return get_json_result(data={"kb_id": req["id"]}) | |
| except Exception as e: | |
| return server_error_response(e) | |
| # noqa: F821 | |
| def update(): | |
| req = request.json | |
| req["name"] = req["name"].strip() | |
| if not KnowledgebaseService.accessible4deletion(req["kb_id"], current_user.id): | |
| return get_json_result( | |
| data=False, | |
| message='No authorization.', | |
| code=settings.RetCode.AUTHENTICATION_ERROR | |
| ) | |
| try: | |
| if not KnowledgebaseService.query( | |
| created_by=current_user.id, id=req["kb_id"]): | |
| return get_json_result( | |
| data=False, message='Only owner of knowledgebase authorized for this operation.', | |
| code=settings.RetCode.OPERATING_ERROR) | |
| e, kb = KnowledgebaseService.get_by_id(req["kb_id"]) | |
| if not e: | |
| return get_data_error_result( | |
| message="Can't find this knowledgebase!") | |
| if req.get("parser_id", "") == "tag" and os.environ.get('DOC_ENGINE', "elasticsearch") == "infinity": | |
| return get_json_result( | |
| data=False, | |
| message='The chunk method Tag has not been supported by Infinity yet.', | |
| code=settings.RetCode.OPERATING_ERROR | |
| ) | |
| if req["name"].lower() != kb.name.lower() \ | |
| and len( | |
| KnowledgebaseService.query(name=req["name"], tenant_id=current_user.id, status=StatusEnum.VALID.value)) > 1: | |
| return get_data_error_result( | |
| message="Duplicated knowledgebase name.") | |
| del req["kb_id"] | |
| if not KnowledgebaseService.update_by_id(kb.id, req): | |
| return get_data_error_result() | |
| if kb.pagerank != req.get("pagerank", 0): | |
| if req.get("pagerank", 0) > 0: | |
| settings.docStoreConn.update({"kb_id": kb.id}, {PAGERANK_FLD: req["pagerank"]}, | |
| search.index_name(kb.tenant_id), kb.id) | |
| else: | |
| # Elasticsearch requires PAGERANK_FLD be non-zero! | |
| settings.docStoreConn.update({"exists": PAGERANK_FLD}, {"remove": PAGERANK_FLD}, | |
| search.index_name(kb.tenant_id), kb.id) | |
| e, kb = KnowledgebaseService.get_by_id(kb.id) | |
| if not e: | |
| return get_data_error_result( | |
| message="Database error (Knowledgebase rename)!") | |
| kb = kb.to_dict() | |
| kb.update(req) | |
| return get_json_result(data=kb) | |
| except Exception as e: | |
| return server_error_response(e) | |
| # noqa: F821 | |
| def detail(): | |
| kb_id = request.args["kb_id"] | |
| try: | |
| tenants = UserTenantService.query(user_id=current_user.id) | |
| for tenant in tenants: | |
| if KnowledgebaseService.query( | |
| tenant_id=tenant.tenant_id, id=kb_id): | |
| break | |
| else: | |
| return get_json_result( | |
| data=False, message='Only owner of knowledgebase authorized for this operation.', | |
| code=settings.RetCode.OPERATING_ERROR) | |
| kb = KnowledgebaseService.get_detail(kb_id) | |
| if not kb: | |
| return get_data_error_result( | |
| message="Can't find this knowledgebase!") | |
| return get_json_result(data=kb) | |
| except Exception as e: | |
| return server_error_response(e) | |
| # noqa: F821 | |
| def list_kbs(): | |
| keywords = request.args.get("keywords", "") | |
| page_number = int(request.args.get("page", 1)) | |
| items_per_page = int(request.args.get("page_size", 150)) | |
| parser_id = request.args.get("parser_id") | |
| orderby = request.args.get("orderby", "create_time") | |
| desc = request.args.get("desc", True) | |
| try: | |
| tenants = TenantService.get_joined_tenants_by_user_id(current_user.id) | |
| kbs, total = KnowledgebaseService.get_by_tenant_ids( | |
| [m["tenant_id"] for m in tenants], current_user.id, page_number, | |
| items_per_page, orderby, desc, keywords, parser_id) | |
| return get_json_result(data={"kbs": kbs, "total": total}) | |
| except Exception as e: | |
| return server_error_response(e) | |
| # noqa: F821 | |
| def rm(): | |
| req = request.json | |
| if not KnowledgebaseService.accessible4deletion(req["kb_id"], current_user.id): | |
| return get_json_result( | |
| data=False, | |
| message='No authorization.', | |
| code=settings.RetCode.AUTHENTICATION_ERROR | |
| ) | |
| try: | |
| kbs = KnowledgebaseService.query( | |
| created_by=current_user.id, id=req["kb_id"]) | |
| if not kbs: | |
| return get_json_result( | |
| data=False, message='Only owner of knowledgebase authorized for this operation.', | |
| code=settings.RetCode.OPERATING_ERROR) | |
| for doc in DocumentService.query(kb_id=req["kb_id"]): | |
| if not DocumentService.remove_document(doc, kbs[0].tenant_id): | |
| return get_data_error_result( | |
| message="Database error (Document removal)!") | |
| f2d = File2DocumentService.get_by_document_id(doc.id) | |
| if f2d: | |
| FileService.filter_delete([File.source_type == FileSource.KNOWLEDGEBASE, File.id == f2d[0].file_id]) | |
| File2DocumentService.delete_by_document_id(doc.id) | |
| FileService.filter_delete( | |
| [File.source_type == FileSource.KNOWLEDGEBASE, File.type == "folder", File.name == kbs[0].name]) | |
| if not KnowledgebaseService.delete_by_id(req["kb_id"]): | |
| return get_data_error_result( | |
| message="Database error (Knowledgebase removal)!") | |
| for kb in kbs: | |
| settings.docStoreConn.delete({"kb_id": kb.id}, search.index_name(kb.tenant_id), kb.id) | |
| settings.docStoreConn.deleteIdx(search.index_name(kb.tenant_id), kb.id) | |
| return get_json_result(data=True) | |
| except Exception as e: | |
| return server_error_response(e) | |
| # noqa: F821 | |
| def list_tags(kb_id): | |
| if not KnowledgebaseService.accessible(kb_id, current_user.id): | |
| return get_json_result( | |
| data=False, | |
| message='No authorization.', | |
| code=settings.RetCode.AUTHENTICATION_ERROR | |
| ) | |
| tags = settings.retrievaler.all_tags(current_user.id, [kb_id]) | |
| return get_json_result(data=tags) | |
| # noqa: F821 | |
| def list_tags_from_kbs(): | |
| kb_ids = request.args.get("kb_ids", "").split(",") | |
| for kb_id in kb_ids: | |
| if not KnowledgebaseService.accessible(kb_id, current_user.id): | |
| return get_json_result( | |
| data=False, | |
| message='No authorization.', | |
| code=settings.RetCode.AUTHENTICATION_ERROR | |
| ) | |
| tags = settings.retrievaler.all_tags(current_user.id, kb_ids) | |
| return get_json_result(data=tags) | |
| # noqa: F821 | |
| def rm_tags(kb_id): | |
| req = request.json | |
| if not KnowledgebaseService.accessible(kb_id, current_user.id): | |
| return get_json_result( | |
| data=False, | |
| message='No authorization.', | |
| code=settings.RetCode.AUTHENTICATION_ERROR | |
| ) | |
| e, kb = KnowledgebaseService.get_by_id(kb_id) | |
| for t in req["tags"]: | |
| settings.docStoreConn.update({"tag_kwd": t, "kb_id": [kb_id]}, | |
| {"remove": {"tag_kwd": t}}, | |
| search.index_name(kb.tenant_id), | |
| kb_id) | |
| return get_json_result(data=True) | |
| # noqa: F821 | |
| def rename_tags(kb_id): | |
| req = request.json | |
| if not KnowledgebaseService.accessible(kb_id, current_user.id): | |
| return get_json_result( | |
| data=False, | |
| message='No authorization.', | |
| code=settings.RetCode.AUTHENTICATION_ERROR | |
| ) | |
| e, kb = KnowledgebaseService.get_by_id(kb_id) | |
| settings.docStoreConn.update({"tag_kwd": req["from_tag"], "kb_id": [kb_id]}, | |
| {"remove": {"tag_kwd": req["from_tag"].strip()}, "add": {"tag_kwd": req["to_tag"]}}, | |
| search.index_name(kb.tenant_id), | |
| kb_id) | |
| return get_json_result(data=True) | |
| # noqa: F821 | |
| def knowledge_graph(kb_id): | |
| if not KnowledgebaseService.accessible(kb_id, current_user.id): | |
| return get_json_result( | |
| data=False, | |
| message='No authorization.', | |
| code=settings.RetCode.AUTHENTICATION_ERROR | |
| ) | |
| _, kb = KnowledgebaseService.get_by_id(kb_id) | |
| req = { | |
| "kb_id": [kb_id], | |
| "knowledge_graph_kwd": ["graph"] | |
| } | |
| obj = {"graph": {}, "mind_map": {}} | |
| try: | |
| sres = settings.retrievaler.search(req, search.index_name(kb.tenant_id), [kb_id]) | |
| except Exception as e: | |
| logging.exception(e) | |
| return get_json_result(data=obj) | |
| for id in sres.ids[:1]: | |
| ty = sres.field[id]["knowledge_graph_kwd"] | |
| try: | |
| content_json = json.loads(sres.field[id]["content_with_weight"]) | |
| except Exception: | |
| continue | |
| obj[ty] = content_json | |
| if "nodes" in obj["graph"]: | |
| obj["graph"]["nodes"] = sorted(obj["graph"]["nodes"], key=lambda x: x.get("pagerank", 0), reverse=True)[:256] | |
| if "edges" in obj["graph"]: | |
| obj["graph"]["edges"] = sorted(obj["graph"]["edges"], key=lambda x: x.get("weight", 0), reverse=True)[:128] | |
| return get_json_result(data=obj) |