List Evaluation Runs

List Evaluation Runs

POST 
/api/2/auto_eval/evaluation/list_runs

List evaluation runs with optional filters

Request

application/json

Body

filters

object

Filter listed evaluation runs by ALL filters specified

query string

search query substring match for experiment name or metadata

projectId string

filter evaluation runs associated with the project

runType EvaluationRunType (string)

filter by run type. If not specified, lists all run types

Possible values: [EVALUATION_RUN_TYPE_UNSPECIFIED, EVALUATION_RUN_TYPE_ADHOC, EVALUATION_RUN_TYPE_EXPERIMENT]

experimentId string

filter runs associated with this experiment

startTime date-time

A summary is retrieved for a time range from start_time to end_time If no end_time is provided, current time is used

endTime date-time

A summary is retrieved for a time range from start_time to end_time If no end_time is provided, current time is used

pageIndex integer
pageSize integer

Responses

200

Successful operation

application/json

Schema

Schema

evaluationRuns

object[]

required

Array [

id stringrequired

name stringrequired

createdAt date-timerequired

A summary is retrieved for a time range from start_time to end_time If no end_time is provided, current time is used

creatorId string

projectId stringrequired

resultDatasetId string

sourceDatasetId string

experimentId string

experimentName string

metadata

object

fields

object

required

property name*

object

Ordered row values with length always equal to num_rows on the corresponding view.

property name* any

Ordered row values with length always equal to num_rows on the corresponding view.

aggregateMetrics

object[]

required

Array [

metric

object

required

id string

name string

description string

deploymentStatus ModelDeploymentStatus (string)

Possible values: [MODEL_DEPLOYMENT_STATUS_UNSPECIFIED, MODEL_DEPLOYMENT_STATUS_PENDING, MODEL_DEPLOYMENT_STATUS_ONLINE, MODEL_DEPLOYMENT_STATUS_OFFLINE, MODEL_DEPLOYMENT_STATUS_PAUSED]

aggregateMethod MetricAggregateMethod (string)required

Possible values: [METRIC_AGGREGATE_METHOD_UNSPECIFIED, METRIC_AGGREGATE_METHOD_SUM, METRIC_AGGREGATE_METHOD_AVG]

score numberrequired

]

runType EvaluationRunType (string)required

Possible values: [EVALUATION_RUN_TYPE_UNSPECIFIED, EVALUATION_RUN_TYPE_ADHOC, EVALUATION_RUN_TYPE_EXPERIMENT]

numRows integerrequired

]

totalCount integerrequired

Total count of evaluation runs which can be listed with applicable filters, regardless of page size

Example (from schema)

{
  "evaluationRuns": [
    {
      "id": "string",
      "name": "string",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "creatorId": "string",
      "projectId": "string",
      "resultDatasetId": "string",
      "sourceDatasetId": "string",
      "experimentId": "string",
      "experimentName": "string",
      "metadata": {
        "fields": {}
      },
      "aggregateMetrics": [
        {
          "metric": {
            "id": "string",
            "name": "string",
            "description": "string",
            "deploymentStatus": "MODEL_DEPLOYMENT_STATUS_UNSPECIFIED"
          },
          "aggregateMethod": "METRIC_AGGREGATE_METHOD_UNSPECIFIED",
          "score": 0
        }
      ],
      "runType": "EVALUATION_RUN_TYPE_UNSPECIFIED",
      "numRows": 0
    }
  ],
  "totalCount": 0
}

Loading...