●Change8

v0.3.9

Breaking Changes
📦 ragas
⚠ 2 breaking✨ 9 features🐛 5 fixes⚡ 1 deprecations🔧 5 symbols

Summary

This release focuses heavily on migrating core metrics to a new structure, removing deprecated metrics like 'aspect critic', and introducing new features like synthetic data traceability metadata. Several documentation fixes and minor bug fixes related to OpenAI models were also implemented.

⚠️ Breaking Changes

  • The metrics 'aspect critic' and 'simple criteria' have been removed and replaced with discrete metric examples.
  • The metric 'AnswerSimilarity' has been removed from the collections API in favor of 'SemanticSimilarity'.

Migration Steps

  1. Replace usage of removed metrics 'aspect critic' and 'simple criteria' with discrete metric examples.
  2. Replace usage of 'AnswerSimilarity' in collections API with 'SemanticSimilarity'.
  3. Remove usage of the deprecated `ground_truths` field.

✨ New Features

  • Added metadata fields for synthetic data traceability.
  • Migrated and added support for SummaryScore metric.
  • Migrated and added support for noise sensitivity metric.
  • Migrated and added support for Faithfullness metric.
  • Migrated and added support for Answer Accuracy and Context Relevance metrics.
  • Migrated and added support for Context Precision (with and without reference).
  • Migrated and added support for factual correctness metric.
  • Migrated and added support for Response Groundedness metric.
  • Migrated and added support for Context Recall metric.

🐛 Bug Fixes

  • Fixed a missing line break in documentation step titles and descriptions.
  • Fixed documentation for discrete, numeric, and ranking metrics using instructor.
  • Fixed recall formula label in SQL metrics documentation.
  • Fixed office hours link.
  • Fixed an error handling `max_completeion_tokens` for newer OpenAI models.

🔧 Affected Symbols

aspect critic metricsimple criteria metricground_truthsAnswerSimilaritySemanticSimilarity

⚡ Deprecations

  • The field `ground_truths` has been removed.