开发者
示例与工作流
读取笔记、安全追加文字与批注 PDF 的完整流程。
让助手总结笔记(只读)
- 调用
rooqi_request_read_access→approvalRequired。在 RooQi 中批准并选择项目。 - 再次调用
rooqi_request_read_access→ready。 rooqi_list_approved_documents→{ "<id>": "第三讲", … }- 以
{ "documentID": "<id>" }调用rooqi_read_note→ 已保存文字与 revision。
助手只能看到已保存文字,看不到手写、图像或 PDF 原文。
安全地追加摘要
- 请求写入授权并批准。
- 读取笔记,获得当前
revision。 - 为
operationID生成新的 UUID,在调用前先保存。 - 调用
rooqi_append_text:
{
"operationID": "3B1F7A2C-9E44-4D51-A0C6-1E2F3A4B5C6D",
"documentID": "<id>",
"text": "摘要:…",
"expectedVersion": 7,
"provider": "example-assistant",
"model": "example-model-1",
"promptVersion": "summary-v1"
}- 遇到
mutationUncertain或超时,用相同内容再次调用。遇到mutationRejected,重新读取;只有确实要发起新写入时才使用新的operationID。
在 PDF 中高亮一句话
- 调用
rooqi_request_pdf_annotation_access,批准后再次调用。 - 以文稿调用
rooqi_list_pdf_targets→ 从availableSourcePages中选择surfaceID与页。 - 以某个区域调用
rooqi_read_pdf_page,例如第 0 页上半部分:
{ "documentID": "<doc>", "surfaceID": "<surface>", "pageIndex": 0,
"rect": { "x": 0, "y": 0, "width": 1000000, "height": 500000 } }- 根据返回的
lines[].rect把rect缩小到目标行并再次读取,然后调用rooqi_annotate_pdf:使用相同query、以返回的revision作为expectedVersion、sourceAssetID与三个 digest、kind: "highlight"、空的comment。 - 结果不确定时,用同一
operationID调用rooqi_query_pdf_operation。