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

200

{
  "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,
          "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,
              "total_cost": "<string>",
              "prompt_cost": "<string>",
              "completion_cost": "<string>",
              "feedback_stats": {},
              "app_path": "<string>",
              "feedbacks": [
                {
                  "key": "<string>",
                  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "created_at": "2023-11-07T05:31:56Z",
                  "modified_at": "2023-11-07T05:31:56Z",
                  "score": 123,
                  "value": 123,
                  "comment": "<string>",
                  "correction": {},
                  "feedback_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "comparative_experiment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "trace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "start_time": "2023-11-07T05:31:56Z",
                  "is_root": false,
                  "feedback_source": {
                    "type": "<string>",
                    "metadata": {},
                    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "ls_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "user_name": "<string>"
                  },
                  "extra": {},
                  "feedback_thread_id": "<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
    }
  ]
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Path Parameters

dataset_id · string<uuid> · required

Body

application/json

session_ids · string<uuid>[] · required

Minimum array length: 1

group_by · enum<string> · required

Available options: run_metadata, example_metadata

metadata_key · string · required

offset · integer · default: 0

Required range: x >= 0

limit · integer · default: 10

Required range: x >= 1

preview · boolean · default: false

per_group_limit · integer · default: 5

Required range: 1 <= x <= 10

filters · Filters · object

Show child attributes

Response

200

application/json

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.

groups · ExampleGroupWithSessions · object[] · required

Show child attributes