doc: 为可扩展组件添加注释

pkg/provider/entities.py

@@ -23,14 +23,19 @@ class Message(pydantic.BaseModel):
     """消息"""
 
     role: str  # user, system, assistant, tool, command, plugin
+    """消息的角色"""
 
     name: typing.Optional[str] = None
+    """名称，仅函数调用返回时设置"""
 
     content: typing.Optional[str] = None
+    """内容"""
 
     function_call: typing.Optional[FunctionCall] = None
+    """函数调用，不再受支持，请使用tool_calls"""
 
     tool_calls: typing.Optional[list[ToolCall]] = None
+    """工具调用"""
 
     tool_call_id: typing.Optional[str] = None
 

pkg/provider/modelmgr/api.py

@@ -38,6 +38,15 @@ class LLMAPIRequester(metaclass=abc.ABCMeta):
         self,
         query: core_entities.Query,
     ) -> typing.AsyncGenerator[llm_entities.Message, None]:
-        """请求
+        """请求API
+
+        对话前文可以从 query 对象中获取。
+        可以多次yield消息对象。
+
+        Args:
+            query (core_entities.Query): 本次请求的上下文对象
+
+        Yields:
+            pkg.provider.entities.Message: 返回消息对象
         """
         raise NotImplementedError

pkg/provider/sysprompt/entities.py

@@ -10,5 +10,7 @@ class Prompt(pydantic.BaseModel):
     """供AI使用的Prompt"""
 
     name: str
+    """名称"""
 
     messages: list[entities.Message]
+    """消息列表"""

pkg/provider/sysprompt/loader.py

@@ -36,7 +36,7 @@ class PromptLoader(metaclass=abc.ABCMeta):
 
     @abc.abstractmethod
     async def load(self):
-        """加载Prompt
+        """加载Prompt，存放到prompts列表中
         """
         raise NotImplementedError