Get Evaluation Run

Get Evaluation Run

POST 
/api/2/auto_eval/evaluation/get_run

Get a specific evaluation run by id

Request

application/json

Body

id stringrequired

Responses

200

Successful operation

application/json

Schema

Schema

evaluationRun

object

required

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

Example (from schema)

{
  "evaluationRun": {
    "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
  }
}

Loading...