The type of the data object being mapped
Basic field mapping:
type MyData = {
userQuery: string;
context: string;
response: string;
};
const mapping: ObjectMapping<MyData> = {
input: "userQuery", // Map "input" to "userQuery"
reference: "context", // Map "reference" to "context"
output: "response", // Map "output" to "response"
};
Nested property mapping:
type ApiData = {
request: {
body: {
query: string;
context: string;
};
};
response: {
data: {
text: string;
};
};
};
const mapping: ObjectMapping<ApiData> = {
input: "request.body.query",
reference: "request.body.context",
output: "response.data.text",
};
Array element access:
type DataWithArrays = {
messages: Array<{ role: string; content: string }>;
sources: string[];
};
const mapping: ObjectMapping<DataWithArrays> = {
firstMessage: "messages[0].content",
lastSource: "sources[-1]", // Last element
allRoles: "$.messages[*].role", // JSONPath for all roles
};
Function-based transformations:
type RawData = {
firstName: string;
lastName: string;
contexts: string[];
scores: number[];
};
const mapping: ObjectMapping<RawData> = {
// Combine fields
fullName: (data) => `${data.firstName} ${data.lastName}`,
// Transform array to string
contextText: (data) => data.contexts.join("\n\n"),
// Calculate derived value
averageScore: (data) =>
data.scores.reduce((a, b) => a + b, 0) / data.scores.length,
// Conditional logic
status: (data) => data.scores.length > 0 ? "active" : "inactive",
};
Mixed mapping types:
type ComplexData = {
user: {
name: string;
email: string;
};
items: Array<{ id: number; name: string }>;
metadata: {
tags: string[];
};
};
const mapping: ObjectMapping<ComplexData> = {
// Simple dot notation
userName: "user.name",
// Array access
firstItemId: "items[0].id",
// JSONPath for complex query
allItemNames: "$.items[*].name",
// Function for transformation
formattedTags: (data) => data.metadata.tags.map(t => `#${t}`).join(" "),
};
Real-world evaluator binding:
import { bindEvaluator, createHallucinationEvaluator } from "@arizeai/phoenix-evals";
type QAData = {
question: string;
context: string;
answer: string;
};
const mapping: ObjectMapping<QAData> = {
input: "question", // Evaluator expects "input"
reference: "context", // Evaluator expects "reference"
output: "answer", // Evaluator expects "output"
};
const evaluator = bindEvaluator(
createHallucinationEvaluator({ model: openai("gpt-4") }),
{ inputMapping: mapping }
);
A mapping configuration that transforms data from one structure to another.
This type defines how to map fields from your data structure to the fields expected by an evaluator or other component. The mapping is flexible and supports multiple extraction methods.
Key Features: