Metadata-Version: 2.4
Name: llama-index-embeddings-huggingface-api
Version: 0.3.1
Summary: llama-index embeddings huggingface api integration
Author-email: Your Name <you@example.com>
License-Expression: MIT
License-File: LICENSE
Requires-Python: <4.0,>=3.9
Requires-Dist: huggingface-hub[inference]>=0.31.0
Requires-Dist: llama-index-core<0.13,>=0.12.0
Requires-Dist: llama-index-utils-huggingface<0.4,>=0.3.0
Description-Content-Type: text/markdown

# LlamaIndex Embeddings Integration: Huggingface API

Integration with Hugging Face's Inference API for embeddings.

For more information on Hugging Face's Inference API, visit [Hugging Face's Inference API documentation](https://huggingface.co/docs/api-inference/quicktour).

## Installation

```shell
pip install llama-index-embeddings-huggingface-api
```

## Usage

```python
from llama_index.embeddings.huggingface_api import (
    HuggingFaceInferenceAPIEmbedding,
)

my_embed = HuggingFaceInferenceAPIEmbedding(
    model_name="BAAI/bge-small-en-v1.5",
    token="<your-token>",  # Optional
)

embeddings = my_embed.get_text_embedding("Why sky is blue")
```
