Skip to content
Qualia Docs

Versions_ListVersionPreviewItems

GET
/v1/accounts/{account}/datasets/{dataset}/versionPreviews/{versionPreview}/items
 
curl --request GET \
  --url https://dev-api.qualiastudios.dev/v1/accounts/example/datasets/example/versionPreviews/example/items \
  --header 'X-API-Key: <X-API-Key>'

A preview’s windows, take by take, with what each measured: the numbers its charts draw. Paged. (— api-linter: core::0132::http-uri-parent=disabled api-linter: core::0132::method-signature=disabled aip.dev/not-precedent: a window is not a resource of its own; it is read through the preview that froze it. —)

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
account
required
string

The account id.

dataset
required
string

The dataset id.

versionPreview
required
string

The versionPreview id.

Query Parameters

Section titled “Query Parameters ”
pageSize
integer format: int32

At most this many windows; 0 means 500, the maximum is 2000.

pageToken
string

From a previous response’s next_page_token.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Response for Versions.ListVersionPreviewItems.

object
versionPreviewItems

One page of windows, in take order and each take’s in time order.

Array<object>

One window of a preview: a stretch of one take the version would hold, and how it measured.

object
take

Accounts/{account}/datasets/{dataset}/episodes/{episode}: the take it is cut from.

string
piece

Its place among the take’s windows, from 0.

integer format: int32
pieces

The take’s windows: 1 for a take as recorded or trimmed, more for a split.

integer format: int32
startSeconds

Where it starts, seconds from the start of the take’s recording.

number format: double
endSeconds

Where it ends, seconds from the start of the take’s recording.

number format: double
label

The take as a person finds it in the dataset, e.g. “episode 41 · pick_cup_041”.

string
episode

Accounts/{account}/datasets/{dataset}/episodes/{episode}: the episode the version pins for it. The take itself when it is published as recorded; for an edited take, its new episode once the preview is PUBLISHED, and empty before (publishing makes the new episodes).

string
analysis

How it moves, measured over the window alone, as Episode.analysis reads; unset when it could not be measured.

object
version

The definition the numbers follow; a reader treats another one as not measured yet.

string
unmeasuredReason

Why the take could not be measured: “no_joints” (no state) or “channel_never_read”. Empty when measured.

string
fps

Rows per second it was measured at.

number format: double
frames

Rows read.

integer format: int32
speedVariance

Variance of the joint speed over every state channel, (units/s)^2.

number format: double
speedMean

Mean joint speed over every state channel, units/s.

number format: double
jerkMean

Mean norm of the state’s third difference, units/s^3.

number format: double
highFrequencyRatio

Share of the speed spectrum’s power above 3 Hz.

number format: double
idleRatio

Share of frames under 5% of the top speed.

number format: double
tremble

Mean |v_smooth - v| / (|v_smooth| + |v|) over the arm joints.

number format: double
gripperEventCount

Commanded gripper moves of at least 30% of their travel.

integer format: int32
gripperFlickerCount

The most events of one gripper inside 0.5 s.

integer format: int32
correctionCount

Regrasps within 3 s, plus events the arm retraces its approach round.

integer format: int32
stateChannels

State channel names, in the order of the poses.

Array<string>
startPose

First state row, every channel.

Array<number>
endPose

Last state row, every channel.

Array<number>
channels

Every commanded channel, in recording order.

Array<object>

One commanded channel’s training-chart inputs.

object
name

Channel name, as the recording names it.

string
progress

The value at 50 evenly spaced points of the take, first to last.

Array<number>
autocorrelation

Autocorrelation at lags 1..min(100, frames / 2); empty when the channel never moves, and in a list.

Array<number>
alignment

Unset when the state has no channel of this name, and in a list.

object
correlation

Correlation at lags -30..30 frames; NaN where a lag has no variance. Empty when the take is under 5 frames.

Array<number>
nextPageToken

Empty on the last page.

string
Example generated
{
  "versionPreviewItems": [
    {}
  ],
  "nextPageToken": "example"
}

default

Section titled “default ”

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}