安装

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

pip install txtai

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

可选依赖项

txtai 具有以下可选依赖项，可以作为额外项安装。setup.py 的 install_requires 部分支持以下模式。

注意：提供额外项是为了方便。另外，也可以安装单个包以限制依赖项。

全部

安装所有依赖项。

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]

针对流水线类别提供了更精细的额外项：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 构建工作流 偶尔会包含变通方案。常见问题 也有常见问题列表，包括常见的安装问题。

仅 CPU

默认安装会添加支持 GPU 的 PyTorch。这会带来一些依赖项。在仅 CPU 环境中运行或使用不依赖 PyTorch 的嵌入/LLM 模型（例如 llama.cpp 或 API 服务）时，可以按如下方式与 txtai 一起安装仅 CPU 的 PyTorch 包。

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

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

从源代码安装

还可以直接从 GitHub 安装 txtai 以获取最新的未发布功能。

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

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

Conda

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

conda install -c conda-forge txtai

使用容器运行

txtai 提供 Docker 镜像。请参阅本节，了解有关基于容器安装的更多信息。