From 85ae1c8ac34402a042548a97943ba618ea819981 Mon Sep 17 00:00:00 2001 From: yassinnouh21 Date: Sun, 11 Jan 2026 17:09:30 +0200 Subject: [PATCH] =?UTF-8?q?docs:=20add=20migration=20note=20for=20Conversa?= =?UTF-8?q?tionRelevancyMetric=20=E2=86=92=20TurnRelevancyMetric?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add a note to the Turn Relevancy docs page explaining that ConversationRelevancyMetric was renamed to TurnRelevancyMetric in v3.7.x, with example import changes. Fixes #2321 --- docs/docs/metrics-turn-relevancy.mdx | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/docs/metrics-turn-relevancy.mdx b/docs/docs/metrics-turn-relevancy.mdx index 6ede87064..d7ac4477b 100644 --- a/docs/docs/metrics-turn-relevancy.mdx +++ b/docs/docs/metrics-turn-relevancy.mdx @@ -21,6 +21,20 @@ import MetricTagsDisplayer from '@site/src/components/MetricTagsDisplayer'; rag={true} /> +:::note Migration from v3.6.x +If you're upgrading from DeepEval v3.6.x or earlier, note that `ConversationRelevancyMetric` has been renamed to `TurnRelevancyMetric`. Simply update your imports: + +```python +# Before (v3.6.x and earlier) +from deepeval.metrics import ConversationRelevancyMetric + +# After (v3.7.x+) +from deepeval.metrics import TurnRelevancyMetric +``` + +The API and functionality remain the same. +::: + The turn relevancy metric is a conversational metric that determines whether your LLM chatbot is able to consistently generate relevant responses **throughout a conversation**. ## Required Arguments