Skip to main content
This guide explains how to configure the By AI Agent metric in Quality AI to run AI-based evaluations through Artemis. The metric uses a parent metric with multiple sub-metrics, each with its own question, weight, and logic. A single evaluation call processes all sub-metrics and returns results with justifications. Supervisors can pass metadata to the Execute API request through requestMeta. The system maps configured custom fields to key-value pairs and includes conversationId by default. By AI Agent connects to your Artemis project through project-based authentication set up when you create the metric.

When to use this metric

Use this metric type for evaluation scenarios that require:

Prerequisites

Before creating a By AI Agent metric, confirm:
  • Access to both Quality AI and Agent Platform, using the same workspace on both.
  • Permissions to view and deploy project/app.
  • The By AI Agent Metric feature is enabled for your workspace account.
  • At least one project/app is configured on the Agent Platform with the required response structure.
  • (Optional) Custom fields in the Quality AI custom field registry to enable request metadata mapping.
  • A deployed Artemis project with its Project Key and Channel ID.

Configure a By AI Agent metric

Step 1: Navigate to metric configuration

  1. Navigate to Quality AI > Configure > Evaluation Forms > Evaluation Metrics.
  2. Click + New Evaluation Metric.
  3. From the Evaluation Metrics Measurement Type dropdown, select By AI Agent.

Step 2: Create the parent metric

  1. Enter a descriptive Name (for example, Compliance Disclosure).
  2. Select the Language for the AI Agent’s evaluation.
  3. The Question field is defined later under the sub-metrics section.

Step 3: Connect to 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 automatically sets the required origin header on the run API; no manual token management is needed.

Step 4: Test the connection and fetch sub-metrics

  1. Click Test Connection.
  2. The system sends a test call to the selected app and retrieves available sub-metrics for configuration.
  3. On success, the panel confirms the connection and shows how many sub-metrics the agent application includes.
If the agentic app response doesn’t match the required contract, Test Connection fails, blocking configuration.

Step 5: Configure sub-metrics

Upon successful connection, the system displays all sub-metrics returned by the agentic app with their reference names. Click Edit next to the Weightage field to open the sub-metric configuration panel, where you can define the following:
Sub-metric weightages must sum to 100%; they allocate 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 evaluations that depend on conversation data. These fields populate the requestMeta object of the Execute API request.
  1. Select a conversation-level Custom Field.
  2. Define Header Name as the key in requestMeta.
  3. Add multiple mappings using + Add Custom Field.
For Agent AI and Express sources, customConversationId is automatically included in requestMeta. When all details are configured, click Create to save the metric for AI Agent evaluation.

Set up the response format

Ensure that the agent is instructed to respond in the specified response format.

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 (conversationId and configured custom fields).
The agent evaluates all sub-metrics and returns structured results. The system maps results and displays adherence with reasoning.

Request metadata in the Execute API

The system sends metadata in the requestMeta object of the Execute API. The requestMeta object includes:
  • Contents: the conversationId (always 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.
Example:
This metadata is used only during evaluation execution and isn’t stored in the results.

Response format for sub-metrics

The Agent Platform must return responses in this JSON format for Quality AI to process sub-metric results:

Sample response

The Agent Platform contract strictly defines the response format; Quality AI only consumes and maps the response, not modifying the contract.

Audit logs (By AI Agent V2)

For By AI Agent V2 (Artemis) metrics, the Audit Screen records an audit log for each evaluation, allowing you to review and debug agent calls. The log lists one entry per sub-metric evaluation:

Manage evaluation metrics

Edit an evaluation metric

  1. Select a By AI Agent metric.
  2. Click 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 an evaluation metric

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.
The system allows deletion only after you resolve all dependencies and save the changes.