文档

ListMemories - 获取长期记忆体列表

更新时间:

获取memory列表。

调试

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

授权信息

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

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

请求语法

GET /{workspaceId}/memories

请求参数

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

业务空间 Id

llm-us9hjmt32nysdm5v
maxResultsinteger

最大返回数量

10
nextTokenstring

由前一次的请求返回,传入时本次查询结果将基于前一次请求结果进行分页

dc270401186b433f975d7e1faaa34e0e

返回参数

名称类型描述示例值
object

Schema of Response

maxResultsinteger

最大返回个数

10
memoriesarray<object>

长期记忆体列表

object
descriptionstring

长期记忆体的描述

通过api创建
memoryIdstring

长期记忆 Id

3fc531f4519444beaafffa4538f60667
nextTokenstring

用于实现基于令牌的分页

dc270401186b433f975d7e1faaa34e0e
requestIdstring

请求 Id

6a71f2d9-f1c9-913b-818b-114029103cad
totalCountinteger

长期记忆体总数

105
workspaceIdstring

业务空间 Id

llm-us9hjmt32nysdm5v

示例

正常返回示例

JSON格式

{
  "maxResults": 10,
  "memories": [
    {
      "description": "通过api创建\n",
      "memoryId": "3fc531f4519444beaafffa4538f60667"
    }
  ],
  "nextToken": "dc270401186b433f975d7e1faaa34e0e",
  "requestId": "6a71f2d9-f1c9-913b-818b-114029103cad\n",
  "totalCount": 105,
  "workspaceId": "llm-us9hjmt32nysdm5v"
}

错误码

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.长期记忆服务内部异常。

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