Files
ipass__ipass/www/apix.html
T
admin 26a0f2f4f4 feat(apix): usage_hint 字段 —— /api/v1/me 帮用户 AI 自动发现调用语法 (1.0.22)
`desc` 是中文给运维看的,`params` 只对 vendor 有意义(passthrough 是空数组)。
`/api/v1/me` 把条目下发给用户 AI 后,AI 必须能自己拼出:
- 路径尾部是什么(/ocr /ocr/base64 /ocr/url)
- 每个端点的 Content-Type(multipart 还是 json)
- 上游字段名 / Swagger 在哪

加 `usage_hint` 字段:管理员按 OpenAPI 风格填写自由格式,由 /api/v1/me
原样透传给用户 AI。AI 直接解析,无需再读人工文档。

设计要点:
- 不进 shm(热路径只查 base/key/asset_id/mode,进 shm 占带宽)
- 截断到 1KB(够写 3-5 个端点说明,长 Swagger 截断而非拒绝)
- 默认空字符串,向后兼容旧数据
- passthrough 推荐填,vendor 可选填

改动:
- models.rs: ApiProxy 加 usage_hint 字段
- apix.rs: upsert 收 usage_hint_raw + 截断;view 回显
- api.rs: save 解析 usage_hint;响应回显
- www/apix.html: 描述加 usage_hint 解释
- www/assets/apix.js: 表单加 textarea + 提交带 usage_hint
- tests/llm/e2e.sh: §11.5 加 1 条 usage_hint 写入与回显断言
- 回归 227/0 全绿(修复断言 1 条)
2026-09-15 11:30:16 +08:00

52 lines
2.2 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<base href="/admin/">
<title>API 代理 · 尚数网 山海关</title>
<link rel="stylesheet" href="assets/admin.css">
</head>
<body>
<div id="shell"></div>
<div class="wrap">
<div class="panel">
<div class="panel-head">
<div>
<h2>代理列表</h2>
<div class="desc">
把外部供应商的 API 挂到网关下:调用方用<b>同一把账号 API Key</b> 访问
<code>/apix/&lt;slug&gt;?参数=值</code>,网关换成<b>该代理自身登记的供应商 Key</b>后转发,并返回供应商原样结果。
每家供应商的基址与 Key 都在每一条代理里单独填写,互不影响。停用的代理对调用方表现为 404(共享内存已摘除,立即生效)。
<br><br>
<b>代理模式</b>:
<span class="badge" style="background:#eee;color:#666">vendor</span>
单一供应商收口 <code>POST /api/v1/ai/request</code>,网关按 <code>asset_id</code> 拼体(防止客户端挑最贵的资产刷);
<span class="badge" style="background:#eef6ee;color:#3a7">passthrough</span>
透传内部 REST 服务(OCR / 文生图 / TTS),访问 <code>/apixp/&lt;slug&gt;/&lt;路径尾部&gt;</code>,
方法/请求体/Content-Type 原样转发,上游路径 = base + 尾部。
<br><br>
<b>调用语法提示(<code>usage_hint</code>)</b>:
passthrough 推荐填写一段机器可读文本,由 <code>GET /api/v1/me</code> 下发给用户 AI,
让 AI <b>自己拼出</b>调用语法(路径尾部/Content-Type/字段名/Swagger),不用看文档。
</div>
</div>
<button class="btn-primary btn-sm" id="newApixBtn">+ 新建代理</button>
</div>
<table>
<thead><tr>
<th>slug</th><th>asset_id</th><th>调用地址</th><th>供应商</th><th>状态</th><th>创建时间</th><th>操作</th>
</tr></thead>
<tbody id="apixBody"></tbody>
</table>
</div>
</div>
<div id="toast"></div>
<script src="assets/core.js"></script>
<script src="assets/apix.js"></script>
</body>
</html>