Interface CollectionDefinition<Schema>

Represents the options for the createCollection command.

Field

vector - Options related to vector search.

Field

indexing - Options related to indexing.

Field

defaultId - Options related to the default ID.

interface CollectionDefinition<Schema> {
    defaultId?: CollectionDefaultIdOptions;
    indexing?: CollectionIndexingOptions<Schema>;
    lexical?: CollectionLexicalOptions;
    rerank?: CollectionRerankOptions;
    vector?: CollectionVectorOptions;
}

Type Parameters

Schema extends SomeDoc

Hierarchy (view full)

CollectionDefinition
- CreateCollectionOptions

Index

Properties

defaultId? indexing? lexical? rerank? vector?

Properties

`Optional` defaultId

defaultId?: CollectionDefaultIdOptions

Options related to the default ID.

`Optional` indexing

indexing?: CollectionIndexingOptions<Schema>

Options related to indexing.

`Optional` lexical

lexical?: CollectionLexicalOptions

Options related to lexical (bm25) search.

`Optional` rerank

rerank?: CollectionRerankOptions

Options related to reranking.

`Optional` vector

vector?: CollectionVectorOptions

Options related to vector search.