objects

Validate an object

Checks if a data object's structure conforms to the specified collection schema and metadata rules without actually storing the object.

A successful validation returns a 200 OK status code with no body. If validation fails, an error response with details is returned.

post/objects/validate

Request

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

Request 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.

Response

Object is valid according to the schema.

Changes

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