huggingface: fix model param population

[keenborder786]

• Description: Fix the validation error for endpoint_url for HuggingFaceEndpoint. I have given a descriptive detail of the isse in the issue that I have created.
• Issue: HuggingFaceEndpoint Endpoint URL validation Error #24742

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
langchain	⬜️ Ignored (Inspect)	Visit Preview		Aug 24, 2024 0:39am

[keenborder786]

@eyurtsev, @ccurme please review

[eyurtsev]

Could you update the doc-string for the wrapper to explain which variables can be specified?

---

I haven't used this wrapper, but the new code does not behave correctly as far as I can tell. If repo_id is not strictly necessary for initializaiton, then a user may be relying on endpoint_url being specified via an env variable. This scenario will cause a validation error right now.

I am trying to initialize the HuggingFaceEndpoint, but despite passing the correct repo_id, I am encountering an error. I have identified the bug: even though I provide the repo_id, the HuggingFaceEndpoint validation always checks for the endpoint_url, which is incorrect. If the repo_id is passed, it should not be checking for the endpoint_url. I will create a PR to fix this issue.

Old validation does not seem to be checking endpoint_url, it seems to be loading it from the environment by default.

Possible solutions:

1. Throw an error if both values can be loaded
2. Only try to load_endpoint url after repo_id is missing and only then do the check that at least one of them is specified (this is still too implicit -- so bad solution)
3. Change precedence order if it's obvious that repo_id should be favored over endpoint_url (too implicit -- so bad solution)

[keenborder786]

• I have updated the wrapper's docstring.

• Previously, the endpoint_url was first checked from environment variables. If the endpoint_url was not set as an environment variable and only repo_id was provided, an error would occur despite the repo_id being passed. I have now revised this behavior so that the code first checks whether the user has provided a repo_id or endpoint_url directly. Only after that, if repo_id is not provided will it then retrieve the values from the environment variables.

• See below please.

llm = HuggingFaceEndpoint(
                repo_id="microsoft/Phi-3-mini-4k-instruct", # user intend to use repo_id but validation error will be raised
for `endpoint_url` env variable missing which is wrong since user has passed repo_id
                huggingfacehub_api_token = 'xxxxxx',
                task="text-generation",
                max_new_tokens=512,
                do_sample=False,
                repetition_penalty=1.03,
            )

[eyurtsev]

Left a PR explaining the fix. The current fix introduces another bug in a situation where a user is relying for the endpoint URL to be loaded from the env

[keenborder786]

@eyurtsev will have a look

[eyurtsev]

We lost validation on repo_id being unspecified and endpoint_url being unspecified

[keenborder786]

Nope, the validation is happening above. See Line 149. @eyurtsev

[keenborder786]

@eyurtsev please see

[keenborder786]

@ccurme

[keenborder786]

@ccurme @hwchase17

fixed

[efriis]

ended up rewriting the implementation to also include the model param. This is a lightly breaking change but only for people that were incorrectly populating the model param as well as others, which was likely done by mistake.