ragflow/sdk/python/ragflow_sdk/modules/agent.py
Mathias Panzenböck 38e7dc6246 added type annotations and __slots__ to the Python SDK
I've also added __slots__ less so to improve efficiency and more to be sure
there are no typos on assignments.

There remain a few untyped parts where I could not find documentation of the
types. These things are in particular:

- Agent.Dsl
- Agent.create_session()
- DataSet.ParserConfig - I'm not sure if the documented parameters are complete.
- Session.ask() - kwargs specific to agent/chat
2025-11-20 00:39:32 +01:00

131 lines
4.2 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 typing import Any, Optional, TYPE_CHECKING
from .base import Base
from .session import Session
if TYPE_CHECKING:
from ..ragflow import RAGFlow
__all__ = 'Agent',
class Agent(Base):
__slots__ = (
'id',
'avatar',
'canvas_type',
'description',
'dsl',
)
id: Optional[str]
avatar: Optional[str]
canvas_type: Optional[str]
description: Optional[str]
dsl: Optional["Agent.Dsl"]
def __init__(self, rag: "RAGFlow", res_dict: dict[str, Any]) -> None:
self.id = None
self.avatar = None
self.canvas_type = None
self.description = None
self.dsl = None
super().__init__(rag, res_dict)
class Dsl(Base):
__slots__ = (
'answer',
'components',
'graph',
'history',
'messages',
'path',
'reference',
)
# TODO: Proper typing including TypedDict for the dicts. Where is the specification of the DSL?
answer: list[Any]
components: dict[str, Any]
graph: dict[str, Any]
history: list[Any]
messages: list[Any]
path: list[Any]
reference: list[Any]
def __init__(self, rag: "RAGFlow", res_dict: dict[str, Any]) -> None:
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)
# TODO: Proper typing of kwargs. Where are these parameters defined?
def create_session(self, **kwargs: dict[str, Any]) -> 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: Optional[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) -> None:
res = self.rm(f"/agents/{self.id}/sessions", {"ids": ids})
res = res.json()
if res.get("code") != 0:
raise Exception(res.get("message"))