v1

latestOpenAPI 3.1.02026-07-1320186461.3 KB

List Experiments Api

Lists experiments given a set of filters incl. their high-level statistics.

post/api/parea/v1/experiments

Request body

project_namestring nullable

Name of the project to filter experiments by.

metadata_filterobject nullable

Filters experiments to contain the given metadata. The metadata_filter is a dictionary where the keys are the metadata keys and the values are the metadata values to filter by.

experiment_name_filterstring nullable

Filters experiments to contain the given string in their name.

run_name_filterstring nullable

Filters experiments to contain the given string in their run name.

experiment_uuidsstring[] nullable

Filters experiments to contain the given UUIDs.

Example request

{
  "experiment_name_filter": "Hello World",
  "metadata_filter": {
    "purpose": "testing"
  },
  "project_name": "development",
  "run_name_filter": "v1"
}

Response

Successful Response

namestring required

Name of the experiment

run_namestring nullable

Name of the run. Must be unique for each experiment and can only contain alphanumeric characters, hyphens, and underscores.

project_uuidstring required

UUID of the project associated with this experiment

is_publicboolean

If experiment should be public

metadataobject nullable

Any additional key-value pairs which provide context or are useful for filtering.

uuidstring required

UUID of the created experiment

created_atstring required

Timestamp the experiment was created

status'pending' | 'running' | 'completed' | 'failed' required

num_samplesinteger nullable

Number of samples in the experiment

Example response

[
  {
    "created_at": "2024-04-15 22:19:13",
    "is_public": false,
    "metadata": {
      "dataset": "dev 123"
    },
    "name": "greeting",
    "num_samples": 6,
    "pinned_stats": [
      {
        "operation": "mean",
        "value": 0.176471,
        "var1": "levenshtein"
      },
      {
        "operation": "mean",
        "value": 0.00002,
        "var1": "Cost"
      },
      {
        "operation": "mean",
        "value": 11,
        "var1": "Total Tokens"
      },
      {
        "operation": "mean",
        "value": 9,
        "var1": "Output Tokens"
      },
      {
        "operation": "mean",
        "value": 2,
        "var1": "Input Tokens"
      },
      {
        "operation": "mean",
        "value": 0.65273,
        "var1": "Latency"
      }
    ],
    "project_uuid": "...",
    "run_name": "bijou-kail",
    "status": "completed",
    "uuid": "..."
  }
]