curl --request GET \
--url https://api.hebbianrobotics.com/api/v1beta/quality/frame-quality \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.hebbianrobotics.com/api/v1beta/quality/frame-quality"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.hebbianrobotics.com/api/v1beta/quality/frame-quality', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));false{
"analysis": "<string>",
"classification_version": "<string>",
"coverage_share": 0.5,
"dataset": "<string>",
"distorted_frames": 1,
"distorted_share": 0.5,
"frame_quality": "<string>",
"frames_measured": 1,
"jerky_frames": 1,
"jerky_share": 0.5,
"usable_frames": 1,
"usable_share": 0.5
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}Get dataset frame-quality
Each measured frame is counted once as usable, distorted, or jerky. The response includes category counts, shares, and coverage.
curl --request GET \
--url https://api.hebbianrobotics.com/api/v1beta/quality/frame-quality \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.hebbianrobotics.com/api/v1beta/quality/frame-quality"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.hebbianrobotics.com/api/v1beta/quality/frame-quality', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));false{
"analysis": "<string>",
"classification_version": "<string>",
"coverage_share": 0.5,
"dataset": "<string>",
"distorted_frames": 1,
"distorted_share": 0.5,
"frame_quality": "<string>",
"frames_measured": 1,
"jerky_frames": 1,
"jerky_share": 0.5,
"usable_frames": 1,
"usable_share": 0.5
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}Authorizations
Bearer access token issued through OAuth 2.0 client credentials.
Query Parameters
Dataset ID from GET /api/v1beta/quality/datasets.
Opaque analysis token from an earlier response. Omit to use the latest
measurement.
Opaque frame_quality token from an earlier response. Omit to use the
latest measurement.
Response
Frame-quality counts, shares, and coverage
Dataset-level frame-quality counts, shares, and measurement completeness.
Each measured frame belongs to one category. Shares are derived from the
category counts and frames_measured, and are null when no frames were
measured.
Opaque token identifying the analysis used for this response.
Opaque classification version. Match this value when comparing frame-quality results.
Measurement completeness in [0, 1]. null when a reliable
denominator is unavailable.
0 <= x <= 1Dataset ID used in the request.
Frames with image-quality problems that limit readability.
x >= 0distorted_frames / frames_measured.
0 <= x <= 1Opaque token identifying the frame-quality measurement.
Frames included in the three frame-quality categories.
x >= 0Readable frames with a large change from the preceding frame.
x >= 0jerky_frames / frames_measured.
0 <= x <= 1Frames not classified as distorted or jerky.
x >= 0usable_frames / frames_measured.
0 <= x <= 1