HuggingFaceEndpointEmbeddings Class — langchain Architecture

Source Code

libs/partners/huggingface/langchain_huggingface/embeddings/huggingface_endpoint.py lines 15–172

class HuggingFaceEndpointEmbeddings(BaseModel, Embeddings):
    """HuggingFaceHub embedding models.

    To use, you should have the `huggingface_hub` python package installed, and the
    environment variable `HUGGINGFACEHUB_API_TOKEN` set with your API token, or pass
    it as a named parameter to the constructor.

    Example:
        ```python
        from langchain_huggingface import HuggingFaceEndpointEmbeddings

        model = "sentence-transformers/all-mpnet-base-v2"
        hf = HuggingFaceEndpointEmbeddings(
            model=model,
            task="feature-extraction",
            huggingfacehub_api_token="my-api-key",
        )
        ```
    """

    client: Any = None

    async_client: Any = None

    model: str | None = None
    """Model name to use."""

    provider: str | None = None
    """Name of the provider to use for inference with the model specified in
        `repo_id`. e.g. "sambanova". if not specified, defaults to HF Inference API.
        available providers can be found in the [huggingface_hub documentation](https://huggingface.co/docs/huggingface_hub/guides/inference#supported-providers-and-tasks)."""

    repo_id: str | None = None
    """Huggingfacehub repository id, for backward compatibility."""

    task: str | None = "feature-extraction"
    """Task to call the model with."""

    model_kwargs: dict | None = None
    """Keyword arguments to pass to the model."""

    huggingfacehub_api_token: str | None = Field(
        default_factory=from_env("HUGGINGFACEHUB_API_TOKEN", default=None)
    )

    model_config = ConfigDict(
        extra="forbid",
        protected_namespaces=(),
    )

    @model_validator(mode="after")
    def validate_environment(self) -> Self:
        """Validate that api key and python package exists in environment."""
        huggingfacehub_api_token = self.huggingfacehub_api_token or os.getenv(
            "HF_TOKEN"
        )

        try:
            from huggingface_hub import (  # type: ignore[import]
                AsyncInferenceClient,
                InferenceClient,
            )

            if self.model:
                self.repo_id = self.model
            elif self.repo_id:
                self.model = self.repo_id
            else:
                self.model = DEFAULT_MODEL
                self.repo_id = DEFAULT_MODEL

            client = InferenceClient(
                model=self.model,
                token=huggingfacehub_api_token,
                provider=self.provider,  # type: ignore[arg-type]
            )

            async_client = AsyncInferenceClient(
                model=self.model,
                token=huggingfacehub_api_token,
                provider=self.provider,  # type: ignore[arg-type]