https://github.com/neuml/txtai.py

Python client for txtai
https://github.com/neuml/txtai.py

machine-learning nlp python search

Last synced: 2 months ago
JSON representation

Python client for txtai

• Host: GitHub
• URL: https://github.com/neuml/txtai.py
• Owner: neuml
• License: apache-2.0
• Created: 2023-12-22T16:49:20.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2025-06-10T14:11:03.000Z (7 months ago)
• Last Synced: 2025-07-07T10:36:00.571Z (6 months ago)
• Topics: machine-learning, nlp, python, search
• Language: Python
• Homepage:
• Size: 25.4 KB
• Stars: 15
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


    





    Python client for txtai





    

        

    

    

        

    

    

        

    

    

        

    



[txtai](https://github.com/neuml/txtai) is an all-in-one AI framework 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

```