GPTCache

环境要求

• Python 3.8.1 或更高版本
• 已安装 pip（版本过低需先升级）
• 示例运行需要 OPENAI_API_KEY 环境变量
• 可访问 PyPI 安装 gptcache 包

安装与启动步骤

1. 1检查 Python 版本

   GPTCache 要求 Python 3.8.1 以上，先确认本机版本是否满足，不满足需先升级 Python。

   python --version

   复制

2. 2升级 pip

   如果安装库时因 pip 版本过低报错，先升级 pip 再继续后续安装。

   python -m pip install --upgrade pip

   复制

3. 3安装 GPTCache

   官方推荐的快速安装方式，一条命令即可装好基础缓存功能，额外特性所需库会自动安装。

   pip install gptcache

   复制

4. 4设置 API Key

   运行官方示例前必须设置 OPENAI_API_KEY。Unix/Linux/MacOS 用 export，仅当前会话有效。

   export OPENAI_API_KEY=sk-xxxxxxxx

   复制

5. 5Windows 设置密钥

   Windows 系统改用 set 命令设置同一环境变量，写法与 Unix 不同。

   set OPENAI_API_KEY=YOUR_API_KEY

   复制

6. 6确认密钥已生效

   通过 echo 打印环境变量，确认输出的是刚设置的密钥，再运行示例代码。

   echo $OPENAI_API_KEY

   复制

7. 7源码开发安装(可选)

   需要基于源码开发时，克隆仓库后安装依赖并执行 setup.py 安装到本地环境。

   pip install -r requirements.txt
   python setup.py install

   复制

关键配置

如何确认成功

pip install 无报错即安装成功；执行 echo $OPENAI_API_KEY 能打印出密钥值，说明环境已就绪。

常见问题

注意事项

• 项目仍在快速迭代，API 可能随时变化，请以最新官方文档和 release note 为准。
• 官方已不再新增对新 API 或模型的支持，鼓励使用 gptcache 的 get 和 set API。
• export / set 设置的环境变量仅当前会话有效，重启终端后需重新设置。
• GPTCache 已与 LangChain 完全集成，可参考官方给出的 LangChain 集成用法说明。