Weaviate · Schema

BatchDelete

Weaviate BatchDelete schema

Vector DatabaseAIMachine LearningSemantic SearchOpen SourceGraphQLKubernetes

Properties

Name Type Description
match object Outlines how to find the objects to be deleted.
output string Controls the verbosity of the output, possible values are: `minimal`, `verbose`. Defaults to `minimal`.
deletionTimeUnixMilli integer Timestamp of deletion in milliseconds since epoch UTC.
dryRun boolean If true, the call will show which objects would be matched using the specified filter without deleting any objects.

Depending on the configured verbosity, you will either receive a count of
View JSON Schema on GitHub

JSON Schema

weaviate-batch-delete-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/weaviate/json-schema/weaviate-batch-delete-schema.json",
  "title": "BatchDelete",
  "description": "Weaviate BatchDelete schema",
  "type": "object",
  "properties": {
    "match": {
      "type": "object",
      "description": "Outlines how to find the objects to be deleted.",
      "properties": {
        "class": {
          "type": "string",
          "description": "The name of the collection (class) from which to delete objects.",
          "example": "City"
        },
        "where": {
          "$ref": "#/components/schemas/WhereFilter"
        }
      }
    },
    "output": {
      "type": "string",
      "description": "Controls the verbosity of the output, possible values are: `minimal`, `verbose`. Defaults to `minimal`.",
      "default": "minimal"
    },
    "deletionTimeUnixMilli": {
      "type": "integer",
      "format": "int64",
      "description": "Timestamp of deletion in milliseconds since epoch UTC."
    },
    "dryRun": {
      "type": "boolean",
      "description": "If true, the call will show which objects would be matched using the specified filter without deleting any objects. <br/><br/>Depending on the configured verbosity, you will either receive a count of affected objects, or a list of IDs.",
      "default": false
    }
  }
}