Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Embedders list token as mandatory init parameter although it is optional #8762

Closed
julian-risch opened this issue Jan 22, 2025 · 1 comment
Closed
Assignees
Labels
P2 Medium priority, add to the next sprint if no P1 available type:documentation Improvements on the docs

Comments

@julian-risch
Copy link
Member

julian-risch commented Jan 22, 2025

Several embedders list token as mandatory init parameter although it is optional

We should remove the row containing mandatory init parameters for those four embedders.

The text description could also be more clear.

The component uses a HF_API_TOKEN environment variable by default. Otherwise, you can pass a Hugging Face API token at initialization with token:

Only if the user tries to access a private model or public but gated, the component uses a HF_API_TOKEN environment variable by default or a secret explicitly provided by the user.

@julian-risch julian-risch added type:documentation Improvements on the docs P2 Medium priority, add to the next sprint if no P1 available labels Jan 22, 2025
@anakin87
Copy link
Member

Agree!

Some additions:

  • all components based on Hugging Face should support both HF_API_TOKEN and HF_TOKEN enviroment variables
  • the token is not only required for private models, but also for public but gated models (e.g models from Meta, Google, Mistral... an example: https://huggingface.co/meta-llama/Llama-3.1-8B-Instruct)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P2 Medium priority, add to the next sprint if no P1 available type:documentation Improvements on the docs
Projects
None yet
Development

No branches or pull requests

3 participants