mirror of
https://git.mirrors.martin98.com/https://github.com/infiniflow/ragflow.git
synced 2025-04-22 06:00:00 +08:00
47926f7d21
### What problem does this PR solve? - The API documentation lacks detailed error code explanations. Added error code tables to `python_api_reference.md` and `http_api_reference.md` to clarify possible error codes and their meanings. - Error handling in the codebase is inconsistent. Standardized error handling logic in `sdk/python/ragflow_sdk/modules/chunk.py`. - Improved API comments by adding standardized docstrings to enhance code readability and maintainability. ### Type of change - [x] Documentation Update - [x] Refactoring
51 lines
1.7 KiB
Python
51 lines
1.7 KiB
Python
#
|
|
# Copyright 2025 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.
|
|
#
|
|
|
|
from .base import Base
|
|
|
|
class ChunkUpdateError(Exception):
|
|
def __init__(self, code=None, message=None, details=None):
|
|
self.code = code
|
|
self.message = message
|
|
self.details = details
|
|
super().__init__(message)
|
|
|
|
class Chunk(Base):
|
|
def __init__(self, rag, res_dict):
|
|
self.id = ""
|
|
self.content = ""
|
|
self.important_keywords = []
|
|
self.questions = []
|
|
self.create_time = ""
|
|
self.create_timestamp = 0.0
|
|
self.dataset_id = None
|
|
self.document_name = ""
|
|
self.document_id = ""
|
|
self.available = True
|
|
for k in list(res_dict.keys()):
|
|
if k not in self.__dict__:
|
|
res_dict.pop(k)
|
|
super().__init__(rag, res_dict)
|
|
|
|
def update(self, update_message: dict):
|
|
res = self.put(f"/datasets/{self.dataset_id}/documents/{self.document_id}/chunks/{self.id}", update_message)
|
|
res = res.json()
|
|
if res.get("code") != 0:
|
|
raise ChunkUpdateError(
|
|
code=res.get("code"),
|
|
message=res.get("message"),
|
|
details=res.get("details")
|
|
) |