Example

A single evaluation example with flexible key-value properties.

Use Example.create() to construct an example with arbitrary fields such as input, actualOutput, expectedOutput, etc.

const example = Example.create({
  input: "What is the capital of France?",
  actual_output: "Paris is the capital of France.",
  expected_output: "Paris",
});

example.get("input"); // "What is the capital of France?"

Attributes

create()

Create an example with the given properties.

Any key-value pairs passed in props become accessible via .get(). Common keys: input, actual_output, expected_output, retrieval_context.

function create(props: Record<string, unknown> = {}): Example

Parameters

Returns

Example

from()

Reconstruct an Example from an API response dict.

Separates the fixed metadata fields (example_id, created_at, name) from user-defined properties.

function from(data: ExampleDict): Example

Parameters

Returns

Example

get()

Get a property by key.

function get(key: string): unknown

Parameters

Returns

unknown

has()

Check if a property key exists.

function has(key: string): boolean

Parameters

Returns

boolean

toJSON()

Serialize to the API wire format.

function toJSON(): ExampleDict

Returns

ExampleDict