Documentation | Evaluation Dashboards › Widgets

Evaluation Dashboards

EvaluationDashboardsResource

Methods

client.evaluation_dashboards.create() ->

EvaluationDashboard

post/v5/evaluation-dashboards

Create a new evaluation dashboard for an evaluation or evaluation group

client.evaluation_dashboards.list() -> SyncCursorPage[

EvaluationDashboard

]

get/v5/evaluation-dashboards

List dashboards filtered by evaluation_id, evaluation_group_id, tags, creators, or search

client.evaluation_dashboards.retrieve(, ) ->

EvaluationDashboard

get/v5/evaluation-dashboards/{dashboard_id}

Get a single evaluation dashboard by ID

client.evaluation_dashboards.update(, ) ->

EvaluationDashboard

patch/v5/evaluation-dashboards/{dashboard_id}

Partially update dashboard metadata (name, description, widget_order)

client.evaluation_dashboards.delete() ->

EvaluationDashboard

delete/v5/evaluation-dashboards/{dashboard_id}

Soft delete an evaluation dashboard

Domain types

class EvaluationDashboard: ...

Evaluation Dashboards

Widgets

EvaluationDashboardsResource.WidgetsResource

Methods

client.evaluation_dashboards.widgets.create(, ) ->

EvaluationDashboardWidgetWithResult

post/v5/evaluation-dashboards/{dashboard_id}/widgets

Create a new widget, add it to the dashboard, and compute its results

client.evaluation_dashboards.widgets.update(, ) ->

EvaluationDashboardWidgetWithResult

patch/v5/evaluation-dashboards/{dashboard_id}/widgets/{widget_id}

Update a widget and compute its results. If the widget is only used by this dashboard, it is updated in place. If shared across multiple dashboards, a copy is created.

Parameters

dashboard_id: str

widget_id: str

config: Optional[Dict[str,

object

]]

Chart-specific display configuration

query: Optional[

Query

]

Structured query AST for metric computation (SeriesQuery or MetricQuery)

class QuerySeriesQuery: ...

Query that returns a series of records (used for table/bar/histogram widgets).

Used for widget types: table, bar, histogram. Returns: {"type": "series", "data": [...]}

Example SQL equivalent: SELECT category, AVG(score) as avg_score, COUNT(*) as count FROM evaluation_items WHERE score > 0.5 AND category = 'test' GROUP BY category ORDER BY avg_score DESC LIMIT 100

class QueryMetricQuery: ...

Query that returns a single metric value (used for metric widgets).

Used for widget type: metric. Enforces exactly 1 aggregation in select. Returns: {"type": "metric", "data": ...}

Example SQL equivalent: SELECT AVG(score) as average_score FROM evaluation_items

title: Optional[str]

(maxLength: 256, minLength: 1)

Widget title

Returns

EvaluationDashboardWidgetWithResult

id: str

Unique identifier of the widget

account_id: str

Account that owns this widget

created_at:

datetime

(format: date-time)

When the widget was created

title: str

Widget title

type: Literal["bar", "histogram", "metric", "table", "markdown", "heading"]

Widget type

config: Optional[Dict[str,

object

]]

Display configuration

object: Optional[Literal["evaluation_widget"]]

(default: "evaluation_widget")

query: Optional[

Query

]

Structured query AST for computation (SeriesQuery or MetricQuery)

result: Optional[

Result

]

Computed result for this widget

Request example

import os
from scale_gp_beta import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
evaluation_dashboard_widget_with_result = client.evaluation_dashboards.widgets.update(
    widget_id="widget_id",
    dashboard_id="dashboard_id",
)
print(evaluation_dashboard_widget_with_result.id)

200Example

{
  "id": "id",
  "account_id": "account_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "title": "title",
  "type": "bar",
  "config": {
    "foo": "bar"
  },
  "object": "evaluation_widget",
  "query": {
    "select": [
      {
        "expression": {
          "column": "column",
          "source": "source",
          "type": "COLUMN"
        },
        "alias": "alias"
      }
    ],
    "filter": {
      "conditions": [
        {
          "column": "column",
          "operator": "=",
          "value": {},
          "source": "source"
        }
      ],
      "logicalOperators": [
        "AND"
      ]
    },
    "groupBy": [
      "string"
    ],
    "limit": 1,
    "orderBy": [
      {
        "column": "column",
        "direction": "ASC",
        "source": "source"
      }
    ]
  },
  "result": {
    "id": "id",
    "computation_status": "computation_status",
    "widget_id": "widget_id",
    "computed_at": "2019-12-27T18:11:19.117Z",
    "computed_result": {
      "foo": "bar"
    },
    "error_message": "error_message"
  }
}

client.evaluation_dashboards.widgets.delete(, )

delete/v5/evaluation-dashboards/{dashboard_id}/widgets/{widget_id}

Remove a widget from the dashboard (does not delete the widget)

Domain types

class EvaluationDashboardWidget: ...

class EvaluationDashboardWidgetResult: ...

class EvaluationDashboardWidgetWithResult: ...

Response model for widget creation - includes widget and computed result