model_lab_runs
Creates, updates, deletes, gets or lists a model_lab_runs resource.
Overview
| Name | model_lab_runs |
| Type | Resource |
| Id | datadog.llm_observability.model_lab_runs |
Fields
The following fields are returned by SELECT queries:
- get_model_lab_run
- list_model_lab_runs
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier of the run. (example: 42) |
attributes | object | Attributes of a Model Lab run. |
type | string | The JSON:API type for a Model Lab run resource. (runs) (example: runs) |
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier of the run. (example: 42) |
attributes | object | Attributes of a Model Lab run. |
type | string | The JSON:API type for a Model Lab run resource. (runs) (example: runs) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_model_lab_run | select | run_id | Get a single Model Lab run by its ID. | |
list_model_lab_runs | select | filter[id], filter, filter[owner_id], filter[status], filter[project_id], filter[tags], filter[params], filter[parent_run_id], pinned_first, include_pinned, include_descendant_matches, sort, page[size], page[number] | List all Model Lab runs for the current organization. | |
delete_model_lab_run | delete | run_id | Delete a Model Lab run by its ID. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
run_id | integer (int64) | The ID of the Model Lab run. |
site | string | The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both. |
filter | string | Text search filter for run name or description. |
filter[id] | string | Filter by run ID(s). Comma-separated list for multiple IDs. |
filter[owner_id] | string | Filter by owner UUID. |
filter[params] | string | Filter by params. Format: key:value,key2:>0.5,key3:true. |
filter[parent_run_id] | string | Filter by parent run ID. Use 'null' to return only root runs (runs with no parent). |
filter[project_id] | integer (int64) | Filter by project ID. |
filter[status] | string | Filter by run status. Valid values: pending, running, completed, failed, killed, unresponsive, paused. |
filter[tags] | string | Filter by tags. Format: key:value,key2:value2. |
include_descendant_matches | boolean | When true, also return runs whose descendants match the active filters. The descendant_match field in each result indicates whether the run was included via a descendant match. |
include_pinned | boolean | Include all runs pinned by the current user, regardless of other filters. |
page[number] | integer (int64) | Page number (1-indexed). |
page[size] | integer (int64) | Number of items per page. Maximum is 100. |
pinned_first | boolean | Sort pinned runs before non-pinned runs. Pinned runs are ordered by pin time descending. |
sort | string | Sort field. Valid values: name, created_at, updated_at, duration. Prefix with '-' for descending order (e.g., -updated_at). |
SELECT examples
- get_model_lab_run
- list_model_lab_runs
Get a single Model Lab run by its ID.
SELECT
id,
attributes,
type
FROM datadog.llm_observability.model_lab_runs
WHERE run_id = '{{ run_id }}' -- required
;
List all Model Lab runs for the current organization.
SELECT
id,
attributes,
type
FROM datadog.llm_observability.model_lab_runs
WHERE filter[id] = '{{ filter[id] }}'
AND filter = '{{ filter }}'
AND filter[owner_id] = '{{ filter[owner_id] }}'
AND filter[status] = '{{ filter[status] }}'
AND filter[project_id] = '{{ filter[project_id] }}'
AND filter[tags] = '{{ filter[tags] }}'
AND filter[params] = '{{ filter[params] }}'
AND filter[parent_run_id] = '{{ filter[parent_run_id] }}'
AND pinned_first = '{{ pinned_first }}'
AND include_pinned = '{{ include_pinned }}'
AND include_descendant_matches = '{{ include_descendant_matches }}'
AND sort = '{{ sort }}'
AND page[size] = '{{ page[size] }}'
AND page[number] = '{{ page[number] }}'
;
DELETE examples
- delete_model_lab_run
Delete a Model Lab run by its ID.
DELETE FROM datadog.llm_observability.model_lab_runs
WHERE run_id = '{{ run_id }}' --required
;