ListMemories - 获取长期记忆体列表

获取指定业务空间下一个或多个长期记忆体的详细信息。

接口说明

  • 分页查询首页时,仅需设置MaxResults以限制返回信息的条目数,返回结果中的NextToken将作为查询后续页的凭证。查询后续页时,将NextToken参数设置为上一次返回结果中获取到的NextToken作为查询凭证(如果NextToken为空,表示结果已经完全返回,不需要再请求),并设置MaxResults限制返回条目数。
  • 本接口具有幂等性。

限流说明: 请确保两次请求间隔至少 1 秒,否则可能触发系统限流。如遇限流,请稍后重试。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
sfm:ListMemorieslist
*全部资源
*

请求语法

GET /{workspaceId}/memories HTTP/1.1

请求参数

名称类型必填描述示例值
workspaceIdstring

长期记忆体所属的业务空间 ID。在百炼的控制台首页,单击页面左上角业务空间详情图标获取。

llm-3z7uw7fwz0vexxxx
maxResultsinteger

分页查询时每页行数。取值范围[1-50]。

默认值: 当不设置值时,默认值为 10。

10
nextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

dc270401186b433f975d7e1faaa3xxxx

返回参数

名称类型描述示例值
object

Schema of Response

maxResultsinteger

分页查询时每页长期记忆体的数量。

10
memoriesarray<object>

长期记忆体列表。

MemoryListobject

长期记忆体对象。

descriptionstring

长期记忆体的描述信息。

我的大模型应用$APP_ID关于A用户的长期记忆体
memoryIdstring

长期记忆体 ID。

3fc531f4519444beaafffa4538f6xxxx
nextTokenstring

本次调用返回的查询凭证值。

dc270401186b433f975d7e1faaa3xxxx
requestIdstring

请求 ID。

6a71f2d9-f1c9-913b-818b-11402910xxxx
totalCountinteger

返回结果的总条数。

105
workspaceIdstring

长期记忆体列表所属的业务空间 ID。

llm-3z7uw7fwz0vexxxx

示例

正常返回示例

JSON格式

{
  "maxResults": 10,
  "memories": [
    {
      "description": "我的大模型应用$APP_ID关于A用户的长期记忆体",
      "memoryId": "3fc531f4519444beaafffa4538f6xxxx"
    }
  ],
  "nextToken": "dc270401186b433f975d7e1faaa3xxxx",
  "requestId": "6a71f2d9-f1c9-913b-818b-11402910xxxx\n",
  "totalCount": 105,
  "workspaceId": "llm-3z7uw7fwz0vexxxx\n"
}

错误码

HTTP status code错误码错误信息描述
400Memory.MaxResultsInvalidInput parameter maxResults is invalid.入参maxResults是无效的
400Memory.NextTokenInvalidInput parameter nextToken is invalid.入参nextToken是无效的。
404Memory.MemoryIdNotFoundMemory Id not exist or is not authorized.memoryId 未找到
500Memory.InternalErrorMemory service inner exception.长期记忆服务内部异常。

访问错误中心查看更多错误码。