更新send_api.py中的文档,增加了参数说明和返回值格式,添加了异常抛出信息

This commit is contained in:
minecraft1024a
2025-08-13 11:20:46 +08:00
committed by Windpicker-owo
parent 3538d614ee
commit ddd647a5ee

View File

@@ -375,16 +375,21 @@ async def adapter_command_to_stream(
雅诺狐的耳朵特别软 雅诺狐的耳朵特别软
Args: Args:
action: 适配器命令动作,如"get_group_list""get_friend_list" action (str): 适配器命令动作,如"get_group_list""get_friend_list"
params: 命令参数字典 params (dict): 命令参数字典,包含命令所需的参数
stream_id: 聊天流ID可选如果不提供则自动生成一个 platform (Optional[str]): 目标平台标识,可选,用于多平台支持
timeout: 超时时间(秒) stream_id (Optional[str]): 聊天流ID可选如果不提供则自动生成临时ID
storage_message: 是否存储消息到数据库 timeout (float): 超时时间默认30.0秒
show_log: 是否显示日志 storage_message (bool): 是否存储消息到数据库默认False
Returns: Returns:
dict: 适配器返回的响应,格式为 {"status": "ok/failed", "data": {...}, "message": "..."} dict: 适配器返回的响应,包含以下可能的状态:
如果发送失败则返回 {"status": "error", "message": "错误信息"} - 成功: {"status": "ok", "data": {...}, "message": "..."}
- 失败: {"status": "failed", "message": "错误信息"}
- 错误: {"status": "error", "message": "错误信息"}
Raises:
ValueError: 当stream_id和platform都未提供时抛出
""" """
if not stream_id and not platform: if not stream_id and not platform:
raise ValueError("必须提供stream_id或platform参数") raise ValueError("必须提供stream_id或platform参数")