跳至內容

訊息參考

代理主機協定中每個 JSON-RPC 方法的完整參考,依方向與類型編排。每個方法都會連結到記錄其參數與結果的通道參考頁面。

用戶端 → 伺服器 請求

帶有 id 且預期會收到回應的方法。伺服器端的處理常式位於「參考」欄所指示的通道頁面上。

方法說明參考
initialize建立新連線並協商協定版本。通用
ping驗證 AHP 連線是否仍存活,並避免被閒置逾時的中介者(代理伺服器、負載平衡器等)通用
reconnect重新建立已中斷的連線。伺服器會重播遺漏的操作或提供新的快照。通用
subscribe訂閱以 URI 識別的通道。通用
createSession工作階段通道
disposeSession處置工作階段並清理伺服器端資源。工作階段通道
createChat在工作階段中建立新聊天。聊天通道
disposeChat處置聊天並清理伺服器端資源。聊天通道
createTerminal在伺服器上建立新的終端機。終端機通道
disposeTerminal處置終端機,若其行程仍在執行則予以終止。終端機通道
createResourceWatch(無參數)
listSessions傳回工作階段摘要的清單。用於填入工作階段清單與側邊欄。根通道
resourceRead依 URI 讀取資源的內容。通用
resourceWrite將內容寫入伺服器檔案系統上的檔案。通用
resourceList列出伺服器檔案系統上某個檔案 URI 的目錄項目。通用
resourceCopy將資源從某個 URI 複製到另一個 URI(位於伺服器的檔案系統)。通用
resourceDelete刪除伺服器檔案系統上位於某個 URI 的資源。通用
resourceMove將資源從某個 URI 移動(重新命名)到另一個 URI(位於伺服器的檔案系統)。通用
resourceResolve解析資源 — 結合 POSIX 的 statrealpath通用
resourceMkdirmkdir -p 語意在伺服器的檔案系統上建立目錄。通用
resourceRequest請求存取接收端檔案系統上某個資源的權限。通用
fetchTurns請求主機將較舊的歷史回合載入聊天狀態。工作階段通道
authenticate為受保護資源推送 ******。resource 欄位 MUST 符合用戶端從伺服器發現的受保護通用
resolveSessionConfig反覆解析工作階段組態結構描述。用戶端傳送目前的部分工作階段組態與任何根通道
sessionConfigCompletions向伺服器查詢動態工作階段組態屬性的允許值。根通道
completions為部分輸入的內容請求補全項目(例如使用者目前正在撰寫的使用者工作階段通道
invokeChangesetOperation對變更集、單一檔案或行範圍叫用伺服器定義的 {@link ChangesetOperation}。變更集通道

用戶端 → 伺服器 通知

不帶 id 且不預期收到回應的方法。每個通知都帶有頂層 channel: URI

方法說明參考
unsubscribe停止接收某個通道的更新。通用
dispatchAction射後即忘的操作分派(預寫入)。用戶端將操作樂觀地套用到本地狀態,而伺服器一旦通用

伺服器 → 用戶端 請求

由伺服器發起、用戶端必須回應的方法。

方法說明參考
resourceRead依 URI 讀取資源的內容。通用
resourceWrite將內容寫入伺服器檔案系統上的檔案。通用
resourceList列出伺服器檔案系統上某個檔案 URI 的目錄項目。通用
resourceCopy將資源從某個 URI 複製到另一個 URI(位於伺服器的檔案系統)。通用
resourceDelete刪除伺服器檔案系統上位於某個 URI 的資源。通用
resourceMove將資源從某個 URI 移動(重新命名)到另一個 URI(位於伺服器的檔案系統)。通用
resourceResolve解析資源 — 結合 POSIX 的 statrealpath通用
resourceMkdirmkdir -p 語意在伺服器的檔案系統上建立目錄。通用
resourceRequest請求存取接收端檔案系統上某個資源的權限。通用
createResourceWatch(無參數)

伺服器 → 用戶端 通知

由伺服器推送、且沒有前置請求的方法。每個通知都帶有頂層 channel: URI

方法說明參考
action每個操作都包裝在 ActionEnvelope 中。通用
root/sessionAdded當建立新工作階段時,廣播給所有訂閱根通道的用戶端。根通道
root/sessionRemoved當工作階段被處置時,廣播給所有訂閱根通道的用戶端。根通道
root/sessionSummaryChanged當現有工作階段的摘要變更(標題、狀態、modifiedAt、模型、工作目錄、已讀/完成根通道
root/progress長時間執行作業的通用進度通知。根通道
auth/required當受保護資源需要(重新)驗證時,由伺服器發送。通用
otlp/exportLogs將一批 OTLP 日誌記錄傳遞給已訂閱主機日誌通道(公告於遙測通道
otlp/exportTraces將一批 OTLP 追蹤傳遞給已訂閱主機追蹤通道(公告於遙測通道
otlp/exportMetrics將一批 OTLP 指標資料點傳遞給已訂閱主機指標通道(公告於遙測通道

版本引入

上述所有訊息皆於協定版本 1 引入。

以 MIT 授權發布。