Variable vectorsConst

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<
          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<I>>;
          } & { sourceProperties?: PrimitiveKeys<T>[] },
          "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">