Variable configureConst

Type Declaration

• 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: GenerativeAzureOpenAIConfigCreate,
      ) => ModuleConfig<"generative-openai", GenerativeAzureOpenAIConfig>;
      cohere: (
          config?: GenerativeCohereConfigCreate,
      ) => ModuleConfig<"generative-cohere", GenerativeCohereConfig | undefined>;
      contextualai: (
          config?: GenerativeContextualAIConfigCreate,
      ) => ModuleConfig<
          "generative-contextualai",
          GenerativeContextualAIConfig
          | undefined,
      >;
      databricks: (
          config: GenerativeDatabricksConfig,
      ) => ModuleConfig<"generative-databricks", GenerativeDatabricksConfig>;
      google: (
          config?: GenerativeGoogleConfig,
      ) => ModuleConfig<"generative-google", GenerativeGoogleConfig | undefined>;
      openAI: (
          config?: GenerativeOpenAIConfigCreate,
      ) => ModuleConfig<"generative-openai", GenerativeOpenAIConfig | undefined>;
      palm: (
          config?: GenerativeGoogleConfig,
      ) => ModuleConfig<"generative-palm", GenerativeGoogleConfig | undefined>;
      xai: (
          config?: GenerativeXAIConfig,
      ) => ModuleConfig<"generative-xai", GenerativeXAIConfig | undefined>;
      anthropic(
          config?: GenerativeAnthropicConfig,
      ): ModuleConfig<
          "generative-anthropic",
          GenerativeAnthropicConfig
          | undefined,
      >;
      anyscale(
          config?: GenerativeAnyscaleConfig,
      ): ModuleConfig<
          "generative-anyscale",
          GenerativeAnyscaleConfig
          | undefined,
      >;
      aws(
          config: GenerativeAWSConfig,
      ): ModuleConfig<"generative-aws", GenerativeAWSConfig>;
      friendliai(
          config?: GenerativeFriendliAIConfig,
      ): ModuleConfig<
          "generative-friendliai",
          GenerativeFriendliAIConfig
          | undefined,
      >;
      mistral(
          config?: GenerativeMistralConfig,
      ): ModuleConfig<"generative-mistral", GenerativeMistralConfig | undefined>;
      nvidia(
          config?: GenerativeNvidiaConfig,
      ): ModuleConfig<"generative-nvidia", GenerativeNvidiaConfig | undefined>;
      ollama(
          config?: GenerativeOllamaConfig,
      ): ModuleConfig<"generative-ollama", GenerativeOllamaConfig | undefined>;
  }

  • azureOpenAI: (
        config: GenerativeAzureOpenAIConfigCreate,
    ) => ModuleConfig<"generative-openai", GenerativeAzureOpenAIConfig>

    Create a ModuleConfig<'generative-openai', GenerativeAzureOpenAIConfig> object for use when performing AI generation using the generative-openai module.

    See the documentation for detailed usage.

  • cohere: (
        config?: GenerativeCohereConfigCreate,
    ) => ModuleConfig<"generative-cohere", GenerativeCohereConfig | undefined>

    Create a ModuleConfig<'generative-cohere', GenerativeCohereConfig> object for use when performing AI generation using the generative-cohere module.

    See the documentation for detailed usage.

  • contextualai: (
        config?: GenerativeContextualAIConfigCreate,
    ) => ModuleConfig<
        "generative-contextualai",
        GenerativeContextualAIConfig
        | undefined,
    >

    Create a ModuleConfig<'generative-contextualai', GenerativeContextualAIConfig | undefined> object for use when performing AI generation using the generative-contextualai module.

    See the documentation for detailed usage.

  • databricks: (
        config: GenerativeDatabricksConfig,
    ) => ModuleConfig<"generative-databricks", GenerativeDatabricksConfig>

    Create a ModuleConfig<'generative-databricks', GenerativeDatabricksConfig> object for use when performing AI generation using the generative-databricks module.

    See the documentation for detailed usage.

  • google: (
        config?: GenerativeGoogleConfig,
    ) => ModuleConfig<"generative-google", GenerativeGoogleConfig | undefined>

    Create a ModuleConfig<'generative-google', GenerativeGoogleConfig> object for use when performing AI generation using the generative-google module.

    See the documentation for detailed usage.

  • openAI: (
        config?: GenerativeOpenAIConfigCreate,
    ) => ModuleConfig<"generative-openai", GenerativeOpenAIConfig | undefined>

    Create a ModuleConfig<'generative-openai', GenerativeOpenAIConfig | undefined> object for use when performing AI generation using the generative-openai module.

    See the documentation for detailed usage.

  • palm: (
        config?: GenerativeGoogleConfig,
    ) => ModuleConfig<"generative-palm", GenerativeGoogleConfig | undefined>

    Create a ModuleConfig<'generative-palm', GenerativePaLMConfig> object for use when performing AI generation using the generative-palm module.

    See the documentation for detailed usage.

    Deprecated

    Use google instead.

  • xai: (
        config?: GenerativeXAIConfig,
    ) => ModuleConfig<"generative-xai", GenerativeXAIConfig | undefined>

    Create a ModuleConfig<'generative-xai', GenerativeXAIConfig | undefined> object for use when performing AI generation using the generative-xai module.

    See the documentation for detailed usage.

  • anthropic: function

    • anthropic(
          config?: GenerativeAnthropicConfig,
      ): ModuleConfig<
          "generative-anthropic",
          GenerativeAnthropicConfig
          | undefined,
      >

      Create a ModuleConfig<'generative-anthropic', GenerativeAnthropicConfig | undefined> object for use when performing AI generation using the generative-anthropic module.

      See the documentation for detailed usage.

      Parameters

      • Optionalconfig: GenerativeAnthropicConfig

        The configuration for the generative-anthropic module.

      Returns ModuleConfig<"generative-anthropic", GenerativeAnthropicConfig | undefined>

      The configuration object.

  • anyscale: function

    • anyscale(
          config?: GenerativeAnyscaleConfig,
      ): ModuleConfig<"generative-anyscale", GenerativeAnyscaleConfig | undefined>

      Create a ModuleConfig<'generative-anyscale', GenerativeAnyscaleConfig | undefined> object for use when performing AI generation using the generative-anyscale module.

      See the documentation for detailed usage.

      Parameters

      • Optionalconfig: GenerativeAnyscaleConfig

        The configuration for the generative-aws module.

      Returns ModuleConfig<"generative-anyscale", GenerativeAnyscaleConfig | undefined>

      The configuration object.

  • aws: function

    • aws(
          config: GenerativeAWSConfig,
      ): ModuleConfig<"generative-aws", GenerativeAWSConfig>

      Create a ModuleConfig<'generative-aws', GenerativeAWSConfig> object for use when performing AI generation using the generative-aws module.

      See the documentation for detailed usage.

      Parameters

      • config: GenerativeAWSConfig

        The configuration for the generative-aws module.

      Returns ModuleConfig<"generative-aws", GenerativeAWSConfig>

      The configuration object.

  • friendliai: function

    • friendliai(
          config?: GenerativeFriendliAIConfig,
      ): ModuleConfig<
          "generative-friendliai",
          GenerativeFriendliAIConfig
          | undefined,
      >

      Create a ModuleConfig<'generative-friendliai', GenerativeFriendliAIConfig | undefined> object for use when performing AI generation using the generative-friendliai module.

      See the documentation for detailed usage.

      Parameters

      • Optionalconfig: GenerativeFriendliAIConfig

      Returns ModuleConfig<"generative-friendliai", GenerativeFriendliAIConfig | undefined>

  • mistral: function

    • mistral(
          config?: GenerativeMistralConfig,
      ): ModuleConfig<"generative-mistral", GenerativeMistralConfig | undefined>

      Create a ModuleConfig<'generative-mistral', GenerativeMistralConfig | undefined> object for use when performing AI generation using the generative-mistral module.

      See the documentation for detailed usage.

      Parameters

      • Optionalconfig: GenerativeMistralConfig

        The configuration for the generative-mistral module.

      Returns ModuleConfig<"generative-mistral", GenerativeMistralConfig | undefined>

      The configuration object.

  • nvidia: function

    • nvidia(
          config?: GenerativeNvidiaConfig,
      ): ModuleConfig<"generative-nvidia", GenerativeNvidiaConfig | undefined>

      Create a ModuleConfig<'generative-nvidia', GenerativeNvidiaConfig | undefined> object for use when performing AI generation using the generative-mistral module.

      See the documentation for detailed usage.

      Parameters

      • Optionalconfig: GenerativeNvidiaConfig

        The configuration for the generative-nvidia module.

      Returns ModuleConfig<"generative-nvidia", GenerativeNvidiaConfig | undefined>

      The configuration object.

  • ollama: function

    • ollama(
          config?: GenerativeOllamaConfig,
      ): ModuleConfig<"generative-ollama", GenerativeOllamaConfig | undefined>

      Create a ModuleConfig<'generative-ollama', GenerativeOllamaConfig | undefined> object for use when performing AI generation using the generative-ollama module.

      See the documentation for detailed usage.

      Parameters

      • Optionalconfig: GenerativeOllamaConfig

        The configuration for the generative-openai module.

      Returns ModuleConfig<"generative-ollama", GenerativeOllamaConfig | undefined>

      The configuration object.

• invertedIndex: (
      options: {
          bm25b?: number;
          bm25k1?: number;
          cleanupIntervalSeconds?: number;
          indexNullState?: boolean;
          indexPropertyLength?: boolean;
          indexTimestamps?: boolean;
          stopwordsAdditions?: string[];
          stopwordsPreset?: "none" | "en";
          stopwordsRemovals?: string[];
      },
  ) => {
      bm25?: { b?: number; k1?: number };
      cleanupIntervalSeconds?: number;
      indexNullState?: boolean;
      indexPropertyLength?: boolean;
      indexTimestamps?: boolean;
      stopwords?: {
          additions?: (string | undefined)[];
          preset?: string;
          removals?: (string | undefined)[];
      };
  }

  Create an InvertedIndexConfigCreate object to be used when defining the configuration of the keyword searching algorithm of your collection.

  See the docs for details!

• multiTenancy: (
      options?: {
          autoTenantActivation?: boolean;
          autoTenantCreation?: boolean;
          enabled?: boolean;
      },
  ) => {
      autoTenantActivation?: boolean;
      autoTenantCreation?: boolean;
      enabled?: boolean;
  }

  Create a MultiTenancyConfigCreate object to be used when defining the multi-tenancy configuration of your collection.

• multiVectors: {
      multi2VecJinaAI: <
          N extends string
          | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Multi2MultivecJinaAIConfig & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          } & {
              encoding?: {
                  dprojections?: number;
                  ksim?: number;
                  repetitions?: number;
                  type?: "muvera";
              };
          },
      ) => VectorConfigCreate<never, N, I, "multi2multivec-jinaai">;
      multi2VecWeaviate: <
          N extends string
          | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<Multi2MultivecWeaviateConfig, Multi2VecOmissions> & {
              imageField: string;
          } & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          } & {
              encoding?: {
                  dprojections?: number;
                  ksim?: number;
                  repetitions?: number;
                  type?: "muvera";
              };
          },
      ) => VectorConfigCreate<never, N, I, "multi2multivec-weaviate">;
      selfProvided: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: ConfigureNonTextMultiVectorizerOptions<N, I, "none">,
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "none">;
      text2VecJinaAI: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: ConfigureTextMultiVectorizerOptions<
              T,
              N,
              I,
              "text2multivec-jinaai",
          >,
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2multivec-jinaai">;
  }

  • multi2VecJinaAI: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Multi2MultivecJinaAIConfig & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        } & {
            encoding?: {
                dprojections?: number;
                ksim?: number;
                repetitions?: number;
                type?: "muvera";
            };
        },
    ) => VectorConfigCreate<never, N, I, "multi2multivec-jinaai">

    Create a VectorConfigCreate object with the vectorizer set to 'multi2multivec-jinaai'.

    See the documentation for detailed usage.

  • multi2VecWeaviate: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<Multi2MultivecWeaviateConfig, Multi2VecOmissions> & {
            imageField: string;
        } & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        } & {
            encoding?: {
                dprojections?: number;
                ksim?: number;
                repetitions?: number;
                type?: "muvera";
            };
        },
    ) => VectorConfigCreate<never, N, I, "multi2multivec-weaviate">

    Create a VectorConfigCreate object with the vectorizer set to 'multi2multivec-weaviate'.

    See the documentation for detailed usage.

  • selfProvided: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: ConfigureNonTextMultiVectorizerOptions<N, I, "none">,
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "none">

    Create a multi-vector VectorConfigCreate object with the vectorizer set to 'none'.

  • text2VecJinaAI: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: ConfigureTextMultiVectorizerOptions<
            T,
            N,
            I,
            "text2multivec-jinaai",
        >,
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2multivec-jinaai">

    Create a multi-vector VectorConfigCreate object with the vectorizer set to 'text2multivec-jinaai'.

    See the documentation for detailed usage.

• objectTTL: {
      deleteByCreationTime: (
          options: { defaultTTLSeconds: number; filterExpiredObjects?: boolean },
      ) => {
          defaultTTLSeconds?: number;
          deleteOn?: string;
          enabled?: boolean;
          filterExpiredObjects?: boolean;
      };
      deleteByDateProperty: (
          options: {
              defaultTTLSeconds?: number;
              filterExpiredObjects?: boolean;
              property: string;
          },
      ) => {
          defaultTTLSeconds?: number;
          deleteOn?: string;
          enabled?: boolean;
          filterExpiredObjects?: boolean;
      };
      deleteByUpdateTime: (
          options: { defaultTTLSeconds: number; filterExpiredObjects?: boolean },
      ) => {
          defaultTTLSeconds?: number;
          deleteOn?: string;
          enabled?: boolean;
          filterExpiredObjects?: boolean;
      };
  }

• replication: (
      options: {
          asyncConfig?: {
              aliveNodesCheckingFrequency?: number;
              diffBatchSize?: number;
              diffPerNodeTimeout?: number;
              frequency?: number;
              frequencyWhilePropagating?: number;
              hashtreeHeight?: number;
              loggingFrequency?: number;
              maxWorkers?: number;
              prePropagationTimeout?: number;
              propagationBatchSize?: number;
              propagationConcurrency?: number;
              propagationDelay?: number;
              propagationLimit?: number;
              propagationTimeout?: number;
          };
          asyncEnabled?: boolean;
          deletionStrategy?: ReplicationDeletionStrategy;
          factor?: number;
      },
  ) => {
      asyncConfig?: {
          aliveNodesCheckingFrequency?: number;
          diffBatchSize?: number;
          diffPerNodeTimeout?: number;
          frequency?: number;
          frequencyWhilePropagating?: number;
          hashtreeHeight?: number;
          loggingFrequency?: number;
          maxWorkers?: number;
          prePropagationTimeout?: number;
          propagationBatchSize?: number;
          propagationConcurrency?: number;
          propagationDelay?: number;
          propagationLimit?: number;
          propagationTimeout?: number;
      };
      asyncEnabled?: boolean;
      deletionStrategy?: ReplicationDeletionStrategy;
      factor?: number;
  }

  Create a ReplicationConfigCreate object to be used when defining the replication configuration of your collection.

  NOTE: You can only use one of Sharding or Replication, not both.

  See the docs for more details.

• reranker: {
      cohere: (
          config?: RerankerCohereConfig,
      ) => ModuleConfig<"reranker-cohere", RerankerCohereConfig | undefined>;
      contextualai: (
          config?: RerankerContextualAIConfig,
      ) => ModuleConfig<
          "reranker-contextualai",
          RerankerContextualAIConfig
          | undefined,
      >;
      jinaai: (
          config?: RerankerJinaAIConfig,
      ) => ModuleConfig<"reranker-jinaai", RerankerJinaAIConfig | undefined>;
      nvidia: (
          config?: RerankerNvidiaConfig,
      ) => ModuleConfig<"reranker-nvidia", RerankerNvidiaConfig | undefined>;
      transformers: () => ModuleConfig<
          "reranker-transformers",
          Record<string, never>,
      >;
      voyageAI: (
          config?: RerankerVoyageAIConfig,
      ) => ModuleConfig<"reranker-voyageai", RerankerVoyageAIConfig | undefined>;
  }

  • cohere: (
        config?: RerankerCohereConfig,
    ) => ModuleConfig<"reranker-cohere", RerankerCohereConfig | undefined>

    Create a ModuleConfig<'reranker-cohere', RerankerCohereConfig> object for use when reranking using the reranker-cohere module.

    See the documentation for detailed usage.

  • contextualai: (
        config?: RerankerContextualAIConfig,
    ) => ModuleConfig<
        "reranker-contextualai",
        RerankerContextualAIConfig
        | undefined,
    >

    Create a ModuleConfig<'reranker-contextualai', RerankerContextualAIConfig> object for use when reranking using the reranker-contextualai module.

    See the documentation for detailed usage.

  • jinaai: (
        config?: RerankerJinaAIConfig,
    ) => ModuleConfig<"reranker-jinaai", RerankerJinaAIConfig | undefined>

    Create a ModuleConfig<'reranker-jinaai', RerankerJinaAIConfig> object for use when reranking using the reranker-jinaai module.

    See the documentation for detailed usage.

  • nvidia: (
        config?: RerankerNvidiaConfig,
    ) => ModuleConfig<"reranker-nvidia", RerankerNvidiaConfig | undefined>

    Create a ModuleConfig<'reranker-nvidia', RerankerNvidiaConfig> object for use when reranking using the reranker-nvidia module.

    See the documentation for detailed usage.

  • transformers: () => ModuleConfig<"reranker-transformers", Record<string, never>>

    Create a ModuleConfig<'reranker-transformers', Record<string, never>> object for use when reranking using the reranker-transformers module.

    See the documentation for detailed usage.

  • voyageAI: (
        config?: RerankerVoyageAIConfig,
    ) => ModuleConfig<"reranker-voyageai", RerankerVoyageAIConfig | undefined>

    Create a ModuleConfig<'reranker-voyageai', RerankerVoyageAIConfig> object for use when reranking using the reranker-voyageai module.

    See the documentation for detailed usage.

• sharding: (
      options: {
          desiredCount?: number;
          desiredVirtualCount?: number;
          virtualPerPhysical?: number;
      },
  ) => ShardingConfigCreate

  Create a ShardingConfigCreate object to be used when defining the sharding configuration of your collection.

  NOTE: You can only use one of Sharding or Replication, not both.

  See the docs for more details.

• 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?: VectorIndexConfigDynamicCreateOptions,
      ) => ModuleConfig<"dynamic", VectorIndexConfigDynamicCreate | undefined>;
      flat: (
          opts?: VectorIndexConfigFlatCreateOptions,
      ) => ModuleConfig<"flat", VectorIndexConfigFlatCreate | undefined>;
      hfresh: (
          opts?: VectorIndexConfigHFreshCreateOptions,
      ) => ModuleConfig<"hfresh", VectorIndexConfigHFreshCreate | undefined>;
      hnsw: (
          opts?: VectorIndexConfigHNSWCreateOptions,
      ) => ModuleConfig<"hnsw", VectorIndexConfigHNSWCreate | undefined>;
      multiVector: {
          encoding: {
              muvera: (
                  options?: {
                      dprojections?: number;
                      ksim?: number;
                      repetitions?: number;
                  },
              ) => {
                  dprojections?: number;
                  ksim?: number;
                  repetitions?: number;
                  type?: "muvera";
              };
          };
          multiVector: (
              options?: {
                  aggregation?: string;
                  encoding?: {
                      dprojections?: number;
                      ksim?: number;
                      repetitions?: number;
                      type?: "muvera";
                  };
              },
          ) => MultiVectorConfigCreate;
      };
      quantizer: {
          bq: (
              options?: { cache?: boolean; rescoreLimit?: number },
          ) => BQConfigCreate;
          none: () => UncompressedConfig;
          pq: (
              options?: {
                  bitCompression?: boolean;
                  centroids?: number;
                  encoder?: { distribution?: PQEncoderDistribution; type?: PQEncoderType };
                  segments?: number;
                  trainingLimit?: number;
              },
          ) => PQConfigCreate;
          rq: (options?: { bits?: number; rescoreLimit?: number }) => RQConfigCreate;
          sq: (
              options?: { rescoreLimit?: number; trainingLimit?: number },
          ) => SQConfigCreate;
      };
  }

  • dynamic: (
        opts?: VectorIndexConfigDynamicCreateOptions,
    ) => ModuleConfig<"dynamic", VectorIndexConfigDynamicCreate | undefined>

    Create a ModuleConfig<'dynamic', VectorIndexConfigDynamicCreate | undefined> object when defining the configuration of the dynamic vector index.

    Use this method when defining the options.vectorIndexConfig argument of the configure.vectors method.

  • flat: (
        opts?: VectorIndexConfigFlatCreateOptions,
    ) => ModuleConfig<"flat", VectorIndexConfigFlatCreate | undefined>

    Create a ModuleConfig<'flat', VectorIndexConfigFlatCreate | undefined> object when defining the configuration of the FLAT vector index.

    Use this method when defining the options.vectorIndexConfig argument of the configure.vectors method.

  • hfresh: (
        opts?: VectorIndexConfigHFreshCreateOptions,
    ) => ModuleConfig<"hfresh", VectorIndexConfigHFreshCreate | undefined>

    Create a ModuleConfig<'hfresh', VectorIndexConfigHFreshCreate | undefined> object when defining the configuration of the HFresh vector index.

    Use this method when defining the options.vectorIndexConfig argument of the configure.vectors method.

  • hnsw: (
        opts?: VectorIndexConfigHNSWCreateOptions,
    ) => ModuleConfig<"hnsw", VectorIndexConfigHNSWCreate | undefined>

    Create a ModuleConfig<'hnsw', VectorIndexConfigHNSWCreate | undefined> object when defining the configuration of the HNSW vector index.

    Use this method when defining the options.vectorIndexConfig argument of the configure.vectors method.

  • multiVector: {
        encoding: {
            muvera: (
                options?: {
                    dprojections?: number;
                    ksim?: number;
                    repetitions?: number;
                },
            ) => {
                dprojections?: number;
                ksim?: number;
                repetitions?: number;
                type?: "muvera";
            };
        };
        multiVector: (
            options?: {
                aggregation?: string;
                encoding?: {
                    dprojections?: number;
                    ksim?: number;
                    repetitions?: number;
                    type?: "muvera";
                };
            },
        ) => MultiVectorConfigCreate;
    }

    Define the configuration for a multi-vector index.

    • encoding: {
          muvera: (
              options?: {
                  dprojections?: number;
                  ksim?: number;
                  repetitions?: number;
              },
          ) => {
              dprojections?: number;
              ksim?: number;
              repetitions?: number;
              type?: "muvera";
          };
      }

      Specify the encoding configuration for a multi-vector index.

      • muvera: (
            options?: { dprojections?: number; ksim?: number; repetitions?: number },
        ) => {
            dprojections?: number;
            ksim?: number;
            repetitions?: number;
            type?: "muvera";
        }

        Create an object of type MuveraEncodingConfigCreate to be used when defining the encoding configuration of a multi-vector index using MUVERA.

    • multiVector: (
          options?: {
              aggregation?: string;
              encoding?: {
                  dprojections?: number;
                  ksim?: number;
                  repetitions?: number;
                  type?: "muvera";
              };
          },
      ) => MultiVectorConfigCreate

      Create an object of type MultiVectorConfigCreate to be used when defining the configuration of a multi-vector index.

  • quantizer: {
        bq: (
            options?: { cache?: boolean; rescoreLimit?: number },
        ) => BQConfigCreate;
        none: () => UncompressedConfig;
        pq: (
            options?: {
                bitCompression?: boolean;
                centroids?: number;
                encoder?: { distribution?: PQEncoderDistribution; type?: PQEncoderType };
                segments?: number;
                trainingLimit?: number;
            },
        ) => PQConfigCreate;
        rq: (options?: { bits?: number; rescoreLimit?: number }) => RQConfigCreate;
        sq: (
            options?: { rescoreLimit?: number; trainingLimit?: number },
        ) => SQConfigCreate;
    }

    Define the quantizer configuration to use when creating a vector index.

    • bq: (options?: { cache?: boolean; rescoreLimit?: number }) => BQConfigCreate

      Create an object of type BQConfigCreate to be used when defining the quantizer configuration of a vector index.

    • none: () => UncompressedConfig

      Create an object of type UncompressedConfig to be used when defining the quantizer configuration of a vector index.

      This is useful for disabling the default quantization present in Weaviate>=1.33.0.

    • pq: (
          options?: {
              bitCompression?: boolean;
              centroids?: number;
              encoder?: { distribution?: PQEncoderDistribution; type?: PQEncoderType };
              segments?: number;
              trainingLimit?: number;
          },
      ) => PQConfigCreate

      Create an object of type PQConfigCreate to be used when defining the quantizer configuration of a vector index.

    • rq: (options?: { bits?: number; rescoreLimit?: number }) => RQConfigCreate

      Create an object of type RQConfigCreate to be used when defining the quantizer configuration of a vector index.

    • sq: (options?: { rescoreLimit?: number; trainingLimit?: number }) => SQConfigCreate

      Create an object of type SQConfigCreate to be used when defining the quantizer configuration of a vector index.

• vectorizer: {
      img2VecNeural: <
          N extends string
          | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Img2VecNeuralConfig & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          },
      ) => VectorConfigCreate<never, N, I, "img2vec-neural">;
      multi2VecBind: <
          N extends string
          | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<Multi2VecBindConfig, Multi2VecOmissions> & {
              audioFields?: string[] | Multi2VecField[];
              depthFields?: string[] | Multi2VecField[];
              imageFields?: string[] | Multi2VecField[];
              IMUFields?: string[] | Multi2VecField[];
              textFields?: string[] | Multi2VecField[];
              thermalFields?: string[] | Multi2VecField[];
              videoFields?: string[] | Multi2VecField[];
          } & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          },
      ) => VectorConfigCreate<never, N, I, "multi2vec-bind">;
      multi2VecClip: <
          N extends string
          | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<Multi2VecClipConfig, Multi2VecOmissions> & {
              imageFields?: string[] | Multi2VecField[];
              textFields?: string[] | Multi2VecField[];
          } & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          },
      ) => VectorConfigCreate<never, N, I, "multi2vec-clip">;
      multi2VecCohere: <
          N extends string
          | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<Multi2VecCohereConfig, Multi2VecOmissions> & {
              imageFields?: string[] | Multi2VecField[];
              textFields?: string[] | Multi2VecField[];
          } & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          },
      ) => VectorConfigCreate<never, N, I, "multi2vec-cohere">;
      multi2VecGoogle: <
          N extends string
          | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts: ConfigureNonTextVectorizerOptions<N, I, "multi2vec-google">,
      ) => VectorConfigCreate<never, N, I, "multi2vec-google">;
      multi2VecJinaAI: <
          N extends string
          | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<Multi2VecJinaAIConfig, Multi2VecOmissions> & {
              imageFields?: string[] | Multi2VecField[];
              textFields?: string[] | Multi2VecField[];
          } & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          },
      ) => VectorConfigCreate<never, N, I, "multi2vec-jinaai">;
      multi2VecPalm: <
          N extends string
          | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts: ConfigureNonTextVectorizerOptions<N, I, "multi2vec-palm">,
      ) => VectorConfigCreate<never, N, I, "multi2vec-palm">;
      multi2VecVoyageAI: <
          N extends string
          | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<Multi2VecVoyageAIConfig, Multi2VecOmissions> & {
              imageFields?: string[] | Multi2VecField[];
              textFields?: string[] | Multi2VecField[];
              videoFields?: string[] | Multi2VecField[];
          } & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          },
      ) => VectorConfigCreate<never, N, I, "multi2vec-voyageai">;
      none: <N extends string | undefined = undefined, I extends string = "hnsw">(
          opts?: {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          },
      ) => VectorConfigCreate<never, N, I, "none">;
      ref2VecCentroid: <
          N extends string
          | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts: ConfigureNonTextVectorizerOptions<N, I, "ref2vec-centroid">,
      ) => VectorConfigCreate<never, N, I, "ref2vec-centroid">;
      selfProvided: <
          N extends string
          | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          },
      ) => VectorConfigCreate<never, N, I, "none">;
      text2VecAWS: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts: ConfigureTextVectorizerOptions<T, N, I, "text2vec-aws">,
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-aws">;
      text2VecAzureOpenAI: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts: ConfigureTextVectorizerOptions<T, N, I, "text2vec-azure-openai">,
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-azure-openai">;
      text2VecCohere: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Text2VecCohereConfig & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          } & { sourceProperties?: PrimitiveKeys<T>[] },
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-cohere">;
      text2VecContextionary: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Text2VecContextionaryConfig & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          } & { sourceProperties?: PrimitiveKeys<T>[] },
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-contextionary">;
      text2VecDatabricks: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts: ConfigureTextVectorizerOptions<T, N, I, "text2vec-databricks">,
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-databricks">;
      text2VecGoogle: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Text2VecGoogleConfig & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          } & { sourceProperties?: PrimitiveKeys<T>[] },
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-google">;
      text2VecGPT4All: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Text2VecGPT4AllConfig & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          } & { sourceProperties?: PrimitiveKeys<T>[] },
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-gpt4all">;
      text2VecHuggingFace: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Text2VecHuggingFaceConfig & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          } & { sourceProperties?: PrimitiveKeys<T>[] },
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-huggingface">;
      text2VecJinaAI: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Text2VecJinaAIConfig & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          } & { sourceProperties?: PrimitiveKeys<T>[] },
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-jinaai">;
      text2VecMistral: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Text2VecMistralConfig & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          } & { sourceProperties?: PrimitiveKeys<T>[] },
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-mistral">;
      text2VecModel2Vec: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Text2VecModel2Vec & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          } & { sourceProperties?: PrimitiveKeys<T>[] },
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-model2vec">;
      text2VecNvidia: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Text2VecNvidiaConfig & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          } & { sourceProperties?: PrimitiveKeys<T>[] },
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-nvidia">;
      text2VecOllama: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Text2VecOllamaConfig & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          } & { sourceProperties?: PrimitiveKeys<T>[] },
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-ollama">;
      text2VecOpenAI: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Text2VecOpenAIConfig & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          } & { sourceProperties?: PrimitiveKeys<T>[] },
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-openai">;
      text2VecPalm: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Text2VecGoogleConfig & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          } & { sourceProperties?: PrimitiveKeys<T>[] },
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-palm">;
      text2VecTransformers: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Text2VecTransformersConfig & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          } & { sourceProperties?: PrimitiveKeys<T>[] },
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-transformers">;
      text2VecVoyageAI: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Text2VecVoyageAIConfig & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          } & { sourceProperties?: PrimitiveKeys<T>[] },
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-voyageai">;
      text2VecWeaviate: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Text2VecWeaviateConfig & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          } & { sourceProperties?: PrimitiveKeys<T>[] },
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-weaviate">;
  }

  Deprecated

  Use configure.vectors instead.

  • img2VecNeural: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Img2VecNeuralConfig & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        },
    ) => VectorConfigCreate<never, N, I, "img2vec-neural">

    Create a VectorConfigCreate object with the vectorizer set to 'img2vec-neural'.

    See the documentation for detailed usage.

  • multi2VecBind: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<Multi2VecBindConfig, Multi2VecOmissions> & {
            audioFields?: string[] | Multi2VecField[];
            depthFields?: string[] | Multi2VecField[];
            imageFields?: string[] | Multi2VecField[];
            IMUFields?: string[] | Multi2VecField[];
            textFields?: string[] | Multi2VecField[];
            thermalFields?: string[] | Multi2VecField[];
            videoFields?: string[] | Multi2VecField[];
        } & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        },
    ) => VectorConfigCreate<never, N, I, "multi2vec-bind">

    Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-bind'.

    See the documentation for detailed usage.

  • multi2VecClip: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<Multi2VecClipConfig, Multi2VecOmissions> & {
            imageFields?: string[] | Multi2VecField[];
            textFields?: string[] | Multi2VecField[];
        } & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        },
    ) => VectorConfigCreate<never, N, I, "multi2vec-clip">

    Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-clip'.

    See the documentation for detailed usage.

  • multi2VecCohere: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<Multi2VecCohereConfig, Multi2VecOmissions> & {
            imageFields?: string[] | Multi2VecField[];
            textFields?: string[] | Multi2VecField[];
        } & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        },
    ) => VectorConfigCreate<never, N, I, "multi2vec-cohere">

    Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-cohere'.

    See the documentation for detailed usage.

  • multi2VecGoogle: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts: ConfigureNonTextVectorizerOptions<N, I, "multi2vec-google">,
    ) => VectorConfigCreate<never, N, I, "multi2vec-google">

    Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-google'.

    See the documentation for detailed usage.

  • multi2VecJinaAI: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<Multi2VecJinaAIConfig, Multi2VecOmissions> & {
            imageFields?: string[] | Multi2VecField[];
            textFields?: string[] | Multi2VecField[];
        } & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        },
    ) => VectorConfigCreate<never, N, I, "multi2vec-jinaai">

    Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-jinaai'.

    See the documentation for detailed usage.

  • multi2VecPalm: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts: ConfigureNonTextVectorizerOptions<N, I, "multi2vec-palm">,
    ) => VectorConfigCreate<never, N, I, "multi2vec-palm">

    Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-palm'.

    See the documentation for detailed usage.

    Deprecated

    Use multi2VecGoogle instead.

  • multi2VecVoyageAI: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<Multi2VecVoyageAIConfig, Multi2VecOmissions> & {
            imageFields?: string[] | Multi2VecField[];
            textFields?: string[] | Multi2VecField[];
            videoFields?: string[] | Multi2VecField[];
        } & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        },
    ) => VectorConfigCreate<never, N, I, "multi2vec-voyageai">

    Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-clip'.

    See the documentation for detailed usage.

  • none: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        },
    ) => VectorConfigCreate<never, N, I, "none">

    Create a VectorConfigCreate object with the vectorizer set to 'none'.

    Deprecated

    Use selfProvided instead.

  • ref2VecCentroid: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts: ConfigureNonTextVectorizerOptions<N, I, "ref2vec-centroid">,
    ) => VectorConfigCreate<never, N, I, "ref2vec-centroid">

    Create a VectorConfigCreate object with the vectorizer set to 'ref2vec-centroid'.

    See the documentation for detailed usage.

  • selfProvided: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        },
    ) => VectorConfigCreate<never, N, I, "none">

    Create a VectorConfigCreate object with the vectorizer set to 'none'.

  • text2VecAWS: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts: ConfigureTextVectorizerOptions<T, N, I, "text2vec-aws">,
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-aws">

    Create a VectorConfigCreate object with the vectorizer set to 'text2vec-aws'.

    See the documentation for detailed usage.

  • text2VecAzureOpenAI: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts: ConfigureTextVectorizerOptions<T, N, I, "text2vec-azure-openai">,
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-azure-openai">

    Create a VectorConfigCreate object with the vectorizer set to 'text2vec-azure-openai'.

    See the documentation for detailed usage.

  • text2VecCohere: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Text2VecCohereConfig & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        } & { sourceProperties?: PrimitiveKeys<T>[] },
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-cohere">

    Create a VectorConfigCreate object with the vectorizer set to 'text2vec-cohere'.

    See the documentation for detailed usage.

  • text2VecContextionary: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Text2VecContextionaryConfig & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        } & { sourceProperties?: PrimitiveKeys<T>[] },
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-contextionary">

    Create a VectorConfigCreate object with the vectorizer set to 'text2vec-contextionary'.

    See the documentation for detailed usage.

    Deprecated

    The contextionary model is old and not recommended for use. If you are looking for a local, lightweight model try the new text2vec-model2vec module instead.

  • text2VecDatabricks: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts: ConfigureTextVectorizerOptions<T, N, I, "text2vec-databricks">,
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-databricks">

    Create a VectorConfigCreate object with the vectorizer set to 'text2vec-databricks'.

    See the documentation for detailed usage.

  • text2VecGoogle: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Text2VecGoogleConfig & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        } & { sourceProperties?: PrimitiveKeys<T>[] },
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-google">

    Create a VectorConfigCreate object with the vectorizer set to 'text2vec-google'.

    See the documentation for detailed usage.

  • text2VecGPT4All: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Text2VecGPT4AllConfig & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        } & { sourceProperties?: PrimitiveKeys<T>[] },
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-gpt4all">

    Create a VectorConfigCreate object with the vectorizer set to 'text2vec-gpt4all'.

    See the documentation for detailed usage.

  • text2VecHuggingFace: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Text2VecHuggingFaceConfig & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        } & { sourceProperties?: PrimitiveKeys<T>[] },
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-huggingface">

    Create a VectorConfigCreate object with the vectorizer set to 'text2vec-huggingface'.

    See the documentation for detailed usage.

  • text2VecJinaAI: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Text2VecJinaAIConfig & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        } & { sourceProperties?: PrimitiveKeys<T>[] },
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-jinaai">

    Create a VectorConfigCreate object with the vectorizer set to 'text2vec-jinaai'.

    See the documentation for detailed usage.

  • text2VecMistral: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Text2VecMistralConfig & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        } & { sourceProperties?: PrimitiveKeys<T>[] },
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-mistral">

    Create a VectorConfigCreate object with the vectorizer set to 'text2vec-mistral'.

    See the documentation for detailed usage.

  • text2VecModel2Vec: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Text2VecModel2Vec & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        } & { sourceProperties?: PrimitiveKeys<T>[] },
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-model2vec">

    Create a VectorConfigCreate object with the vectorizer set to 'text2vec-model2vec'.

  • text2VecNvidia: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Text2VecNvidiaConfig & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        } & { sourceProperties?: PrimitiveKeys<T>[] },
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-nvidia">

  • text2VecOllama: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Text2VecOllamaConfig & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        } & { sourceProperties?: PrimitiveKeys<T>[] },
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-ollama">

    Create a VectorConfigCreate object with the vectorizer set to 'text2vec-ollama'.

    See the documentation for detailed usage.

  • text2VecOpenAI: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Text2VecOpenAIConfig & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        } & { sourceProperties?: PrimitiveKeys<T>[] },
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-openai">

    Create a VectorConfigCreate object with the vectorizer set to 'text2vec-openai'.

    See the documentation for detailed usage.

  • text2VecPalm: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Text2VecGoogleConfig & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        } & { sourceProperties?: PrimitiveKeys<T>[] },
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-palm">

    Create a VectorConfigCreate object with the vectorizer set to 'text2vec-palm'.

    See the documentation for detailed usage.

    Deprecated

    Use text2VecGoogle instead.

  • text2VecTransformers: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Text2VecTransformersConfig & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        } & { sourceProperties?: PrimitiveKeys<T>[] },
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-transformers">

    Create a VectorConfigCreate object with the vectorizer set to 'text2vec-transformers'.

    See the documentation for detailed usage.

  • text2VecVoyageAI: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Text2VecVoyageAIConfig & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        } & { sourceProperties?: PrimitiveKeys<T>[] },
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-voyageai">

    Create a VectorConfigCreate object with the vectorizer set to 'text2vec-voyageai'.

    See the documentation for detailed usage.

  • text2VecWeaviate: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Text2VecWeaviateConfig & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        } & { sourceProperties?: PrimitiveKeys<T>[] },
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-weaviate">

    Create a VectorConfigCreate object with the vectorizer set to 'text2vec-weaviate'.

    See the documentation for detailed usage.

• vectors: {
      img2VecNeural: <
          N extends string
          | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Img2VecNeuralConfig & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          },
      ) => VectorConfigCreate<never, N, I, "img2vec-neural">;
      multi2VecBind: <
          N extends string
          | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<
              Omit<Multi2VecBindConfig, Multi2VecOmissions> & {
                  audioFields?: string[] | Multi2VecField[];
                  depthFields?: string[] | Multi2VecField[];
                  imageFields?: string[] | Multi2VecField[];
                  IMUFields?: string[] | Multi2VecField[];
                  textFields?: string[] | Multi2VecField[];
                  thermalFields?: string[] | Multi2VecField[];
                  videoFields?: string[] | Multi2VecField[];
              } & {
                  name?: N;
                  quantizer?: QuantizerConfigCreate;
                  vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
              },
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate<never, N, I, "multi2vec-bind">;
      multi2VecClip: <
          N extends string
          | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<
              Omit<Multi2VecClipConfig, Multi2VecOmissions> & {
                  imageFields?: string[] | Multi2VecField[];
                  textFields?: string[] | Multi2VecField[];
              } & {
                  name?: N;
                  quantizer?: QuantizerConfigCreate;
                  vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
              },
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate<never, N, I, "multi2vec-clip">;
      multi2VecCohere: <
          N extends string
          | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<
              Omit<Multi2VecCohereConfig, Multi2VecOmissions> & {
                  imageFields?: string[] | Multi2VecField[];
                  textFields?: string[] | Multi2VecField[];
              } & {
                  name?: N;
                  quantizer?: QuantizerConfigCreate;
                  vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
              },
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate<never, N, I, "multi2vec-cohere">;
      multi2VecGoogle: <
          N extends string
          | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts: Omit<
              ConfigureNonTextVectorizerOptions<N, I, "multi2vec-google">,
              "vectorizeCollectionName",
          > & { model?: string; modelId?: undefined },
      ) => VectorConfigCreate<never, N, I, "multi2vec-google">;
      multi2VecJinaAI: <
          N extends string
          | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<
              Omit<Multi2VecJinaAIConfig, Multi2VecOmissions> & {
                  imageFields?: string[] | Multi2VecField[];
                  textFields?: string[] | Multi2VecField[];
              } & {
                  name?: N;
                  quantizer?: QuantizerConfigCreate;
                  vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
              },
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate<never, N, I, "multi2vec-jinaai">;
      multi2VecNvidia: <
          N extends string
          | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<Multi2VecNvidiaConfig, Multi2VecOmissions> & {
              imageFields?: string[] | Multi2VecField[];
              outputEncoding?: string;
              textFields?: string[] | Multi2VecField[];
          } & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          },
      ) => VectorConfigCreate<never, N, I, "multi2vec-nvidia">;
      multi2VecVoyageAI: <
          N extends string
          | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<
              Omit<Multi2VecVoyageAIConfig, Multi2VecOmissions> & {
                  imageFields?: string[] | Multi2VecField[];
                  textFields?: string[] | Multi2VecField[];
                  videoFields?: string[] | Multi2VecField[];
              } & {
                  name?: N;
                  quantizer?: QuantizerConfigCreate;
                  vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
              },
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate<never, N, I, "multi2vec-voyageai">;
      none: <N extends string | undefined = undefined, I extends string = "hnsw">(
          opts?: {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          },
      ) => VectorConfigCreate<never, N, I, "none">;
      ref2VecCentroid: <
          N extends string
          | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts: ConfigureNonTextVectorizerOptions<N, I, "ref2vec-centroid">,
      ) => VectorConfigCreate<never, N, I, "ref2vec-centroid">;
      selfProvided: <
          N extends string
          | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          },
      ) => VectorConfigCreate<never, N, I, "none">;
      text2VecAWS: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts: Omit<
              ConfigureTextVectorizerOptions<T, N, I, "text2vec-aws">,
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-aws">;
      text2VecAzureOpenAI: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts: Omit<
              ConfigureTextVectorizerOptions<T, N, I, "text2vec-azure-openai">,
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-azure-openai">;
      text2VecCohere: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<
              Text2VecCohereConfig & {
                  name?: N;
                  quantizer?: QuantizerConfigCreate;
                  vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
              } & { sourceProperties?: PrimitiveKeys<T>[] },
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-cohere">;
      text2VecContextionary: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<
              Text2VecContextionaryConfig & {
                  name?: N;
                  quantizer?: QuantizerConfigCreate;
                  vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
              } & { sourceProperties?: PrimitiveKeys<T>[] },
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-contextionary">;
      text2VecDatabricks: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts: Omit<
              ConfigureTextVectorizerOptions<T, N, I, "text2vec-databricks">,
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-databricks">;
      text2VecGoogle: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<
              Text2VecGoogleConfig & {
                  name?: N;
                  quantizer?: QuantizerConfigCreate;
                  vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<(...)>>;
              } & { sourceProperties?: PrimitiveKeys<(...)>[] },
              "vectorizeCollectionName",
          > & { model?: string; modelId?: undefined },
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-google">;
      text2VecGoogleAiStudio: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Text2VecGoogleAiStudioConfig & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          } & { sourceProperties?: PrimitiveKeys<T>[] },
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-google">;
      text2VecGPT4All: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<
              Text2VecGPT4AllConfig & {
                  name?: N;
                  quantizer?: QuantizerConfigCreate;
                  vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
              } & { sourceProperties?: PrimitiveKeys<T>[] },
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-gpt4all">;
      text2VecHuggingFace: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<
              Text2VecHuggingFaceConfig & {
                  name?: N;
                  quantizer?: QuantizerConfigCreate;
                  vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
              } & { sourceProperties?: PrimitiveKeys<T>[] },
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-huggingface">;
      text2VecJinaAI: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<
              Text2VecJinaAIConfig & {
                  name?: N;
                  quantizer?: QuantizerConfigCreate;
                  vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
              } & { sourceProperties?: PrimitiveKeys<T>[] },
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-jinaai">;
      text2VecMistral: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<
              Text2VecMistralConfig & {
                  name?: N;
                  quantizer?: QuantizerConfigCreate;
                  vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
              } & { sourceProperties?: PrimitiveKeys<T>[] },
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-mistral">;
      text2VecModel2Vec: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Text2VecModel2Vec & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          } & { sourceProperties?: PrimitiveKeys<T>[] },
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-model2vec">;
      text2VecMorph: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Text2VecMorphConfig & {
              name?: N;
              quantizer?: QuantizerConfigCreate;
              vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
          } & { sourceProperties?: PrimitiveKeys<T>[] },
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-morph">;
      text2VecNvidia: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<
              Text2VecNvidiaConfig & {
                  name?: N;
                  quantizer?: QuantizerConfigCreate;
                  vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
              } & { sourceProperties?: PrimitiveKeys<T>[] },
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-nvidia">;
      text2VecOllama: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<
              Text2VecOllamaConfig & {
                  name?: N;
                  quantizer?: QuantizerConfigCreate;
                  vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
              } & { sourceProperties?: PrimitiveKeys<T>[] },
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-ollama">;
      text2VecOpenAI: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<
              Text2VecOpenAIConfig & {
                  name?: N;
                  quantizer?: QuantizerConfigCreate;
                  vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
              } & { sourceProperties?: PrimitiveKeys<T>[] },
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-openai">;
      text2VecTransformers: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<
              Text2VecTransformersConfig & {
                  name?: N;
                  quantizer?: QuantizerConfigCreate;
                  vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
              } & { sourceProperties?: PrimitiveKeys<T>[] },
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-transformers">;
      text2VecVoyageAI: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<
              Text2VecVoyageAIConfig & {
                  name?: N;
                  quantizer?: QuantizerConfigCreate;
                  vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
              } & { sourceProperties?: PrimitiveKeys<T>[] },
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-voyageai">;
      text2VecWeaviate: <
          T,
          N extends string | undefined = undefined,
          I extends string = "hnsw",
      >(
          opts?: Omit<
              Text2VecWeaviateConfig & {
                  name?: N;
                  quantizer?: QuantizerConfigCreate;
                  vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
              } & { sourceProperties?: PrimitiveKeys<T>[] },
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-weaviate">;
  }

  • img2VecNeural: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Img2VecNeuralConfig & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        },
    ) => VectorConfigCreate<never, N, I, "img2vec-neural">

    Create a VectorConfigCreate object with the vectorizer set to 'img2vec-neural'.

    See the documentation for detailed usage.

  • multi2VecBind: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<
            Omit<Multi2VecBindConfig, Multi2VecOmissions> & {
                audioFields?: string[] | Multi2VecField[];
                depthFields?: string[] | Multi2VecField[];
                imageFields?: string[] | Multi2VecField[];
                IMUFields?: string[] | Multi2VecField[];
                textFields?: string[] | Multi2VecField[];
                thermalFields?: string[] | Multi2VecField[];
                videoFields?: string[] | Multi2VecField[];
            } & {
                name?: N;
                quantizer?: QuantizerConfigCreate;
                vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
            },
            "vectorizeCollectionName",
        >,
    ) => VectorConfigCreate<never, N, I, "multi2vec-bind">

  • multi2VecClip: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<
            Omit<Multi2VecClipConfig, Multi2VecOmissions> & {
                imageFields?: string[] | Multi2VecField[];
                textFields?: string[] | Multi2VecField[];
            } & {
                name?: N;
                quantizer?: QuantizerConfigCreate;
                vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
            },
            "vectorizeCollectionName",
        >,
    ) => VectorConfigCreate<never, N, I, "multi2vec-clip">

  • multi2VecCohere: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<
            Omit<Multi2VecCohereConfig, Multi2VecOmissions> & {
                imageFields?: string[] | Multi2VecField[];
                textFields?: string[] | Multi2VecField[];
            } & {
                name?: N;
                quantizer?: QuantizerConfigCreate;
                vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
            },
            "vectorizeCollectionName",
        >,
    ) => VectorConfigCreate<never, N, I, "multi2vec-cohere">

  • multi2VecGoogle: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts: Omit<
            ConfigureNonTextVectorizerOptions<N, I, "multi2vec-google">,
            "vectorizeCollectionName",
        > & { model?: string; modelId?: undefined },
    ) => VectorConfigCreate<never, N, I, "multi2vec-google">

  • multi2VecJinaAI: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<
            Omit<Multi2VecJinaAIConfig, Multi2VecOmissions> & {
                imageFields?: string[] | Multi2VecField[];
                textFields?: string[] | Multi2VecField[];
            } & {
                name?: N;
                quantizer?: QuantizerConfigCreate;
                vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
            },
            "vectorizeCollectionName",
        >,
    ) => VectorConfigCreate<never, N, I, "multi2vec-jinaai">

  • multi2VecNvidia: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<Multi2VecNvidiaConfig, Multi2VecOmissions> & {
            imageFields?: string[] | Multi2VecField[];
            outputEncoding?: string;
            textFields?: string[] | Multi2VecField[];
        } & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        },
    ) => VectorConfigCreate<never, N, I, "multi2vec-nvidia">

    Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-nvidia'.

    See the documentation for detailed usage.

  • multi2VecVoyageAI: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<
            Omit<Multi2VecVoyageAIConfig, Multi2VecOmissions> & {
                imageFields?: string[] | Multi2VecField[];
                textFields?: string[] | Multi2VecField[];
                videoFields?: string[] | Multi2VecField[];
            } & {
                name?: N;
                quantizer?: QuantizerConfigCreate;
                vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
            },
            "vectorizeCollectionName",
        >,
    ) => VectorConfigCreate<never, N, I, "multi2vec-voyageai">

  • none: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        },
    ) => VectorConfigCreate<never, N, I, "none">

    Create a VectorConfigCreate object with the vectorizer set to 'none'.

    Deprecated

    Use selfProvided instead.

  • ref2VecCentroid: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts: ConfigureNonTextVectorizerOptions<N, I, "ref2vec-centroid">,
    ) => VectorConfigCreate<never, N, I, "ref2vec-centroid">

    Create a VectorConfigCreate object with the vectorizer set to 'ref2vec-centroid'.

    See the documentation for detailed usage.

  • selfProvided: <N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        },
    ) => VectorConfigCreate<never, N, I, "none">

    Create a VectorConfigCreate object with the vectorizer set to 'none'.

  • text2VecAWS: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts: Omit<
            ConfigureTextVectorizerOptions<T, N, I, "text2vec-aws">,
            "vectorizeCollectionName",
        >,
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-aws">

  • text2VecAzureOpenAI: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts: Omit<
            ConfigureTextVectorizerOptions<T, N, I, "text2vec-azure-openai">,
            "vectorizeCollectionName",
        >,
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-azure-openai">

  • text2VecCohere: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<
            Text2VecCohereConfig & {
                name?: N;
                quantizer?: QuantizerConfigCreate;
                vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
            } & { sourceProperties?: PrimitiveKeys<T>[] },
            "vectorizeCollectionName",
        >,
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-cohere">

  • text2VecContextionary: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<
            Text2VecContextionaryConfig & {
                name?: N;
                quantizer?: QuantizerConfigCreate;
                vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
            } & { sourceProperties?: PrimitiveKeys<T>[] },
            "vectorizeCollectionName",
        >,
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-contextionary">

    Deprecated

    The contextionary model is old and not recommended for use. If you are looking for a local, lightweight model try the new text2vec-model2vec module instead.

  • text2VecDatabricks: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts: Omit<
            ConfigureTextVectorizerOptions<T, N, I, "text2vec-databricks">,
            "vectorizeCollectionName",
        >,
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-databricks">

  • text2VecGoogle: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<
            Text2VecGoogleConfig & {
                name?: N;
                quantizer?: QuantizerConfigCreate;
                vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<(...)>>;
            } & { sourceProperties?: PrimitiveKeys<(...)>[] },
            "vectorizeCollectionName",
        > & { model?: string; modelId?: undefined },
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-google">

  • text2VecGoogleAiStudio: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Text2VecGoogleAiStudioConfig & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        } & { sourceProperties?: PrimitiveKeys<T>[] },
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-google">

    Create a VectorConfigCreate object with the vectorizer set to 'text2vec-google' with specific options for AI studio deployments.

    See the documentation for detailed usage.

  • text2VecGPT4All: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<
            Text2VecGPT4AllConfig & {
                name?: N;
                quantizer?: QuantizerConfigCreate;
                vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
            } & { sourceProperties?: PrimitiveKeys<T>[] },
            "vectorizeCollectionName",
        >,
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-gpt4all">

    Deprecated

    The text2vec-gpt4all vectorizer is deprecated and will be removed in a future release. See the docs (https://docs.weaviate.io/weaviate/model-providers) for alternatives.

  • text2VecHuggingFace: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<
            Text2VecHuggingFaceConfig & {
                name?: N;
                quantizer?: QuantizerConfigCreate;
                vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
            } & { sourceProperties?: PrimitiveKeys<T>[] },
            "vectorizeCollectionName",
        >,
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-huggingface">

  • text2VecJinaAI: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<
            Text2VecJinaAIConfig & {
                name?: N;
                quantizer?: QuantizerConfigCreate;
                vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
            } & { sourceProperties?: PrimitiveKeys<T>[] },
            "vectorizeCollectionName",
        >,
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-jinaai">

  • text2VecMistral: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<
            Text2VecMistralConfig & {
                name?: N;
                quantizer?: QuantizerConfigCreate;
                vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
            } & { sourceProperties?: PrimitiveKeys<T>[] },
            "vectorizeCollectionName",
        >,
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-mistral">

  • text2VecModel2Vec: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Text2VecModel2Vec & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        } & { sourceProperties?: PrimitiveKeys<T>[] },
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-model2vec">

    Create a VectorConfigCreate object with the vectorizer set to 'text2vec-model2vec'.

  • text2VecMorph: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Text2VecMorphConfig & {
            name?: N;
            quantizer?: QuantizerConfigCreate;
            vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
        } & { sourceProperties?: PrimitiveKeys<T>[] },
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-morph">

  • text2VecNvidia: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<
            Text2VecNvidiaConfig & {
                name?: N;
                quantizer?: QuantizerConfigCreate;
                vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
            } & { sourceProperties?: PrimitiveKeys<T>[] },
            "vectorizeCollectionName",
        >,
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-nvidia">

  • text2VecOllama: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<
            Text2VecOllamaConfig & {
                name?: N;
                quantizer?: QuantizerConfigCreate;
                vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
            } & { sourceProperties?: PrimitiveKeys<T>[] },
            "vectorizeCollectionName",
        >,
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-ollama">

  • text2VecOpenAI: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<
            Text2VecOpenAIConfig & {
                name?: N;
                quantizer?: QuantizerConfigCreate;
                vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
            } & { sourceProperties?: PrimitiveKeys<T>[] },
            "vectorizeCollectionName",
        >,
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-openai">

  • text2VecTransformers: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<
            Text2VecTransformersConfig & {
                name?: N;
                quantizer?: QuantizerConfigCreate;
                vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
            } & { sourceProperties?: PrimitiveKeys<T>[] },
            "vectorizeCollectionName",
        >,
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-transformers">

  • text2VecVoyageAI: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<
            Text2VecVoyageAIConfig & {
                name?: N;
                quantizer?: QuantizerConfigCreate;
                vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
            } & { sourceProperties?: PrimitiveKeys<T>[] },
            "vectorizeCollectionName",
        >,
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-voyageai">

  • text2VecWeaviate: <T, N extends string | undefined = undefined, I extends string = "hnsw">(
        opts?: Omit<
            Text2VecWeaviateConfig & {
                name?: N;
                quantizer?: QuantizerConfigCreate;
                vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
            } & { sourceProperties?: PrimitiveKeys<T>[] },
            "vectorizeCollectionName",
        >,
    ) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-weaviate">