Promptify

环境要求

• Python 3.9 或更高版本
• 可用的 pip 包管理工具
• 访问 PyPI 或 GitHub 的网络环境
• 可选：需要评估指标支持时安装 promptify[eval]

安装与启动步骤

1. 1确认 Python 版本

   Promptify 要求 Python 3.9+，先确认本机 Python 版本满足要求，否则先升级 Python。

   python --version

   复制

2. 2通过 pip 安装

   README 推荐的标准安装方式，从 PyPI 拉取并安装 Promptify 及其依赖。

   pip install promptify

   复制

3. 3或从 GitHub 安装

   想使用仓库最新代码时，可直接从 GitHub 源码安装，与上一步二选一。

   pip install git+https://github.com/promptslab/Promptify.git

   复制

4. 4安装评估扩展

   仅在需要 evaluation metrics 时执行，安装可选依赖 extras。

   pip install promptify[eval]

   复制

5. 5运行 NER 示例

   用 README 的 3 行 NER 示例验证库可用，注意 model 与 domain 需按 README 写法传入。

   from promptify import NER
   
   ner = NER(model="gpt-4o-mini", domain="medical")
   result = ner("The patient is a 93-year-old female with a medical history of chronic right hip pain, osteoporosis, hypertension, depression, and chronic atrial fibrillation admitted for evaluation and management of severe nausea and vomiting and urinary tract infection")
   print(result)

   复制

关键配置

如何确认成功

运行 NER 示例后打印出 NERResult(entities=[Entity(...)]) 结构的对象，即表示安装与调用成功。

常见问题

注意事项

• README 节选未给出 API Key 的设置方法，实际调用大模型前需按后端要求自行配置密钥。
• README 节选只演示了 NER 用法，其他任务类请查阅完整文档。
• 项目基于 LiteLLM 作为通用 LLM 后端，可切换的模型范围以后端支持为准。
• 本教程不含 Docker、云服务等部署方式，Promptify 属于 Python 库/依赖。