Weaviate · Schema

BatchReference

Weaviate BatchReference schema

Vector DatabaseAIMachine LearningSemantic SearchOpen SourceGraphQLKubernetes

Properties

Name Type Description
from string Long-form beacon-style URI to identify the source of the cross-reference, including the property name. Should be in the form of `weaviate://localhost/objects///`, where
to string Short-form URI to point to the cross-reference. Should be in the form of `weaviate://localhost/` for the example of a local cross-reference to an object.
tenant string Name of the reference tenant.
View JSON Schema on GitHub

JSON Schema

weaviate-batch-reference-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/weaviate/json-schema/weaviate-batch-reference-schema.json",
  "title": "BatchReference",
  "description": "Weaviate BatchReference schema",
  "type": "object",
  "properties": {
    "from": {
      "type": "string",
      "format": "uri",
      "description": "Long-form beacon-style URI to identify the source of the cross-reference, including the property name. Should be in the form of `weaviate://localhost/objects/<uuid>/<className>/<propertyName>`, where `<className>` and `<propertyName>` must represent the cross-reference property of the source class to be used.",
      "example": "weaviate://localhost/Zoo/a5d09582-4239-4702-81c9-92a6e0122bb4/hasAnimals"
    },
    "to": {
      "type": "string",
      "format": "uri",
      "description": "Short-form URI to point to the cross-reference. Should be in the form of `weaviate://localhost/<uuid>` for the example of a local cross-reference to an object.",
      "example": "weaviate://localhost/97525810-a9a5-4eb0-858a-71449aeb007f"
    },
    "tenant": {
      "type": "string",
      "description": "Name of the reference tenant."
    }
  }
}