Variable defaultConst

default: {
    ApiKey: typeof ApiKey;
    AuthAccessTokenCredentials: typeof AuthAccessTokenCredentials;
    AuthClientCredentials: typeof AuthClientCredentials;
    AuthUserPasswordCredentials: typeof AuthUserPasswordCredentials;
    client: ((params) => Promise<WeaviateClient>);
    configGuards: {
        quantizer: typeof Quantizer;
        vectorIndex: typeof VectorIndex;
    };
    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>);
            openAI: ((config?) => ModuleConfig<"generative-openai", undefined | GenerativeOpenAIConfig>);
            palm: ((config?) => ModuleConfig<"generative-palm", undefined | GenerativePaLMConfig>);
            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>;
            octoai(config?): ModuleConfig<"generative-octoai", undefined | GenerativeOctoAIConfig>;
            ollama(config?): ModuleConfig<"generative-ollama", undefined | GenerativeOllamaConfig>;
        };
        invertedIndex: ((options) => RecursivePartial<InvertedIndexConfig>);
        multiTenancy: ((options?) => RecursivePartial<MultiTenancyConfig>);
        replication: ((options) => RecursivePartial<ReplicationConfig>);
        reranker: {
            cohere: ((config?) => ModuleConfig<"reranker-cohere", undefined | RerankerCohereConfig>);
            jinaai: ((config?) => ModuleConfig<"reranker-jinaai", undefined | RerankerJinaAIConfig>);
            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 | RecursivePartial<VectorIndexConfigDynamic>>);
            flat: ((opts?) => ModuleConfig<"flat", undefined | RecursivePartial<VectorIndexConfigFlat>>);
            hnsw: ((opts?) => ModuleConfig<"hnsw", undefined | RecursivePartial<VectorIndexConfigHNSW>>);
            quantizer: {
                bq: ((options?) => QuantizerRecursivePartial<BQConfig>);
                pq: ((options?) => QuantizerRecursivePartial<PQConfig>);
                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">);
            multi2VecPalm: (<N, I>(opts) => VectorConfigCreate<never, N, I, "multi2vec-palm">);
            none: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "none">);
            ref2VecCentroid: (<N, I>(opts) => VectorConfigCreate<never, N, I, "ref2vec-centroid">);
            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">);
            text2VecHuggingFace: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-huggingface">);
            text2VecJina: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-jina">);
            text2VecMistral: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-mistral">);
            text2VecOctoAI: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-octoai">);
            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">);
        };
    };
    connectToCustom: ((options) => Promise<WeaviateClient>);
    connectToLocal: ((options?) => Promise<WeaviateClient>);
    connectToWCD: ((clusterURL, options?) => Promise<WeaviateClient>);
    connectToWCS: ((clusterURL, options?) => Promise<WeaviateClient>);
    connectToWeaviateCloud: ((clusterURL, options?) => Promise<WeaviateClient>);
    reconfigure: {
        invertedIndex: ((options) => InvertedIndexConfigUpdate);
        replication: ((options) => RecursivePartial<ReplicationConfig>);
        vectorIndex: {
            flat: ((options) => ModuleConfig<"flat", VectorIndexConfigFlatUpdate>);
            hnsw: ((options) => ModuleConfig<"hnsw", VectorIndexConfigHNSWUpdate>);
            quantizer: {
                bq: ((options?) => BQConfigUpdate);
                pq: ((options?) => PQConfigUpdate);
                sq: ((options?) => SQConfigUpdate);
            };
        };
        vectorizer: {
            update: (<N, I>(options) => VectorConfigUpdate<N, I>);
        };
    };
} = ...

Type declaration

Settings

Member Visibility

Theme