You're viewing version 3.3 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

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.
• To create a new strategy, specify a strategy without an id.

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

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": "existing_strategy_id",
        "type": "summarization",
        "namespace": "updated_namespace"
      },
      {
        "type": "keyword_extraction"
      }
    ],
    "embedding_model_id": "new_embedding_model",
    "embedding_model_type": "dense",
    "embedding_dimension": 768
  }
}

Example response

{
  "result": "updated",
  "_id": "HudqiJkB1SltqOcZusVU",
  "_version": 2,
  "_shards": {
    "total": 2,
    "successful": 1,
    "failed": 0
  }
}

Response fields

The following table lists all response body fields.