Opik Integration Guide for TRACE

This guide explains how to configure Opik, run evaluation tests, and submit results to the TRACE Metrics API for automated Responsible AI scoring and compliance mapping.

Step 1: Configure Opik Metrics

Use Opik’s evaluation metrics to systematically assess your model outputs.

from opik.evaluation.metrics import Equals, Moderation, GEval
# Example output and reference
output = """Paris is the capital of France and one of the most visited cities in the world"""
reference = """Paris is the capital of France and a major tourist destination."""
metrics = [
Equals(case_sensitive=False),
Moderation()
]
metric_results = {}
for m in metrics:
if isinstance(m, Equals):
result = m.score(output=output, reference=reference)
elif isinstance(m, Moderation):
result = m.score(output=output, reference=reference)
else:
continue
metric_results[m.__class__.__name__] = result.value

Step 2: Prepare TRACE Payload

Use the following format to create your submission JSON:

{
"metric_metadata": {
"application_name": "chat-application",
"version": "1.0.0",
"provider": "opik",
"use_case": "transportation"
},
"metric_data": {
"opik": {
"Equals": 1.0,
"Moderation": 0.0
}
}
}

Step 3: Get Your API Key

To submit to TRACE, you need a subscription key.

Read: How to Get and Use Your TRACE API Key

Once you’ve generated it, use it in the header for all API requests.

Step 4: Submit to TRACE API

cURL Example:

curl -X POST https://api.cognitiveview.com/metrics \
-H "Content-Type: application/json" \
-H "Ocp-Apim-Subscription-Key: Bearer YOUR_API_KEY" \
-d @trace_payload.json

Python Example:

import requests
url = "https://api.cognitiveview.com/metrics"
headers = {
"Content-Type": "application/json",
"Ocp-Apim-Subscription-Key": "YOUR_API_KEY"
}
payload = { ... } # Your JSON from above
response = requests.post(url, headers=headers, json=payload)
print("Status Code:", response.status_code)
print("Response:", response.json())

What TRACE Returns

On success, TRACE responds with a JSON containing a report_id, like:

{
"message": "Evaluation in progress.",
"report_id": "gW3eQpV63sRTrQey9uJPNp"
}

This ID is used to retrieve your full evaluation.

How to Access Your TRACE Report →