Skip to content

Commit c66b8a7

Browse files
committed
add doc for agentic memory enhancement
Signed-off-by: Sicheng Song <sicheng.song@outlook.com>
1 parent 7fd3379 commit c66b8a7

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

_ml-commons-plugin/api/agent-apis/execute-agent.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ Field | Data type | Required/Optional | Description
3434
:--- | :--- | :---
3535
`parameters`| Object | Required | The parameters required by the agent. Any agent parameters configured during registration can be overridden using this field.
3636
`parameters.verbose`| Boolean | Optional | Provides verbose output.
37+
`parameters.memory_id` | String | Optional | The memory session ID to continue an existing conversation. When the agent uses `agentic_memory`, omit this field to start a new session.
38+
`parameters.memory_container_id` | String | Optional | Overrides the configured memory container for this execution when the agent uses `agentic_memory`.
39+
40+
When the agent is configured with `agentic_memory`, the response includes a `memory_id`. Use that value in subsequent requests to continue the same session. You must provide a memory container ID either in the agent registration (`memory.memory_container_id`) or per request (`parameters.memory_container_id`); otherwise, execution fails.
3741

3842
## Example request
3943

@@ -70,4 +74,4 @@ Therefore, the population increase of Seattle from 2021 to 2023 is 58,000."""
7074
}
7175
]
7276
}
73-
```
77+
```

_ml-commons-plugin/api/agent-apis/register-agent.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ Field | Data type | Required/Optional | Agent type | Description
3838
`description` | String | Optional| All | A description of the agent. |
3939
`tools` | Array | Optional | All | A list of tools for the agent to execute.
4040
`app_type` | String | Optional | All | Specifies an optional agent category. You can then perform operations on all agents in the category. For example, you can delete all messages for RAG agents.
41-
`memory.type` | String | Optional | `conversational_flow`, `conversational` | Specifies where to store the conversational memory. Currently, the only supported type is `conversation_index` (store the memory in a conversational system index).
41+
`memory.type` | String | Optional | `conversational_flow`, `conversational` | Specifies where to store the conversational memory. Supported values are `conversation_index` (store memory in conversation indices) and `agentic_memory` (store memory in a memory container).
42+
`memory.memory_container_id` | String | Optional | `conversational_flow`, `conversational` | The default memory container ID for `agentic_memory`. If omitted here, you must provide `parameters.memory_container_id` when executing the agent. If neither is provided, the request fails.
4243
`llm.model_id` | String | Required | `conversational` | The model ID of the LLM to which to send questions.
4344
`llm.parameters.response_filter` | String | Required | `conversational` | The pattern for parsing the LLM response. For each LLM, you need to provide the field where the response is located. For example, for the Anthropic Claude model, the response is located in the `completion` field, so the pattern is `$.completion`. For OpenAI models, the pattern is `$.choices[0].message.content`.
4445
`llm.parameters.max_iteration` | Integer | Optional | `conversational` | The maximum number of messages to send to the LLM. Default is `10`.
@@ -52,6 +53,15 @@ Field | Data type | Required/Optional | Agent type | Description
5253
`inject_datetime` | Boolean | Optional | `conversational`, `plan_execute_and_reflect` | Whether to automatically inject the current date into the system prompt. Default is `false`.
5354
`datetime_format` | String | Optional | `conversational`, `plan_execute_and_reflect` | A format string for dates used when `inject_datetime` is enabled. Default is `"yyyy-MM-dd'T'HH:mm:ss'Z'"` (ISO format).
5455

56+
To use agentic memory, create a memory container using the [Create memory container API]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/agentic-memory-apis/create-memory-container/) and set the memory configuration like this:
57+
58+
```json
59+
"memory": {
60+
"type": "agentic_memory",
61+
"memory_container_id": "<memory_container_id>"
62+
}
63+
```
64+
5565
The `tools` array contains a list of tools for the agent. Each tool contains the following fields.
5666

5767
Field | Data type | Required/Optional | Description

0 commit comments

Comments
 (0)