You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _ml-commons-plugin/api/agent-apis/execute-agent.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,6 +34,10 @@ Field | Data type | Required/Optional | Description
34
34
:--- | :--- | :---
35
35
`parameters`| Object | Required | The parameters required by the agent. Any agent parameters configured during registration can be overridden using this field.
`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.
37
41
38
42
## Example request
39
43
@@ -70,4 +74,4 @@ Therefore, the population increase of Seattle from 2021 to 2023 is 58,000."""
Copy file name to clipboardExpand all lines: _ml-commons-plugin/api/agent-apis/register-agent.md
+11-1Lines changed: 11 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,8 @@ Field | Data type | Required/Optional | Agent type | Description
38
38
`description` | String | Optional| All | A description of the agent. |
39
39
`tools` | Array | Optional | All | A list of tools for the agent to execute.
40
40
`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.
42
43
`llm.model_id` | String | Required | `conversational` | The model ID of the LLM to which to send questions.
43
44
`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`.
44
45
`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
52
53
`inject_datetime` | Boolean | Optional | `conversational`, `plan_execute_and_reflect` | Whether to automatically inject the current date into the system prompt. Default is `false`.
53
54
`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).
54
55
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
+
55
65
The `tools` array contains a list of tools for the agent. Each tool contains the following fields.
56
66
57
67
Field | Data type | Required/Optional | Description
0 commit comments