- By AI Agent V1, which uses the existing Agent Platform V1 integration.
- By AI Agent V2 (Artemis), which uses Agent Platform V2 (Artemis) with project-based authentication.
requestMeta-based metadata for the Execute API request, including customConversationId and configured custom fields.
This guide explains how to configure and use the By AI Agent metric in Quality AI, including version selection, agentic application configuration, sub-metrics, custom field propagation, response format, and evaluation results.
When to Use This Metric
Use this metric type for evaluation scenarios that require:Prerequisites
Before creating a By AI Agent metric, confirm:- You have access to both Quality AI and Agent Platform.
- The same workspace is available across both platforms.
- You have permissions to view and deploy agentic applications.
- The By AI Agent Metric feature is enabled for your workspace account.
- You have configured at least one agentic app on the Agent Platform with the required response structure.
- Custom fields exist in the Quality AI custom field registry if you want to pass request metadata.
Choose a Version: V1 or V2
When you add a By AI Agent metric in Quality AI, select the version you want to use.- By AI Agent V1: Uses the existing Agent Platform V1 integration.
- By AI Agent V2 (Artemis): Uses Agent Platform V2 (Artemis) with project-based authentication.
Configure By AI Agent Metric
Step 1: Navigate to Metric Configuration
- Navigate to Quality AI > Configure > Evaluation Forms > Evaluation Metrics.
- Select + New Evaluation Metric.
- From the Evaluation Metrics Measurement Type dropdown, select By AI Agent.
- Select the version, By AI Agent V1 or By AI Agent V2 (Artemis).
Step 2: Create the Parent Metric
- Enter a descriptive Name (for example, Compliance Disclosure).
- Select the Language for the AI Agent’s evaluation.
- The Question field is defined later under sub-metrics.
Step 3: Connect to the Agent Platform
Provide the connection details for the version you selected.By AI Agent V1
- In the Agent App dropdown, choose from available apps in your workspace.
- Select the Environment (for example, Draft, Version 1, Version 2).
By AI Agent V2 (Artemis)
Enter the details of the Artemis project to evaluate against: By AI Agent V2 uses project-key-based authentication. The system creates the authentication token from the Project Key, refreshes it periodically, and sets the required origin header on the run API automatically, no manual token management is needed.
Step 4: Test Connection and Fetch Sub-Metrics
- Select Test Connection.
- The system sends a test call to the selected app and retrieves available sub-metrics for configuration.
- On success, the panel confirms the connection and shows how many sub-metrics the agent application includes.
Test Connection behaves the same for V1 and V2. If the agentic app response doesn’t match the required contract, Test Connection fails and blocks configuration.
Step 5: Configure Sub-Metrics
Upon successful connection, the system displays all sub-metrics returned by the agentic app with their reference names. Select Edit next to the Weightage field to open the sub-metric configuration panel, where you can define the following: Sub-metric weightages must add up to 100%, they split the score within the parent metric’s total.
Step 6: Configure Custom Field Propagation
Optionally configure custom fields to send to the Agent Platform as metadata for conversation dependent evaluation. These fields populate therequestMeta object of the Execute API request.
For Agent AI and Express sources, customConversationId is automatically included in requestMeta.
- Select a conversation-level Custom Field.
- Define Header Name as the key in
requestMeta. - Add multiple mappings using + Add Custom Field.
Configure the Agent Platform response
Quality AI expects the Agent Platform application to return the response in the JSON format below to process the sub-metric results.- Navigate to your AI Agent configuration in the Agent Platform.
- Locate the Description field.
- Follow the Response format for Sub-metrics specification.
Example Use Case: UDAP Compliance
For financial services compliance, a single parent metric can evaluate multiple aspects in one API call:
Each sub-metric is evaluated independently with a single API call, providing detailed justifications for each aspect.
Evaluation Flow
The system sends a single evaluation request that includes:- Conversation data (transcripts and sub-metrics).
requestMeta(customConversationIdand configured custom fields).
Request Metadata in Execute API
The system sends metadata in therequestMeta object of the Execute API.
The requestMeta object includes:
- Contents: The
customConversationId(automatically included for Agent AI and Express sources) and custom fields configured for the metric, represented as key-value pairs. - Custom Field Mapping Rules: The system derives keys from Header Names and sources values from conversation-level custom fields. It supports configuration of multiple custom fields per metric.
customConversationId is used in the requestMeta request object, while conversationId is returned as part of the evaluation response. This metadata is used only during evaluation execution and isn’t stored in the results.
Response Format for Sub-metrics
The Agent Platform application must return the following JSON structure for Quality AI to process the sub-metric results.Sample Response
The Agent Platform contract strictly defines the response format, and no one can modify it. Quality AI only consumes and maps the response.
Audit Logs (By AI Agent V2)
For By AI Agent V2 (Artemis) metrics, the Audit Screen records an audit log for each evaluation so you can review and debug agent calls. The log lists one entry per sub-metric evaluation:Managing Evaluation Metrics
Edit and Delete Evaluation Metrics
Steps to edit and delete existing Evaluation Metrics:- Select an AI Agent metric.
- Select Edit to update the required metric details and fields.
When you update a By AI Agent V2 connection field (Project Key, Project ID, Deployment ID, or Channel ID), the system records a change log entry, for example: “Project ID was updated from {old value} to {new value} for metric {metric name} of type By AI Agent.”
Delete Evaluation Metrics
Before deleting a metric:- Remove it from all associated evaluation forms (for example, Chat Form – COMMON, New Points Based).
- Reassign any linked attributes (for example, Agent AI Metric Attribute-1) to a different metric.