Type alias CollectionConfigCreate<TProperties, N>

CollectionConfigCreate<TProperties, N>: {
    description?: string;
    generative?: ModuleConfig<GenerativeSearch, GenerativeConfig>;
    invertedIndex?: InvertedIndexConfigCreate;
    multiTenancy?: MultiTenancyConfigCreate;
    name: N;
    properties?: PropertyConfigCreate<TProperties>[];
    references?: ReferenceConfigCreate<TProperties>[];
    replication?: ReplicationConfigCreate;
    reranker?: ModuleConfig<Reranker, RerankerConfig>;
    sharding?: ShardingConfigCreate;
    vectorizers?: VectorizersConfigCreate<TProperties>;
}

All the options available when creating a new collection.

Inspect the docs for more information on the different configuration options and how they affect the behavior of your collection.

Type Parameters

TProperties = undefined
N = string

Type declaration

Optional description?: string
The description of the collection.
Optional generative?: ModuleConfig<GenerativeSearch, GenerativeConfig>
The configuration for Weaviate's generative capabilities.
Optional invertedIndex?: InvertedIndexConfigCreate
The configuration for Weaviate's inverted index.
Optional multiTenancy?: MultiTenancyConfigCreate
The configuration for Weaviate's multi-tenancy capabilities.
name: N
The name of the collection.
Optional properties?: PropertyConfigCreate<TProperties>[]
The properties of the objects in the collection.
Optional references?: ReferenceConfigCreate<TProperties>[]
The references of the objects in the collection.
Optional replication?: ReplicationConfigCreate
The configuration for Weaviate's replication strategy. Is mutually exclusive with sharding.
Optional reranker?: ModuleConfig<Reranker, RerankerConfig>
The configuration for Weaviate's reranking capabilities.
Optional sharding?: ShardingConfigCreate
The configuration for Weaviate's sharding strategy. Is mutually exclusive with replication.
Optional vectorizers?: VectorizersConfigCreate<TProperties>
The configuration for Weaviate's vectorizer(s) capabilities.

Type alias CollectionConfigCreate<TProperties, N>

Type Parameters

Type declaration

`Optional` description?: string

`Optional` generative?: ModuleConfig<GenerativeSearch, GenerativeConfig>

`Optional` invertedIndex?: InvertedIndexConfigCreate

`Optional` multiTenancy?: MultiTenancyConfigCreate

name: N

`Optional` properties?: PropertyConfigCreate<TProperties>[]

`Optional` references?: ReferenceConfigCreate<TProperties>[]

`Optional` replication?: ReplicationConfigCreate

`Optional` reranker?: ModuleConfig<Reranker, RerankerConfig>

`Optional` sharding?: ShardingConfigCreate

`Optional` vectorizers?: VectorizersConfigCreate<TProperties>

Settings

Member Visibility

Theme

Type alias CollectionConfigCreate<TProperties, N>

Type Parameters

Type declaration

Optional description?: string

Optional generative?: ModuleConfig<GenerativeSearch, GenerativeConfig>

Optional invertedIndex?: InvertedIndexConfigCreate

Optional multiTenancy?: MultiTenancyConfigCreate

name: N

Optional properties?: PropertyConfigCreate<TProperties>[]

Optional references?: ReferenceConfigCreate<TProperties>[]

Optional replication?: ReplicationConfigCreate

Optional reranker?: ModuleConfig<Reranker, RerankerConfig>

Optional sharding?: ShardingConfigCreate

Optional vectorizers?: VectorizersConfigCreate<TProperties>

Settings

Member Visibility

Theme

`Optional` description?: string

`Optional` generative?: ModuleConfig<GenerativeSearch, GenerativeConfig>

`Optional` invertedIndex?: InvertedIndexConfigCreate

`Optional` multiTenancy?: MultiTenancyConfigCreate

`Optional` properties?: PropertyConfigCreate<TProperties>[]

`Optional` references?: ReferenceConfigCreate<TProperties>[]

`Optional` replication?: ReplicationConfigCreate

`Optional` reranker?: ModuleConfig<Reranker, RerankerConfig>

`Optional` sharding?: ShardingConfigCreate

`Optional` vectorizers?: VectorizersConfigCreate<TProperties>