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

Update comments (#4569)

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

Add license statement.

### Type of change

- [x] Refactoring

Signed-off-by: Jin Hai <haijin.chn@gmail.com>
This commit is contained in:
Jin Hai
2025-01-21 20:52:28 +08:00
committed by GitHub
parent 583050a876
commit 3894de895b
86 changed files with 1034 additions and 145 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
sdk/python/ragflow_sdk/modules/__init__.py
View File

@ -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.
#

16
sdk/python/ragflow_sdk/modules/agent.py
View File

@ -1,3 +1,19 @@
#
# 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
import requests

16
sdk/python/ragflow_sdk/modules/base.py
View File

@ -1,3 +1,19 @@
#
# 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(object):
def __init__(self, rag, res_dict):
self.rag = rag

26
sdk/python/ragflow_sdk/modules/chat.py
View File

@ -1,3 +1,19 @@
#
# 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
@ -44,12 +60,11 @@ class Chat(Base):
def update(self, update_message: dict):
res = self.put(f'/chats/{self.id}',
update_message)
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()
@ -57,9 +72,10 @@ class Chat(Base):
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,
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 = 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 = []
@ -68,7 +84,7 @@ class Chat(Base):
return result_list
raise Exception(res["message"])
def delete_sessions(self,ids: list[str] | None = None):
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:

25
sdk/python/ragflow_sdk/modules/chunk.py
View File

@ -1,3 +1,19 @@
#
# 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
@ -18,11 +34,8 @@ class Chunk(Base):
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)
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 :
if res.get("code") != 0:
raise Exception(res["message"])

49
sdk/python/ragflow_sdk/modules/dataset.py
View File

@ -1,3 +1,19 @@
#
# 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 .document import Document
from .base import Base
@ -29,48 +45,51 @@ class DataSet(Base):
def update(self, update_message: dict):
res = self.put(f'/datasets/{self.id}',
update_message)
update_message)
res = res.json()
if res.get("code") != 0:
raise Exception(res["message"])
def upload_documents(self,document_list: list[dict]):
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)
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=[]
doc_list = []
for doc in res["data"]:
document = Document(self.rag,doc)
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, keywords: str | None = None, page: int = 1, page_size: int = 30, orderby: str = "create_time", desc: bool = True):
res = self.get(f"/datasets/{self.id}/documents",params={"id": id,"keywords": keywords,"page": page,"page_size": page_size,"orderby": orderby,"desc": desc})
def list_documents(self, id: str | None = None, keywords: str | None = None, page: int = 1, page_size: int = 30,
orderby: str = "create_time", desc: bool = True):
res = self.get(f"/datasets/{self.id}/documents",
params={"id": id, "keywords": keywords, "page": page, "page_size": page_size, "orderby": orderby,
"desc": desc})
res = res.json()
documents = []
if res.get("code") == 0:
for document in res["data"].get("docs"):
documents.append(Document(self.rag,document))
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})
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})
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})
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"))

38
sdk/python/ragflow_sdk/modules/document.py
View File

@ -1,3 +1,19 @@
#
# 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
@ -32,7 +48,6 @@ class Document(Base):
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.id}',
update_message)
@ -48,29 +63,28 @@ class Document(Base):
except json.JSONDecodeError:
return res.content
def list_chunks(self,page=1, page_size=30, keywords=""):
data={"keywords": keywords,"page":page,"page_size":page_size}
def list_chunks(self, page=1, page_size=30, keywords=""):
data = {"keywords": keywords, "page": page, "page_size": page_size}
res = self.get(f'/datasets/{self.dataset_id}/documents/{self.id}/chunks', data)
res = res.json()
if res.get("code") == 0:
chunks=[]
chunks = []
for data in res["data"].get("chunks"):
chunk = Chunk(self.rag,data)
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})
{"content": content, "important_keywords": important_keywords, "questions": questions})
res = res.json()
if res.get("code") == 0:
return Chunk(self.rag,res["data"].get("chunk"))
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})
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"))
if res.get("code") != 0:
raise Exception(res.get("message"))

39
sdk/python/ragflow_sdk/modules/session.py
View File

@ -1,3 +1,19 @@
#
# 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
@ -8,8 +24,8 @@ class Session(Base):
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:
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:
@ -17,11 +33,11 @@ class Session(Base):
self.__session_type = "agent"
super().__init__(rag, res_dict)
def ask(self, question="",stream=True,**kwargs):
def ask(self, question="", stream=True, **kwargs):
if self.__session_type == "agent":
res=self._ask_agent(question,stream)
res = self._ask_agent(question, stream)
elif self.__session_type == "chat":
res=self._ask_chat(question,stream,**kwargs)
res = self._ask_chat(question, stream, **kwargs)
for line in res.iter_lines():
line = line.decode("utf-8")
if line.startswith("{"):
@ -44,25 +60,26 @@ class Session(Base):
message = Message(self.rag, temp_dict)
yield message
def _ask_chat(self, question: str, stream: bool,**kwargs):
json_data={"question": question, "stream": True,"session_id":self.id}
def _ask_chat(self, question: str, stream: bool, **kwargs):
json_data = {"question": question, "stream": True, "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):
def _ask_agent(self, question: str, stream: bool):
res = self.post(f"/agents/{self.agent_id}/completions",
{"question": question, "stream": True,"session_id":self.id}, stream=stream)
{"question": question, "stream": True, "session_id": self.id}, stream=stream)
return res
def update(self,update_message):
def update(self, update_message):
res = self.put(f"/chats/{self.chat_id}/sessions/{self.id}",
update_message)
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?"