RUN AN EVALUATION IN THE BUILDER
- Go to the Evaluations page and click
Run Evaluation. - In the Builder, click
Run an Evaluation. - Under Inference Source, select
Use modelto generate new responses, orUse traceto score existing conversations. - In the Assistant Model section, choose the model under test.
- Optional: in the Tools and User Model sections, add tools and a simulated user.
- In the Evaluators section, click
Select Evaluatorsand choose your evaluators. - In the Dataset section, choose the dataset.
- Optional: in the Failure Mode Analysis section, check
Generate failure modes after evaluation. - Optional: in the Inference Configuration section, set inference parameters for the model under test, such as
Temperature,Max Tokens, andSeed. - Click
Run Evaluation, enter a name for the evaluation, and confirm.
ADD TOOLS AND A SIMULATED USER
To evaluate a model as an agent, attach the tools it can call and, optionally, a simulated user that continues the conversation. Each evaluator then scores the full conversation, including every tool call and tool result. Use this when the quality you care about depends on how the model works through a task, not only on its final answer.- Expand the Tools section and open the
Select tools and implementationslist. Under each tool, check the tool implementation that answers its calls. After you check one implementation for a tool, the other implementations for that tool name are disabled. If a tool has no implementation yet, clickCreate an implementation. - Optional: expand the User Model section and choose a model to play the user. Set
Max user turnsto limit the number of user messages in each conversation, including the first.
Remove user model.
For each row, the evaluation keeps the messages up to and including the first user message and discards every later message. The model under test answers and calls tools until it gives a final answer. With a user model, the simulated user replies and the model answers again, until the simulated user ends the conversation or it reaches the maximum number of user turns. To give the simulated user a goal for each row, add a user persona.
These requirements apply:
- Tool calling: The model under test must support tool calling. Oumi checks Oumi-served pretrained models and custom models against the tool-calling support of their base model, and rejects the run if the base model cannot call tools. Hosted API models are accepted, because the provider handles tool calls.
- User model: The user model must be a hosted API model. The User Model section lists only models that can play the user.
- Interactive tool implementations: A run that attaches an interactive tool implementation must also set a user model, because the simulated user answers those calls.
SCORE EXISTING CONVERSATIONS
When your dataset holds conversations that already happened, such as traces from Import observability logs, you can score them without running a model. The evaluators score each conversation as it is, including its tool calls. In the Builder, selectUse trace under Inference Source. The model, tool, user model, and inference sections are hidden, because no model runs. Choose your evaluators and dataset, and run the evaluation.
COMPARE TRACES WITH MODEL RUNS
When you plan to replace or fine-tune the model behind your traces, evaluate four sets of conversations with the same evaluators:- The traces as they are, with
Use trace. - The original model (the teacher), run again through your tool implementations.
- The untuned candidate model, as a baseline.
- The fine-tuned candidate model.
RUN AN EVALUATION WITH THE API
Send aPOST request to /evaluations:run. Authenticate with your Oumi API key in the X-API-Key header. This example attaches tools and a simulated user. Omit agenticInferenceConfig for a plain evaluation.
{"recipeId": ..., "recipeVersion": ...} as recipe to run a saved evaluation recipe.
For agenticInferenceConfig, see its field reference. The same object configures synthesis jobs. For the other fields, see the evaluation schema.
To score existing conversations with the API, set skipInference to true and forceInference to false. forceInference defaults to true, so you must set it explicitly. modelIdentifier and inferenceConfig are still required by the schema, but the run does not use them. Omit agenticInferenceConfig.
VALIDATION RULES
- At least one evaluator is required.
forceInferenceandskipInferencecannot both betrue.maxUserTurnsrequiresuserModelSpec, and must be between 1 and 20.- The tool implementations in one run must serve distinct tool names.
- When the run attaches tool implementations, the model under test must support tool calling.
- A run that attaches an interactive tool implementation must set
userModelSpec. - All simulated tool implementations in one run must use the same model.
- The user model must be a hosted API model.