Plan Adherence
The Plan Adherence metric is an agentic metric that extracts the task and plan from your agent's trace which are then used to evaluate how well your agent has adhered to the plan in completing the task. It is a self-explaining eval, which means it outputs a reason for its metric score.
Plan Adherence metric analyzes your agent's full trace to extract the plan and analyse agent's execution in adhering to this plan, this requires setting up tracing.
Usage
To begin, set up tracing and simply supply the PlanAdherenceMetric() to your agent's @observe tag or in the evals_iterator method.
from somewhere import llm
from deepeval.tracing import observe
from deepeval.dataset import Golden, EvaluationDataset
from deepeval.metrics import PlanAdherenceMetric
@observe
def tool_call(input):
...
return [ToolCall(name="CheckWhether")]
@observe
def agent(input):
tools = tool_call(input)
output = llm(input, tools)
update_current_trace(
input=input,
output=output,
tools_called=tools
)
return output
# Create dataset
dataset = EvaluationDataset(goldens=[Golden(input="What's the weather like in SF?")])
# Initialize metric
plan_adherence = PlanAdherenceMetric(threshold=0.7, model="gpt-4o")
# Loop through dataset
for goldens in dataset.evals_iterator(metrics=[plan_adherence]):
trip_planner_agent(golden.input)
There are SEVEN optional parameters when creating a PlanAdherenceMetric:
- [Optional]
threshold: a float representing the minimum passing threshold, defaulted to 0.5. - [Optional]
model: a string specifying which of OpenAI's GPT models to use, OR any custom LLM model of typeDeepEvalBaseLLM. Defaulted to 'gpt-4o'. - [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.
To learn more about how the evals_iterator work, click here.
As a standalone
You can also run the PlanAdherenceMetric on a single test case as a standalone, one-off execution.
...
metric.measure(convo_test_case)
print(metric.score, metric.reason)
This is great for debugging or if you wish to build your own evaluation pipeline, but you will NOT get the benefits (testing reports) and all the optimizations (speed, caching, computation) the evaluate() function or deepeval test run offers.
How Is It Calculated?
The PlanAdherenceMetric score is calculated by following these steps:
- Extract Task from the trace, this defines the user's goal or intent for the agent and is actionable.
- Extract Plan from the trace, a plan is extracted from the agent's
thinkingorreasoning. If there are no statements that clearly define or imply a plan from the trace, the metric passes by default with a score of1. - Evaluate the agent's execution steps from the trace and see how accurately the agent has adhered to the plan.
- The Alignment Score uses an LLM to generate the final score with all the pre-processed and extracted information like plan, task and execution steps.