EngineError
A valid request URL is required to generate request examples{
"groups": [
{
"filter": "<string>",
"group_key": "<string>",
"sessions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filter": "<string>",
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"extra": {},
"name": "<string>",
"description": "<string>",
"default_dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reference_dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"run_count": 123,
"latency_p50": 123,
"latency_p99": 123,
"first_token_p50": 123,
"first_token_p99": 123,
"total_tokens": 123,
"prompt_tokens": 123,
"completion_tokens": 123,
"total_cost": "<string>",
"prompt_cost": "<string>",
"completion_cost": "<string>",
"last_run_start_time": "2023-11-07T05:31:56Z",
"last_run_start_time_live": "2023-11-07T05:31:56Z",
"feedback_stats": {},
"session_feedback_stats": {},
"run_facets": [
{}
],
"error_rate": 123,
"streaming_rate": 123,
"test_run_number": 123,
"experiment_progress": {
"expected_run_count": 123,
"run_progress": 123,
"evaluator_progress": {}
},
"example_count": 123,
"min_start_time": "2023-11-07T05:31:56Z",
"max_start_time": "2023-11-07T05:31:56Z"
}
],
"examples": [
{
"dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"inputs": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"runs": [
{
"name": "<string>",
"trace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"inputs": {},
"inputs_preview": "<string>",
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"extra": {},
"error": "<string>",
"execution_order": 1,
"serialized": {},
"outputs": {},
"outputs_preview": "<string>",
"parent_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"manifest_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"manifest_s3_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"events": [
{}
],
"tags": [
"<string>"
],
"inputs_s3_urls": {},
"outputs_s3_urls": {},
"s3_urls": {},
"dotted_order": "<string>",
"trace_min_start_time": "2023-11-07T05:31:56Z",
"trace_max_start_time": "2023-11-07T05:31:56Z",
"reference_example_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"total_tokens": 123,
"prompt_tokens": 123,
"completion_tokens": 123,
"first_token_time": "2023-11-07T05:31:56Z",
"total_cost": "<string>",
"prompt_cost": "<string>",
"completion_cost": "<string>",
"feedback_stats": {},
"app_path": "<string>"
}
],
"outputs": {},
"source_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"attachment_urls": {}
}
],
"example_count": 123,
"count": 123,
"total_tokens": 123,
"total_cost": "<string>",
"min_start_time": "2023-11-07T05:31:56Z",
"max_start_time": "2023-11-07T05:31:56Z",
"latency_p50": 123,
"latency_p99": 123,
"feedback_stats": {},
"prompt_tokens": 123,
"completion_tokens": 123,
"prompt_cost": "<string>",
"completion_cost": "<string>",
"error_rate": 123
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Read Examples With Runs Grouped
Fetch examples for a dataset, and fetch the runs for each example if they are associated with the given session_ids.
POST
/
api
/
v1
/
datasets
/
{dataset_id}
/
group
/
runs
Error
A valid request URL is required to generate request examples{
"groups": [
{
"filter": "<string>",
"group_key": "<string>",
"sessions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filter": "<string>",
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"extra": {},
"name": "<string>",
"description": "<string>",
"default_dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reference_dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"run_count": 123,
"latency_p50": 123,
"latency_p99": 123,
"first_token_p50": 123,
"first_token_p99": 123,
"total_tokens": 123,
"prompt_tokens": 123,
"completion_tokens": 123,
"total_cost": "<string>",
"prompt_cost": "<string>",
"completion_cost": "<string>",
"last_run_start_time": "2023-11-07T05:31:56Z",
"last_run_start_time_live": "2023-11-07T05:31:56Z",
"feedback_stats": {},
"session_feedback_stats": {},
"run_facets": [
{}
],
"error_rate": 123,
"streaming_rate": 123,
"test_run_number": 123,
"experiment_progress": {
"expected_run_count": 123,
"run_progress": 123,
"evaluator_progress": {}
},
"example_count": 123,
"min_start_time": "2023-11-07T05:31:56Z",
"max_start_time": "2023-11-07T05:31:56Z"
}
],
"examples": [
{
"dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"inputs": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"runs": [
{
"name": "<string>",
"trace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"inputs": {},
"inputs_preview": "<string>",
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"extra": {},
"error": "<string>",
"execution_order": 1,
"serialized": {},
"outputs": {},
"outputs_preview": "<string>",
"parent_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"manifest_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"manifest_s3_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"events": [
{}
],
"tags": [
"<string>"
],
"inputs_s3_urls": {},
"outputs_s3_urls": {},
"s3_urls": {},
"dotted_order": "<string>",
"trace_min_start_time": "2023-11-07T05:31:56Z",
"trace_max_start_time": "2023-11-07T05:31:56Z",
"reference_example_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"total_tokens": 123,
"prompt_tokens": 123,
"completion_tokens": 123,
"first_token_time": "2023-11-07T05:31:56Z",
"total_cost": "<string>",
"prompt_cost": "<string>",
"completion_cost": "<string>",
"feedback_stats": {},
"app_path": "<string>"
}
],
"outputs": {},
"source_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"attachment_urls": {}
}
],
"example_count": 123,
"count": 123,
"total_tokens": 123,
"total_cost": "<string>",
"min_start_time": "2023-11-07T05:31:56Z",
"max_start_time": "2023-11-07T05:31:56Z",
"latency_p50": 123,
"latency_p99": 123,
"feedback_stats": {},
"prompt_tokens": 123,
"completion_tokens": 123,
"prompt_cost": "<string>",
"completion_cost": "<string>",
"error_rate": 123
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
API KeyTenant IDBearer Auth
Path Parameters
Body
application/json
Required array length:
1 - 10 elementsAvailable options:
run_metadata, example_metadata Required range:
x >= 0Required range:
1 <= x <= 20Required range:
1 <= x <= 10Show child attributes
Show child attributes
Response
Successful Response
Response for grouped comparison view of dataset examples.
Returns dataset examples grouped by a run metadata value (e.g., model='gpt-4'). Optional filters are applied to all runs before grouping.
Shows:
- Which examples were executed with each metadata value
- Per-session aggregate statistics for runs on those examples
- The actual example data with their associated runs
Used for comparing how different sessions performed on the same set of examples.
Show child attributes
Show child attributes
Was this page helpful?
⌘I