Ragas项目中OpenAI API密钥传递方式的优化实践

背景介绍

在Ragas项目（一个用于评估检索增强生成系统的开源框架）中，开发者通常需要通过环境变量来设置OpenAI API密钥。然而，在实际开发过程中，我们经常遇到需要动态传递密钥的场景，比如在多租户系统中管理不同用户的API密钥，或者在测试环境中临时切换密钥。

问题发现

在Ragas 0.2.5版本中，开发者发现当尝试通过代码直接传递OpenAI API密钥而非使用环境变量时，系统会抛出错误提示："The api_key client option must be set either by passing api_key to the client or by setting the OPENAI_API_KEY environment variable"。这表明系统未能正确识别通过代码传递的密钥。

技术分析

深入分析这个问题，我们发现Ragas框架在评估过程中会自动创建默认的LLM和Embedding实例，而不会优先使用开发者通过metrics参数传递的已配置实例。这种行为导致了即使开发者在metrics中正确设置了API密钥，系统仍然尝试使用未配置密钥的默认实例。

解决方案

经过项目维护者的验证，确认最新版本已经修复了这个问题。现在开发者可以通过以下两种方式安全地传递OpenAI API密钥：

1. 直接实例化方式：

evaluator_llm = LangchainLLMWrapper(ChatOpenAI(model="gpt-4o", api_key=openai_api_key))
evaluator_embeddings = LangchainEmbeddingsWrapper(OpenAIEmbeddings(model="text-embedding-3-large", api_key=openai_api_key))

2. 评估时显式传递方式：

results = evaluate(dataset=eval_dataset, 
                  metrics=metrics, 
                  llm=evaluator_llm, 
                  embeddings=embedding_model)

最佳实践建议

1. 密钥管理：虽然现在支持代码传递，但生产环境中仍建议优先使用环境变量或密钥管理系统，避免密钥硬编码。

2. 版本兼容性：不同版本的Ragas可能对密钥传递方式有不同要求，建议开发者明确项目依赖版本。

3. 多实例管理：当需要同时使用多个不同API密钥时，确保为每个实例单独配置，避免全局设置导致的冲突。

总结

Ragas项目对OpenAI API密钥传递方式的优化，为开发者提供了更大的灵活性。这一改进使得框架能够更好地适应各种复杂的应用场景，特别是在需要动态管理多个API密钥的情况下。开发者现在可以根据具体需求选择最适合的密钥传递方式，而不再局限于环境变量这一单一途径。