Skip to main content

ProjectEvaluationRunMetricSummary

A summary of a single metric for all Evaluation Runs over a time range.

    metricAggregate

    object

    required

    Aggregate metric for the full time range (e.g. weighted average of the metric)

    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

    statisticalMetrics

    object

    required

    Statistical metrics computed for this evaluation metric, over all runs in the time range. Including:

    • 'standard_deviation': the standard deviation of the aggregated means of the metric over all runs

    property name* number

    results

    object[]

    required

  • Array [

    • timestamp 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

    aggregateScore numberrequired

  • ]