Variable vectorizerConst

Type Declaration

• 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.