nat.embedder.huggingface_embedder

Classes

HuggingFaceEmbedderConfig

HuggingFace embedder provider for local and remote embedding generation.

Functions

huggingface_embedder_provider(config, _builder)

Register HuggingFace embedder as a provider.

Module Contents

class HuggingFaceEmbedderConfig

Bases: nat.data_models.embedder.EmbedderBaseConfig, nat.data_models.retry_mixin.RetryMixin

HuggingFace embedder provider for local and remote embedding generation.

When endpoint_url is provided, connects to a remote TEI server or HuggingFace Inference Endpoint. Otherwise, loads models locally via the sentence-transformers library.

model_config

model_name: str | None = None

endpoint_url: str | None = None

api_key: nat.data_models.common.OptionalSecretStr = None

timeout: float = None

device: str = None

normalize_embeddings: bool = None

batch_size: int = None

max_seq_length: int | None = None

trust_remote_code: bool = None

validate_mode()

Ensure either model_name (local) or endpoint_url (remote) is provided.

async huggingface_embedder_provider(

config: HuggingFaceEmbedderConfig,

_builder: nat.builder.builder.Builder,

)

Register HuggingFace embedder as a provider.