weaviate-client
    Preparing search index...

    Type Alias CollectionConfigCreate<TProperties, N, TVectors>

    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 CollectionConfigCreate<
        TProperties = undefined,
        N = string,
        TVectors = undefined,
    > = {
        description?: string;
        generative?: ModuleConfig<GenerativeSearch, GenerativeConfig>;
        invertedIndex?: InvertedIndexConfigCreate;
        multiTenancy?: MultiTenancyConfigCreate;
        name: N;
        objectTTL?: ObjectTTLConfigCreate;
        properties?: PropertyConfigCreate<TProperties>[];
        references?: ReferenceConfigCreate<TProperties>[];
        replication?: ReplicationConfigCreate;
        reranker?: ModuleConfig<Reranker, RerankerConfig>;
        sharding?: ShardingConfigCreate;
        vectorizers?: VectorizersConfigCreate<TProperties, TVectors>;
    }

    Type Parameters

    • TProperties = undefined
    • N = string
    • TVectors = undefined
    Index

    Properties

    description? generative? invertedIndex? multiTenancy? name objectTTL? properties? references? replication? reranker? sharding? vectorizers?

    Properties

    description?: string

    The description of the collection.

    generative?: ModuleConfig<GenerativeSearch, GenerativeConfig>

    The configuration for Weaviate's generative capabilities.

    invertedIndex?: InvertedIndexConfigCreate

    The configuration for Weaviate's inverted index.

    multiTenancy?: MultiTenancyConfigCreate

    The configuration for Weaviate's multi-tenancy capabilities.

    name: N

    The name of the collection.

    objectTTL?: ObjectTTLConfigCreate

    The configuration for object TTL.

    properties?: PropertyConfigCreate<TProperties>[]

    The properties of the objects in the collection.

    references?: ReferenceConfigCreate<TProperties>[]

    The references of the objects in the collection.

    replication?: ReplicationConfigCreate

    The configuration for Weaviate's replication strategy. Is mutually exclusive with sharding.

    reranker?: ModuleConfig<Reranker, RerankerConfig>

    The configuration for Weaviate's reranking capabilities.

    sharding?: ShardingConfigCreate

    The configuration for Weaviate's sharding strategy. Is mutually exclusive with replication.

    vectorizers?: VectorizersConfigCreate<TProperties, TVectors>

    The configuration for Weaviate's vectorizer(s) capabilities.

    Settings

    Member Visibility

    On This Page

    Properties