介面總表
- 規範性
- 草案 1.0
- 更新於
- 檢視 Markdown
4.1 介面總表
合規的服務必須實作標記為「必需」的每個介面,可以實作可選介面,並透過其服務描述中的能力旗標宣告。
| 方法 | 路徑 | 必需性 | 用途 |
|---|---|---|---|
| GET | /.well-known/lmsp.json |
必需 | 服務與能力發現 |
| GET | /lmsp/v1/openapi.json |
必需 | 機器可讀的介面規範 |
| GET | /lmsp/v1/health |
必需 | 存活與就緒檢查 |
| POST | /lmsp/v1/pair |
必需 | 用配對碼換取 Bearer Token |
| GET | /lmsp/v1/models |
必需 | 取得本地模型列表 |
| GET | /lmsp/v1/models/{model_id} |
必需 | 取得單個模型詳情 |
| POST | /lmsp/v1/responses |
必需 | 同步或串流生成 |
| GET | /lmsp/v1/responses/{response_id} |
可選 | 查詢已儲存的回應 |
| POST | /lmsp/v1/tasks |
必需 | 建立非同步生成任務 |
| GET | /lmsp/v1/tasks/{task_id} |
必需 | 查詢非同步任務 |
| POST | /lmsp/v1/tasks/{task_id}/cancel |
必需 | 取消非同步任務 |
| GET | /lmsp/v1/tasks/{task_id}/events |
可選 | 訂閱或恢復事件流 |
| POST | /lmsp/v1/models/{model_id}/load |
可選 | 預載入模型 |
| POST | /lmsp/v1/models/{model_id}/unload |
可選 | 解除安裝模型 |
/v1 下相容 OpenAI 的介面,以及可選的相容 Ollama 的介面,列在第 8 章。
4.2 約定
- 請求主體。 請求主體和回應體均為 JSON(
application/json),事件流(text/event-stream)和錯誤(application/problem+json)除外。 - 路徑引數。 花括號中的名稱(如
{model_id})是佔位符。取值必須經過百分號編碼。形如qwen3:14b-q4_k_m的模型 id 要寫成qwen3%3A14b-q4_k_m。 - 驗證。 除
/.well-known/lmsp.json、/lmsp/v1/openapi.json、/lmsp/v1/health和/lmsp/v1/pair之外,每個介面都要求Authorization: Bearer <token>。 - 可選介面。 服務未實作的可選介面必須回傳
501 Not Implemented,錯誤碼為unsupported_capability。 - 版本與錯誤。 請求可以攜帶版本請求標頭,所有錯誤使用統一的格式,兩者均在第 9 章中定義。
- 合約。 發布在
/lmsp/1.0/openapi.json的 OpenAPI 文件是本章的機器可讀形式。兩者如有差異,以文本為準。