batch

Create objects in batch

Registers multiple data objects in a single request for efficiency. Metadata and schema values for each object are validated.

Note (idempotence): This operation is idempotent based on the object UUIDs provided. If an object with a given UUID already exists, it will be overwritten (similar to a PUT operation for that specific object within the batch).

post/batch/objects

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/batch/objects
  • 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

fieldsstring[]

Controls which fields are returned in the response for each object. Default is ALL.

Response

Request processed successfully. Individual object statuses are provided in the response body.

classstring

Name of the collection (class) the object belongs to.

vectorWeightsVectorWeights

Allow custom overrides of vector weights as math expressions. E.g. pancake: 7 will set the weight for the word pancake to 7 in the vectorization, whereas w * 3 would triple the originally calculated word. This is an open object, with OpenAPI Specification 3.0 this will be more detailed. See Weaviate docs for more info. In the future this will become a key/value (string/string) object.

propertiesPropertySchema

Names and values of an individual property. A returned response may also contain additional metadata, such as from classification or feature projection.

idstring uuid

The UUID of the object.

creationTimeUnixinteger

(Response only) Timestamp of creation of this object in milliseconds since epoch UTC.

lastUpdateTimeUnixinteger

(Response only) Timestamp of the last object update in milliseconds since epoch UTC.

vectornumber[]

A vector representation of the object in the Contextionary. If provided at object creation, this wil take precedence over any vectorizer setting.

vectorsVectors

A map of named vectors for multi-vector representations.

tenantstring

The name of the tenant the object belongs to.

additionalAdditionalProperties

(Response only) Additional meta information about a single object.

Changes

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