Weaviate · Schema

Classification

Manage classifications, trigger them and view status of past classifications.

Vector DatabaseAIMachine LearningSemantic SearchOpen SourceGraphQLKubernetes

Properties

Name	Type	Description
id	string	ID to uniquely identify this classification run.
class	string	The name of the collection (class) which is used in this classification.
classifyProperties	array	Which ref-property to set as part of the classification.
basedOnProperties	array	Base the text-based classification on these fields (of type text).
status	string	Status of this classification.
meta	object
type	string	Which algorithm to use for classifications.
settings	object	Classification-type specific settings.
error	string	Error message if status == failed.
filters	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/weaviate/json-schema/weaviate-classification-schema.json",
  "title": "Classification",
  "description": "Manage classifications, trigger them and view status of past classifications.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "ID to uniquely identify this classification run.",
      "example": "ee722219-b8ec-4db1-8f8d-5150bb1a9e0c"
    },
    "class": {
      "type": "string",
      "description": "The name of the collection (class) which is used in this classification.",
      "example": "City"
    },
    "classifyProperties": {
      "type": "array",
      "description": "Which ref-property to set as part of the classification.",
      "example": [
        "inCountry"
      ],
      "items": {
        "type": "string"
      }
    },
    "basedOnProperties": {
      "type": "array",
      "description": "Base the text-based classification on these fields (of type text).",
      "example": [
        "description"
      ],
      "items": {
        "type": "string"
      }
    },
    "status": {
      "type": "string",
      "description": "Status of this classification.",
      "enum": [
        "running",
        "completed",
        "failed"
      ],
      "example": "running"
    },
    "meta": {
      "$ref": "#/components/schemas/ClassificationMeta"
    },
    "type": {
      "type": "string",
      "description": "Which algorithm to use for classifications."
    },
    "settings": {
      "type": "object",
      "description": "Classification-type specific settings."
    },
    "error": {
      "type": "string",
      "description": "Error message if status == failed.",
      "default": "",
      "example": "classify xzy: something went wrong"
    },
    "filters": {
      "type": "object",
      "properties": {
        "sourceWhere": {
          "$ref": "#/components/schemas/WhereFilter"
        },
        "trainingSetWhere": {
          "$ref": "#/components/schemas/WhereFilter"
        },
        "targetWhere": {
          "$ref": "#/components/schemas/WhereFilter"
        }
      }
    }
  }
}