将flask改成fastapi

sdk/python/ragflow_sdk/__init__.py

@@ -0,0 +1,40 @@
+#
+#  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 beartype.claw import beartype_this_package
+beartype_this_package()
+
+import importlib.metadata
+
+from .ragflow import RAGFlow
+from .modules.dataset import DataSet
+from .modules.chat import Chat
+from .modules.session import Session
+from .modules.document import Document
+from .modules.chunk import Chunk
+from .modules.agent import Agent
+
+__version__ = importlib.metadata.version("ragflow_sdk")
+
+__all__ = [
+    "RAGFlow",
+    "DataSet",
+    "Chat",
+    "Session",
+    "Document",
+    "Chunk",
+    "Agent"
+]

sdk/python/ragflow_sdk/modules/__init__.py

@@ -0,0 +1,15 @@
+#
+#  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.
+#

sdk/python/ragflow_sdk/modules/agent.py

@@ -0,0 +1,94 @@
+#
+#  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
+from .session import Session
+
+
+class Agent(Base):
+    def __init__(self, rag, res_dict):
+        self.id  = None
+        self.avatar = None
+        self.canvas_type = None
+        self.description = None
+        self.dsl = None
+        super().__init__(rag, res_dict)
+
+    class Dsl(Base):
+        def __init__(self, rag, res_dict):
+            self.answer = []
+            self.components = {
+                "begin": {
+                    "downstream": ["Answer:China"],
+                    "obj": {
+                        "component_name": "Begin",
+                        "params": {}
+                    },
+                    "upstream": []
+                }
+            }
+            self.graph = {
+                "edges": [],
+                "nodes": [
+                    {
+                        "data": {
+                            "label": "Begin",
+                            "name": "begin"
+                        },
+                        "id": "begin",
+                        "position": {
+                            "x": 50,
+                            "y": 200
+                        },
+                        "sourcePosition": "left",
+                        "targetPosition": "right",
+                        "type": "beginNode"
+                    }
+                ]
+            }
+            self.history =  []
+            self.messages =  []
+            self.path =  []
+            self.reference = []
+            super().__init__(rag, res_dict)
+
+    
+    def create_session(self, **kwargs) -> Session:
+        res = self.post(f"/agents/{self.id}/sessions", json=kwargs)
+        res = res.json()
+        if res.get("code") == 0:
+            return Session(self.rag, res.get("data"))
+        raise Exception(res.get("message"))
+
+    
+    def list_sessions(self, page: int = 1, page_size: int = 30, orderby: str = "create_time", desc: bool = True,
+                      id: str = None) -> list[Session]:
+        res = self.get(f"/agents/{self.id}/sessions",
+                       {"page": page, "page_size": page_size, "orderby": orderby, "desc": desc, "id": id})
+        res = res.json()
+        if res.get("code") == 0:
+            result_list = []
+            for data in res.get("data"):
+                temp_agent = Session(self.rag, data)
+                result_list.append(temp_agent)
+            return result_list
+        raise Exception(res.get("message"))
+    
+    def delete_sessions(self, ids: list[str] | None = None):
+        res = self.rm(f"/agents/{self.id}/sessions", {"ids": ids})
+        res = res.json()
+        if res.get("code") != 0:
+            raise Exception(res.get("message"))

sdk/python/ragflow_sdk/modules/base.py

@@ -0,0 +1,58 @@
+#
+#  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.
+#
+
+
+class Base:
+    def __init__(self, rag, res_dict):
+        self.rag = rag
+        self._update_from_dict(rag, res_dict)
+
+    def _update_from_dict(self, rag, res_dict):
+        for k, v in res_dict.items():
+            if isinstance(v, dict):
+                self.__dict__[k] = Base(rag, v)
+            else:
+                self.__dict__[k] = v
+
+    def to_json(self):
+        pr = {}
+        for name in dir(self):
+            value = getattr(self, name)
+            if not name.startswith("__") and not callable(value) and name != "rag":
+                if isinstance(value, Base):
+                    pr[name] = value.to_json()
+                else:
+                    pr[name] = value
+        return pr
+
+    def post(self, path, json=None, stream=False, files=None):
+        res = self.rag.post(path, json, stream=stream, files=files)
+        return res
+
+    def get(self, path, params=None):
+        res = self.rag.get(path, params)
+        return res
+
+    def rm(self, path, json):
+        res = self.rag.delete(path, json)
+        return res
+
+    def put(self, path, json):
+        res = self.rag.put(path, json)
+        return res
+
+    def __str__(self):
+        return str(self.to_json())

sdk/python/ragflow_sdk/modules/chat.py

@@ -0,0 +1,87 @@
+#
+#  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
+from .session import Session
+
+
+class Chat(Base):
+    def __init__(self, rag, res_dict):
+        self.id = ""
+        self.name = "assistant"
+        self.avatar = "path/to/avatar"
+        self.llm = Chat.LLM(rag, {})
+        self.prompt = Chat.Prompt(rag, {})
+        super().__init__(rag, res_dict)
+
+    class LLM(Base):
+        def __init__(self, rag, res_dict):
+            self.model_name = None
+            self.temperature = 0.1
+            self.top_p = 0.3
+            self.presence_penalty = 0.4
+            self.frequency_penalty = 0.7
+            self.max_tokens = 512
+            super().__init__(rag, res_dict)
+
+    class Prompt(Base):
+        def __init__(self, rag, res_dict):
+            self.similarity_threshold = 0.2
+            self.keywords_similarity_weight = 0.7
+            self.top_n = 8
+            self.top_k = 1024
+            self.variables = [{"key": "knowledge", "optional": True}]
+            self.rerank_model = ""
+            self.empty_response = None
+            self.opener = "Hi! I'm your assistant. What can I do for you?"
+            self.show_quote = True
+            self.prompt = (
+                "You are an intelligent assistant. Please summarize the content of the knowledge base to answer the question. "
+                "Please list the data in the knowledge base and answer in detail. When all knowledge base content is irrelevant to the question, "
+                "your answer must include the sentence 'The answer you are looking for is not found in the knowledge base!' "
+                "Answers need to consider chat history.\nHere is the knowledge base:\n{knowledge}\nThe above is the knowledge base."
+            )
+            super().__init__(rag, res_dict)
+
+    def update(self, update_message: dict):
+        res = self.put(f"/chats/{self.id}", update_message)
+        res = res.json()
+        if res.get("code") != 0:
+            raise Exception(res["message"])
+
+    def create_session(self, name: str = "New session") -> Session:
+        res = self.post(f"/chats/{self.id}/sessions", {"name": name})
+        res = res.json()
+        if res.get("code") == 0:
+            return Session(self.rag, res["data"])
+        raise Exception(res["message"])
+
+    def list_sessions(self, page: int = 1, page_size: int = 30, orderby: str = "create_time", desc: bool = True, id: str = None, name: str = None) -> list[Session]:
+        res = self.get(f"/chats/{self.id}/sessions", {"page": page, "page_size": page_size, "orderby": orderby, "desc": desc, "id": id, "name": name})
+        res = res.json()
+        if res.get("code") == 0:
+            result_list = []
+            for data in res["data"]:
+                result_list.append(Session(self.rag, data))
+            return result_list
+        raise Exception(res["message"])
+
+    def delete_sessions(self, ids: list[str] | None = None):
+        res = self.rm(f"/chats/{self.id}/sessions", {"ids": ids})
+        res = res.json()
+        if res.get("code") != 0:
+            raise Exception(res.get("message"))

sdk/python/ragflow_sdk/modules/chunk.py

@@ -0,0 +1,57 @@
+#
+#  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
+        # Additional fields for retrieval results
+        self.similarity = 0.0
+        self.vector_similarity = 0.0
+        self.term_similarity = 0.0
+        self.positions = []
+        self.doc_type = ""
+        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")
+            )

sdk/python/ragflow_sdk/modules/dataset.py

@@ -0,0 +1,114 @@
+#
+#  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
+from .document import Document
+
+
+class DataSet(Base):
+    class ParserConfig(Base):
+        def __init__(self, rag, res_dict):
+            super().__init__(rag, res_dict)
+
+    def __init__(self, rag, res_dict):
+        self.id = ""
+        self.name = ""
+        self.avatar = ""
+        self.tenant_id = None
+        self.description = ""
+        self.embedding_model = ""
+        self.permission = "me"
+        self.document_count = 0
+        self.chunk_count = 0
+        self.chunk_method = "naive"
+        self.parser_config = None
+        self.pagerank = 0
+        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.id}", update_message)
+        res = res.json()
+        if res.get("code") != 0:
+            raise Exception(res["message"])
+
+        self._update_from_dict(self.rag, res.get("data", {}))
+        return self
+
+    def upload_documents(self, document_list: list[dict]):
+        url = f"/datasets/{self.id}/documents"
+        files = [("file", (ele["display_name"], ele["blob"])) for ele in document_list]
+        res = self.post(path=url, json=None, files=files)
+        res = res.json()
+        if res.get("code") == 0:
+            doc_list = []
+            for doc in res["data"]:
+                document = Document(self.rag, doc)
+                doc_list.append(document)
+            return doc_list
+        raise Exception(res.get("message"))
+
+    def list_documents(
+        self,
+        id: str | None = None,
+        name: str | None = None,
+        keywords: str | None = None,
+        page: int = 1,
+        page_size: int = 30,
+        orderby: str = "create_time",
+        desc: bool = True,
+        create_time_from: int = 0,
+        create_time_to: int = 0,
+    ):
+        params = {
+            "id": id,
+            "name": name,
+            "keywords": keywords,
+            "page": page,
+            "page_size": page_size,
+            "orderby": orderby,
+            "desc": desc,
+            "create_time_from": create_time_from,
+            "create_time_to": create_time_to,
+        }
+        res = self.get(f"/datasets/{self.id}/documents", params=params)
+        res = res.json()
+        documents = []
+        if res.get("code") == 0:
+            for document in res["data"].get("docs"):
+                documents.append(Document(self.rag, document))
+            return documents
+        raise Exception(res["message"])
+
+    def delete_documents(self, ids: list[str] | None = None):
+        res = self.rm(f"/datasets/{self.id}/documents", {"ids": ids})
+        res = res.json()
+        if res.get("code") != 0:
+            raise Exception(res["message"])
+
+    def async_parse_documents(self, document_ids):
+        res = self.post(f"/datasets/{self.id}/chunks", {"document_ids": document_ids})
+        res = res.json()
+        if res.get("code") != 0:
+            raise Exception(res.get("message"))
+
+    def async_cancel_parse_documents(self, document_ids):
+        res = self.rm(f"/datasets/{self.id}/chunks", {"document_ids": document_ids})
+        res = res.json()
+        if res.get("code") != 0:
+            raise Exception(res.get("message"))

sdk/python/ragflow_sdk/modules/document.py

@@ -0,0 +1,101 @@
+#
+#  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.
+#
+
+import json
+
+from .base import Base
+from .chunk import Chunk
+
+
+class Document(Base):
+    class ParserConfig(Base):
+        def __init__(self, rag, res_dict):
+            super().__init__(rag, res_dict)
+
+    def __init__(self, rag, res_dict):
+        self.id = ""
+        self.name = ""
+        self.thumbnail = None
+        self.dataset_id = None
+        self.chunk_method = "naive"
+        self.parser_config = {"pages": [[1, 1000000]]}
+        self.source_type = "local"
+        self.type = ""
+        self.created_by = ""
+        self.size = 0
+        self.token_count = 0
+        self.chunk_count = 0
+        self.progress = 0.0
+        self.progress_msg = ""
+        self.process_begin_at = None
+        self.process_duration = 0.0
+        self.run = "0"
+        self.status = "1"
+        self.meta_fields = {}
+        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):
+        if "meta_fields" in update_message:
+            if not isinstance(update_message["meta_fields"], dict):
+                raise Exception("meta_fields must be a dictionary")
+        res = self.put(f"/datasets/{self.dataset_id}/documents/{self.id}", update_message)
+        res = res.json()
+        if res.get("code") != 0:
+            raise Exception(res["message"])
+
+        self._update_from_dict(self.rag, res.get("data", {}))
+        return self
+
+    def download(self):
+        res = self.get(f"/datasets/{self.dataset_id}/documents/{self.id}")
+        error_keys = set(["code", "message"])
+        try:
+            response = res.json()
+            actual_keys = set(response.keys())
+            if actual_keys == error_keys:
+                raise Exception(res.get("message"))
+            else:
+                return res.content
+        except json.JSONDecodeError:
+            return res.content
+
+    def list_chunks(self, page=1, page_size=30, keywords="", id=""):
+        data = {"keywords": keywords, "page": page, "page_size": page_size, "id": id}
+        res = self.get(f"/datasets/{self.dataset_id}/documents/{self.id}/chunks", data)
+        res = res.json()
+        if res.get("code") == 0:
+            chunks = []
+            for data in res["data"].get("chunks"):
+                chunk = Chunk(self.rag, data)
+                chunks.append(chunk)
+            return chunks
+        raise Exception(res.get("message"))
+
+    def add_chunk(self, content: str, important_keywords: list[str] = [], questions: list[str] = []):
+        res = self.post(f"/datasets/{self.dataset_id}/documents/{self.id}/chunks", {"content": content, "important_keywords": important_keywords, "questions": questions})
+        res = res.json()
+        if res.get("code") == 0:
+            return Chunk(self.rag, res["data"].get("chunk"))
+        raise Exception(res.get("message"))
+
+    def delete_chunks(self, ids: list[str] | None = None):
+        res = self.rm(f"/datasets/{self.dataset_id}/documents/{self.id}/chunks", {"chunk_ids": ids})
+        res = res.json()
+        if res.get("code") != 0:
+            raise Exception(res.get("message"))

sdk/python/ragflow_sdk/modules/session.py

@@ -0,0 +1,103 @@
+#
+#  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.
+#
+
+import json
+
+from .base import Base
+
+
+class Session(Base):
+    def __init__(self, rag, res_dict):
+        self.id = None
+        self.name = "New session"
+        self.messages = [{"role": "assistant", "content": "Hi! I am your assistant, can I help you?"}]
+        for key, value in res_dict.items():
+            if key == "chat_id" and value is not None:
+                self.chat_id = None
+                self.__session_type = "chat"
+            if key == "agent_id" and value is not None:
+                self.agent_id = None
+                self.__session_type = "agent"
+        super().__init__(rag, res_dict)
+
+    def ask(self, question="", stream=True, **kwargs):
+        if self.__session_type == "agent":
+            res = self._ask_agent(question, stream)
+        elif self.__session_type == "chat":
+            res = self._ask_chat(question, stream, **kwargs)
+
+        if stream:
+            for line in res.iter_lines():
+                line = line.decode("utf-8")
+                if line.startswith("{"):
+                    json_data = json.loads(line)
+                    raise Exception(json_data["message"])
+                if not line.startswith("data:"):
+                    continue
+                json_data = json.loads(line[5:])
+                if json_data["data"] is True or json_data["data"].get("running_status"):
+                    continue
+                message = self._structure_answer(json_data)
+                yield message
+        else:
+            try:
+                json_data = json.loads(res.text)
+            except ValueError:
+                raise Exception(f"Invalid response {res}")
+            return self._structure_answer(json_data)
+        
+
+    def _structure_answer(self, json_data):
+        answer = json_data["data"]["answer"]
+        reference = json_data["data"].get("reference", {})
+        temp_dict = {
+            "content": answer,
+            "role": "assistant"
+        }
+        if reference and "chunks" in reference:
+            chunks = reference["chunks"]
+            temp_dict["reference"] = chunks
+        message = Message(self.rag, temp_dict)
+        return message
+
+    def _ask_chat(self, question: str, stream: bool, **kwargs):
+        json_data = {"question": question, "stream": stream, "session_id": self.id}
+        json_data.update(kwargs)
+        res = self.post(f"/chats/{self.chat_id}/completions",
+                        json_data, stream=stream)
+        return res
+
+    def _ask_agent(self, question: str, stream: bool):
+        res = self.post(f"/agents/{self.agent_id}/completions",
+                        {"question": question, "stream": stream, "session_id": self.id}, stream=stream)
+        return res
+
+    def update(self, update_message):
+        res = self.put(f"/chats/{self.chat_id}/sessions/{self.id}",
+                       update_message)
+        res = res.json()
+        if res.get("code") != 0:
+            raise Exception(res.get("message"))
+
+
+class Message(Base):
+    def __init__(self, rag, res_dict):
+        self.content = "Hi! I am your assistant, can I help you?"
+        self.reference = None
+        self.role = "assistant"
+        self.prompt = None
+        self.id = None
+        super().__init__(rag, res_dict)

sdk/python/ragflow_sdk/ragflow.py

@@ -0,0 +1,285 @@
+#
+#  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.
+
+from typing import Optional
+
+import requests
+
+from .modules.agent import Agent
+from .modules.chat import Chat
+from .modules.chunk import Chunk
+from .modules.dataset import DataSet
+
+
+class RAGFlow:
+    def __init__(self, api_key, base_url, version="v1"):
+        """
+        api_url: http://<host_address>/api/v1
+        """
+        self.user_key = api_key
+        self.api_url = f"{base_url}/api/{version}"
+        self.authorization_header = {"Authorization": "{} {}".format("Bearer", self.user_key)}
+
+    def post(self, path, json=None, stream=False, files=None):
+        res = requests.post(url=self.api_url + path, json=json, headers=self.authorization_header, stream=stream, files=files)
+        return res
+
+    def get(self, path, params=None, json=None):
+        res = requests.get(url=self.api_url + path, params=params, headers=self.authorization_header, json=json)
+        return res
+
+    def delete(self, path, json):
+        res = requests.delete(url=self.api_url + path, json=json, headers=self.authorization_header)
+        return res
+
+    def put(self, path, json):
+        res = requests.put(url=self.api_url + path, json=json, headers=self.authorization_header)
+        return res
+
+    def create_dataset(
+        self,
+        name: str,
+        avatar: Optional[str] = None,
+        description: Optional[str] = None,
+        embedding_model: Optional[str] = None,
+        permission: str = "me",
+        chunk_method: str = "naive",
+        parser_config: Optional[DataSet.ParserConfig] = None,
+    ) -> DataSet:
+        payload = {
+            "name": name,
+            "avatar": avatar,
+            "description": description,
+            "embedding_model": embedding_model,
+            "permission": permission,
+            "chunk_method": chunk_method,
+        }
+        if parser_config is not None:
+            payload["parser_config"] = parser_config.to_json()
+
+        res = self.post("/datasets", payload)
+        res = res.json()
+        if res.get("code") == 0:
+            return DataSet(self, res["data"])
+        raise Exception(res["message"])
+
+    def delete_datasets(self, ids: list[str] | None = None):
+        res = self.delete("/datasets", {"ids": ids})
+        res = res.json()
+        if res.get("code") != 0:
+            raise Exception(res["message"])
+
+    def get_dataset(self, name: str):
+        _list = self.list_datasets(name=name)
+        if len(_list) > 0:
+            return _list[0]
+        raise Exception("Dataset %s not found" % name)
+
+    def list_datasets(self, page: int = 1, page_size: int = 30, orderby: str = "create_time", desc: bool = True, id: str | None = None, name: str | None = None) -> list[DataSet]:
+        res = self.get(
+            "/datasets",
+            {
+                "page": page,
+                "page_size": page_size,
+                "orderby": orderby,
+                "desc": desc,
+                "id": id,
+                "name": name,
+            },
+        )
+        res = res.json()
+        result_list = []
+        if res.get("code") == 0:
+            for data in res["data"]:
+                result_list.append(DataSet(self, data))
+            return result_list
+        raise Exception(res["message"])
+
+    def create_chat(self, name: str, avatar: str = "", dataset_ids=None, llm: Chat.LLM | None = None, prompt: Chat.Prompt | None = None) -> Chat:
+        if dataset_ids is None:
+            dataset_ids = []
+        dataset_list = []
+        for id in dataset_ids:
+            dataset_list.append(id)
+
+        if llm is None:
+            llm = Chat.LLM(
+                self,
+                {
+                    "model_name": None,
+                    "temperature": 0.1,
+                    "top_p": 0.3,
+                    "presence_penalty": 0.4,
+                    "frequency_penalty": 0.7,
+                    "max_tokens": 512,
+                },
+            )
+        if prompt is None:
+            prompt = Chat.Prompt(
+                self,
+                {
+                    "similarity_threshold": 0.2,
+                    "keywords_similarity_weight": 0.7,
+                    "top_n": 8,
+                    "top_k": 1024,
+                    "variables": [{"key": "knowledge", "optional": True}],
+                    "rerank_model": "",
+                    "empty_response": None,
+                    "opener": None,
+                    "show_quote": True,
+                    "prompt": None,
+                },
+            )
+            if prompt.opener is None:
+                prompt.opener = "Hi! I'm your assistant. What can I do for you?"
+            if prompt.prompt is None:
+                prompt.prompt = (
+                    "You are an intelligent assistant. Please summarize the content of the knowledge base to answer the question. "
+                    "Please list the data in the knowledge base and answer in detail. When all knowledge base content is irrelevant to the question, "
+                    "your answer must include the sentence 'The answer you are looking for is not found in the knowledge base!' "
+                    "Answers need to consider chat history.\nHere is the knowledge base:\n{knowledge}\nThe above is the knowledge base."
+                )
+
+        temp_dict = {"name": name, "avatar": avatar, "dataset_ids": dataset_list if dataset_list else [], "llm": llm.to_json(), "prompt": prompt.to_json()}
+        res = self.post("/chats", temp_dict)
+        res = res.json()
+        if res.get("code") == 0:
+            return Chat(self, res["data"])
+        raise Exception(res["message"])
+
+    def delete_chats(self, ids: list[str] | None = None):
+        res = self.delete("/chats", {"ids": ids})
+        res = res.json()
+        if res.get("code") != 0:
+            raise Exception(res["message"])
+
+    def list_chats(self, page: int = 1, page_size: int = 30, orderby: str = "create_time", desc: bool = True, id: str | None = None, name: str | None = None) -> list[Chat]:
+        res = self.get(
+            "/chats",
+            {
+                "page": page,
+                "page_size": page_size,
+                "orderby": orderby,
+                "desc": desc,
+                "id": id,
+                "name": name,
+            },
+        )
+        res = res.json()
+        result_list = []
+        if res.get("code") == 0:
+            for data in res["data"]:
+                result_list.append(Chat(self, data))
+            return result_list
+        raise Exception(res["message"])
+
+    def retrieve(
+        self,
+        dataset_ids,
+        document_ids=None,
+        question="",
+        page=1,
+        page_size=30,
+        similarity_threshold=0.2,
+        vector_similarity_weight=0.3,
+        top_k=1024,
+        rerank_id: str | None = None,
+        keyword: bool = False,
+        cross_languages: list[str]|None = None,
+        metadata_condition: dict | None = None,
+    ):
+        if document_ids is None:
+            document_ids = []
+        data_json = {
+            "page": page,
+            "page_size": page_size,
+            "similarity_threshold": similarity_threshold,
+            "vector_similarity_weight": vector_similarity_weight,
+            "top_k": top_k,
+            "rerank_id": rerank_id,
+            "keyword": keyword,
+            "question": question,
+            "dataset_ids": dataset_ids,
+            "document_ids": document_ids,
+            "cross_languages": cross_languages,
+            "metadata_condition": metadata_condition
+        }
+        # Send a POST request to the backend service (using requests library as an example, actual implementation may vary)
+        res = self.post("/retrieval", json=data_json)
+        res = res.json()
+        if res.get("code") == 0:
+            chunks = []
+            for chunk_data in res["data"].get("chunks"):
+                chunk = Chunk(self, chunk_data)
+                chunks.append(chunk)
+            return chunks
+        raise Exception(res.get("message"))
+
+    def list_agents(self, page: int = 1, page_size: int = 30, orderby: str = "update_time", desc: bool = True, id: str | None = None, title: str | None = None) -> list[Agent]:
+        res = self.get(
+            "/agents",
+            {
+                "page": page,
+                "page_size": page_size,
+                "orderby": orderby,
+                "desc": desc,
+                "id": id,
+                "title": title,
+            },
+        )
+        res = res.json()
+        result_list = []
+        if res.get("code") == 0:
+            for data in res["data"]:
+                result_list.append(Agent(self, data))
+            return result_list
+        raise Exception(res["message"])
+
+    def create_agent(self, title: str, dsl: dict, description: str | None = None) -> None:
+        req = {"title": title, "dsl": dsl}
+
+        if description is not None:
+            req["description"] = description
+
+        res = self.post("/agents", req)
+        res = res.json()
+
+        if res.get("code") != 0:
+            raise Exception(res["message"])
+
+    def update_agent(self, agent_id: str, title: str | None = None, description: str | None = None, dsl: dict | None = None) -> None:
+        req = {}
+
+        if title is not None:
+            req["title"] = title
+
+        if description is not None:
+            req["description"] = description
+
+        if dsl is not None:
+            req["dsl"] = dsl
+
+        res = self.put(f"/agents/{agent_id}", req)
+        res = res.json()
+
+        if res.get("code") != 0:
+            raise Exception(res["message"])
+
+    def delete_agent(self, agent_id: str) -> None:
+        res = self.delete(f"/agents/{agent_id}", {})
+        res = res.json()
+
+        if res.get("code") != 0:
+            raise Exception(res["message"])