安装

最简单的安装方式是通过 pip 和 PyPI

pip install txtai

支持 Python 3.9+。建议使用 Python 虚拟环境。

可选依赖项

txtai 有以下可选依赖项，可以通过 extras 安装。以下模式在 setup.py 的 install_requires 部分中受支持。

注意：Extras 是为了方便而提供的。或者，可以单独安装各个包以限制依赖项。

全部

安装所有依赖项。

pip install txtai[all]

ANN

额外的 ANN 后端。

pip install txtai[ann]

API

通过 Web API 提供 txtai 服务。

pip install txtai[api]

云

与云计算接口。

pip install txtai[cloud]

控制台

命令行索引查询控制台。

pip install txtai[console]

数据库

额外的内容存储选项。

pip install txtai[database]

图

主题建模、数据连接和网络分析。

pip install txtai[graph]

模型

额外的非标准模型。

pip install txtai[model]

管道

所有管道 - 默认安装包含大多数常见管道。

pip install txtai[pipeline]

对于管道类别，有更细粒度的 extras 可用：pipeline-audio、pipeline-data、pipeline-image、pipeline-llm、pipeline-text 和 pipeline-train。

评分

额外的评分方法。

pip install txtai[scoring]

向量

额外的向量方法。

pip install txtai[vectors]

工作流

所有工作流任务 - 默认安装包含大多数常见工作流任务。

pip install txtai[workflow]

组合依赖项

可以同时指定多个依赖项。

pip install txtai[pipeline,workflow]

特定环境的前提条件

以下是特定环境的额外前提条件。

Linux

AudioStream 和 Microphone 管道需要 PortAudio 系统库。Transcription 管道需要 SoundFile 系统库。

macOS

旧版本的 Faiss 在 macOS 上有一个运行时依赖于 libomp。在这种情况下运行 brew install libomp。

AudioStream 和 Microphone 管道需要 PortAudio 系统库。运行 brew install portaudio。

Windows

可选依赖项需要 C++ Build Tools

txtai 构建工作流 偶尔会有针对其他已知但临时的依赖问题的解决方法。FAQ 还列出了常见问题，包括常见的安装问题。

仅 CPU

默认安装添加了支持 GPU 的 PyTorch。这带来了许多依赖项。当在仅 CPU 环境中运行或使用不带 PyTorch 的 Embeddings/LLM 模型（例如 llama.cpp 或 API 服务）时，可以通过以下方式安装仅 CPU 的 PyTorch 包和 txtai。

pip install txtai torch==[version]+cpu \
-f https://download.pytorch.org/whl/torch

其中 [version] 是 PyTorch 的版本（例如 2.4.1）。Docker Hub 上的 txtai-cpu 镜像使用此方法来减小镜像大小。

从源代码安装

txtai 也可以直接从 GitHub 安装，以访问最新的、未发布的功能。

pip install git+https://github.com/neuml/txtai

可以通过在上述 URL 末尾添加 #egg=txtai[<name-of-extra>] 来从 GitHub 安装 extras。

Conda

社区支持的 txtai 包 可通过 conda-forge 获得。

conda install -c conda-forge txtai

使用容器运行

txtai 的 Docker 镜像可用。参见此部分 了解更多关于基于容器的安装信息。