Skip to main content

​
documents.delete

Delete one or more items by id within a namespace. Missing ids are listed in not_found_ids without failing the request. Deleting items frees global item quota immediately. 
client.documents.delete(namespace_name: str, *, ids: list[str]) -> dict[str, Any]
client.vectors.delete(namespace_name: str, *, ids: list[str]) -> dict[str, Any]
Both call the same endpoint. Use whichever matches the resource you uploaded with. API: POST /namespaces/{namespace_name}/items/delete — see Delete items

​
Parameters

​
namespace_name
string
required
Namespace to delete from.
​
ids
array
required
Non-empty array of item id strings. Maximum 100 ids per request.

​
Examples

from moorcheh import MoorchehClient, MoorchehApiError

with MoorchehClient("http://localhost:8080") as client:
    result = client.documents.delete(
        "my-documents",
        ids=["doc-1", "doc-missing"],
    )

    print(result["deleted"], result["not_found_ids"])
    # 1 ['doc-missing']
A response with deleted: 0 means none of the requested ids existed — this is still a successful call, not an exception.

​
Returns

​
status
string
"success" when the delete request completed.
​
message
string
Human-readable result description.
​
namespace_name
string
Namespace items were deleted from.
​
requested
number
Number of ids sent in the request.
​
deleted
number
Number of items actually removed.
​
not_found_ids
array
Ids that were not found in the namespace (may be empty).
Example return value (partial)
{
  "status": "success",
  "message": "Delete by ids completed.",
  "namespace_name": "my-documents",
  "requested": 2,
  "deleted": 1,
  "not_found_ids": ["doc-missing"],
}
Example return value (none found)
{
  "status": "success",
  "message": "Delete by ids completed.",
  "namespace_name": "my-documents",
  "requested": 2,
  "deleted": 0,
  "not_found_ids": ["doc-missing", "another-missing"],
}

​
Error Handling

Non-2xx responses raise MoorchehApiError. Partial deletes (some ids not found) do not raise — check not_found_ids. 
from moorcheh import MoorchehClient, MoorchehApiError

try:
    with MoorchehClient() as client:
        result = client.documents.delete("my-documents", ids=["doc-1"])
except MoorchehApiError as e:
    print(e.status_code, e.body)
StatusCause
400Empty ids, more than 100 ids, or empty id string
404Namespace not found
  • Maximum 100 ids per request
  • Deleting items frees quota toward the global 100,000 item limit
  • A successful response with deleted: 0 means none of the requested ids existed