from typing import Any, Dict, List, Literal, Optional, Union
from deprecation import deprecated as docstring_deprecated
from pydantic import AnyHttpUrl, Field
from typing_extensions import deprecated as typing_deprecated
from weaviate.collections.classes.config_base import (
_ConfigCreateModel,
_ConfigUpdateModel,
_EnumLikeStr,
)
from weaviate.collections.classes.config_vector_index import (
VectorIndexType,
_VectorIndexConfigCreate,
_VectorIndexConfigDynamicUpdate,
_VectorIndexConfigFlatUpdate,
_VectorIndexConfigHFreshUpdate,
_VectorIndexConfigHNSWUpdate,
_VectorIndexConfigUpdate,
)
from weaviate.collections.classes.config_vectorizers import (
AWSModel,
AWSService,
CohereModel,
CohereMultimodalModel,
CohereTruncation,
JinaModel,
JinaMultimodalModel,
Multi2VecField,
OpenAIModel,
OpenAIType,
Vectorizers,
VoyageModel,
VoyageMultimodalModel,
WeaviateModel,
_Img2VecNeuralConfig,
_map_multi2vec_fields,
_Multi2VecBindConfig,
_Multi2VecClipConfig,
_Multi2VecCohereConfig,
_Multi2VecGoogleConfig,
_Multi2VecJinaConfig,
_Multi2VecNvidiaConfig,
_Multi2VecVoyageaiConfig,
_Ref2VecCentroidConfig,
_Text2ColbertJinaAIConfig,
_Text2VecAWSConfig,
_Text2VecAzureOpenAIConfig,
_Text2VecCohereConfig,
_Text2VecContextionaryConfig,
_Text2VecDatabricksConfig,
_Text2VecGoogleConfig,
_Text2VecGPT4AllConfig,
_Text2VecHuggingFaceConfig,
_Text2VecJinaConfig,
_Text2VecMistralConfig,
_Text2VecModel2VecConfig,
_Text2VecNvidiaConfig,
_Text2VecOllamaConfig,
_Text2VecOpenAIConfig,
_Text2VecTransformersConfig,
_Text2VecVoyageConfig,
_Text2VecWeaviateConfig,
_VectorizerConfigCreate,
_VectorizerCustomConfig,
)
from ...warnings import _Warnings
[docs]
class _NamedVectorConfigCreate(_ConfigCreateModel):
name: str
properties: Optional[List[str]] = Field(default=None, min_length=1, alias="source_properties")
vectorizer: _VectorizerConfigCreate
vectorIndexType: VectorIndexType = Field(default=VectorIndexType.HNSW, exclude=True)
vectorIndexConfig: Optional[_VectorIndexConfigCreate] = Field(
default=None, alias="vector_index_config"
)
[docs]
def _to_dict(self) -> Dict[str, Any]:
ret_dict: Dict[str, Any] = self.__parse_vectorizer()
if self.vectorIndexConfig is not None:
ret_dict["vectorIndexType"] = self.vectorIndexConfig.vector_index_type().value
ret_dict["vectorIndexConfig"] = self.vectorIndexConfig._to_dict()
else:
ret_dict["vectorIndexType"] = self.vectorIndexType.value
return ret_dict
def __parse_vectorizer(self) -> Dict[str, Any]:
vectorizer_options = self.vectorizer._to_dict()
if self.properties is not None:
vectorizer_options["properties"] = self.properties
return {"vectorizer": {self.vectorizer.vectorizer.value: vectorizer_options}}
[docs]
class _NamedVectorConfigUpdate(_ConfigUpdateModel):
name: str
vectorIndexConfig: _VectorIndexConfigUpdate = Field(..., alias="vector_index_config")
[docs]
class _NamedVectors:
[docs]
@staticmethod
def none(
name: str, *, vector_index_config: Optional[_VectorIndexConfigCreate] = None
) -> _NamedVectorConfigCreate:
"""Create a named vector using no vectorizer. You will need to provide the vectors yourself.
Args:
name: The name of the named vector.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
"""
return _NamedVectorConfigCreate(
name=name,
vectorizer=_VectorizerConfigCreate(vectorizer=Vectorizers.NONE),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def custom(
name: str,
*,
module_name: str,
module_config: Optional[Dict[str, Any]] = None,
source_properties: Optional[List[str]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
) -> _NamedVectorConfigCreate:
"""Create a named vector using no vectorizer. You will need to provide the vectors yourself.
Args:
name: The name of the named vector.
module_name: The name of the custom module to use.
module_config: The configuration of the custom module to use.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
"""
return _NamedVectorConfigCreate(
name=name,
source_properties=source_properties,
vectorizer=_VectorizerCustomConfig(
vectorizer=_EnumLikeStr(module_name), module_config=module_config
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def text2colbert_jinaai(
name: str,
*,
dimensions: Optional[int] = None,
model: Optional[str] = None,
source_properties: Optional[List[str]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `text2colbert_jinaai` module.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/jinaai/colbert)
for detailed usage.
Args:
name: The name of the named vector.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
model: The model to use. Defaults to `None`, which uses the server-defined default.
dimensions: Number of dimensions. Applicable to v3 OpenAI models only. Defaults to `None`, which uses the server-defined default.
"""
return _NamedVectorConfigCreate(
name=name,
source_properties=source_properties,
vector_index_config=vector_index_config,
vectorizer=_Text2ColbertJinaAIConfig(
model=model,
dimensions=dimensions,
vectorizeClassName=vectorize_collection_name,
),
)
[docs]
@staticmethod
def text2vec_cohere(
name: str,
*,
base_url: Optional[AnyHttpUrl] = None,
model: Optional[Union[CohereModel, str]] = None,
truncate: Optional[CohereTruncation] = None,
source_properties: Optional[List[str]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `text2vec_cohere` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/cohere/embeddings)
for detailed usage.
Args:
name: The name of the named vector.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
model: The model to use. Defaults to `None`, which uses the server-defined default.
truncate: The truncation strategy to use. Defaults to `None`, which uses the server-defined default.
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
base_url: The base URL to use where API requests should go. Defaults to `None`, which uses the server-defined default.
Raises:
pydantic.ValidationError: If `model` is not a valid value from the `CohereModel` type or if `truncate` is not a valid value from the `CohereTruncation` type.
"""
return _NamedVectorConfigCreate(
name=name,
source_properties=source_properties,
vectorizer=_Text2VecCohereConfig(
baseURL=base_url,
model=model,
dimensions=None,
truncate=truncate,
vectorizeClassName=vectorize_collection_name,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def multi2vec_cohere(
name: str,
*,
base_url: Optional[AnyHttpUrl] = None,
image_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
model: Optional[Union[CohereMultimodalModel, str]] = None,
text_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
truncate: Optional[CohereTruncation] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `multi2vec_cohere` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/cohere/embeddings-multimodal)
for detailed usage.
Args:
name: The name of the named vector.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
model: The model to use. Defaults to `None`, which uses the server-defined default.
truncate: The truncation strategy to use. Defaults to `None`, which uses the server-defined default.
base_url: The base URL to use where API requests should go. Defaults to `None`, which uses the server-defined default.
image_fields: The image fields to use in vectorization.
text_fields: The text fields to use in vectorization.
Raises:
pydantic.ValidationError: If `model` is not a valid value from the `CohereMultimodalModel` type or if `truncate` is not a valid value from the `CohereTruncation` type.
"""
return _NamedVectorConfigCreate(
name=name,
vectorizer=_Multi2VecCohereConfig(
baseURL=base_url,
model=model,
dimensions=None,
truncate=truncate,
imageFields=_map_multi2vec_fields(image_fields),
textFields=_map_multi2vec_fields(text_fields),
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def text2vec_contextionary(
name: str,
*,
source_properties: Optional[List[str]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `text2vec_contextionary` model.
See the [documentation](https://weaviate.io/developers/weaviate/modules/retriever-vectorizer-modules/text2vec-contextionary)
for detailed usage.
Args:
name: The name of the named vector.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
"""
return _NamedVectorConfigCreate(
name=name,
source_properties=source_properties,
vectorizer=_Text2VecContextionaryConfig(
vectorizeClassName=vectorize_collection_name,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def text2vec_databricks(
name: str,
*,
endpoint: str,
instruction: Optional[str] = None,
source_properties: Optional[List[str]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `text2vec-databricks` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/databricks/embeddings)
for detailed usage.
Args:
name: The name of the named vector.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
endpoint: The endpoint to use.
instruction: The instruction strategy to use. Defaults to `None`, which uses the server-defined default.
"""
return _NamedVectorConfigCreate(
name=name,
source_properties=source_properties,
vectorizer=_Text2VecDatabricksConfig(
endpoint=endpoint,
instruction=instruction,
vectorizeClassName=vectorize_collection_name,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def text2vec_mistral(
name: str,
*,
base_url: Optional[AnyHttpUrl] = None,
model: Optional[str] = None,
source_properties: Optional[List[str]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `text2vec-mistral` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/mistral/embeddings)
for detailed usage.
Args:
name: The name of the named vector.
base_url: The base URL to use where API requests should go. Defaults to `None`, which uses the server-defined default.
model: The model to use. Defaults to `None`, which uses the server-defined default.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
"""
return _NamedVectorConfigCreate(
name=name,
source_properties=source_properties,
vectorizer=_Text2VecMistralConfig(
baseURL=base_url,
model=model,
vectorizeClassName=vectorize_collection_name,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def text2vec_ollama(
name: str,
*,
api_endpoint: Optional[str] = None,
model: Optional[str] = None,
source_properties: Optional[List[str]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `text2vec-ollama` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/ollama/embeddings)
for detailed usage.
Args:
name: The name of the named vector.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
model: The model to use. Defaults to `None`, which uses the server-defined default.
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
api_endpoint: The base URL to use where API requests should go. Defaults to `None`, which uses the server-defined default.
Docker users may need to specify an alias, such as `http://host.docker.internal:11434` so that the container can access the host machine.
"""
return _NamedVectorConfigCreate(
name=name,
source_properties=source_properties,
vectorizer=_Text2VecOllamaConfig(
apiEndpoint=api_endpoint,
model=model,
vectorizeClassName=vectorize_collection_name,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def text2vec_openai(
name: str,
*,
base_url: Optional[AnyHttpUrl] = None,
dimensions: Optional[int] = None,
model: Optional[Union[OpenAIModel, str]] = None,
model_version: Optional[str] = None,
type_: Optional[OpenAIType] = None,
source_properties: Optional[List[str]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `text2vec_openai` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/openai/embeddings)
for detailed usage.
Args:
name: The name of the named vector.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
model: The model to use. Defaults to `None`, which uses the server-defined default.
model_version: The model version to use. Defaults to `None`, which uses the server-defined default.
type_: The type of model to use. Defaults to `None`, which uses the server-defined default.
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
base_url: The base URL to use where API requests should go. Defaults to `None`, which uses the server-defined default.
dimensions: Number of dimensions. Applicable to v3 OpenAI models only. Defaults to `None`, which uses the server-defined default.
Raises:
pydantic.ValidationError: If `type_` is not a valid value from the `OpenAIType` type.
"""
return _NamedVectorConfigCreate(
name=name,
source_properties=source_properties,
vectorizer=_Text2VecOpenAIConfig(
baseURL=base_url,
model=model,
modelVersion=model_version,
type_=type_,
vectorizeClassName=vectorize_collection_name,
dimensions=dimensions,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def text2vec_aws(
name: str,
region: str,
*,
endpoint: Optional[str] = None,
model: Optional[Union[AWSModel, str]] = None,
service: Union[AWSService, str] = "bedrock",
source_properties: Optional[List[str]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `text2vec_aws` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/aws/embeddings)
for detailed usage.
Args:
name: The name of the named vector.
region: The AWS region to run the model from, REQUIRED.
endpoint: The endpoint to use. Defaults to `None`, which uses the server-defined default.
model: The model to use.
service: The AWS service to use. Defaults to `bedrock`.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
"""
return _NamedVectorConfigCreate(
name=name,
source_properties=source_properties,
vectorizer=_Text2VecAWSConfig(
model=model,
endpoint=endpoint,
region=region,
service=service,
vectorizeClassName=vectorize_collection_name,
targetModel=None,
targetVariant=None,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def img2vec_neural(
name: str,
image_fields: List[str],
*,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
) -> _NamedVectorConfigCreate:
"""Create a `Img2VecNeuralConfig` object for use when vectorizing using the `img2vec-neural` model.
See the [documentation](https://weaviate.io/developers/weaviate/modules/retriever-vectorizer-modules/img2vec-neural)
for detailed usage.
Args:
name: The name of the named vector.
image_fields: The image fields to use. This is a required field and must match the property fields of the collection that are defined as `DataType.BLOB`.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
Raises:
pydantic.ValidationError: If `image_fields` is not a `list`.
"""
return _NamedVectorConfigCreate(
name=name,
vectorizer=_Img2VecNeuralConfig(imageFields=image_fields),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def multi2vec_clip(
name: str,
*,
inference_url: Optional[str] = None,
image_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
text_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `multi2vec_clip` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/transformers/embeddings-multimodal)
for detailed usage.
Args:
name: The name of the named vector.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
image_fields: The image fields to use in vectorization.
text_fields: The text fields to use in vectorization.
inference_url: The inference url to use where API requests should go. Defaults to `None`, which uses the server-defined default.
"""
return _NamedVectorConfigCreate(
name=name,
vectorizer=_Multi2VecClipConfig(
imageFields=_map_multi2vec_fields(image_fields),
textFields=_map_multi2vec_fields(text_fields),
inferenceUrl=inference_url,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
@docstring_deprecated(
deprecated_in="4.9.0",
details="""
This method is deprecated and will be removed in Q2 '25. Please use :meth:`~weaviate.collections.classes.config._NamedVectors.multi2vec_google` instead.
""",
)
@typing_deprecated(
"This method is deprecated and will be removed in Q2 '25. Please use `multi2vec_google` instead."
)
def multi2vec_palm(
name: str,
*,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
location: str,
project_id: str,
image_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
text_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
video_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
dimensions: Optional[int] = None,
video_interval_seconds: Optional[int] = None,
model_id: Optional[str] = None,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `multi2vec_palm` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/google/embeddings-multimodal)
for detailed usage.
Args:
name: The name of the named vector.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
location: Where the model runs. REQUIRED.
project_id: The project ID to use, REQUIRED.
image_fields: The image fields to use in vectorization.
text_fields: The text fields to use in vectorization.
video_fields: The video fields to use in vectorization.
dimensions: The number of dimensions to use. Defaults to `None`, which uses the server-defined default.
video_interval_seconds: Length of a video interval. Defaults to `None`, which uses the server-defined default.
model_id: The model ID to use. Defaults to `None`, which uses the server-defined default.
"""
_Warnings.palm_to_google_m2v()
return _NamedVectorConfigCreate(
name=name,
vectorizer=_Multi2VecGoogleConfig(
projectId=project_id,
location=location,
imageFields=_map_multi2vec_fields(image_fields),
textFields=_map_multi2vec_fields(text_fields),
videoFields=_map_multi2vec_fields(video_fields),
dimensions=dimensions,
modelId=model_id,
videoIntervalSeconds=video_interval_seconds,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def multi2vec_google(
name: str,
*,
location: str,
project_id: str,
image_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
text_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
video_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
dimensions: Optional[int] = None,
video_interval_seconds: Optional[int] = None,
model_id: Optional[str] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `multi2vec_google` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/google/embeddings-multimodal)
for detailed usage.
Args:
name: The name of the named vector.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
location: Where the model runs. REQUIRED.
project_id: The project ID to use, REQUIRED.
image_fields: The image fields to use in vectorization.
text_fields: The text fields to use in vectorization.
video_fields: The video fields to use in vectorization.
dimensions: The number of dimensions to use. Defaults to `None`, which uses the server-defined default.
video_interval_seconds: Length of a video interval. Defaults to `None`, which uses the server-defined default.
model_id: The model ID to use. Defaults to `None`, which uses the server-defined default.
"""
return _NamedVectorConfigCreate(
name=name,
vectorizer=_Multi2VecGoogleConfig(
projectId=project_id,
location=location,
imageFields=_map_multi2vec_fields(image_fields),
textFields=_map_multi2vec_fields(text_fields),
videoFields=_map_multi2vec_fields(video_fields),
dimensions=dimensions,
modelId=model_id,
videoIntervalSeconds=video_interval_seconds,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def multi2vec_bind(
name: str,
*,
audio_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
depth_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
image_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
imu_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
text_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
thermal_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
video_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `multi2vec_bind` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/imagebind/embeddings-multimodal)
for detailed usage.
Args:
name: The name of the named vector.
audio_fields: The audio fields to use in vectorization.
depth_fields: The depth fields to use in vectorization.
image_fields: The image fields to use in vectorization.
imu_fields: The IMU fields to use in vectorization.
text_fields: The text fields to use in vectorization.
thermal_fields: The thermal fields to use in vectorization.
video_fields: The video fields to use in vectorization.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
"""
return _NamedVectorConfigCreate(
name=name,
vectorizer=_Multi2VecBindConfig(
audioFields=_map_multi2vec_fields(audio_fields),
depthFields=_map_multi2vec_fields(depth_fields),
imageFields=_map_multi2vec_fields(image_fields),
IMUFields=_map_multi2vec_fields(imu_fields),
textFields=_map_multi2vec_fields(text_fields),
thermalFields=_map_multi2vec_fields(thermal_fields),
videoFields=_map_multi2vec_fields(video_fields),
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def multi2vec_voyageai(
name: str,
*,
base_url: Optional[AnyHttpUrl] = None,
model: Optional[Union[VoyageMultimodalModel, str]] = None,
truncation: Optional[bool] = None,
output_encoding: Optional[str] = None,
image_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
text_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `multi2vec_voyageai` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/voyageai/embeddings-multimodal)
for detailed usage.
Args:
name: The name of the named vector.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
model: The model to use. Defaults to `None`, which uses the server-defined default.
truncation: The truncation strategy to use. Defaults to `None`, which uses the server-defined default.
base_url: The base URL to use where API requests should go. Defaults to `None`, which uses the server-defined default.
image_fields: The image fields to use in vectorization.
text_fields: The text fields to use in vectorization.
Raises:
pydantic.ValidationError: If `model` is not a valid value from the `VoyageaiMultimodalModel` type.
"""
return _NamedVectorConfigCreate(
name=name,
vectorizer=_Multi2VecVoyageaiConfig(
baseURL=base_url,
model=model,
truncation=truncation,
dimensions=None,
imageFields=_map_multi2vec_fields(image_fields),
textFields=_map_multi2vec_fields(text_fields),
videoFields=None,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def multi2vec_nvidia(
name: str,
*,
base_url: Optional[AnyHttpUrl] = None,
model: Optional[str] = None,
truncation: Optional[bool] = None,
output_encoding: Optional[str] = None,
image_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
text_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `multi2vec_nvidia` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/nvidia/embeddings-multimodal)
for detailed usage.
Args:
name: The name of the named vector.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
model: The model to use. Defaults to `None`, which uses the server-defined default.
truncation: The truncation strategy to use. Defaults to `None`, which uses the server-defined default.
base_url: The base URL to use where API requests should go. Defaults to `None`, which uses the server-defined default.
image_fields: The image fields to use in vectorization.
text_fields: The text fields to use in vectorization.
Raises:
pydantic.ValidationError: If `model` is not a valid value from the `NvidiaMultimodalModel` type.
"""
return _NamedVectorConfigCreate(
name=name,
vectorizer=_Multi2VecNvidiaConfig(
baseURL=base_url,
model=model,
truncation=truncation,
imageFields=_map_multi2vec_fields(image_fields),
textFields=_map_multi2vec_fields(text_fields),
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def ref2vec_centroid(
name: str,
reference_properties: List[str],
*,
method: Literal["mean"] = "mean",
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `ref2vec_centroid` model.
See the [documentation](https://weaviate.io/developers/weaviate/modules/retriever-vectorizer-modules/text2vec-gpt4all)
for detailed usage.
Args:
name: The name of the named vector.
reference_properties: The reference properties to use in vectorization, REQUIRED.
method: The method to use. Defaults to `mean`.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
"""
return _NamedVectorConfigCreate(
name=name,
vectorizer=_Ref2VecCentroidConfig(
referenceProperties=reference_properties,
method=method,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def text2vec_azure_openai(
name: str,
resource_name: str,
deployment_id: str,
*,
base_url: Optional[AnyHttpUrl] = None,
dimensions: Optional[int] = None,
model: Optional[str] = None,
source_properties: Optional[List[str]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `text2vec_azure_openai` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/openai-azure/embeddings)
for detailed usage.
Args:
name: The name of the named vector.
resource_name: The resource name to use, REQUIRED.
deployment_id: The deployment ID to use, REQUIRED.
base_url: The base URL to use where API requests should go. Defaults to `None`, which uses the server-defined default.
dimensions: The dimensionality of the vectors. Defaults to `None`, which uses the server-defined default.
model: The model to use. Defaults to `None`, which uses the server-defined default.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
"""
return _NamedVectorConfigCreate(
name=name,
source_properties=source_properties,
vectorizer=_Text2VecAzureOpenAIConfig(
baseURL=base_url,
dimensions=dimensions,
model=model,
resourceName=resource_name,
deploymentId=deployment_id,
vectorizeClassName=vectorize_collection_name,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def text2vec_gpt4all(
name: str,
*,
source_properties: Optional[List[str]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `text2vec_gpt4all` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/gpt4all/embeddings)
for detailed usage.
Args:
name: The name of the named vector.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
"""
return _NamedVectorConfigCreate(
name=name,
source_properties=source_properties,
vectorizer=_Text2VecGPT4AllConfig(
vectorizeClassName=vectorize_collection_name,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def text2vec_huggingface(
name: str,
*,
model: Optional[str] = None,
passage_model: Optional[str] = None,
query_model: Optional[str] = None,
endpoint_url: Optional[AnyHttpUrl] = None,
wait_for_model: Optional[bool] = None,
use_gpu: Optional[bool] = None,
use_cache: Optional[bool] = None,
source_properties: Optional[List[str]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `text2vec_huggingface` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/huggingface/embeddings)
for detailed usage.
Args:
name: The name of the named vector.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
model: The model to use. Defaults to `None`, which uses the server-defined default.
passage_model: The passage model to use. Defaults to `None`, which uses the server-defined default.
query_model: The query model to use. Defaults to `None`, which uses the server-defined default.
endpoint_url: The endpoint URL to use. Defaults to `None`, which uses the server-defined default.
wait_for_model: Whether to wait for the model to be loaded. Defaults to `None`, which uses the server-defined default.
use_gpu: Whether to use the GPU. Defaults to `None`, which uses the server-defined default.
use_cache: Whether to use the cache. Defaults to `None`, which uses the server-defined default.
Raises:
pydantic.ValidationError: If the arguments passed to the function are invalid.
It is important to note that some of these variables are mutually exclusive.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/huggingface/embeddings#vectorizer-parameters) for more details.
"""
return _NamedVectorConfigCreate(
name=name,
source_properties=source_properties,
vectorizer=_Text2VecHuggingFaceConfig(
model=model,
passageModel=passage_model,
queryModel=query_model,
endpointURL=endpoint_url,
waitForModel=wait_for_model,
useGPU=use_gpu,
useCache=use_cache,
vectorizeClassName=vectorize_collection_name,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
@docstring_deprecated(
deprecated_in="4.9.0",
details="""
This method is deprecated and will be removed in Q2 '25. Please use :meth:`~weaviate.collections.classes.config._NamedVectors.text2vec_google` instead.
""",
)
@typing_deprecated(
"This method is deprecated and will be removed in Q2 '25. Please use `text2vec_google` instead."
)
def text2vec_palm(
name: str,
project_id: str,
*,
source_properties: Optional[List[str]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
api_endpoint: Optional[str] = None,
model_id: Optional[str] = None,
title_property: Optional[str] = None,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `text2vec_palm` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/google/embeddings)
for detailed usage.
Args:
name: The name of the named vector.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
project_id: The project ID to use, REQUIRED.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
api_endpoint: The API endpoint to use without a leading scheme such as `http://`. Defaults to `None`, which uses the server-defined default
model_id: The model ID to use. Defaults to `None`, which uses the server-defined default.
title_property: The Weaviate property name for the `gecko-002` or `gecko-003` model to use as the title.
Raises:
pydantic.ValidationError: If `api_endpoint` is not a valid URL.
"""
_Warnings.palm_to_google_t2v()
return _NamedVectorConfigCreate(
name=name,
source_properties=source_properties,
vectorizer=_Text2VecGoogleConfig(
projectId=project_id,
apiEndpoint=api_endpoint,
dimensions=None,
modelId=model_id,
vectorizeClassName=vectorize_collection_name,
titleProperty=title_property,
taskType=None,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def text2vec_google(
name: str,
project_id: str,
*,
api_endpoint: Optional[str] = None,
model_id: Optional[str] = None,
title_property: Optional[str] = None,
source_properties: Optional[List[str]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `text2vec_palm` model.
See the [documentation]https://weaviate.io/developers/weaviate/model-providers/google/embeddings)
for detailed usage.
Args:
name: The name of the named vector.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
project_id: The project ID to use, REQUIRED.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
api_endpoint: The API endpoint to use without a leading scheme such as `http://`. Defaults to `None`, which uses the server-defined default
model_id: The model ID to use. Defaults to `None`, which uses the server-defined default.
title_property: The Weaviate property name for the `gecko-002` or `gecko-003` model to use as the title.
Raises:
pydantic.ValidationError: If `api_endpoint` is not a valid URL.
"""
return _NamedVectorConfigCreate(
name=name,
source_properties=source_properties,
vectorizer=_Text2VecGoogleConfig(
projectId=project_id,
apiEndpoint=api_endpoint,
dimensions=None,
modelId=model_id,
vectorizeClassName=vectorize_collection_name,
titleProperty=title_property,
taskType=None,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def text2vec_google_aistudio(
name: str,
*,
model_id: Optional[str] = None,
title_property: Optional[str] = None,
source_properties: Optional[List[str]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `text2vec_palm` model.
See the [documentation]https://weaviate.io/developers/weaviate/model-providers/google/embeddings)
for detailed usage.
Args:
name: The name of the named vector.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
model_id: The model ID to use. Defaults to `None`, which uses the server-defined default.
title_property: The Weaviate property name for the `gecko-002` or `gecko-003` model to use as the title.
Raises:
pydantic.ValidationError: If `api_endpoint` is not a valid URL.
"""
return _NamedVectorConfigCreate(
name=name,
source_properties=source_properties,
vectorizer=_Text2VecGoogleConfig(
projectId=None,
apiEndpoint="generativelanguage.googleapis.com",
dimensions=None,
modelId=model_id,
vectorizeClassName=vectorize_collection_name,
titleProperty=title_property,
taskType=None,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def text2vec_transformers(
name: str,
*,
dimensions: Optional[int] = None,
pooling_strategy: Literal["masked_mean", "cls"] = "masked_mean",
inference_url: Optional[str] = None,
passage_inference_url: Optional[str] = None,
query_inference_url: Optional[str] = None,
source_properties: Optional[List[str]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `text2vec_transformers` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/transformers/embeddings)
for detailed usage.
Args:
name: The name of the named vector.
dimensions: The number of dimensions for the generated embeddings. Defaults to `None`, which uses the server-defined default.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
pooling_strategy: The pooling strategy to use. Defaults to `masked_mean`.
inference_url: The inferenceUrl to use where API requests should go. You can use either this OR passage/query_inference_url. Defaults to `None`, which uses the server-defined default.
passage_inference_url: The inferenceUrl to use where passage API requests should go. You can use either this and query_inference_url OR inference_url. Defaults to `None`, which uses the server-defined default.
query_inference_url: The inferenceUrl to use where query API requests should go. You can use either this and passage_inference_url OR inference_url. Defaults to `None`, which uses the server-defined default.
"""
return _NamedVectorConfigCreate(
name=name,
source_properties=source_properties,
vectorizer=_Text2VecTransformersConfig(
dimensions=dimensions,
poolingStrategy=pooling_strategy,
vectorizeClassName=vectorize_collection_name,
inferenceUrl=inference_url,
passageInferenceUrl=passage_inference_url,
queryInferenceUrl=query_inference_url,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def text2vec_jinaai(
name: str,
*,
base_url: Optional[str] = None,
dimensions: Optional[int] = None,
model: Optional[Union[JinaModel, str]] = None,
source_properties: Optional[List[str]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `text2vec-jinaai` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/jinaai/embeddings) for detailed usage.
Args:
name: The name of the named vector.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
base_url: The base URL to send the vectorization requests to. Defaults to `None`, which uses the server-defined default.
dimensions: The number of dimensions for the generated embeddings. Defaults to `None`, which uses the server-defined default.
model: The model to use. Defaults to `None`, which uses the server-defined default.
"""
return _NamedVectorConfigCreate(
name=name,
source_properties=source_properties,
vectorizer=_Text2VecJinaConfig(
baseURL=base_url,
dimensions=dimensions,
model=model,
vectorizeClassName=vectorize_collection_name,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def multi2vec_jinaai(
name: str,
*,
base_url: Optional[AnyHttpUrl] = None,
model: Optional[Union[JinaMultimodalModel, str]] = None,
dimensions: Optional[int] = None,
image_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
text_fields: Optional[Union[List[str], List[Multi2VecField]]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `multi2vec_jinaai` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/jinaai/embeddings-multimodal)
for detailed usage.
Args:
name: The name of the named vector.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
model: The model to use. Defaults to `None`, which uses the server-defined default.
base_url: The base URL to use where API requests should go. Defaults to `None`, which uses the server-defined default.
dimensions: The number of dimensions for the generated embeddings (only available for some models). Defaults to `None`, which uses the server-defined default.
image_fields: The image fields to use in vectorization.
text_fields: The text fields to use in vectorization.
Raises:
pydantic.ValidationError: If `model` is not a valid value from the `JinaMultimodalModel` type.
"""
return _NamedVectorConfigCreate(
name=name,
vectorizer=_Multi2VecJinaConfig(
baseURL=base_url,
model=model,
dimensions=dimensions,
imageFields=_map_multi2vec_fields(image_fields),
textFields=_map_multi2vec_fields(text_fields),
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def text2vec_voyageai(
name: str,
*,
model: Optional[Union[VoyageModel, str]] = None,
base_url: Optional[str] = None,
truncate: Optional[bool] = None,
source_properties: Optional[List[str]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `text2vec-jinaai` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/voyageai/embeddings)
for detailed usage.
Args:
name: The name of the named vector.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
model: The model to use. Defaults to `None`, which uses the server-defined default.
See the
[documentation](https://weaviate.io/developers/weaviate/model-providers/voyageai/embeddings#available-models) for more details.
base_url: The base URL to use where API requests should go. Defaults to `None`, which uses the server-defined default.
truncate: Whether to truncate the input texts to fit within the context length. Defaults to `None`, which uses the server-defined default.
"""
return _NamedVectorConfigCreate(
name=name,
source_properties=source_properties,
vectorizer=_Text2VecVoyageConfig(
model=model,
vectorizeClassName=vectorize_collection_name,
baseURL=base_url,
truncate=truncate,
dimensions=None,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def text2vec_weaviate(
name: str,
*,
model: Optional[Union[WeaviateModel, str]] = None,
base_url: Optional[str] = None,
dimensions: Optional[int] = None,
source_properties: Optional[List[str]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
return _NamedVectorConfigCreate(
name=name,
source_properties=source_properties,
vectorizer=_Text2VecWeaviateConfig(
model=model,
vectorizeClassName=vectorize_collection_name,
baseURL=base_url,
dimensions=dimensions,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def text2vec_nvidia(
name: str,
*,
model: Optional[str] = None,
base_url: Optional[str] = None,
truncate: Optional[bool] = None,
source_properties: Optional[List[str]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `text2vec-nvidia` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/nvidia/embeddings)
for detailed usage.
Args:
name: The name of the named vector.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
model: The model to use. Defaults to `None`, which uses the server-defined default.
See the
[documentation](https://weaviate.io/developers/weaviate/model-providers/nvidia/embeddings#available-models) for more details.
base_url: The base URL to use where API requests should go. Defaults to `None`, which uses the server-defined default.
truncate: Whether to truncate the input texts to fit within the context length. Defaults to `None`, which uses the server-defined default.
"""
return _NamedVectorConfigCreate(
name=name,
source_properties=source_properties,
vectorizer=_Text2VecNvidiaConfig(
model=model,
vectorizeClassName=vectorize_collection_name,
baseURL=base_url,
truncate=truncate,
),
vector_index_config=vector_index_config,
)
[docs]
@staticmethod
def text2vec_model2vec(
name: str,
*,
source_properties: Optional[List[str]] = None,
vector_index_config: Optional[_VectorIndexConfigCreate] = None,
vectorize_collection_name: bool = True,
inference_url: Optional[str] = None,
) -> _NamedVectorConfigCreate:
"""Create a named vector using the `text2vec-model2vec` model.
See the [documentation](https://weaviate.io/developers/weaviate/model-providers/model2vec/embeddings)
for detailed usage.
Args:
name: The name of the named vector.
source_properties: Which properties should be included when vectorizing. By default all text properties are included.
vector_index_config: The configuration for Weaviate's vector index. Use wvc.config.Configure.VectorIndex to create a vector index configuration. None by default
vectorize_collection_name: Whether to vectorize the collection name. Defaults to `True`.
inference_url: The inference url to use where API requests should go. Defaults to `None`, which uses the server-defined default.
"""
return _NamedVectorConfigCreate(
name=name,
source_properties=source_properties,
vectorizer=_Text2VecModel2VecConfig(
vectorizeClassName=vectorize_collection_name,
inferenceUrl=inference_url,
),
vector_index_config=vector_index_config,
)
[docs]
class _NamedVectorsUpdate:
[docs]
@staticmethod
def update(
name: str,
*,
vector_index_config: Union[
_VectorIndexConfigHNSWUpdate,
_VectorIndexConfigHFreshUpdate,
_VectorIndexConfigFlatUpdate,
_VectorIndexConfigDynamicUpdate,
],
) -> _NamedVectorConfigUpdate:
"""Update the vector index configuration of a named vector.
This is the only update operation allowed currently. If you wish to change the vectorization configuration itself, you will have to
recreate the collection with the new configuration.
Args:
name: The name of the named vector.
vector_index_config: The configuration for Weaviate's vector index. Use `wvc.config.Reconfigure.VectorIndex` to create a vector index configuration. `None` by default
"""
return _NamedVectorConfigUpdate(
name=name,
vector_index_config=vector_index_config,
)