schema

Update collection definition

Updates the configuration settings of an existing collection (className) based on the provided definition. Note: This operation modifies mutable settings specified in the request body. It does not add properties (use POST /schema/{className}/properties for that) or change the collection name.

put/schema/{className}

Request

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

Path parameters

classNamestring required

The name of the collection (class) to update.

Request body

classstring

Name of the collection (formerly 'class') (required). Multiple words should be concatenated in CamelCase, e.g. ArticleAuthor.

vectorConfigobject

Configure named vectors. Either use this field or vectorizer, vectorIndexType, and vectorIndexConfig fields. Available from v1.24.0.

vectorIndexTypestring

Name of the vector index type to use for the collection (e.g. hnsw or flat).

vectorIndexConfigobject

Vector-index config, that is specific to the type of index selected in vectorIndexType

shardingConfigobject

Manage how the index should be sharded and distributed in the cluster

vectorizerstring

Specify how the vectors for this collection should be determined. The options are either none - this means you have to import a vector with each object yourself - or the name of a module that provides vectorization capabilities, such as text2vec-weaviate. If left empty, it defaults to none.

moduleConfigobject

Configuration specific to modules in a collection context.

descriptionstring

Description of the collection for metadata purposes.

Response

Collection settings updated successfully.

classstring

Name of the collection (formerly 'class') (required). Multiple words should be concatenated in CamelCase, e.g. ArticleAuthor.

vectorConfigobject

Configure named vectors. Either use this field or vectorizer, vectorIndexType, and vectorIndexConfig fields. Available from v1.24.0.

vectorIndexTypestring

Name of the vector index type to use for the collection (e.g. hnsw or flat).

vectorIndexConfigobject

Vector-index config, that is specific to the type of index selected in vectorIndexType

shardingConfigobject

Manage how the index should be sharded and distributed in the cluster

vectorizerstring

Specify how the vectors for this collection should be determined. The options are either none - this means you have to import a vector with each object yourself - or the name of a module that provides vectorization capabilities, such as text2vec-weaviate. If left empty, it defaults to none.

moduleConfigobject

Configuration specific to modules in a collection context.

descriptionstring

Description of the collection for metadata purposes.

Changes

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