使用 SearchWikiPages 接口根据查询文本搜索当前已发布的 Wiki 页面。该接口用于发现页面;获取完整正文时继续调用 GetWikiPage。
前提条件
已创建 AgentStorage 实例且状态为
normal,并获取实例访问地址(endpoint)和实例名。已创建 API Key。
Wiki 操作使用完整三段 Agent Scope(
appId/tenantId/agentId),每段非空且不能为*,最长 128 字节,不能包含/;不要传入runId。
请求参数
字段 | 类型 | 必填 | 说明 |
| string | 是 | 记忆库名称。 |
| object | 是 | 完整三段 Agent Scope,规则与 |
| string | 是 | 非空查询文本。 |
| int | 否 | 返回数量,默认 10,最大 100。 |
请求示例
使用 API Key 认证时,通过 x-ots-instancename 和 x-ots-apikey 请求头传入实例名和 API Key。
curl -X POST https://<endpoint>/SearchWikiPages \
-H "x-ots-instancename: <instance-name>" \
-H "x-ots-apikey: <your-api-key>" \
-H "Content-Type: application/json" \
-d '{
"memoryStoreName": "agent_memory",
"scope": {
"appId": "app-001",
"tenantId": "user-001",
"agentId": "assistant"
},
"query": "支付回调如何保证幂等",
"limit": 5
}'响应
字段 | 说明 |
| 按相关性排序的页面列表,字段见Wiki 页面对象。 |
| 页面与查询的相关性得分。 |
搜索结果不返回 content。应用应选择少量命中页面,再按 path 调用 GetWikiPage 获取正文。
{
"pages": [
{
"path": "/wiki/payment-callback.md",
"title": "支付回调",
"type": "guide",
"description": "支付回调的幂等与验签要求",
"sources": [
"raw/product/payment.md"
],
"score": 0.87
}
]
}