Variable configureConst

Type Declaration

• dataType: {
      BLOB: "blob";
      BLOBHASH: "blobHash";
      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;
      cohere: (config?: GenerativeCohereConfigCreate) => ModuleConfig;
      contextualai: (config?: GenerativeContextualAIConfigCreate) => ModuleConfig;
      databricks: (config: GenerativeDatabricksConfigCreate) => ModuleConfig;
      google: (config?: GenerativePaLMConfigCreate) => ModuleConfig;
      openAI: (config?: GenerativeOpenAIConfigCreate) => ModuleConfig;
      palm: (config?: GenerativePaLMConfigCreate) => ModuleConfig;
      xai: (config?: GenerativeXAIConfigCreate) => ModuleConfig;
      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>;
  }

• invertedIndex: (
      options: {
          bm25b?: number;
          bm25k1?: number;
          cleanupIntervalSeconds?: number;
          indexNullState?: boolean;
          indexPropertyLength?: boolean;
          indexTimestamps?: boolean;
          stopwordPresets?: { [presetName: string]: string[] };
          stopwordsAdditions?: string[];
          stopwordsPreset?: "en" | "none";
          stopwordsRemovals?: string[];
      },
  ) => InvertedIndexConfigCreate

  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;
      },
  ) => MultiTenancyConfigCreate

  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 VectorIndexType = "hnsw",
      >(
          opts?: ConfigureNonTextMultiVectorizerOptions,
      ) => VectorConfigCreate;
      multi2VecWeaviate: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts: ConfigureNonTextMultiVectorizerOptions,
      ) => VectorConfigCreate;
      selfProvided: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureNonTextMultiVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecJinaAI: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureTextMultiVectorizerOptions,
      ) => VectorConfigCreate;
  }

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

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

  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;
      contextualai: (config?: RerankerContextualAIConfig) => ModuleConfig;
      jinaai: (config?: RerankerJinaAIConfig) => ModuleConfig;
      nvidia: (config?: RerankerNvidiaConfig) => ModuleConfig;
      transformers: () => ModuleConfig;
      voyageAI: (config?: RerankerVoyageAIConfig) => ModuleConfig;
  }

• 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;
      flat: (opts?: VectorIndexConfigFlatCreateOptions) => ModuleConfig;
      hfresh: (opts?: VectorIndexConfigHFreshCreateOptions) => ModuleConfig;
      hnsw: (opts?: VectorIndexConfigHNSWCreateOptions) => ModuleConfig;
      multiVector: {
          encoding: {
              muvera: (
                  options?: {
                      dprojections?: number;
                      ksim?: number;
                      repetitions?: number;
                  },
              ) => MuveraEncodingConfigCreate;
          };
          multiVector: (
              options?: {
                  aggregation?: "maxSim" | string;
                  encoding?: MultiVectorConfigCreate["encoding"];
              },
          ) => 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;
      };
  }

• vectorizer: {
      img2VecNeural: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts: ConfigureNonTextVectorizerOptions,
      ) => VectorConfigCreate;
      multi2VecBind: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureNonTextVectorizerOptions,
      ) => VectorConfigCreate;
      multi2VecClip: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureNonTextVectorizerOptions,
      ) => VectorConfigCreate;
      multi2VecCohere: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureNonTextVectorizerOptions,
      ) => VectorConfigCreate;
      multi2VecGoogle: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts: ConfigureNonTextVectorizerOptions,
      ) => VectorConfigCreate;
      multi2VecJinaAI: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureNonTextVectorizerOptions,
      ) => VectorConfigCreate;
      multi2VecPalm: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts: ConfigureNonTextVectorizerOptions,
      ) => VectorConfigCreate;
      multi2VecTwelveLabs: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureNonTextVectorizerOptions,
      ) => VectorConfigCreate;
      multi2VecVoyageAI: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureNonTextVectorizerOptions,
      ) => VectorConfigCreate;
      none: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureNonTextVectorizerOptions,
      ) => VectorConfigCreate;
      ref2VecCentroid: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts: ConfigureNonTextVectorizerOptions,
      ) => VectorConfigCreate;
      selfProvided: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureNonTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecAWS: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecAzureOpenAI: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecCohere: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecContextionary: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecDatabricks: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecDigitalOcean: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecGoogle: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecGPT4All: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecHuggingFace: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecJinaAI: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecMistral: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecModel2Vec: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecNvidia: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecOllama: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecOpenAI: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecPalm: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecTransformers: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecVoyageAI: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecWeaviate: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
  }

  Deprecated

  Use configure.vectors instead.

• vectors: {
      img2VecNeural: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts: ConfigureNonTextVectorizerOptions,
      ) => VectorConfigCreate;
      multi2VecBind: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: Omit<
              ConfigureNonTextVectorizerOptions,
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate;
      multi2VecClip: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: Omit<
              ConfigureNonTextVectorizerOptions,
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate;
      multi2VecCohere: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: Omit<
              ConfigureNonTextVectorizerOptions,
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate;
      multi2VecGoogle: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts: Omit<
              ConfigureNonTextVectorizerOptions,
              "vectorizeCollectionName",
          > & { model?: string; modelId?: never },
      ) => VectorConfigCreate;
      multi2VecGoogleGemini: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      multi2VecJinaAI: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: Omit<
              ConfigureNonTextVectorizerOptions,
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate;
      multi2VecNvidia: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureNonTextVectorizerOptions,
      ) => VectorConfigCreate;
      multi2VecTwelveLabs: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: Omit<
              ConfigureNonTextVectorizerOptions,
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate;
      multi2VecVoyageAI: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: Omit<
              ConfigureNonTextVectorizerOptions,
              "vectorizeCollectionName",
          >,
      ) => VectorConfigCreate;
      none: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureNonTextVectorizerOptions,
      ) => VectorConfigCreate;
      ref2VecCentroid: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts: ConfigureNonTextVectorizerOptions,
      ) => VectorConfigCreate;
      selfProvided: <
          N extends string
          | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureNonTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecAWS: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts: Omit<ConfigureTextVectorizerOptions, "vectorizeCollectionName">,
      ) => VectorConfigCreate;
      text2VecAzureOpenAI: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts: Omit<ConfigureTextVectorizerOptions, "vectorizeCollectionName">,
      ) => VectorConfigCreate;
      text2VecCohere: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: Omit<ConfigureTextVectorizerOptions, "vectorizeCollectionName">,
      ) => VectorConfigCreate;
      text2VecContextionary: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: Omit<ConfigureTextVectorizerOptions, "vectorizeCollectionName">,
      ) => VectorConfigCreate;
      text2VecDatabricks: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts: Omit<ConfigureTextVectorizerOptions, "vectorizeCollectionName">,
      ) => VectorConfigCreate;
      text2VecDigitalOcean: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts: Omit<ConfigureTextVectorizerOptions, "vectorizeCollectionName">,
      ) => VectorConfigCreate;
      text2VecGoogle: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: Omit<ConfigureTextVectorizerOptions, "vectorizeCollectionName"> & {
              model?: string;
              modelId?: never;
          },
      ) => VectorConfigCreate;
      text2VecGoogleAiStudio: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecGoogleGemini: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecGPT4All: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: Omit<ConfigureTextVectorizerOptions, "vectorizeCollectionName">,
      ) => VectorConfigCreate;
      text2VecHuggingFace: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: Omit<ConfigureTextVectorizerOptions, "vectorizeCollectionName">,
      ) => VectorConfigCreate;
      text2VecJinaAI: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: Omit<ConfigureTextVectorizerOptions, "vectorizeCollectionName">,
      ) => VectorConfigCreate;
      text2VecMistral: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: Omit<ConfigureTextVectorizerOptions, "vectorizeCollectionName">,
      ) => VectorConfigCreate;
      text2VecModel2Vec: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecMorph: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: ConfigureTextVectorizerOptions,
      ) => VectorConfigCreate;
      text2VecNvidia: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: Omit<ConfigureTextVectorizerOptions, "vectorizeCollectionName">,
      ) => VectorConfigCreate;
      text2VecOllama: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: Omit<ConfigureTextVectorizerOptions, "vectorizeCollectionName">,
      ) => VectorConfigCreate;
      text2VecOpenAI: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: Omit<ConfigureTextVectorizerOptions, "vectorizeCollectionName">,
      ) => VectorConfigCreate;
      text2VecTransformers: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: Omit<ConfigureTextVectorizerOptions, "vectorizeCollectionName">,
      ) => VectorConfigCreate;
      text2VecVoyageAI: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: Omit<ConfigureTextVectorizerOptions, "vectorizeCollectionName">,
      ) => VectorConfigCreate;
      text2VecWeaviate: <
          T,
          N extends string | undefined = undefined,
          I extends VectorIndexType = "hnsw",
      >(
          opts?: Omit<ConfigureTextVectorizerOptions, "vectorizeCollectionName">,
      ) => VectorConfigCreate;
  }