跳到主要内容

快速开始

这一页直接跟随当前 memorose-server 的真实 API。它是从服务跑起来,到完成一次真实检索回路的最短路径。

你需要什么

  • 一个运行中的 Memorose 服务,地址是 http://127.0.0.1:3000
  • dashboard 登录凭据
  • jq
  • uuidgen

最短主路径

  1. 登录并拿到 bearer token
  2. 创建一个 stream
  3. 摄入一条事件
  4. 对这个 stream 做一次检索
  5. 查看整合积压是否清空
提示

如果你只想验证 API 表面,这一页已经够用。如果你想理解背后的模型,再继续读 架构概览

1. 先设基础变量

export BASE_URL="http://127.0.0.1:3000"
export USER_ID="dylan"
export ORG_ID="default"

2. 登录并获取 Token

/v1 路由可以直接使用 dashboard 登录拿到的 JWT:

TOKEN=$(curl -s -X POST "$BASE_URL/v1/dashboard/auth/login" \
-H "Content-Type: application/json" \
-d '{
"username": "admin",
"password": "admin"
}' | jq -r '.token')

3. 创建 Stream ID

STREAM_ID=$(uuidgen | tr '[:upper:]' '[:lower:]')

4. 摄入一个事件

curl -s -X POST "$BASE_URL/v1/users/$USER_ID/streams/$STREAM_ID/events" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"org_id": "default",
"content": "Dylan prefers Rust for systems work and wants concise status updates.",
"content_type": "text"
}'

返回结构:

{
"status": "accepted",
"event_id": "..."
}

5. 检索记忆

curl -s -X POST "$BASE_URL/v1/users/$USER_ID/streams/$STREAM_ID/retrieve" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"org_id": "default",
"query": "What does Dylan prefer for systems work?",
"limit": 5,
"graph_depth": 1
}'

返回结构:

{
"stream_id": "...",
"query": "What does Dylan prefer for systems work?",
"results": [
{
"unit": {
"id": "...",
"memory_type": "Fact",
"content": "...",
"keywords": ["rust", "systems"],
"level": 1
},
"score": 0.9
}
],
"query_time_ms": 12
}

重点字段:

  • results[].unit.level:命中的记忆位于哪一层
  • results[].unit.memory_type:命中的记忆类型
  • score:融合后的最终排序分数
  • query_time_ms:服务端观测到的检索耗时

6. 查看整合积压

curl -s "$BASE_URL/v1/status/pending" \
-H "Authorization: Bearer $TOKEN"

"ready": true 时,当前待处理事件已经清空。

下一步去哪