Skip to content
Qualia Docs

Episodes_BatchSampleEpisodeSeries

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

Several episodes’ series at once, each as SampleEpisodeSeries samples it (QUA-3486): what a dataset’s trajectories read. The takes are read together, so the artifacts they share are opened once and their reads overlap; each take still answers on its own, so one that cannot be read fails alone. Up to 50 takes, each an episode of the parent, and 20000 samples (the takes times max_points).

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.

Query Parameters

Section titled “Query Parameters ”
names
Array<string>

The takes, 1 to 50, each an episode of the parent: accounts/{account}/datasets/{dataset}/episodes/{episode}. Answered in this order.

maxPoints
integer format: int32

As SampleEpisodeSeriesRequest.max_points, for every take. The takes times max_points (400 when unset) are at most 20000: 50 takes at 400, or 10 at 2000.

streams
Array<string>
Allowed values: STREAM_UNSPECIFIED STATE ACTION TCP

As SampleEpisodeSeriesRequest.streams, for every take.

version
string

As SampleEpisodeSeriesRequest.version, for every take.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Response for Episodes.BatchSampleEpisodeSeries.

object
results

One per take asked, in the order asked.

Array<object>

One take’s answer.

object
name

Accounts/{account}/datasets/{dataset}/episodes/{episode}

string
series

Its series, as SampleEpisodeSeries answers; unset where it failed.

object
timeSeconds

Seconds from the first frame sampled, one per sample: a sample’s second of the episode’s recording is this plus window_start_seconds.

Array<number>
channels

Every channel the recording carries, on time_seconds.

Array<object>

One channel: one component of the state or the action vector.

object
stream

Which vector.

string format: enum
Allowed values: STREAM_UNSPECIFIED STATE ACTION TCP
key

Its positional key, “state[3]” or “action[3]”; the dataset’s robot interface names the positions. A TCP channel is named, “left.tcp.x”.

string
values

One value per sample; 0 where valid is false.

Array<number>
valid

Per sample: false where the recording holds no finite value.

Array<boolean>
fps

The recording’s frames per second.

number format: double
frameCount

Frames sampled: the take’s, or what its applied trim keeps.

string
unpublished

True when the take is in no published version yet (a split child before its publish): it has no channels to sample.

boolean
windowStartSeconds

Where the first frame sampled sits in the episode’s recording, in seconds of the recording (the clock its trim, subtasks and markers are in), on that frame: 0 until a trim is applied, the trim’s start once one is; a split’s piece is a recording of its own, so 0. Unset with unpublished.

number format: double
windowEndSeconds

Where the frames sampled end in the recording, in the same seconds: the end of the last one (window_start_seconds plus frame_count / fps). Unset with unpublished.

number format: double
errorCode

Where it failed, the gRPC status code SampleEpisodeSeries would have answered for this take, as google.rpc.Code numbers it (5 NOT_FOUND, 9 FAILED_PRECONDITION, …); 0 where it was read.

integer format: int32
errorMessage

Where it failed, why; empty otherwise.

string
Example 
{
  "results": [
    {
      "series": {
        "channels": [
          {
            "stream": "STREAM_UNSPECIFIED"
          }
        ]
      }
    }
  ]
}

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"
    }
  ]
}