Link Search Menu Expand Document Documentation Menu
Documentation

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.

Delete Memory API

Introduced 3.3

Use this API to delete a specific memory by its type and ID or to delete memories matching a query. This unified API supports deleting memories of any memory type: sessions, working, long-term, or history.

Delete a memory by type and ID

Use this API to delete a memory by type and ID.

Endpoints

DELETE /_plugins/_ml/memory_containers/<memory_container_id>/memories/<type>/<id>

Path parameters

The following table lists the available path parameters.

Parameter Data type Required/Optional Description
memory_container_id String Required The ID of the memory container from which to delete the memory.
type String Required The type of memory to delete. Valid values are sessions, working, long-term, and history.
id String Required The ID of the specific memory to delete.

Example request: Delete a working memory

DELETE /_plugins/_ml/memory_containers/HudqiJkB1SltqOcZusVU/memories/working/XyEuiJkBeh2gPPwzjYWM

Example request: Delete a long-term memory

DELETE /_plugins/_ml/memory_containers/HudqiJkB1SltqOcZusVU/memories/long-term/DcxjTpkBvwXRq366C1Zz

Example request: Delete a sessions memory

DELETE /_plugins/_ml/memory_containers/HudqiJkB1SltqOcZusVU/memories/sessions/CcxjTpkBvwXRq366A1aE

Example request: Delete a history memory

DELETE /_plugins/_ml/memory_containers/HudqiJkB1SltqOcZusVU/memories/history/eMxnTpkBvwXRq366hmAU

Example response

{
  "result": "deleted",
  "_id": "XyEuiJkBeh2gPPwzjYWM",
  "_version": 2,
  "_shards": {
    "total": 2,
    "successful": 1,
    "failed": 0
  }
}

Response fields

The following table lists all response body fields.

Field Data type Description
result String The result of the delete operation.
_id String The ID of the deleted memory.
_version Integer The version number after deletion.
_shards Object Information about the shards involved in the operation.

Delete memories by query

Use this API to delete multiple memories using a query to match specific criteria.

Endpoints

POST /_plugins/_ml/memory_containers/<memory_container_id>/memories/<type>/_delete_by_query

Path parameters

Field Data type Required/Optional Description
memory_container_id String Required The ID of the memory container from which to delete the memory.
type String Required The type of memory to delete. Valid values are sessions, working, long-term, and history.

Request body fields

The request body must contain a query to match the memories you want to delete.

Example request

POST /_plugins/_ml/memory_containers/HudqiJkB1SltqOcZusVU/memories/working/_delete_by_query
{
  "query": {
    "match": {
      "owner_id": "admin"
    }
  }
}

Example response

{
    "took": 159,
    "timed_out": false,
    "total": 6,
    "updated": 0,
    "created": 0,
    "deleted": 6,
    "batches": 1,
    "version_conflicts": 0,
    "noops": 0,
    "retries": {
        "bulk": 0,
        "search": 0
    },
    "throttled_millis": 0,
    "requests_per_second": -1.0,
    "throttled_until_millis": 0,
    "failures": []
}

Response fields

Field Data type Description
took Integer The time, in milliseconds, taken to execute the request.
timed_out Boolean Whether the request timed out.
total Integer The total number of documents processed.
deleted Integer The number of documents deleted.
batches Integer The number of batches processed.
version_conflicts Integer The number of version conflicts encountered.
noops Integer The number of no-operation updates.
retries Object Information about bulk and search retries.
throttled_millis Integer The time, in milliseconds, that the request was throttled.
requests_per_second Float The number of requests processed per second.
throttled_until_millis Integer The time, in milliseconds, until throttling is lifted.
failures Array Any failures that occurred during the operation.
350 characters left

Have a question? .

Want to contribute? or .