Variable configureConst

configure: {
    dataType: {
        BLOB: "blob";
        BOOLEAN: "boolean";
        BOOLEAN_ARRAY: "boolean[]";
        DATE: "date";
        DATE_ARRAY: "date[]";
        GEO_COORDINATES: "geoCoordinates";
        INT: "int";
        INT_ARRAY: "int[]";
        NUMBER: "number";
        NUMBER_ARRAY: "number[]";
        OBJECT: "object";
        OBJECT_ARRAY: "object[]";
        PHONE_NUMBER: "phoneNumber";
        TEXT: "text";
        TEXT_ARRAY: "text[]";
        UUID: "uuid";
        UUID_ARRAY: "uuid[]";
    };
    generative: {
        azureOpenAI: ((config) => ModuleConfig<"generative-openai", GenerativeAzureOpenAIConfig>);
        cohere: ((config?) => ModuleConfig<"generative-cohere", undefined | GenerativeCohereConfig>);
        databricks: ((config) => ModuleConfig<"generative-databricks", GenerativeDatabricksConfig>);
        google: ((config?) => ModuleConfig<"generative-google", undefined | GenerativeGoogleConfig>);
        openAI: ((config?) => ModuleConfig<"generative-openai", undefined | GenerativeOpenAIConfig>);
        palm: ((config?) => ModuleConfig<"generative-palm", undefined | GenerativeGoogleConfig>);
        xai: ((config?) => ModuleConfig<"generative-xai", undefined | GenerativeXAIConfig>);
        anthropic(config?): ModuleConfig<"generative-anthropic", undefined | GenerativeAnthropicConfig>;
        anyscale(config?): ModuleConfig<"generative-anyscale", undefined | GenerativeAnyscaleConfig>;
        aws(config): ModuleConfig<"generative-aws", GenerativeAWSConfig>;
        friendliai(config?): ModuleConfig<"generative-friendliai", undefined | GenerativeFriendliAIConfig>;
        mistral(config?): ModuleConfig<"generative-mistral", undefined | GenerativeMistralConfig>;
        nvidia(config?): ModuleConfig<"generative-nvidia", undefined | GenerativeNvidiaConfig>;
        ollama(config?): ModuleConfig<"generative-ollama", undefined | GenerativeOllamaConfig>;
    };
    invertedIndex: ((options) => {
        bm25?: {
            b?: number;
            k1?: number;
        };
        cleanupIntervalSeconds?: number;
        indexNullState?: boolean;
        indexPropertyLength?: boolean;
        indexTimestamps?: boolean;
        stopwords?: {
            additions?: (undefined | string)[];
            preset?: string;
            removals?: (undefined | string)[];
        };
    });
    multiTenancy: ((options?) => {
        autoTenantActivation?: boolean;
        autoTenantCreation?: boolean;
        enabled?: boolean;
    });
    multiVectors: {
        multi2VecJinaAI: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2multivec-jinaai">);
        selfProvided: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "none">);
        text2VecJinaAI: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2multivec-jinaai">);
    };
    replication: ((options) => {
        asyncEnabled?: boolean;
        deletionStrategy?: ReplicationDeletionStrategy;
        factor?: number;
    });
    reranker: {
        cohere: ((config?) => ModuleConfig<"reranker-cohere", undefined | RerankerCohereConfig>);
        jinaai: ((config?) => ModuleConfig<"reranker-jinaai", undefined | RerankerJinaAIConfig>);
        nvidia: ((config?) => ModuleConfig<"reranker-nvidia", undefined | RerankerNvidiaConfig>);
        transformers: (() => ModuleConfig<"reranker-transformers", Record<string, never>>);
        voyageAI: ((config?) => ModuleConfig<"reranker-voyageai", undefined | RerankerVoyageAIConfig>);
    };
    sharding: ((options) => ShardingConfigCreate);
    tokenization: {
        FIELD: "field";
        GSE: "gse";
        KAGOME_KR: "kagome_kr";
        LOWERCASE: "lowercase";
        TRIGRAM: "trigram";
        WHITESPACE: "whitespace";
        WORD: "word";
    };
    vectorDistances: {
        COSINE: "cosine";
        DOT: "dot";
        HAMMING: "hamming";
        L2_SQUARED: "l2-squared";
    };
    vectorIndex: {
        dynamic: ((opts?) => ModuleConfig<"dynamic", undefined | VectorIndexConfigDynamicCreate>);
        flat: ((opts?) => ModuleConfig<"flat", undefined | VectorIndexConfigFlatCreate>);
        hnsw: ((opts?) => ModuleConfig<"hnsw", undefined | VectorIndexConfigHNSWCreate>);
        multiVector: {
            encoding: {
                muvera: ((options?) => {
                    dprojections?: number;
                    ksim?: number;
                    repetitions?: number;
                    type?: "muvera";
                });
            };
            multiVector: ((options?) => MultiVectorConfigCreate);
        };
        quantizer: {
            bq: ((options?) => QuantizerRecursivePartial<BQConfig>);
            none: (() => UncompressedConfig);
            pq: ((options?) => QuantizerRecursivePartial<PQConfig>);
            rq: ((options?) => QuantizerRecursivePartial<RQConfig>);
            sq: ((options?) => QuantizerRecursivePartial<SQConfig>);
        };
    };
    vectorizer: {
        img2VecNeural: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "img2vec-neural">);
        multi2VecBind: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-bind">);
        multi2VecClip: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-clip">);
        multi2VecCohere: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-cohere">);
        multi2VecGoogle: (<N, I>(opts) => VectorConfigCreate<never, N, I, "multi2vec-google">);
        multi2VecJinaAI: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-jinaai">);
        multi2VecPalm: (<N, I>(opts) => VectorConfigCreate<never, N, I, "multi2vec-palm">);
        multi2VecVoyageAI: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-voyageai">);
        none: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "none">);
        ref2VecCentroid: (<N, I>(opts) => VectorConfigCreate<never, N, I, "ref2vec-centroid">);
        selfProvided: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "none">);
        text2VecAWS: (<T, N, I>(opts) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-aws">);
        text2VecAzureOpenAI: (<T, N, I>(opts) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-azure-openai">);
        text2VecCohere: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-cohere">);
        text2VecContextionary: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-contextionary">);
        text2VecDatabricks: (<T, N, I>(opts) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-databricks">);
        text2VecGPT4All: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-gpt4all">);
        text2VecGoogle: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-google">);
        text2VecHuggingFace: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-huggingface">);
        text2VecJinaAI: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-jinaai">);
        text2VecMistral: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-mistral">);
        text2VecModel2Vec: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-model2vec">);
        text2VecNvidia: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-nvidia">);
        text2VecOllama: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-ollama">);
        text2VecOpenAI: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-openai">);
        text2VecPalm: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-palm">);
        text2VecTransformers: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-transformers">);
        text2VecVoyageAI: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-voyageai">);
        text2VecWeaviate: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-weaviate">);
    };
    vectors: {
        img2VecNeural: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "img2vec-neural">);
        multi2VecBind: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-bind">);
        multi2VecClip: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-clip">);
        multi2VecCohere: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-cohere">);
        multi2VecGoogle: (<N, I>(opts) => VectorConfigCreate<never, N, I, "multi2vec-google">);
        multi2VecJinaAI: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-jinaai">);
        multi2VecNvidia: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-nvidia">);
        multi2VecVoyageAI: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-voyageai">);
        none: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "none">);
        ref2VecCentroid: (<N, I>(opts) => VectorConfigCreate<never, N, I, "ref2vec-centroid">);
        selfProvided: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "none">);
        text2VecAWS: (<T, N, I>(opts) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-aws">);
        text2VecAzureOpenAI: (<T, N, I>(opts) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-azure-openai">);
        text2VecCohere: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-cohere">);
        text2VecContextionary: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-contextionary">);
        text2VecDatabricks: (<T, N, I>(opts) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-databricks">);
        text2VecGPT4All: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-gpt4all">);
        text2VecGoogle: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-google">);
        text2VecHuggingFace: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-huggingface">);
        text2VecJinaAI: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-jinaai">);
        text2VecMistral: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-mistral">);
        text2VecModel2Vec: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-model2vec">);
        text2VecNvidia: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-nvidia">);
        text2VecOllama: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-ollama">);
        text2VecOpenAI: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-openai">);
        text2VecTransformers: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-transformers">);
        text2VecVoyageAI: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-voyageai">);
        text2VecWeaviate: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-weaviate">);
    };
} = ...

Type declaration

Settings

Member Visibility

Theme