Update Memory Container API

Introduced 3.3

Use this API to update an existing memory container’s properties, such as name, description, configuration, and access permissions.

Endpoints

PUT /_plugins/_ml/memory_containers/{memory_container_id}

Path parameters

Request fields

The configuration object

The configuration object supports the following fields.

Update behavior

Note the following update behavior.

Strategy updates

• To update a specific strategy, specify the strategy id. Only the fields that you provide are updated. You cannot change the type of an existing strategy.
• To create a new strategy, specify a strategy without an id.
• To disable a strategy without removing it, set its enabled field to false.

Backend roles updates

• Adding new backend_roles grants new users read or write access with those roles.
• The new backend_roles field overwrites the existing field, so include the original roles if you want to keep them.

Namespace updates

• The namespace field in the strategies object is updated by overwriting. Include the original namespace if you want to keep it.

Embedding model restrictions

• The embedding_model_id, embedding_model_type, and embedding_dimension fields can only be updated if no long-term memory index has been created for this memory container. Once a long-term memory index with the specified index_prefix is created, these embedding fields cannot be updated.

Example request

The following request updates the namespace of an existing strategy and adds a USER_PREFERENCE strategy. To find the IDs of existing strategies, use the Get Memory Container API:

PUT /_plugins/_ml/memory_containers/HudqiJkB1SltqOcZusVU
{
  "name": "opensearch-agents-memory",
  "description": "Updated memory container for OpenSearch agents",
  "backend_roles": ["admin", "ml_user"],
  "configuration": {
    "strategies": [
      {
        "id": "semantic_53d1751c",
        "namespace": ["user_id", "session_id"]
      },
      {
        "type": "USER_PREFERENCE",
        "namespace": ["user_id"]
      }
    ]
  }
}

Example response

{
  "_index": ".plugins-ml-am-memory-container",
  "_id": "HudqiJkB1SltqOcZusVU",
  "_version": 2,
  "result": "updated",
  "_shards": {
    "total": 1,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 5,
  "_primary_term": 1
}

Response fields

The following table lists all response body fields.