ListMemoryNodes

更新时间:
复制 MD 格式

Retrieves a list of memory segments.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sfm:ListMemoryNodes

list

*All Resource

*

None None

Request syntax

GET /{workspaceId}/memories/{memoryId}/memoryNodes HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

workspaceId

string

Yes

The ID of the workspace.

llm-us9hjmt32nysdm5v

memoryId

string

Yes

The ID of the long-term memory.

6bff4f317a14442fbc9f73d29dbd5fc3

maxResults

integer

No

The maximum number of results to return.

20

nextToken

string

No

The token from a previous request. Pass this token to retrieve the next page of results.

dc270401186b433f975d7e1faaa34e0e

Response elements

Parameter

Type

Description

Example

object

Schema of Response

maxResults

integer

The maximum number of results returned on each page.

20

memoryNodes

array<object>

The array of memory segments.

object

content

string

The content of the memory segment.

用户喜欢吃西红柿炒鸡蛋

memoryNodeId

string

The ID of the memory segment.

68de06c95368463a8be4a84efc872cc5

nextToken

string

The token to retrieve the next page of results.

dc270401186b433f975d7e1faaa34e0e

requestId

string

The ID of the request.

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

totalCount

integer

The total number of memory segments.

100

Examples

Success response

JSON format

{
  "maxResults": 20,
  "memoryNodes": [
    {
      "content": "用户喜欢吃西红柿炒鸡蛋\n",
      "memoryNodeId": "68de06c95368463a8be4a84efc872cc5"
    }
  ],
  "nextToken": "dc270401186b433f975d7e1faaa34e0e\n",
  "requestId": "6a71f2d9-f1c9-913b-818b-114029103cad\n",
  "totalCount": 100
}

Error codes

HTTP status code

Error code

Error message

Description

400 Memory.MaxResultsInvalid Input parameter maxResults is invalid.
400 Memory.MemoryNodeContentInvalid Memory node content is invalid.
400 Memory.NextTokenInvalid Input parameter nextToken is invalid.
500 Memory.InternalError Memory service inner exception.
404 Memory.MemoryIdNotFound Memory Id not exist or is not authorized.
404 Memory.MemoryNodeNotFound MemoryNode not found.

See for a complete list.

Release notes

See Release Notes for a complete list.