docs: add migration note for ConversationRelevancyMetric → TurnRelevancyMetric#2428
Open
YassinNouh21 wants to merge 1 commit intoconfident-ai:mainfrom
Open
Conversation
…ncyMetric 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 confident-ai#2321
|
@YassinNouh21 is attempting to deploy a commit to the Confident AI Team on Vercel. A member of the Team first needs to authorize it. |
Contributor
|
PR author is not in the allowed authors list. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Added a migration note to the Turn Relevancy docs page to help users upgrading from DeepEval v3.6.x or earlier.
Problem
Users upgrading from older versions encounter
ImportError: cannot import name 'ConversationRelevancyMetric'with no explanation of what changed or how to fix it.Solution
Added a
:::noteadmonition at the top of the Turn Relevancy docs page explaining:ConversationRelevancyMetrictoTurnRelevancyMetricFixes #2321