Weaviate · Schema

SingleRef

Either set beacon (direct reference) or set collection (class) and schema (concept reference)

Vector DatabaseAIMachine LearningSemantic SearchOpen SourceGraphQLKubernetes

Properties

Name Type Description
class string If using a concept reference (rather than a direct reference), specify the desired collection (class) name here.
schema object
beacon string If using a direct reference, specify the URI to point to the cross-reference here. Should be in the form of weaviate://localhost/ for the example of a local cross-reference to an object
href string If using a direct reference, this read-only fields provides a link to the referenced resource. If 'origin' is globally configured, an absolute URI is shown - a relative URI otherwise.
classification object
View JSON Schema on GitHub

JSON Schema

weaviate-single-ref-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/weaviate/json-schema/weaviate-single-ref-schema.json",
  "title": "SingleRef",
  "description": "Either set beacon (direct reference) or set collection (class) and schema (concept reference)",
  "type": "object",
  "properties": {
    "class": {
      "type": "string",
      "format": "uri",
      "description": "If using a concept reference (rather than a direct reference), specify the desired collection (class) name here."
    },
    "schema": {
      "$ref": "#/components/schemas/PropertySchema"
    },
    "beacon": {
      "type": "string",
      "format": "uri",
      "description": "If using a direct reference, specify the URI to point to the cross-reference here. Should be in the form of weaviate://localhost/<uuid> for the example of a local cross-reference to an object"
    },
    "href": {
      "type": "string",
      "format": "uri",
      "description": "If using a direct reference, this read-only fields provides a link to the referenced resource. If 'origin' is globally configured, an absolute URI is shown - a relative URI otherwise."
    },
    "classification": {
      "$ref": "#/components/schemas/ReferenceMetaClassification"
    }
  }
}