长期记忆 API

添加记忆片段

• 建立记忆：通过 AddMemory 保存上一轮对话内容，转换为记忆片段并构建语义索引。

• 检索记忆：通过 SearchMemory 基于语义检索相关历史记忆。

最佳实践：在每轮对话结束后及时调用 AddMemory 保存记忆，检索时建议将 top_k 设置在 3 到 10 之间，平衡性能和效果。

# 添加记忆
curl -X POST https://dashscope.aliyuncs.com/api/v2/apps/memory/add \
  --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "messages": [
      {"role": "user", "content": "每天上午9点提醒我喝水"},
      {"role": "assistant", "content": "好的，已记录"},
      {"role": "user", "content": "明天10点提醒我整理会议纪要。"}
    ],
    "user_id": "user_001",
    "memory_library_id": "your_memory_library_id",
    "project_id": "your_project_id",
    "profile_schema": "your_profile_schema_id",
    "meta_data": {
      "location_name": "北京"
    }
  }'
# memory_library_id：非必填，记忆库 ID，在记忆库卡片上获取。不填则使用默认记忆库。
# project_id：非必填，记忆片段规则 ID，在记忆库详情页的记忆规则中获取。
# profile_schema：非必填，用户画像规则 ID，在记忆库详情页的记忆规则中获取。
# meta_data：非必填，自定义元数据，用于对记忆进行分类管理。

# 添加记忆（自定义内容）
curl -X POST https://dashscope.aliyuncs.com/api/v2/apps/memory/add \
  --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "custom_content": "用户周末去上海参加WAIC",
    "user_id": "user_001",
    "memory_library_id": "your_memory_library_id",
    "meta_data": {
      "custom_key": "custom_value"
    }
  }'

# 搜索记忆
curl -X POST https://dashscope.aliyuncs.com/api/v2/apps/memory/memory_nodes/search \
  --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "user_id": "user_001",
    "memory_library_id": "your_memory_library_id",
    "messages": [
      {"role": "user", "content": "我需要做什么？"}
    ],
    "top_k": 5
  }'

更新记忆片段

管理记忆：通过 ListMemory、UpdateMemory、DeleteMemory 管理记忆片段，支持元数据分类和智能去重。

最佳实践：使用元数据对记忆进行分类管理（如按类别、优先级等），便于后续的精确检索和管理。

# 添加记忆
curl -X POST https://dashscope.aliyuncs.com/api/v2/apps/memory/add \
  --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "user_id": "user_001",
    "messages": [
      {"role": "user", "content": "每天上午9点提醒我喝水"},
      {"role": "assistant", "content": "好的，已记录"}
    ]
  }'

# 列出记忆
curl --location --request GET 'https://dashscope.aliyuncs.com/api/v2/apps/memory/memory_nodes?user_id=user_001&page_size=10&page_num=1' \
  --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{}'

# 更新记忆
curl --location --request PATCH 'https://dashscope.aliyuncs.com/api/v2/apps/memory/memory_nodes/{memory_node_id}' \
  --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "user_id": "user_001",
    "custom_content": "还要提醒我上午10点吃药。"
  }'

# 查看更新的记忆
curl -X POST https://dashscope.aliyuncs.com/api/v2/apps/memory/memory_nodes/search \
  --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "user_id": "user_001",
    "memory_library_id": "your_memory_library_id",
    "messages": [
      {"role": "user", "content": "我需要做什么？"}
    ],
    "top_k": 5
  }'

# 删除记忆
curl --location --request DELETE 'https://dashscope.aliyuncs.com/api/v2/apps/memory/memory_nodes/{memory_node_id}' \
  --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{}'

提取用户画像

• 创建画像模板：通过 CreateProfileSchema 定义需要提取的用户属性。

• 提取画像：调用 AddMemory 时传入画像模板 ID，从对话中提取用户属性并更新画像。

• 获取画像：通过 GetUserProfile 获取完整的用户画像信息。

最佳实践：画像字段及描述应该清晰、具体，避免过于抽象。属性名称应尽可能保证在语义中唯一，如["姓名"、"名称"、"名字"]、["年龄"、"年纪"、"岁数"]不应同时出现，否则会对抽取效果有一定影响。不应期望一次对话就能提取所有信息，应通过多轮对话收集。

# 创建画像 Schema
curl -X POST https://dashscope.aliyuncs.com/api/v2/apps/memory/profile_schemas \
  --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "用户基础画像",
    "description": "包含年龄和兴趣的用户信息",
    "attributes": [
      {"name": "年龄", "description": "用户年龄"},
      {"name": "爱好", "description": "用户的兴趣爱好"},
      {"name": "职业", "description": "用户职业"}
    ]
  }'

# 添加包含画像信息的对话（使用上面返回的 profile_schema_id）
curl -X POST https://dashscope.aliyuncs.com/api/v2/apps/memory/add \
  --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "user_id": "user_001",
    "messages": [
      {"role": "user", "content": "我今年28岁，是一名软件工程师。周末喜欢踢足球。"},
      {"role": "assistant", "content": "很高兴认识你！"}
    ],
    "profile_schema": "YOUR_SCHEMA_ID"
  }'

# 获取用户画像（等待3秒后执行）
curl -X GET "https://dashscope.aliyuncs.com/api/v2/apps/memory/profile_schemas/{YOUR_SCHEMA_ID}/user_profile?user_id=user_001" \
  --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
  --header "Content-Type: application/json"