AddMemories - 写入长期记忆
向记忆空间写入消息或文本。sync 缺省为 true,同步等待抽取并仅返回 memories(允许空数组);sync=false 仅返回 taskId,通过 GetMemoryTask 查询。
接口说明
向记忆空间写入消息或文本。sync 缺省为 true,同步等待抽取并仅返回 memories(允许空数组);sync=false 仅返回 taskId,通过 GetMemoryTask 查询。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
agentcore:AddMemories |
create |
*MemoryStore
|
无 | 无 |
请求语法
POST /workspaces/{workspaceId}/memorystores/{memoryStoreName}/memories HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| workspaceId |
string |
是 |
AgentCore 工作空间 ID |
ws-2f5f9c5a8d0e4c3b |
| memoryStoreName |
string |
是 |
MemoryStore 名称 |
customer-memory |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
是 |
写入记忆请求 |
|
| messages |
array<object> |
否 |
消息列表,与 Text 必须且只能提供一个;1~20 条,Content 合计不超过 32000 UTF-8 字节 |
|
|
object |
否 |
|||
| content |
string |
是 |
消息内容 |
用户喜欢徒步旅行。 |
| role |
string |
是 |
消息角色 |
user |
| metadata |
object |
否 |
字符串键值元数据;最多 16 个键,键最长 64 字符,值最长 1024 字符 |
|
|
string |
否 |
元数据值 |
hiking |
|
| referenceTime |
string |
否 |
本批消息或文本的时间参考点;采用带时区的 RFC 3339 格式并支持小数秒 |
2023-05-08T13:56:00+08:00 |
| scope |
object |
否 |
写入范围;UserId、AgentId、SessionId 均可选 |
|
| agentId |
string |
否 |
Agent ID,长度限制 1 - 128 UTF-8 字节,不允许包含 / 或使用 * |
agent-001 |
| sessionId |
string |
否 |
Session ID,长度限制 1 - 128 UTF-8 字节,不允许包含 / 或使用 * |
session-001 |
| userId |
string |
否 |
用户 ID,长度限制 1 - 128 UTF-8 字节,不允许包含 / 或使用 * |
user-001 |
| sync |
boolean |
否 |
是否同步等待记忆抽取完成,缺省为 true |
|
| text |
string |
否 |
直接写入的文本,与 Messages 必须且只能提供一个;不超过 32000 UTF-8 字节 |
用户喜欢徒步旅行。 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| code |
string |
业务状态码 |
SUCCESS |
| data |
object |
写入结果 |
|
| memories |
array<object> |
仅 sync=true 返回的记忆引用,允许空数组;不与 taskId 同时返回 |
|
|
object |
|||
| memoryId |
string |
长期记忆 ID |
mem-2f5f9c5a8d0e4c3b |
| taskId |
string |
仅 sync=false 返回的任务 ID;不与 memories 同时返回 |
task-2f5f9c5a8d0e4c3b |
| httpStatusCode |
integer |
HTTP 状态码 |
200 |
| message |
string |
响应消息 |
success |
| requestId |
string |
请求 ID |
01A00000-0000-0000-0000-000000000001 |
| success |
boolean |
请求是否成功 |
示例
正常返回示例
JSON格式
{
"code": "SUCCESS",
"data": {
"memories": [
{
"memoryId": "mem-2f5f9c5a8d0e4c3b"
}
],
"taskId": "task-2f5f9c5a8d0e4c3b"
},
"httpStatusCode": 200,
"message": "success",
"requestId": "01A00000-0000-0000-0000-000000000001",
"success": true
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | The specified request parameter is invalid. | |
| 500 | UnknownError | The request processing has failed due to some unknown error. | |
| 404 | Resource.NotFound | The specified memory store does not exist. | |
| 429 | Throttling | Request was denied due to request throttling. | |
| 409 | Operation.Conflict | The memory store is not in a state that permits this operation. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。