# mixedbread ai Python SDK
## Introduction to mixedbread ai
mixedbread ai is a cutting-edge research and development company specializing in Natural Language Processing (NLP). At our core, we focus on advancing the field of NLP through innovative research, offering powerful tools for embeddings, retrieval, and other NLP functionalities. Our mission is to make NLP accessible to everyone on every device. To learn more about mixedbread ai, visit our [website](https://mixedbread.ai/).
## Requirements.
Python 3.7+
## Installation & Usage
### Installation
If the python package is hosted on a repository, you can install directly using:
```sh
pip install mixedbread_ai
```
### Usage
```python
from mixedbread_ai import MixedbreadAi
import os
os.environ["MIXEDBREAD_API_KEY"] = "{YOUR_API_KEY}"
mxbai = MixedbreadAi()
embeddings = mxbai.embeddings(
model="e5-large-v2",
input=["I like to eat apples.", "I like to eat bananas."]
)
print(embeddings)
```
Alternatively, you can set the api key via configuration:
```python
from mixedbread_ai import MixedbreadAi
mxbai = MixedbreadAi(
api_key="{YOUR_API_KEY}",
base_url="https://api.mixedbread.ai",
timeout=30,
headers={"X-Custom-Header": "foobar"},
...
)
embeddings = mxbai.embeddings(
model="e5-large-v2",
input=["I like to eat apples.", "I like to eat bananas."],
normalized=False
)
print(embeddings)
```
Don't forget to replace `"{YOUR_API_KEY}"` with your actual API key. If you don't have an API key, you can get one for free by signing up for an account at [mixedbread.ai](https://mixedbread.ai/).
Raw data
{
"_id": null,
"home_page": "https://github.com/mixedbread-ai/python-sdk.git",
"name": "mixedbread_ai",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "Embeddings,NLP,mixedbread.ai",
"author": "mixedbread.ai",
"author_email": "support@mixedbread.ai",
"download_url": "https://files.pythonhosted.org/packages/8f/6f/5843590a6487755a670404e1d8df455c9fb53528dbbf229da590888c4f97/mixedbread_ai-1.2.4.tar.gz",
"platform": null,
"description": "# mixedbread ai Python SDK\n\n## Introduction to mixedbread ai\nmixedbread ai is a cutting-edge research and development company specializing in Natural Language Processing (NLP). At our core, we focus on advancing the field of NLP through innovative research, offering powerful tools for embeddings, retrieval, and other NLP functionalities. Our mission is to make NLP accessible to everyone on every device. To learn more about mixedbread ai, visit our [website](https://mixedbread.ai/).\n\n## Requirements.\nPython 3.7+\n\n## Installation & Usage\n### Installation\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install mixedbread_ai\n```\n\n### Usage\n\n```python\nfrom mixedbread_ai import MixedbreadAi\nimport os\nos.environ[\"MIXEDBREAD_API_KEY\"] = \"{YOUR_API_KEY}\"\n\nmxbai = MixedbreadAi()\nembeddings = mxbai.embeddings(\n model=\"e5-large-v2\",\n input=[\"I like to eat apples.\", \"I like to eat bananas.\"]\n)\n\nprint(embeddings)\n```\n\nAlternatively, you can set the api key via configuration:\n```python\nfrom mixedbread_ai import MixedbreadAi\n\nmxbai = MixedbreadAi(\n api_key=\"{YOUR_API_KEY}\",\n base_url=\"https://api.mixedbread.ai\",\n timeout=30,\n headers={\"X-Custom-Header\": \"foobar\"},\n ...\n)\nembeddings = mxbai.embeddings(\n model=\"e5-large-v2\",\n input=[\"I like to eat apples.\", \"I like to eat bananas.\"],\n normalized=False\n)\n\nprint(embeddings)\n```\n\nDon't forget to replace `\"{YOUR_API_KEY}\"` with your actual API key. If you don't have an API key, you can get one for free by signing up for an account at [mixedbread.ai](https://mixedbread.ai/).",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "mixedbread ai (https://www.mixedbread.ai)",
"version": "1.2.4",
"project_urls": {
"Homepage": "https://github.com/mixedbread-ai/python-sdk.git",
"Repository": "https://github.com/mixedbread-ai/python-sdk.git"
},
"split_keywords": [
"embeddings",
"nlp",
"mixedbread.ai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d47eca55d486667e5506ede83fcfb6c22cdb1ad794dcdd5ac2d5e723feaed937",
"md5": "974fd13be1a48ec8208001d463ec1064",
"sha256": "f3c81fd4184c7c478f8f36229e3b9facdb0d84091f94201722f6c5b71018afac"
},
"downloads": -1,
"filename": "mixedbread_ai-1.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "974fd13be1a48ec8208001d463ec1064",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 19954,
"upload_time": "2024-01-28T10:21:06",
"upload_time_iso_8601": "2024-01-28T10:21:06.901658Z",
"url": "https://files.pythonhosted.org/packages/d4/7e/ca55d486667e5506ede83fcfb6c22cdb1ad794dcdd5ac2d5e723feaed937/mixedbread_ai-1.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8f6f5843590a6487755a670404e1d8df455c9fb53528dbbf229da590888c4f97",
"md5": "a3f7428b1391c8528d6a7a398f019649",
"sha256": "bdbf3336ae070bf04acabaa62611579be9542bc3cb7fffedf7bc50b5c27e7666"
},
"downloads": -1,
"filename": "mixedbread_ai-1.2.4.tar.gz",
"has_sig": false,
"md5_digest": "a3f7428b1391c8528d6a7a398f019649",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 13059,
"upload_time": "2024-01-28T10:21:08",
"upload_time_iso_8601": "2024-01-28T10:21:08.570187Z",
"url": "https://files.pythonhosted.org/packages/8f/6f/5843590a6487755a670404e1d8df455c9fb53528dbbf229da590888c4f97/mixedbread_ai-1.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-28 10:21:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mixedbread-ai",
"github_project": "python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mixedbread_ai"
}
JSON
