Turn Contextual Precision
The turn contextual precision metric is a conversational metric that evaluates whether relevant nodes in your retrieval context are ranked higher than irrelevant nodes throughout a conversation.
Required Arguments
To use the TurnContextualPrecisionMetric, you'll have to provide the following arguments when creating a ConversationalTestCase:
turns-
expected_outcome
You must provide the role, content, and retrieval_context for evaluation to happen. Read the How Is It Calculated section below to learn more.
Usage
The TurnContextualPrecisionMetric() can be used for end-to-end multi-turn evaluation:
from deepeval.test_case import Turn, ConversationalTestCase
from deepeval.metrics import TurnContextualPrecisionMetric
from deepeval import evaluate
content = "We offer a 30-day full refund at no extra cost."
retrieval_context = [
"All customers are eligible for a 30 day full refund at no extra cost."
]
convo_test_case = ConversationalTestCase(
turns=[
Turn(role="user", content="What if these shoes don't fit?"),
Turn(role="assistant", content=content, retrieval_context=retrieval_context)
],
expected_outcome="The chatbot must explain the store policies like refunds, discounts, ..etc.",
)
metric = TurnContextualPrecisionMetric(threshold=0.5)
# To run metric as a standalone
# metric.measure(convo_test_case)
# print(metric.score, metric.reason)
evaluate(test_cases=[convo_test_case], metrics=[metric])There are EIGHT optional parameters when creating a TurnContextualPrecisionMetric:
- [Optional]
threshold: a number representing the minimum passing threshold. Can also be set toNoneto run the metric in score-only mode. Defaulted to0.5. - [Optional]
model: a string specifying which of OpenAI's GPT models to use, OR any custom LLM model of typeDeepEvalBaseLLM. Defaulted togpt-5.4. - [Optional]
include_reason: a boolean which when set toTrue, will include a reason for its evaluation score. Defaulted toTrue. - [Optional]
strict_mode: a boolean which when set toTrue, enforces a binary metric score: 1 for perfection, 0 otherwise. It also overrides the current threshold and sets it to 1. Defaulted toFalse. -
[Optional]
async_mode: a boolean which when set toTrue, enables concurrent execution within themeasure()method. Defaulted toTrue. - [Optional]
verbose_mode: a boolean which when set toTrue, prints the intermediate steps used to calculate said metric to the console, as outlined in the How Is It Calculated section. Defaulted toFalse. - [Optional]
window_size: an integer which defines the size of the sliding window of turns used during evaluation. Defaulted to10. - [Optional]
flaky: a boolean which when set toTrue, marks the metric as flaky. Defaulted toFalse.
As a standalone
You can also run the TurnContextualPrecisionMetric on a single test case as a standalone, one-off execution.
...
metric.measure(convo_test_case)
print(metric.score, metric.reason)How Is It Calculated?
The TurnContextualPrecisionMetric score is calculated according to the following equation:
The TurnContextualPrecisionMetric first constructs a sliding windows of turns. For each window, it:
- Evaluates each retrieval context node to determine if it was useful in arriving at the expected outcome
- Calculates weighted precision where earlier relevant nodes contribute more to the score:
- Where nodes ranked higher (lower rank number) contribute more weight to the score
The final score is the average of all precision scores across the conversation. This ensures that relevant retrieval context nodes appear earlier in the ranking.
FAQs
When should I use TurnContextualPrecisionMetric instead of the single-turn version?
ConversationalTestCase and you want to grade each turn's node ranking against the expected_outcome. The single-turn ContextualPrecisionMetric grades one retrieval only.How is precision different from recall and relevancy?
The right info is in my retrieval context but precision is low — what's wrong?
Why does this metric need expected outcome?
expected_outcome to decide which nodes in the retrieval_context were useful before scoring their ranking. Without it there's no ground truth for labeling nodes relevant or irrelevant.