batch

Create cross-references in bulk

Batch create cross-references between collection items in bulk.

post/batch/references

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/batch/references
  • Auth: one of:
    • none
    • OAuth 2 (implicit, authorization URL http://to-be-configured-in-the-application-config)

Query parameters

consistency_levelstring

Determines how many replicas must acknowledge a request before it is considered successful.

Request body

fromstring uri

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.

tostring uri

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.

tenantstring

Name of the reference tenant.

Example request

[
  {
    "from": "weaviate://localhost/Zoo/a5d09582-4239-4702-81c9-92a6e0122bb4/hasAnimals",
    "to": "weaviate://localhost/97525810-a9a5-4eb0-858a-71449aeb007f"
  }
]

Response

Request Successful. Warning: A successful request does not guarantee that every batched reference was successfully created. Inspect the response body to see which references succeeded and which failed.

fromstring uri

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.

tostring uri

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.

tenantstring

Name of the reference tenant.

Example response

[
  {
    "from": "weaviate://localhost/Zoo/a5d09582-4239-4702-81c9-92a6e0122bb4/hasAnimals",
    "to": "weaviate://localhost/97525810-a9a5-4eb0-858a-71449aeb007f"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.