refactor(*): 平台架构 - 拆分后端领域模块并同步插件协议与模型能力
This commit is contained in:
1 parent
916043fb5a
commit
6e5cbc8b05
644 files changed
+62731
-2320
No files matched your search
@@ -0,0 +1,244 @@
|
||||
{
|
||||
"apiVersion": "yingce.plugin/v2",
|
||||
"id": "newapi-chat",
|
||||
"name": "NewAPI Chat",
|
||||
"version": "2.0.0",
|
||||
"author": "NewAPI / 影策",
|
||||
"description": "NewAPI Chat 独立请求协议插件。",
|
||||
"documentation": "# NewAPI Chat\n\n该目录是独立官方协议插件源码。后端从生成的 `newapi-chat.yingce-plugin` 包加载,不依赖系统内置 `host:` 适配器。\n\n完整接口见 [docs/interface.md](docs/interface.md)。\n\n---\n\n# NewAPI Chat 接口字段\n\n## 协议身份\n\n- 插件 ID:`newapi-chat`。\n- Provider ID:`newapi-chat`。\n- 能力:`text`。\n- 默认 Base URL:`http://127.0.0.1:3000`。\n- 鉴权驱动:`bearer`。\n- 创建:`POST /v1/chat/completions`。\n- Agent:`POST /v1/chat/completions`。\n- 生命周期:同步响应。\n\n## 配置字段\n\n| 字段 | 类型 | 必填 | 含义 |\n| --- | --- | --- | --- |\n| `apiKey` | secret | 是 | API Key |\n\n## 统一字段映射\n\n| 统一字段 | 类型 | 必填 | 上游映射 | 说明 |\n| --- | --- | --- | --- | --- |\n| `model` | string | 是 | `model` | 上游模型 ID。 |\n| `messages` | message[] | 是 | `provider message container` | 包含历史消息和当前用户输入。 |\n| `instructions` | string | 否 | `system/instructions` | 系统指令。 |\n| `temperature` | number | 否 | `temperature` | 采样温度。 |\n| `top_p` | number | 否 | `top_p` | 核采样参数。 |\n| `max_tokens` | integer | 否 | `max_tokens/max_output_tokens` | 最大输出 token。 |\n| `tools` | array | 否 | `tools/toolConfig` | 工具定义。 |\n| `tool_choice` | object|string | 否 | `tool_choice` | 工具选择策略。 |\n| `response_format` | object | 否 | `response_format/text` | 结构化输出配置。 |\n| `stream` | boolean | 否 | `stream` | 流式开关;后台任务当前以最终响应归一。 |\n\n## 上游请求模板逐字段清单\n\n下表由插件请求模板生成,覆盖 body、query、headers 和 multipart 文件声明中的每个字段。\n\n| 上游位置 | 值或转换表达式 |\n| --- | --- |\n| `create.method` | `\"POST\"` |\n| `create.path` | `\"/v1/chat/completions\"` |\n| `create.contentType` | `\"application/json\"` |\n| `create.body.model` | `{\"$ref\":\"request.model\"}` |\n| `create.body.messages` | `{\"$ref\":\"request.messages\"}` |\n| `create.body.temperature` | `{\"$omitEmpty\":{\"$ref\":\"request.providerOptions.newapi-chat.temperature\"}}` |\n| `create.body.top_p` | `{\"$omitEmpty\":{\"$ref\":\"request.providerOptions.newapi-chat.top_p\"}}` |\n| `create.body.max_tokens` | `{\"$omitEmpty\":{\"$coalesce\":[{\"$ref\":\"request.extra.max_tokens\"},{\"$ref\":\"request.providerOptions.newapi-chat.max_tokens\"}]}}` |\n| `create.body.tools` | `{\"$omitEmpty\":{\"$ref\":\"request.providerOptions.newapi-chat.tools\"}}` |\n| `create.body.tool_choice` | `{\"$omitEmpty\":{\"$ref\":\"request.providerOptions.newapi-chat.tool_choice\"}}` |\n| `create.body.response_format` | `{\"$omitEmpty\":{\"$ref\":\"request.providerOptions.newapi-chat.response_format\"}}` |\n| `create.body.stream` | `{\"$omitEmpty\":{\"$ref\":\"request.providerOptions.newapi-chat.stream\"}}` |\n| `create.body.provider` | `{\"$omitEmpty\":{\"$ref\":\"request.providerOptions.newapi-chat.provider\"}}` |\n| `create.body.transforms` | `{\"$omitEmpty\":{\"$ref\":\"request.providerOptions.newapi-chat.transforms\"}}` |\n| `create.body.extra_body` | `{\"$omitEmpty\":{\"$ref\":\"request.providerOptions.newapi-chat.extra_body\"}}` |\n| `agent.method` | `\"POST\"` |\n| `agent.path` | `\"/v1/chat/completions\"` |\n| `agent.contentType` | `\"application/json\"` |\n| `agent.body` | `{\"$merge\":[{\"$ref\":\"request.extra.agent.chatCompletion\"},{\"model\":{\"$ref\":\"request.model\"}}]}` |\n\n## Provider 扩展键\n\n- `providerOptions.newapi-chat.extra_body`\n- `providerOptions.newapi-chat.max_tokens`\n- `providerOptions.newapi-chat.provider`\n- `providerOptions.newapi-chat.response_format`\n- `providerOptions.newapi-chat.stream`\n- `providerOptions.newapi-chat.temperature`\n- `providerOptions.newapi-chat.tool_choice`\n- `providerOptions.newapi-chat.tools`\n- `providerOptions.newapi-chat.top_p`\n- `providerOptions.newapi-chat.transforms`\n\n动态模型或工作流允许使用文档声明的完整 `parameters/input/extra_body` 对象;该对象是协议本身的开放 schema,不会被宿主裁剪。\n\n## 响应映射逐字段清单\n\n| 映射位置 | 上游路径或转换表达式 |\n| --- | --- |\n| `response.status` | `\"succeeded\"` |\n| `response.textPaths[0]` | `\"choices.0.message.content\"` |\n| `response.textPaths[1]` | `\"choices.0.text\"` |\n| `response.reasoningPaths[0]` | `\"choices.0.message.reasoning_content\"` |\n| `response.usage` | `{\"$ref\":\"response.usage\"}` |\n| `response.errorPaths[0]` | `\"error.code\"` |\n| `response.messagePaths[0]` | `\"error.message\"` |\n| `agentResponse.textPaths[0]` | `\"choices.0.message.content\"` |\n| `agentResponse.textPaths[1]` | `\"choices.0.text\"` |\n| `agentResponse.reasoningPaths[0]` | `\"choices.0.message.reasoning_content\"` |\n| `agentResponse.toolCallsPath` | `\"choices.0.message.tool_calls\"` |\n| `agentResponse.toolCallIdPaths[0]` | `\"id\"` |\n| `agentResLine truncated
|
||||
"permissions": [
|
||||
"generation.run",
|
||||
"media.read"
|
||||
],
|
||||
"configuration": {
|
||||
"fields": [
|
||||
{
|
||||
"name": "apiKey",
|
||||
"type": "secret",
|
||||
"label": "API Key",
|
||||
"required": true
|
||||
}
|
||||
]
|
||||
},
|
||||
"contributes": {
|
||||
"providers": [
|
||||
{
|
||||
"id": "newapi-chat",
|
||||
"label": "NewAPI Chat",
|
||||
"capabilities": [
|
||||
"text"
|
||||
],
|
||||
"scopes": [
|
||||
"admin.system-channel",
|
||||
"user.custom-channel",
|
||||
"canvas",
|
||||
"creation",
|
||||
"agent"
|
||||
],
|
||||
"baseUrl": "http://127.0.0.1:3000",
|
||||
"requiresPublicMediaUrls": false,
|
||||
"auth": {
|
||||
"type": "bearer",
|
||||
"field": "apiKey"
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "model",
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"mapping": "model",
|
||||
"description": "上游模型 ID。"
|
||||
},
|
||||
{
|
||||
"name": "messages",
|
||||
"type": "message[]",
|
||||
"required": true,
|
||||
"mapping": "provider message container",
|
||||
"description": "包含历史消息和当前用户输入。"
|
||||
},
|
||||
{
|
||||
"name": "instructions",
|
||||
"type": "string",
|
||||
"required": false,
|
||||
"mapping": "system/instructions",
|
||||
"description": "系统指令。"
|
||||
},
|
||||
{
|
||||
"name": "temperature",
|
||||
"type": "number",
|
||||
"required": false,
|
||||
"mapping": "temperature",
|
||||
"description": "采样温度。"
|
||||
},
|
||||
{
|
||||
"name": "top_p",
|
||||
"type": "number",
|
||||
"required": false,
|
||||
"mapping": "top_p",
|
||||
"description": "核采样参数。"
|
||||
},
|
||||
{
|
||||
"name": "max_tokens",
|
||||
"type": "integer",
|
||||
"required": false,
|
||||
"mapping": "max_tokens/max_output_tokens",
|
||||
"description": "最大输出 token。"
|
||||
},
|
||||
{
|
||||
"name": "tools",
|
||||
"type": "array",
|
||||
"required": false,
|
||||
"mapping": "tools/toolConfig",
|
||||
"description": "工具定义。"
|
||||
},
|
||||
{
|
||||
"name": "tool_choice",
|
||||
"type": "object|string",
|
||||
"required": false,
|
||||
"mapping": "tool_choice",
|
||||
"description": "工具选择策略。"
|
||||
},
|
||||
{
|
||||
"name": "response_format",
|
||||
"type": "object",
|
||||
"required": false,
|
||||
"mapping": "response_format/text",
|
||||
"description": "结构化输出配置。"
|
||||
},
|
||||
{
|
||||
"name": "stream",
|
||||
"type": "boolean",
|
||||
"required": false,
|
||||
"mapping": "stream",
|
||||
"description": "流式开关;后台任务当前以最终响应归一。"
|
||||
}
|
||||
],
|
||||
"create": {
|
||||
"method": "POST",
|
||||
"path": "/v1/chat/completions",
|
||||
"contentType": "application/json",
|
||||
"body": {
|
||||
"model": {
|
||||
"$ref": "request.model"
|
||||
},
|
||||
"messages": {
|
||||
"$ref": "request.messages"
|
||||
},
|
||||
"temperature": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.newapi-chat.temperature"
|
||||
}
|
||||
},
|
||||
"top_p": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.newapi-chat.top_p"
|
||||
}
|
||||
},
|
||||
"max_tokens": {
|
||||
"$omitEmpty": {
|
||||
"$coalesce": [
|
||||
{
|
||||
"$ref": "request.extra.max_tokens"
|
||||
},
|
||||
{
|
||||
"$ref": "request.providerOptions.newapi-chat.max_tokens"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"tools": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.newapi-chat.tools"
|
||||
}
|
||||
},
|
||||
"tool_choice": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.newapi-chat.tool_choice"
|
||||
}
|
||||
},
|
||||
"response_format": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.newapi-chat.response_format"
|
||||
}
|
||||
},
|
||||
"stream": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.newapi-chat.stream"
|
||||
}
|
||||
},
|
||||
"provider": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.newapi-chat.provider"
|
||||
}
|
||||
},
|
||||
"transforms": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.newapi-chat.transforms"
|
||||
}
|
||||
},
|
||||
"extra_body": {
|
||||
"$omitEmpty": {
|
||||
"$ref": "request.providerOptions.newapi-chat.extra_body"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"agent": {
|
||||
"method": "POST",
|
||||
"path": "/v1/chat/completions",
|
||||
"contentType": "application/json",
|
||||
"body": {
|
||||
"$merge": [
|
||||
{
|
||||
"$ref": "request.extra.agent.chatCompletion"
|
||||
},
|
||||
{
|
||||
"model": {
|
||||
"$ref": "request.model"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"status": "succeeded",
|
||||
"textPaths": [
|
||||
"choices.0.message.content",
|
||||
"choices.0.text"
|
||||
],
|
||||
"reasoningPaths": [
|
||||
"choices.0.message.reasoning_content"
|
||||
],
|
||||
"usage": {
|
||||
"$ref": "response.usage"
|
||||
},
|
||||
"errorPaths": [
|
||||
"error.code"
|
||||
],
|
||||
"messagePaths": [
|
||||
"error.message"
|
||||
]
|
||||
},
|
||||
"agentResponse": {
|
||||
"textPaths": [
|
||||
"choices.0.message.content",
|
||||
"choices.0.text"
|
||||
],
|
||||
"reasoningPaths": [
|
||||
"choices.0.message.reasoning_content"
|
||||
],
|
||||
"toolCallsPath": "choices.0.message.tool_calls",
|
||||
"toolCallIdPaths": [
|
||||
"id"
|
||||
],
|
||||
"toolCallNamePaths": [
|
||||
"function.name"
|
||||
],
|
||||
"toolCallArgumentsPaths": [
|
||||
"function.arguments"
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user