DeepEval文档中的Synthesizer模块关键修正说明

作为DeepEval项目的重要组件，Synthesizer模块的文档近期进行了几处关键修正，这些修正对于开发者正确使用该模块至关重要。本文将详细介绍这些文档变更内容，帮助开发者避免在实际使用中遇到问题。

过滤配置(Filtration)的拼写修正

原文档中存在的拼写错误已得到修正："filteration"应正确拼写为"filtration"。这一修正涉及多个方面：

1. 类名修正：FiltrationConfig是正确拼写
2. 参数名修正：构造Synthesizer时应使用filtration_config参数
3. URL锚点修正：文档章节链接已更新为正确的拼写

正确用法示例如下：

from deepeval.synthesizer import Synthesizer
from deepeval.synthesizer.config import FiltrationConfig

filtration_config = FiltrationConfig(
  critic_model="gpt-4o",
  synthetic_input_quality_threshold=0.5
)

synthesizer = Synthesizer(filtration_config=filtration_config)

上下文构建配置类名修正

文档中关于从文档生成黄金标准的上下文配置部分存在类名引用错误：

1. 错误引用：原文档使用了ContextExtractionConfig
2. 正确类名：实际应为ContextConstructionConfig
3. 参数名修正：相应参数应为context_construction_config

修正后的正确用法：

from deepeval.synthesizer.config import ContextConstructionConfig

synthesizer.generate_goldens_from_docs(
  document_paths=['example.txt', 'example.docx', 'example.pdf'],
  context_construction_config=ContextConstructionConfig()
)

新增上下文生成参数说明

generate_goldens_from_contexts方法新增了一个先前未文档化的可选参数：

• 参数名：source_files
• 类型：字符串列表
• 作用：指定上下文的来源文件
• 要求：列表长度必须与上下文列表长度一致

这一参数可以帮助开发者更好地追踪生成黄金标准的原始数据来源，提高数据可追溯性。文档已更新说明该方法现在有一个必选参数和三个可选参数。

总结

DeepEval项目团队持续改进文档质量，这些修正确保了开发者能够准确理解和使用Synthesizer模块的各项功能。建议所有使用该模块的开发者检查自己的代码实现，确保与最新文档保持一致，避免因命名差异导致的功能异常。

对于新接触DeepEval的开发者，建议在实现相关功能时参考最新文档，这些修正体现了开源项目在持续迭代中对细节的关注，也展示了社区贡献者在项目质量提升中的重要作用。