Skip to content

docs: add migration note for ConversationRelevancyMetric → TurnRelevancyMetric #2428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
YassinNouh21 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add migration note for ConversationRelevancyMetric → TurnRelevancyMetric #2428

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/docs/metrics-turn-relevancy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading