objects

Get an object

Get a data object based on its collection name (className) and UUID (id).

get/objects/{className}/{id}

Request

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

Path parameters

classNamestring required

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

idstring uuid required

Unique UUID of the object to be retrieved.

Query parameters

includestring

Include additional information, such as classification information. Allowed values include: classification, vector and interpretation.

consistency_levelstring

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

node_namestring

The target node which should fulfill the request.

tenantstring

Specifies the tenant in a request targeting a multi-tenant collection (class).

Response

Successful response containing the object.

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.