Skip to content

Analyze exact immutable dataset-version health evidence

GET
/v1/datasets/versions/{version_id}/health
curl --request GET \
--url https://example.com/v1/datasets/versions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/health

Return a deterministic bounded sample over exact ManifestID bytes.

version_id
required
string format: uuid
account_id

Act on this account (active)

string | null format: uuid

Act on this account (active)

x-api-key
string | null

Successful Response

Media type application/json
DatasetHealthReportResponse

Canonical bounded report for one exact published DatasetVersion.

object
contract
required
string
Allowed value: qds.dataset-health.v1
engine_revision
required
string
>= 1 characters <= 128 characters
dataset_version_id
required
string format: uuid
dataset_snapshot_id
required
string
/^[0-9a-f]{64}$/
membership_hash
required
string
/^[0-9a-f]{64}$/
norm_stats_hash
required
string
/^[0-9a-f]{64}$/
member_count
required
integer
>= 1 <= 100000
sampling
required
DatasetHealthSamplingResponse
object
policy
required
string
Allowed value: balanced-member-ordinal/1
maximum_members
required
integer
Allowed value: 120
sampled_member_count
required
integer
>= 1 <= 120
sampled_rows
required
integer
>= 1 <= 2000000
sampled_ordinals
required
Array<integer>
>= 1 items <= 120 items
sampled_episode_revision_ids
required
Array<string>
>= 1 items <= 120 items
evidence_digest
required
string
/^[0-9a-f]{64}$/
cache_identity
required
string
/^[0-9a-f]{64}$/
health_score
required
integer | null
<= 100
grade
required
string
nullable
Allowed values: A+ A A- B+ B B- C+ C C- D F
summary
required
string | null
<= 4096 characters
metrics
required
DatasetHealthNativeMetricsResponse
object
motion_quality
required
DatasetHealthMetricResponse

One bounded native metric over exact immutable trajectory bytes.

object
score
required
number
<= 1
details
required
workspace_coverage
required
DatasetHealthMetricResponse

One bounded native metric over exact immutable trajectory bytes.

object
score
required
number
<= 1
details
required
data_integrity
required
DatasetHealthMetricResponse

One bounded native metric over exact immutable trajectory bytes.

object
score
required
number
<= 1
details
required
data_health
required
DatasetHealthDiagnosticsResponse
object
action_autocorrelation
required
DatasetHealthMetricResponse

One bounded native metric over exact immutable trajectory bytes.

object
score
required
number
<= 1
details
required
state_action_alignment
required
DatasetHealthMetricResponse

One bounded native metric over exact immutable trajectory bytes.

object
score
required
number
<= 1
details
required
demonstrator_speed_variance
required
DatasetHealthMetricResponse

One bounded native metric over exact immutable trajectory bytes.

object
score
required
number
<= 1
details
required
cross_episode_action_variance
required
DatasetHealthMetricResponse

One bounded native metric over exact immutable trajectory bytes.

object
score
required
number
<= 1
details
required
episode_smoothness
required
DatasetHealthMetricResponse

One bounded native metric over exact immutable trajectory bytes.

object
score
required
number
<= 1
details
required
sensor_health
required
DatasetHealthMetricResponse

One bounded native metric over exact immutable trajectory bytes.

object
score
required
number
<= 1
details
required
flagged_episodes
required
Array<object>
<= 120 items
DatasetHealthFlaggedEpisodeResponse
object
episode_revision_id
required
string
/^[0-9a-f]{64}$/
member_ordinal
required
integer
reasons
required
Array<string>
>= 1 items <= 32 items
severity
required
string
Allowed values: low medium high
recommendations
required
Array<object>
>= 1 items <= 1 items
DatasetHealthRecommendationResponse
object
action
required
string
Allowed values: none review_episodes
target
required
Array<string>
nullable
impact
required
string
>= 1 characters <= 4096 characters
evidence_completeness
required
DatasetHealthEvidenceCompletenessResponse
object
native_trajectory_metrics
required
DatasetHealthNativeEvidenceResponse
object
status
required
string
Allowed value: sampled_exact_immutable
sample_policy
required
string
Allowed value: balanced-member-ordinal/1
visual_diversity
required
DatasetHealthUnavailableEvidenceResponse
object
status
required
string
Allowed value: unavailable
reason
required
string
>= 1 characters <= 4096 characters
demo_quality
required
DatasetHealthUnavailableEvidenceResponse
object
status
required
string
Allowed value: unavailable
reason
required
string
>= 1 characters <= 4096 characters
trajectory_diversity
required
DatasetHealthUnavailableEvidenceResponse
object
status
required
string
Allowed value: unavailable
reason
required
string
>= 1 characters <= 4096 characters
episode_outliers
required
DatasetHealthUnavailableEvidenceResponse
object
status
required
string
Allowed value: unavailable
reason
required
string
>= 1 characters <= 4096 characters
behavioral_coverage
required
DatasetHealthUnavailableEvidenceResponse
object
status
required
string
Allowed value: unavailable
reason
required
string
>= 1 characters <= 4096 characters
mutable_quality_projection
required
DatasetHealthUnreadEvidenceResponse
object
status
required
string
Allowed value: not_read
mutable_review_projection
required
DatasetHealthUnreadEvidenceResponse
object
status
required
string
Allowed value: not_read
report_digest
required
string
/^[0-9a-f]{64}$/
Example
{
"contract": "qds.dataset-health.v1",
"sampling": {
"policy": "balanced-member-ordinal/1",
"maximum_members": 120
},
"grade": "A+",
"flagged_episodes": [
{
"severity": "low"
}
],
"recommendations": [
{
"action": "none"
}
],
"evidence_completeness": {
"native_trajectory_metrics": {
"status": "sampled_exact_immutable",
"sample_policy": "balanced-member-ordinal/1"
},
"visual_diversity": {
"status": "unavailable"
},
"demo_quality": {
"status": "unavailable"
},
"trajectory_diversity": {
"status": "unavailable"
},
"episode_outliers": {
"status": "unavailable"
},
"behavioral_coverage": {
"status": "unavailable"
},
"mutable_quality_projection": {
"status": "not_read"
},
"mutable_review_projection": {
"status": "not_read"
}
}
}

Validation Error

Media type application/json
HTTPValidationError
object
detail
Array<object>
ValidationError
object
loc
required
Location
Array<string | integer>
msg
required
Message
string
type
required
Error Type
string
input
ctx
Context
object
Example generated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}