diff --git a/pkg/core/bootutils/deps.py b/pkg/core/bootutils/deps.py index b4a67f35..83a9b2a7 100644 --- a/pkg/core/bootutils/deps.py +++ b/pkg/core/bootutils/deps.py @@ -29,7 +29,8 @@ required_deps = { "lark_oapi": "lark-oapi", "discord": "discord.py", "cryptography": "cryptography", - "gewechat_client": "gewechat-client" + "gewechat_client": "gewechat-client", + "dashscope": "dashscope", } diff --git a/pkg/core/migrations/m029_dashscope_app_api_config.py b/pkg/core/migrations/m029_dashscope_app_api_config.py new file mode 100644 index 00000000..3a069bac --- /dev/null +++ b/pkg/core/migrations/m029_dashscope_app_api_config.py @@ -0,0 +1,33 @@ +from __future__ import annotations + +from .. import migration + + +@migration.migration_class("dashscope-app-api-config", 29) +class DashscopeAppAPICfgMigration(migration.Migration): + """迁移""" + + async def need_migrate(self) -> bool: + """判断当前环境是否需要运行此迁移""" + return 'dashscope-app-api' not in self.ap.provider_cfg.data + + async def run(self): + """执行迁移""" + self.ap.provider_cfg.data['dashscope-app-api'] = { + "app-type": "agent", + "api-key": "sk-1234567890", + "agent": { + "app-id": "Your_app_id", + "references_quote": "参考资料来自:" + }, + "workflow": { + "app-id": "Your_app_id", + "references_quote": "参考资料来自:", + "biz_params": { + "city": "北京", + "date": "2023-08-10" + } + } + } + + await self.ap.provider_cfg.dump_config() diff --git a/pkg/core/stages/migrate.py b/pkg/core/stages/migrate.py index 6d59065b..a16c9ff5 100644 --- a/pkg/core/stages/migrate.py +++ b/pkg/core/stages/migrate.py @@ -12,6 +12,8 @@ from ..migrations import m020_wecom_config, m021_lark_config, m022_lmstudio_conf from ..migrations import m026_qqofficial_config, m027_wx_official_account_config, m028_aliyun_requester_config +from ..migrations import m029_dashscope_app_api_config + @stage.stage_class("MigrationStage") class MigrationStage(stage.BootingStage): """迁移阶段 diff --git a/pkg/provider/runnermgr.py b/pkg/provider/runnermgr.py index f45abfa4..52e1d8d2 100644 --- a/pkg/provider/runnermgr.py +++ b/pkg/provider/runnermgr.py @@ -5,6 +5,7 @@ from ..core import app from .runners import localagent from .runners import difysvapi +from .runners import dashscopeapi class RunnerManager: @@ -22,6 +23,8 @@ class RunnerManager: self.using_runner = r(self.ap) await self.using_runner.initialize() break + else: + raise ValueError(f"未找到请求运行器: {self.ap.provider_cfg.data['runner']}") def get_runner(self) -> runner.RequestRunner: return self.using_runner diff --git a/pkg/provider/runners/dashscopeapi.py b/pkg/provider/runners/dashscopeapi.py new file mode 100644 index 00000000..0201f35d --- /dev/null +++ b/pkg/provider/runners/dashscopeapi.py @@ -0,0 +1,236 @@ +from __future__ import annotations + +import typing +import json +import base64 +import re + +import dashscope + +from .. import runner +from ...core import entities as core_entities +from .. import entities as llm_entities +from ...utils import image + +class DashscopeAPIError(Exception): + """Dashscope API 请求失败""" + + def __init__(self, message: str): + self.message = message + super().__init__(self.message) + + +@runner.runner_class("dashscope-app-api") +class DashScopeAPIRunner(runner.RequestRunner): + "阿里云百炼DashsscopeAPI对话请求器" + + # 运行器内部使用的配置 + app_type: str # 应用类型 + app_id: str # 应用ID + api_key: str # API Key + references_quote: str # 引用资料提示(当展示回答来源功能开启时,这个变量会作为引用资料名前的提示,可在provider.json中配置) + biz_params: dict = {} # 工作流应用参数(仅在工作流应用中生效) + + async def initialize(self): + """初始化""" + valid_app_types = ["agent", "workflow"] + self.app_type = self.ap.provider_cfg.data["dashscope-app-api"]["app-type"] + #检查配置文件中使用的应用类型是否支持 + if (self.app_type not in valid_app_types): + raise DashscopeAPIError( + f"不支持的 Dashscope 应用类型: {self.app_type}" + ) + + #初始化Dashscope 参数配置 + self.app_id = self.ap.provider_cfg.data["dashscope-app-api"][self.app_type]["app-id"] + self.api_key = self.ap.provider_cfg.data["dashscope-app-api"]["api-key"] + self.references_quote = self.ap.provider_cfg.data["dashscope-app-api"][self.app_type]["references_quote"] + self.biz_params = self.ap.provider_cfg.data["dashscope-app-api"]["workflow"]["biz_params"] + + def _replace_references(self, text, references_dict): + """阿里云百炼平台的自定义应用支持资料引用,此函数可以将引用标签替换为参考资料""" + + # 匹配 [index_id] 形式的字符串 + pattern = re.compile(r'\[(.*?)\]') + + def replacement(match): + # 获取引用编号 + ref_key = match.group(1) + if ref_key in references_dict: + # 如果有对应的参考资料按照provider.json中的reference_quote返回提示,来自哪个参考资料文件 + return f"({self.references_quote} {references_dict[ref_key]})" + else: + # 如果没有对应的参考资料,保留原样 + return match.group(0) + + # 使用 re.sub() 进行替换 + return pattern.sub(replacement, text) + + async def _preprocess_user_message( + self, query: core_entities.Query + ) -> tuple[str, list[str]]: + """预处理用户消息,提取纯文本,阿里云提供的上传文件方法过于复杂,暂不支持上传文件(包括图片)""" + plain_text = "" + image_ids = [] + if isinstance(query.user_message.content, list): + for ce in query.user_message.content: + if ce.type == "text": + plain_text += ce.text + # 暂时不支持上传图片,保留代码以便后续扩展 + # elif ce.type == "image_base64": + # image_b64, image_format = await image.extract_b64_and_format(ce.image_base64) + # file_bytes = base64.b64decode(image_b64) + # file = ("img.png", file_bytes, f"image/{image_format}") + # file_upload_resp = await self.dify_client.upload_file( + # file, + # f"{query.session.launcher_type.value}_{query.session.launcher_id}", + # ) + # image_id = file_upload_resp["id"] + # image_ids.append(image_id) + elif isinstance(query.user_message.content, str): + plain_text = query.user_message.content + + return plain_text, image_ids + + + async def _agent_messages( + self, query: core_entities.Query + ) -> typing.AsyncGenerator[llm_entities.Message, None]: + """Dashscope 智能体对话请求""" + + #局部变量 + chunk = None # 流式传输的块 + pending_content = "" # 待处理的Agent输出内容 + references_dict = {} # 用于存储引用编号和对应的参考资料 + plain_text = "" # 用户输入的纯文本信息 + image_ids = [] # 用户输入的图片ID列表 (暂不支持) + + plain_text, image_ids = await self._preprocess_user_message(query) + + #发送对话请求 + response = dashscope.Application.call( + api_key=self.api_key, # 智能体应用的API Key + app_id=self.app_id, # 智能体应用的ID + prompt=plain_text, # 用户输入的文本信息 + stream=True, # 流式输出 + incremental_output=True, # 增量输出,使用流式输出需要开启增量输出 + session_id=query.session.using_conversation.uuid, # 会话ID用于,多轮对话 + # rag_options={ # 主要用于文件交互,暂不支持 + # "session_file_ids": ["FILE_ID1"], # FILE_ID1 替换为实际的临时文件ID,逗号隔开多个 + # } + ) + + for chunk in response: + if chunk.get("status_code") != 200: + raise DashscopeAPIError( + f"Dashscope API 请求失败: status_code={chunk.get('status_code')} message={chunk.get('message')} request_id={chunk.get('request_id')} " + ) + if not chunk: + continue + + #获取流式传输的output + stream_output = chunk.get("output", {}) + if stream_output.get("text") is not None: + pending_content += stream_output.get("text") + + #保存当前会话的session_id用于下次对话的语境 + query.session.using_conversation.uuid = stream_output.get("session_id") + + #获取模型传出的参考资料列表 + references_dict_list = stream_output.get("doc_references", []) + + #从模型传出的参考资料信息中提取用于替换的字典 + if references_dict_list is not None: + for doc in references_dict_list: + if doc.get("index_id") is not None: + references_dict[doc.get("index_id")] = doc.get("doc_name") + + #将参考资料替换到文本中 + pending_content = self._replace_references(pending_content, references_dict) + + yield llm_entities.Message( + role="assistant", + content=pending_content, + ) + + + async def _workflow_messages( + self, query: core_entities.Query + ) -> typing.AsyncGenerator[llm_entities.Message, None]: + """Dashscope 工作流对话请求""" + + #局部变量 + chunk = None # 流式传输的块 + pending_content = "" # 待处理的Agent输出内容 + references_dict = {} # 用于存储引用编号和对应的参考资料 + plain_text = "" # 用户输入的纯文本信息 + image_ids = [] # 用户输入的图片ID列表 (暂不支持) + + plain_text, image_ids = await self._preprocess_user_message(query) + + #发送对话请求 + response = dashscope.Application.call( + api_key=self.api_key, # 智能体应用的API Key + app_id=self.app_id, # 智能体应用的ID + prompt=plain_text, # 用户输入的文本信息 + stream=True, # 流式输出 + incremental_output=True, # 增量输出,使用流式输出需要开启增量输出 + session_id=query.session.using_conversation.uuid, # 会话ID用于,多轮对话 + biz_params=self.biz_params # 工作流应用的自定义输入参数传递 + # rag_options={ # 主要用于文件交互,暂不支持 + # "session_file_ids": ["FILE_ID1"], # FILE_ID1 替换为实际的临时文件ID,逗号隔开多个 + # } + ) + + #处理API返回的流式输出 + for chunk in response: + if chunk.get("status_code") != 200: + raise DashscopeAPIError( + f"Dashscope API 请求失败: status_code={chunk.get('status_code')} message={chunk.get('message')} request_id={chunk.get('request_id')} " + ) + if not chunk: + continue + + #获取流式传输的output + stream_output = chunk.get("output", {}) + if stream_output.get("text") is not None: + pending_content += stream_output.get("text") + + #保存当前会话的session_id用于下次对话的语境 + query.session.using_conversation.uuid = stream_output.get("session_id") + + #获取模型传出的参考资料列表 + references_dict_list = stream_output.get("doc_references", []) + + #从模型传出的参考资料信息中提取用于替换的字典 + if references_dict_list is not None: + for doc in references_dict_list: + if doc.get("index_id") is not None: + references_dict[doc.get("index_id")] = doc.get("doc_name") + + #将参考资料替换到文本中 + pending_content = self._replace_references(pending_content, references_dict) + + yield llm_entities.Message( + role="assistant", + content=pending_content, + ) + + + + async def run( + self, query: core_entities.Query + ) -> typing.AsyncGenerator[llm_entities.Message, None]: + """运行""" + if self.ap.provider_cfg.data["dashscope-app-api"]["app-type"] == "agent": + async for msg in self._agent_messages(query): + yield msg + elif self.ap.provider_cfg.data["dashscope-app-api"]["app-type"] == "workflow": + async for msg in self._workflow_messages(query): + yield msg + else: + raise DashscopeAPIError( + f"不支持的 Dashscope 应用类型: {self.ap.provider_cfg.data['dashscope-app-api']['app-type']}" + ) + + diff --git a/requirements.txt b/requirements.txt index 27349f64..dbee8256 100644 --- a/requirements.txt +++ b/requirements.txt @@ -29,6 +29,7 @@ lark-oapi discord.py cryptography gewechat-client +dashscope # indirect taskgroup==0.0.0a4 \ No newline at end of file diff --git a/templates/provider.json b/templates/provider.json index 551c7d88..3072a5de 100644 --- a/templates/provider.json +++ b/templates/provider.json @@ -111,5 +111,21 @@ "output-key": "summary", "timeout": 120 } + }, + "dashscope-app-api": { + "app-type": "agent", + "api-key": "sk-1234567890", + "agent": { + "app-id": "Your_app_id", + "references_quote": "参考资料来自:" + }, + "workflow": { + "app-id": "Your_app_id", + "references_quote": "参考资料来自:", + "biz_params": { + "city": "北京", + "date": "2023-08-10" + } + } } } \ No newline at end of file diff --git a/templates/schema/provider.json b/templates/schema/provider.json index e6f806c5..30905c95 100644 --- a/templates/schema/provider.json +++ b/templates/schema/provider.json @@ -425,6 +425,59 @@ } } } + }, + "dashscope-app-api": { + "type": "object", + "title": "阿里百炼平台自建应用 API 配置", + "properties": { + "app-type": { + "type": "string", + "title": "应用类型", + "description": "支持 workflow 和 agent,workflow:智能体编排;agent:普通智能体;请填写下方对应的应用类型 API 参数", + "enum": ["workflow", "agent"], + "default": "agent" + }, + "api-key": { + "type": "string", + "title": "API 密钥" + }, + "agent": { + "type": "object", + "title": "Agent API 参数", + "properties": { + "app-id": { + "type": "string", + "title": "应用 ID" + }, + "references_quote": { + "type": "string", + "title": "参考资料引用", + "description": "设置参考资料引用,用于从 Dashscope App API 结束节点返回的 JSON 数据中提取引用内容", + "default": "参考资料来自:" + } + } + }, + "workflow": { + "type": "object", + "title": "工作流 API 参数", + "properties": { + "app-id": { + "type": "string", + "title": "应用 ID" + }, + "references_quote": { + "type": "string", + "title": "参考资料引用", + "default": "参考资料来自:" + }, + "biz_params": { + "type": "object", + "title": "传入参数", + "default": {} + } + } + } + } } } } \ No newline at end of file