<p align="center">
<img src="https://raw.githubusercontent.com/neuml/txtai/master/logo.png"/>
</p>
<p align="center">
<b>Python client for txtai</b>
</p>
<p align="center">
<a href="https://github.com/neuml/txtai.py/releases">
<img src="https://img.shields.io/github/release/neuml/txtai.py.svg?style=flat&color=success" alt="Version"/>
</a>
<a href="https://github.com/neuml/txtai.py/releases">
<img src="https://img.shields.io/github/release-date/neuml/txtai.py.svg?style=flat&color=blue" alt="GitHub Release Date"/>
</a>
<a href="https://github.com/neuml/txtai.py/issues">
<img src="https://img.shields.io/github/issues/neuml/txtai.py.svg?style=flat&color=success" alt="GitHub Issues"/>
</a>
<a href="https://github.com/neuml/txtai.py">
<img src="https://img.shields.io/github/last-commit/neuml/txtai.py.svg?style=flat&color=blue" alt="GitHub Last Commit"/>
</a>
</p>
[txtai](https://github.com/neuml/txtai) is an all-in-one embeddings database for semantic search, LLM orchestration and language model workflows.
This repository contains Python bindings for the txtai API. This is a minimal dependency library for Python designed for use cases where txtai is running through the API. In all other cases, txtai should be installed directly.
## Installation
txtai.py can be installed via PyPI
pip install txtai.py
## Examples
The examples directory has a series of examples that give an overview of txtai. See the list of examples below.
| Example | Description |
|:----------|:-------------|
| [Introducing txtai](https://github.com/neuml/txtai.py/blob/master/examples/embeddings.py) | Overview of the functionality provided by txtai |
| [Extractive QA with txtai](https://github.com/neuml/txtai.py/blob/master/examples/extractor.py) | Extractive question-answering with txtai |
| [Labeling with zero-shot classification](https://github.com/neuml/txtai.py/blob/master/examples/labels.py) | Labeling with zero-shot classification |
| [Pipelines and workflows](https://github.com/neuml/txtai.py/blob/master/examples/pipelines.py) | Pipelines and workflows |
txtai.py connects to a txtai api instance. See [this link](https://neuml.github.io/txtai/api/) for details on how to start a new api instance.
Once an api instance is running, do the following to run the examples.
```
git clone https://github.com/neuml/txtai.py
cd txtai.py/examples
python embeddings.py
python extractor.py
python labels.py
python pipelines.py
```
Raw data
{
"_id": null,
"home_page": "https://github.com/neuml/txtai.py",
"name": "txtai.py",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "search embedding machine-learning nlp",
"author": "NeuML",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/af/a6/f64f5622e89cb80995c73b94d4c1f8ff4894cc28b4d564fd3cba64075f82/txtai.py-6.3.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/neuml/txtai/master/logo.png\"/>\n</p>\n\n<p align=\"center\">\n <b>Python client for txtai</b>\n</p>\n\n<p align=\"center\">\n <a href=\"https://github.com/neuml/txtai.py/releases\">\n <img src=\"https://img.shields.io/github/release/neuml/txtai.py.svg?style=flat&color=success\" alt=\"Version\"/>\n </a>\n <a href=\"https://github.com/neuml/txtai.py/releases\">\n <img src=\"https://img.shields.io/github/release-date/neuml/txtai.py.svg?style=flat&color=blue\" alt=\"GitHub Release Date\"/>\n </a>\n <a href=\"https://github.com/neuml/txtai.py/issues\">\n <img src=\"https://img.shields.io/github/issues/neuml/txtai.py.svg?style=flat&color=success\" alt=\"GitHub Issues\"/>\n </a>\n <a href=\"https://github.com/neuml/txtai.py\">\n <img src=\"https://img.shields.io/github/last-commit/neuml/txtai.py.svg?style=flat&color=blue\" alt=\"GitHub Last Commit\"/>\n </a>\n</p>\n\n[txtai](https://github.com/neuml/txtai) is an all-in-one embeddings database for semantic search, LLM orchestration and language model workflows.\n\nThis repository contains Python bindings for the txtai API. This is a minimal dependency library for Python designed for use cases where txtai is running through the API. In all other cases, txtai should be installed directly.\n\n## Installation\ntxtai.py can be installed via PyPI\n\n pip install txtai.py\n\n## Examples\nThe examples directory has a series of examples that give an overview of txtai. See the list of examples below.\n\n| Example | Description |\n|:----------|:-------------|\n| [Introducing txtai](https://github.com/neuml/txtai.py/blob/master/examples/embeddings.py) | Overview of the functionality provided by txtai |\n| [Extractive QA with txtai](https://github.com/neuml/txtai.py/blob/master/examples/extractor.py) | Extractive question-answering with txtai |\n| [Labeling with zero-shot classification](https://github.com/neuml/txtai.py/blob/master/examples/labels.py) | Labeling with zero-shot classification |\n| [Pipelines and workflows](https://github.com/neuml/txtai.py/blob/master/examples/pipelines.py) | Pipelines and workflows |\n\ntxtai.py connects to a txtai api instance. See [this link](https://neuml.github.io/txtai/api/) for details on how to start a new api instance.\n\nOnce an api instance is running, do the following to run the examples.\n\n```\ngit clone https://github.com/neuml/txtai.py\ncd txtai.py/examples\npython embeddings.py\npython extractor.py\npython labels.py\npython pipelines.py\n```\n",
"bugtrack_url": null,
"license": "Apache 2.0: http://www.apache.org/licenses/LICENSE-2.0",
"summary": "Python client for txtai",
"version": "6.3.0",
"project_urls": {
"Documentation": "https://github.com/neuml/txtai.py",
"Homepage": "https://github.com/neuml/txtai.py",
"Issue Tracker": "https://github.com/neuml/txtai.py/issues",
"Source Code": "https://github.com/neuml/txtai.py"
},
"split_keywords": [
"search",
"embedding",
"machine-learning",
"nlp"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ffa9a5dead9610058b9e18802bf7f13c99d87f0f64e62f0080d8cbc9b1b36a59",
"md5": "d18d9e6afa307d2964aaab0804eb7b8a",
"sha256": "58e714f901d3203ace6f17e480a7f3c0aa3039e8032be9e5e9986e1eebd17e2f"
},
"downloads": -1,
"filename": "txtai.py-6.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d18d9e6afa307d2964aaab0804eb7b8a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 12986,
"upload_time": "2024-01-02T18:12:36",
"upload_time_iso_8601": "2024-01-02T18:12:36.712258Z",
"url": "https://files.pythonhosted.org/packages/ff/a9/a5dead9610058b9e18802bf7f13c99d87f0f64e62f0080d8cbc9b1b36a59/txtai.py-6.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "afa6f64f5622e89cb80995c73b94d4c1f8ff4894cc28b4d564fd3cba64075f82",
"md5": "195c06ce836452ca292b9f7fd2ae9a1c",
"sha256": "d3dcfe3ec942d633eb1415dbaf2b80ef8a9ed40687b1ca9df421441a28dfcda9"
},
"downloads": -1,
"filename": "txtai.py-6.3.0.tar.gz",
"has_sig": false,
"md5_digest": "195c06ce836452ca292b9f7fd2ae9a1c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11111,
"upload_time": "2024-01-02T18:12:38",
"upload_time_iso_8601": "2024-01-02T18:12:38.315158Z",
"url": "https://files.pythonhosted.org/packages/af/a6/f64f5622e89cb80995c73b94d4c1f8ff4894cc28b4d564fd3cba64075f82/txtai.py-6.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-02 18:12:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "neuml",
"github_project": "txtai.py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "txtai.py"
}
JSON
