tt/ttstd-infinite-canvas
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
72ee04fb66330ce096b5ea8e2fcb9bba527d1bd7
ttstd-infinite-canvas/plugin-packages/openai-responses/docs/interface.md

14 KiB
Raw Blame History

OpenAI Responses 接口字段

协议身份

  • 插件 ID：openai-responses。
  • Provider ID：openai-response。
  • 能力：text。
  • 默认 Base URL：https://api.openai.com。
  • 鉴权驱动：bearer。
  • 创建：POST /responses。
  • Agent：POST /responses。
  • 生命周期：同步响应。

配置字段

字段 类型 必填 含义
apiKey secret 是 API Key

统一字段映射

统一字段 类型 必填 上游映射 说明
model string 是 model 上游模型 ID。
messages message[] 是 provider message container 包含历史消息和当前用户输入。
instructions string 否 system/instructions 系统指令。
temperature number 否 temperature 采样温度。
top_p number 否 top_p 核采样参数。
max_tokens integer 否 max_tokens/max_output_tokens 最大输出 token。
tools array 否 tools/toolConfig 工具定义。
tool_choice object string 否 tool_choice
response_format object 否 response_format/text 结构化输出配置。
stream boolean 否 stream 流式开关；后台任务当前以最终响应归一。

上游请求模板逐字段清单

下表由插件请求模板生成，覆盖 body、query、headers 和 multipart 文件声明中的每个字段。

上游位置 值或转换表达式
create.method "POST"
create.path "/responses"
create.contentType "application/json"
create.body.model {"$ref":"request.model"}
create.body.input {"$filter":{"from":{"$ref":"request.messages"},"as":"message","where":{"$ne":[{"$ref":"message.role"},"system"]}}}
create.body.instructions {"$omitEmpty":{"$ref":"request.instructions"}}
create.body.temperature {"$omitEmpty":{"$ref":"request.providerOptions.openai-response.temperature"}}
create.body.top_p {"$omitEmpty":{"$ref":"request.providerOptions.openai-response.top_p"}}
create.body.max_output_tokens {"$omitEmpty":{"$coalesce":[{"$ref":"request.extra.max_output_tokens"},{"$ref":"request.providerOptions.openai-response.max_output_tokens"}]}}
create.body.tools {"$omitEmpty":{"$ref":"request.providerOptions.openai-response.tools"}}
create.body.tool_choice {"$omitEmpty":{"$ref":"request.providerOptions.openai-response.tool_choice"}}
create.body.text {"$omitEmpty":{"$ref":"request.providerOptions.openai-response.text"}}
create.body.reasoning {"$omitEmpty":{"$ref":"request.providerOptions.openai-response.reasoning"}}
create.body.previous_response_id {"$omitEmpty":{"$ref":"request.providerOptions.openai-response.previous_response_id"}}
create.body.store {"$omitEmpty":{"$ref":"request.providerOptions.openai-response.store"}}
create.body.metadata {"$omitEmpty":{"$ref":"request.providerOptions.openai-response.metadata"}}
create.body.stream {"$omitEmpty":{"$ref":"request.providerOptions.openai-response.stream"}}
create.body.truncation {"$omitEmpty":{"$ref":"request.providerOptions.openai-response.truncation"}}
create.body.user {"$omitEmpty":{"$ref":"request.providerOptions.openai-response.user"}}
agent.method "POST"
agent.path "/responses"
agent.contentType "application/json"
agent.body {"$merge":[{"$ref":"request.extra.agent.responses"},{"model":{"$ref":"request.model"}}]}

Provider 扩展键

  • providerOptions.openai-response.max_output_tokens
  • providerOptions.openai-response.metadata
  • providerOptions.openai-response.previous_response_id
  • providerOptions.openai-response.reasoning
  • providerOptions.openai-response.store
  • providerOptions.openai-response.stream
  • providerOptions.openai-response.temperature
  • providerOptions.openai-response.text
  • providerOptions.openai-response.tool_choice
  • providerOptions.openai-response.tools
  • providerOptions.openai-response.top_p
  • providerOptions.openai-response.truncation
  • providerOptions.openai-response.user

动态模型或工作流允许使用文档声明的完整 parameters/input/extra_body 对象；该对象是协议本身的开放 schema，不会被宿主裁剪。

响应映射逐字段清单

映射位置 上游路径或转换表达式
response.status "succeeded"
response.textPaths[0] "output_text"
response.reasoningPaths[0] "reasoning.summary.0.text"
response.usage {"$ref":"response.usage"}
response.errorPaths[0] "error.code"
response.messagePaths[0] "error.message"
agentResponse.textPaths[0] "output_text"
agentResponse.reasoningPaths[0] "reasoning.summary.0.text"
agentResponse.toolCallsPath "output"
agentResponse.toolCallIdPaths[0] "call_id"
agentResponse.toolCallIdPaths[1] "id"
agentResponse.toolCallNamePaths[0] "name"
agentResponse.toolCallArgumentsPaths[0] "arguments"

响应与错误

插件把上游 task/status/text/media/usage 映射为统一结果。临时媒体 URL 标记为 ephemeral，由宿主立即下载持久化。HTTP 错误、业务 code 和 error object 保持失败语义，不包装成成功。

兼容边界

该包只代表上述线协议 profile；同一品牌的其他 endpoint、云区域或网关包装必须使用独立插件，不能根据模型名猜测。

Manifest 完整接口定义

以下 JSON 与插件包内实际 manifest.json 逐字段一致，覆盖插件身份、权限、配置、鉴权、参数、校验、创建、Agent、查询、取消、结果下载、响应和 Agent 响应映射。documentation 字段的值就是当前完整文档；为避免文档在自身内部无限递归，JSON 中仅用等义占位文本表示正文。

{
  "apiVersion": "yingce.plugin/v2",
  "id": "openai-responses",
  "name": "OpenAI Responses",
  "version": "2.0.0",
  "author": "OpenAI / 影策",
  "description": "OpenAI Responses 独立请求协议插件。",
  "documentation": "<当前插件的完整 documentation，由 README.md 与 docs/interface.md 拼接而成；为避免 JSON 递归，此处不重复展开正文。>",
  "permissions": [
    "generation.run",
    "media.read"
  ],
  "configuration": {
    "fields": [
      {
        "name": "apiKey",
        "type": "secret",
        "label": "API Key",
        "required": true
      }
    ]
  },
  "contributes": {
    "providers": [
      {
        "id": "openai-response",
        "label": "OpenAI Responses",
        "capabilities": [
          "text"
        ],
        "scopes": [
          "admin.system-channel",
          "user.custom-channel",
          "canvas",
          "creation",
          "agent"
        ],
        "baseUrl": "https://api.openai.com",
        "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": "/responses",
          "contentType": "application/json",
          "body": {
            "model": {
              "$ref": "request.model"
            },
            "input": {
              "$filter": {
                "from": {
                  "$ref": "request.messages"
                },
                "as": "message",
                "where": {
                  "$ne": [
                    {
                      "$ref": "message.role"
                    },
                    "system"
                  ]
                }
              }
            },
            "instructions": {
              "$omitEmpty": {
                "$ref": "request.instructions"
              }
            },
            "temperature": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.openai-response.temperature"
              }
            },
            "top_p": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.openai-response.top_p"
              }
            },
            "max_output_tokens": {
              "$omitEmpty": {
                "$coalesce": [
                  {
                    "$ref": "request.extra.max_output_tokens"
                  },
                  {
                    "$ref": "request.providerOptions.openai-response.max_output_tokens"
                  }
                ]
              }
            },
            "tools": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.openai-response.tools"
              }
            },
            "tool_choice": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.openai-response.tool_choice"
              }
            },
            "text": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.openai-response.text"
              }
            },
            "reasoning": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.openai-response.reasoning"
              }
            },
            "previous_response_id": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.openai-response.previous_response_id"
              }
            },
            "store": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.openai-response.store"
              }
            },
            "metadata": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.openai-response.metadata"
              }
            },
            "stream": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.openai-response.stream"
              }
            },
            "truncation": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.openai-response.truncation"
              }
            },
            "user": {
              "$omitEmpty": {
                "$ref": "request.providerOptions.openai-response.user"
              }
            }
          }
        },
        "agent": {
          "method": "POST",
          "path": "/responses",
          "contentType": "application/json",
          "body": {
            "$merge": [
              {
                "$ref": "request.extra.agent.responses"
              },
              {
                "model": {
                  "$ref": "request.model"
                }
              }
            ]
          }
        },
        "response": {
          "status": "succeeded",
          "textPaths": [
            "output_text"
          ],
          "reasoningPaths": [
            "reasoning.summary.0.text"
          ],
          "usage": {
            "$ref": "response.usage"
          },
          "errorPaths": [
            "error.code"
          ],
          "messagePaths": [
            "error.message"
          ]
        },
        "agentResponse": {
          "textPaths": [
            "output_text"
          ],
          "reasoningPaths": [
            "reasoning.summary.0.text"
          ],
          "toolCallsPath": "output",
          "toolCallIdPaths": [
            "call_id",
            "id"
          ],
          "toolCallNamePaths": [
            "name"
          ],
          "toolCallArgumentsPaths": [
            "arguments"
          ]
        }
      }
    ]
  }
}
Reference in New Issue View Git Blame Copy Permalink