Variable reconfigureConst

Type Declaration

• 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;
          stopwordsAdditions?: string[];
          stopwordsPreset?: "none" | "en";
          stopwordsRemovals?: string[];
      },
  ) => InvertedIndexConfigUpdate

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

  See the docs for details!

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

  Create a MultiTenancyConfigUpdate object to be used when updating the multi-tenancy configuration of Weaviate.

  Note: You cannot update a single-tenant collection to become a multi-tenant collection. You must instead create a new multi-tenant collection and migrate the data over manually.

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

• replication: (
      options: {
          asyncEnabled?: boolean;
          deletionStrategy?: ReplicationDeletionStrategy;
          factor?: number;
      },
  ) => ReplicationConfigUpdate

  Create a ReplicationConfigUpdate object to be used when updating the replication configuration of Weaviate.

  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.

• vectorIndex: {
      flat: (
          options: { quantizer?: BQConfigUpdate; vectorCacheMaxObjects?: number },
      ) => ModuleConfig<"flat", VectorIndexConfigFlatUpdate>;
      hnsw: (
          options: {
              dynamicEfFactor?: number;
              dynamicEfMax?: number;
              dynamicEfMin?: number;
              ef?: number;
              filterStrategy?: VectorIndexFilterStrategy;
              flatSearchCutoff?: number;
              quantizer?:
                  | PQConfigUpdate
                  | BQConfigUpdate
                  | SQConfigUpdate
                  | RQConfigUpdate;
              vectorCacheMaxObjects?: number;
          },
      ) => ModuleConfig<"hnsw", VectorIndexConfigHNSWUpdate>;
      quantizer: {
          bq: (
              options?: { cache?: boolean; rescoreLimit?: number },
          ) => BQConfigUpdate;
          pq: (
              options?: {
                  centroids?: number;
                  pqEncoderDistribution?: PQEncoderDistribution;
                  pqEncoderType?: PQEncoderType;
                  segments?: number;
                  trainingLimit?: number;
              },
          ) => PQConfigUpdate;
          rq: (options?: { rescoreLimit?: number }) => RQConfigUpdate;
          sq: (
              options?: { rescoreLimit?: number; trainingLimit?: number },
          ) => SQConfigUpdate;
      };
  }

  • flat: (
        options: { quantizer?: BQConfigUpdate; vectorCacheMaxObjects?: number },
    ) => ModuleConfig<"flat", VectorIndexConfigFlatUpdate>

    Create a ModuleConfig<'flat', VectorIndexConfigFlatUpdate> object to update the configuration of the FLAT vector index.

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

  • hnsw: (
        options: {
            dynamicEfFactor?: number;
            dynamicEfMax?: number;
            dynamicEfMin?: number;
            ef?: number;
            filterStrategy?: VectorIndexFilterStrategy;
            flatSearchCutoff?: number;
            quantizer?:
                | PQConfigUpdate
                | BQConfigUpdate
                | SQConfigUpdate
                | RQConfigUpdate;
            vectorCacheMaxObjects?: number;
        },
    ) => ModuleConfig<"hnsw", VectorIndexConfigHNSWUpdate>

    Create a ModuleConfig<'hnsw', VectorIndexConfigHNSWCreate> object to update the configuration of the HNSW vector index.

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

  • quantizer: {
        bq: (
            options?: { cache?: boolean; rescoreLimit?: number },
        ) => BQConfigUpdate;
        pq: (
            options?: {
                centroids?: number;
                pqEncoderDistribution?: PQEncoderDistribution;
                pqEncoderType?: PQEncoderType;
                segments?: number;
                trainingLimit?: number;
            },
        ) => PQConfigUpdate;
        rq: (options?: { rescoreLimit?: number }) => RQConfigUpdate;
        sq: (
            options?: { rescoreLimit?: number; trainingLimit?: number },
        ) => SQConfigUpdate;
    }

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

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

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

      NOTE: If the vector index already has a quantizer configured, you cannot change its quantizer type; only its values. So if you want to change the quantizer type, you must recreate the collection.

    • pq: (
          options?: {
              centroids?: number;
              pqEncoderDistribution?: PQEncoderDistribution;
              pqEncoderType?: PQEncoderType;
              segments?: number;
              trainingLimit?: number;
          },
      ) => PQConfigUpdate

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

      NOTE: If the vector index already has a quantizer configured, you cannot change its quantizer type; only its values. So if you want to change the quantizer type, you must recreate the collection.

    • rq: (options?: { rescoreLimit?: number }) => RQConfigUpdate

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

      NOTE: If the vector index already has a quantizer configured, you cannot change its quantizer type; only its values. So if you want to change the quantizer type, you must recreate the collection.

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

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

      NOTE: If the vector index already has a quantizer configured, you cannot change its quantizer type; only its values. So if you want to change the quantizer type, you must recreate the collection.

• vectorizer: {
      update: <N extends string | undefined, I extends string>(
          options: VectorizerUpdateOptions<N, I>,
      ) => VectorConfigUpdate<N, I>;
  }

  Deprecated

  Use vectors instead.

  • update: <N extends string | undefined, I extends string>(
        options: VectorizerUpdateOptions<N, I>,
    ) => VectorConfigUpdate<N, I>

    Create a VectorConfigUpdate object to be used when updating the named vector configuration of Weaviate.

• vectors: {
      update: <N extends string | undefined, I extends string>(
          options: VectorizerUpdateOptions<N, I>,
      ) => VectorConfigUpdate<N, I>;
  }

  • update: <N extends string | undefined, I extends string>(
        options: VectorizerUpdateOptions<N, I>,
    ) => VectorConfigUpdate<N, I>

    Create a VectorConfigUpdate object to be used when updating the named vector configuration of Weaviate.