创建记忆导出任务 - CreateCoreSpaceExportJob
功能介绍
将指定 Space 中的长期记忆按条件搜索并导出为指定格式文件。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| agentarts:memorySpace:createCoreSpaceExportJob | Write | memorySpace * | g:ResourceTag/<tag-key> | - | iam:agencies:pass |
URI
POST /v1/core/spaces/{space_id}/export
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| space_id | 是 | String | 参数解释: Space ID,唯一标识一个Space,可以通过AgentArts智能体记忆库控制台或者记忆库查询接口获取。 约束限制: 不涉及。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),符合正则条件^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| format | 否 | String | 参数解释: 导出格式,当前仅支持 jsonl,默认值为 jsonl。 约束限制: 不涉及。 取值范围: 默认取值: jsonl。 |
| bucket | 是 | String | 参数解释: 用户自建的 OBS 桶名,导出文件将存储到此桶中。 约束限制: 需符合 OBS 桶命名规范。 取值范围: 长度 3-63 字符。 默认取值: 不涉及。 |
| file_path_prefix | 是 | String | 参数解释: 用户选择的 OBS 路径前缀(由用户决定存储位置),系统根据用户选择的桶和路径导出文件,导出文件 存储路径为obs://{bucket}/{file_path_prefix}/memories_{job_id}.jsonl,其中job_id为创建导出任务 返回的任务ID。 约束限制: 不涉及。 取值范围: 长度 1-1024 字符。 默认取值: /。 |
| agency_name | 是 | String | 参数解释: IAM 委托名称(必选),用于获取访问用户 OBS 桶的临时凭证。 约束限制: 必须是有效的 IAM 委托名称。 取值范围: 长度 1-64 字符。 默认取值: AgentArtsMemoryImportExportAgency。 |
| filters | 否 | ExportFilterConditions object | 参数解释: 导出过滤条件,所有字段均为可选参数。创建导出的参数和搜索记忆参数保持一致。 约束限制: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| actor_id | 否 | String | 参数解释: 按用户 ID(Actor ID)过滤导出记忆。 约束限制: 不涉及。 取值范围: 长度 1-64 默认取值: 不涉及。 |
| session_id | 否 | String | 参数解释: 按会话 ID(Session ID)过滤导出记忆。 约束限制: 不涉及。 取值范围: 长度 1-64 字符。 默认取值: 不涉及。 |
| strategy_type | 否 | String | 参数解释: 按策略类型过滤导出记忆。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| start_time | 否 | Long | 参数解释: 起始时间戳(毫秒),按记忆创建时间过滤。 约束限制: 不涉及。 取值范围: 0-9223372036854775807。 默认取值: 不涉及。 |
| end_time | 否 | Long | 参数解释: 结束时间戳(毫秒),按记忆创建时间过滤。 约束限制: 不涉及。 取值范围: 0-9223372036854775807。 默认取值: 不涉及。 |
响应参数
状态码:202
| 参数 | 参数类型 | 描述 |
|---|---|---|
| job_id | String | 参数解释: 异步任务 ID,唯一标识一个异步任务。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.01XXXXXX。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息,描述错误详情,供问题排查使用。 取值范围: 不涉及。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.01XXXXXX。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息,描述错误详情,供问题排查使用。 取值范围: 不涉及。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息,描述错误详情,供问题排查使用。 取值范围: 不涉及。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权失败信息。 取值范围: 不涉及。 |
| details | Array of CoreSpaceCommonError objects | 参数解释: 依赖的下游服务错误信息列表,包含导致当前请求失败的下游服务错误详情。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.01XXXXXX。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息,描述错误详情,供问题排查使用。 取值范围: 不涉及。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.01XXXXXX。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息,描述错误详情,供问题排查使用。 取值范围: 不涉及。 |
状态码:429
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.01XXXXXX。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息,描述错误详情,供问题排查使用。 取值范围: 不涉及。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.01XXXXXX。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息,描述错误详情,供问题排查使用。 取值范围: 不涉及。 |
请求示例
/v1/core/spaces/123e4567-e89b-12d3-a456-426614174000/export
响应示例
状态码:202
{
"job_id" : "550e8400-e29b-41d4-a716-446655440000"
} 状态码:400
{
"error_code" : "AgentArts.01010001",
"error_msg" : "请求参数格式不正确"
} 状态码:403
{
"error_code" : "AgentArts.01010002",
"error_msg" : "Insufficient permissions"
} 状态码:404
{
"error_code" : "AgentArts.01010005",
"error_msg" : "Record not found"
} 状态码:429
{
"error_code" : "AgentArts.01020008",
"error_msg" : "System busy, task queued"
} 状态码:500
{
"error_code" : "AgentArts.01010008",
"error_msg" : "Internal service error"
} 状态码
| 状态码 | 描述 |
|---|---|
| 202 | 导出任务创建成功 |
| 400 | 请求参数错误 |
| 401 | 认证失败。 |
| 403 | 权限不足 |
| 404 | Space 不存在 |
| 429 | 系统并发任务已满,任务进入排队 |
| 500 | 内部服务错误 |
错误码
请参见错误码。