| Name | llama-index-embeddings-huggingface-api JSON |
| Version |
0.2.1
JSON |
| download |
| home_page | None |
| Summary | llama-index embeddings huggingface api integration |
| upload_time | 2024-09-17 05:48:46 |
| maintainer | None |
| docs_url | None |
| author | Your Name |
| requires_python | <4.0,>=3.8.1 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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")
```
Raw data
{
"_id": null,
"home_page": null,
"name": "llama-index-embeddings-huggingface-api",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8.1",
"maintainer_email": null,
"keywords": null,
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/69/67/7c05c792a5c38e20c2b95f356ad1ea80f23c40cabc410d300a47aa62278a/llama_index_embeddings_huggingface_api-0.2.1.tar.gz",
"platform": null,
"description": "# LlamaIndex Embeddings Integration: Huggingface API\n\nIntegration with Hugging Face's Inference API for embeddings.\n\nFor more information on Hugging Face's Inference API, visit [Hugging Face's Inference API documentation](https://huggingface.co/docs/api-inference/quicktour).\n\n## Installation\n\n```shell\npip install llama-index-embeddings-huggingface-api\n```\n\n## Usage\n\n```python\nfrom llama_index.embeddings.huggingface_api import (\n HuggingFaceInferenceAPIEmbedding,\n)\n\nmy_embed = HuggingFaceInferenceAPIEmbedding(\n model_name=\"BAAI/bge-small-en-v1.5\",\n token=\"<your-token>\", # Optional\n)\n\nembeddings = my_embed.get_text_embedding(\"Why sky is blue\")\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index embeddings huggingface api integration",
"version": "0.2.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ff61d5e9db46bef3ff28d40ca91b17699f36bbb459611626ba794abe25eda7f7",
"md5": "57c812272b27b70d650d0d9909da9a28",
"sha256": "fbffcaf84d47694a7819a1bfb4aef951e61644f07c7cd347462ee7395f7f12e7"
},
"downloads": -1,
"filename": "llama_index_embeddings_huggingface_api-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "57c812272b27b70d650d0d9909da9a28",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8.1",
"size": 5226,
"upload_time": "2024-09-17T05:48:44",
"upload_time_iso_8601": "2024-09-17T05:48:44.984633Z",
"url": "https://files.pythonhosted.org/packages/ff/61/d5e9db46bef3ff28d40ca91b17699f36bbb459611626ba794abe25eda7f7/llama_index_embeddings_huggingface_api-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "69677c05c792a5c38e20c2b95f356ad1ea80f23c40cabc410d300a47aa62278a",
"md5": "9e65ca72c0da8f9ca1a3e7a3e874203f",
"sha256": "6602901aab20c212f2a20b3078dc747e121d58026a8dc4ea7c3b76f825a00c4b"
},
"downloads": -1,
"filename": "llama_index_embeddings_huggingface_api-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "9e65ca72c0da8f9ca1a3e7a3e874203f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8.1",
"size": 4484,
"upload_time": "2024-09-17T05:48:46",
"upload_time_iso_8601": "2024-09-17T05:48:46.335413Z",
"url": "https://files.pythonhosted.org/packages/69/67/7c05c792a5c38e20c2b95f356ad1ea80f23c40cabc410d300a47aa62278a/llama_index_embeddings_huggingface_api-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-17 05:48:46",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-embeddings-huggingface-api"
}
