项目介绍:create-tsi
create-tsi 是一个由 Deutsche Telekom AG, LlamaIndex 和 Vercel, Inc. 共同开发的生成式 AI RAG 工具包。它主要用于通过 LlamaIndex 以低代码的方式生成 AI 应用程序。
这些通过 create-tsi 生成的 AI 应用程序,使用了由 T-Systems 托管在 Open Telekom Cloud 上的 LLMs(大型语言模型)。
项目目标
create-tsi 的目标是让 AI 应用程序的创建过程变得简单、灵活且快速。使用 create-tsi,可以生成聊天机器人、编写智能代理,并根据特定的使用场景进行定制。
使用说明
要开始使用 create-tsi,首先需要获取一个 T-Systems 的 API 密钥。可以通过 此表单 请求获取试用权限。
一旦获得密钥,只需在终端运行以下命令即可开始:
npx create-tsi@latest
应用生成后,可以查看生成的 README.md
文件来启动你的应用。
你将获得什么?
- Next.js 支持的前端:应用被设置为一个聊天界面,可以回答关于你所输入的数据信息。
- Python FastAPI 后端:你将获得一个由 llama-index python package 支持的后端。
- 后端包含一个单一的端点,允许你发送聊天状态并接收附加响应。
自定义数据使用
除非选择生成一个简单的聊天接口,否则可以提供自己的数据。应用将对其进行索引,并能够回答关于这些数据的问题。
生成的应用会在 backend
目录中包含一个名为 data
的文件夹。应用会读取你放入该文件夹的所有支持的文件格式。
示例操作
最简单的操作方式是以交互模式运行 create-tsi:
npx create-tsi@latest
# 或者
npm create tsi@latest
# 或者
yarn create tsi
# 或者
pnpm create tsi@latest
此时会询问你项目的名称及其他配置选项,例如:
>> npm create-tsi@latest
✔ What is your project named? … my-app
✔ Would you like to generate a NextJS frontend for your FastAPI (Python) backend? … No / Yes
✔ Please provide your T-Systems API key (or reuse TSI_API_KEY env variable): …
✔ Which model would you like to use? › Mixtral-8x7B-Instruct-v0.1
✔ Which embedding model would you like to use? › paraphrase-multilingual-mpnet-base-v2
? Which data source would you like to use? › - Use arrow-keys. Return to submit.
No data, just a simple chat
❯ Use an example PDF
Use local files (.pdf, .doc, .docx, .xls, .xlsx, .csv)
Use local folders
Use website content (requires Chrome)
Use data from a database (Mysql)
行为准则
此项目采用了 Contributor Covenant 2.1 版本作为其行为准则。参与此项目时需始终遵守 CODE_OF_CONDUCT.md 中的条款。
授权信息
该项目遵循 REUSE 软件授权标准。
每个文件都包含版权及许可信息,许可证文本可在 ./LICENSES 文件夹中找到。详细信息请访问 https://reuse.software/。
开发者指南可查看 https://telekom.github.io/reuse-template/。
要为文件添加授权信息,可以运行以下命令:
pipx run reuse annotate --copyright="Deutsche Telekom AG, LlamaIndex, Vercel, Inc." --license="MIT" --recursive --fallback-dot-license --skip-existing .
LlamaIndex 文档
此工具包的灵感来源并改编自 create-next-app。