@labelbox/recursion-sdk 0.0.160 → 0.0.162
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/index.d.ts +1 -1
- package/dist/generated/sdk.gen.d.ts +26 -6
- package/dist/generated/sdk.gen.js +50 -10
- package/dist/generated/types.gen.d.ts +175 -19
- package/dist/reference/resources-reference.generated.js +9 -0
- package/dist/reference/sdk-reference.generated.js +421 -28
- package/package.json +1 -1
|
@@ -2137,6 +2137,14 @@ export const SDK_REFERENCE = {
|
|
|
2137
2137
|
description: 'Stable evaluation identifier (UUID). An evaluation is a multi-problem comparison run.',
|
|
2138
2138
|
format: 'uuid',
|
|
2139
2139
|
},
|
|
2140
|
+
{
|
|
2141
|
+
name: 'kind',
|
|
2142
|
+
required: false,
|
|
2143
|
+
type: 'string',
|
|
2144
|
+
description: 'Which evaluation shape this is. Defaults to solve-and-grade for pre-kind records.',
|
|
2145
|
+
enum: ['solve_and_grade', 'grade_only'],
|
|
2146
|
+
default: 'solve_and_grade',
|
|
2147
|
+
},
|
|
2140
2148
|
{
|
|
2141
2149
|
name: 'name',
|
|
2142
2150
|
required: true,
|
|
@@ -5587,6 +5595,14 @@ export const SDK_REFERENCE = {
|
|
|
5587
5595
|
description: 'Stable evaluation identifier (UUID). An evaluation is a multi-problem comparison run.',
|
|
5588
5596
|
format: 'uuid',
|
|
5589
5597
|
},
|
|
5598
|
+
{
|
|
5599
|
+
name: 'kind',
|
|
5600
|
+
required: false,
|
|
5601
|
+
type: 'string',
|
|
5602
|
+
description: 'Which evaluation shape this is. Defaults to solve-and-grade for pre-kind records.',
|
|
5603
|
+
enum: ['solve_and_grade', 'grade_only'],
|
|
5604
|
+
default: 'solve_and_grade',
|
|
5605
|
+
},
|
|
5590
5606
|
{
|
|
5591
5607
|
name: 'name',
|
|
5592
5608
|
required: true,
|
|
@@ -16325,6 +16341,14 @@ export const SDK_REFERENCE = {
|
|
|
16325
16341
|
description: 'Stable evaluation identifier (UUID). An evaluation is a multi-problem comparison run.',
|
|
16326
16342
|
format: 'uuid',
|
|
16327
16343
|
},
|
|
16344
|
+
{
|
|
16345
|
+
name: 'kind',
|
|
16346
|
+
required: false,
|
|
16347
|
+
type: 'string',
|
|
16348
|
+
description: 'Which evaluation shape this is. Defaults to solve-and-grade for pre-kind records.',
|
|
16349
|
+
enum: ['solve_and_grade', 'grade_only'],
|
|
16350
|
+
default: 'solve_and_grade',
|
|
16351
|
+
},
|
|
16328
16352
|
{
|
|
16329
16353
|
name: 'name',
|
|
16330
16354
|
required: true,
|
|
@@ -17792,12 +17816,12 @@ export const SDK_REFERENCE = {
|
|
|
17792
17816
|
namespace: 'jobsV2',
|
|
17793
17817
|
method: 'getEventLogForOrganization',
|
|
17794
17818
|
signature: 'rl.jobsV2.getEventLogForOrganization({ organizationId, jobV2Id })',
|
|
17795
|
-
example: "const result = await rl.jobsV2.getEventLogForOrganization({\n organizationId: '<organizationId>',\n jobV2Id: '<jobV2Id>',\n});",
|
|
17819
|
+
example: "const result = await rl.jobsV2.getEventLogForOrganization({\n organizationId: '<organizationId>',\n jobV2Id: '<jobV2Id>',\n // optional: after, envelope\n});",
|
|
17796
17820
|
cliInvocation: 'rl jobs-v2 get-event-log-for-organization',
|
|
17797
17821
|
cliExample: 'rl jobs-v2 get-event-log-for-organization \\\n --organization-id <organizationId> \\\n --job-v2-id <jobV2Id>',
|
|
17798
17822
|
curlExample: "curl -X GET 'https://api.recursion.labelbox.com/v1/organizations/<organizationId>/jobs-v2/<jobV2Id>/event-log' \\\n -H 'Authorization: Bearer $LABELBOX_API_KEY'",
|
|
17799
17823
|
summary: 'Read the raw agent-service event log for an org-scoped jobs_v2 row',
|
|
17800
|
-
description: "Returns this job's own agent-service run event replay verbatim (lifecycle markers, stdout/stderr, and contract-event envelopes alike), oldest to newest, capped to a bounded recent window with a truncated flag. Empty when the job has no agent-service run yet.",
|
|
17824
|
+
description: "Returns this job's own agent-service run event replay verbatim (lifecycle markers, stdout/stderr, and contract-event envelopes alike), oldest to newest, capped to a bounded recent window with a truncated flag; with the after cursor only newer events are returned, still capped to the window. Empty when the job has no agent-service run yet.",
|
|
17801
17825
|
httpMethod: 'get',
|
|
17802
17826
|
path: '/v1/organizations/{organizationId}/jobs-v2/{jobV2Id}/event-log',
|
|
17803
17827
|
requiredPermissions: ['jobs:read'],
|
|
@@ -17818,6 +17842,22 @@ export const SDK_REFERENCE = {
|
|
|
17818
17842
|
description: 'Stable jobs_v2 identifier (UUID). One row per background-work unit in the generic, strategy-driven job framework.',
|
|
17819
17843
|
format: 'uuid',
|
|
17820
17844
|
},
|
|
17845
|
+
{
|
|
17846
|
+
name: 'after',
|
|
17847
|
+
in: 'query',
|
|
17848
|
+
required: false,
|
|
17849
|
+
type: 'string',
|
|
17850
|
+
description: 'Return only events whose sequence is greater than this value. Omit to read the whole transcript.',
|
|
17851
|
+
pattern: '^\\d+$',
|
|
17852
|
+
},
|
|
17853
|
+
{
|
|
17854
|
+
name: 'envelope',
|
|
17855
|
+
in: 'query',
|
|
17856
|
+
required: false,
|
|
17857
|
+
type: 'string',
|
|
17858
|
+
description: 'When true, wrap the events in an object that also carries the generation token of the run they came from. Omit for the bare event array.',
|
|
17859
|
+
enum: ['true', 'false'],
|
|
17860
|
+
},
|
|
17821
17861
|
],
|
|
17822
17862
|
response: {
|
|
17823
17863
|
type: 'RolloutTraceResponseDto',
|
|
@@ -17880,6 +17920,13 @@ export const SDK_REFERENCE = {
|
|
|
17880
17920
|
type: 'boolean',
|
|
17881
17921
|
description: 'True when the event stream was trimmed to the most recent window.',
|
|
17882
17922
|
},
|
|
17923
|
+
{
|
|
17924
|
+
name: 'generation',
|
|
17925
|
+
required: false,
|
|
17926
|
+
type: 'string',
|
|
17927
|
+
description: 'Opaque token identifying the run the events came from. It changes when the run is resubmitted and sequences restart, so a client holding an after cursor should discard what it holds and re-read; null while the job has no run yet.',
|
|
17928
|
+
nullable: true,
|
|
17929
|
+
},
|
|
17883
17930
|
],
|
|
17884
17931
|
},
|
|
17885
17932
|
},
|
|
@@ -19966,12 +20013,12 @@ export const SDK_REFERENCE = {
|
|
|
19966
20013
|
namespace: 'jobsV2',
|
|
19967
20014
|
method: 'getRolloutEventsForOrganization',
|
|
19968
20015
|
signature: 'rl.jobsV2.getRolloutEventsForOrganization({ organizationId, jobV2Id, rolloutRunId })',
|
|
19969
|
-
example: "const result = await rl.jobsV2.getRolloutEventsForOrganization({\n organizationId: '<organizationId>',\n jobV2Id: '<jobV2Id>',\n rolloutRunId: '<rolloutRunId>',\n});",
|
|
20016
|
+
example: "const result = await rl.jobsV2.getRolloutEventsForOrganization({\n organizationId: '<organizationId>',\n jobV2Id: '<jobV2Id>',\n rolloutRunId: '<rolloutRunId>',\n // optional: after, envelope\n});",
|
|
19970
20017
|
cliInvocation: 'rl jobs-v2 get-rollout-events-for-organization',
|
|
19971
20018
|
cliExample: 'rl jobs-v2 get-rollout-events-for-organization \\\n --organization-id <organizationId> \\\n --job-v2-id <jobV2Id> \\\n --rollout-run-id <rolloutRunId>',
|
|
19972
20019
|
curlExample: "curl -X GET 'https://api.recursion.labelbox.com/v1/organizations/<organizationId>/jobs-v2/<jobV2Id>/rollouts/<rolloutRunId>/events' \\\n -H 'Authorization: Bearer $LABELBOX_API_KEY'",
|
|
19973
20020
|
summary: "Read a rollout's trace events for an org-scoped jobs_v2 row",
|
|
19974
|
-
description: "Verifies rolloutRunId was reported by this job's own ingested telemetry before proxying agent-service, and bounds the returned event window.",
|
|
20021
|
+
description: "Verifies rolloutRunId was reported by this job's own ingested telemetry before proxying agent-service, and bounds the returned event window; with the after cursor only newer events are returned, still capped to the window.",
|
|
19975
20022
|
httpMethod: 'get',
|
|
19976
20023
|
path: '/v1/organizations/{organizationId}/jobs-v2/{jobV2Id}/rollouts/{rolloutRunId}/events',
|
|
19977
20024
|
requiredPermissions: ['jobs:read'],
|
|
@@ -20000,6 +20047,22 @@ export const SDK_REFERENCE = {
|
|
|
20000
20047
|
description: 'Opaque agent-service run id of the rollout to trace.',
|
|
20001
20048
|
minLength: 1,
|
|
20002
20049
|
},
|
|
20050
|
+
{
|
|
20051
|
+
name: 'after',
|
|
20052
|
+
in: 'query',
|
|
20053
|
+
required: false,
|
|
20054
|
+
type: 'string',
|
|
20055
|
+
description: 'Return only events whose sequence is greater than this value. Omit to read the whole transcript.',
|
|
20056
|
+
pattern: '^\\d+$',
|
|
20057
|
+
},
|
|
20058
|
+
{
|
|
20059
|
+
name: 'envelope',
|
|
20060
|
+
in: 'query',
|
|
20061
|
+
required: false,
|
|
20062
|
+
type: 'string',
|
|
20063
|
+
description: 'When true, wrap the events in an object that also carries the generation token of the run they came from. Omit for the bare event array.',
|
|
20064
|
+
enum: ['true', 'false'],
|
|
20065
|
+
},
|
|
20003
20066
|
],
|
|
20004
20067
|
response: {
|
|
20005
20068
|
type: 'RolloutTraceResponseDto',
|
|
@@ -20062,6 +20125,13 @@ export const SDK_REFERENCE = {
|
|
|
20062
20125
|
type: 'boolean',
|
|
20063
20126
|
description: 'True when the event stream was trimmed to the most recent window.',
|
|
20064
20127
|
},
|
|
20128
|
+
{
|
|
20129
|
+
name: 'generation',
|
|
20130
|
+
required: false,
|
|
20131
|
+
type: 'string',
|
|
20132
|
+
description: 'Opaque token identifying the run the events came from. It changes when the run is resubmitted and sequences restart, so a client holding an after cursor should discard what it holds and re-read; null while the job has no run yet.',
|
|
20133
|
+
nullable: true,
|
|
20134
|
+
},
|
|
20065
20135
|
],
|
|
20066
20136
|
},
|
|
20067
20137
|
},
|
|
@@ -20137,12 +20207,12 @@ export const SDK_REFERENCE = {
|
|
|
20137
20207
|
namespace: 'qa',
|
|
20138
20208
|
method: 'getLiveJobTranscript',
|
|
20139
20209
|
signature: 'rl.qa.getLiveJobTranscript({ environmentId, qaJobId })',
|
|
20140
|
-
example: "const result = await rl.qa.getLiveJobTranscript({\n environmentId: '<environmentId>',\n qaJobId: '<qaJobId>',\n});",
|
|
20210
|
+
example: "const result = await rl.qa.getLiveJobTranscript({\n environmentId: '<environmentId>',\n qaJobId: '<qaJobId>',\n // optional: after, envelope\n});",
|
|
20141
20211
|
cliInvocation: 'rl qa get-live-job-transcript',
|
|
20142
20212
|
cliExample: 'rl qa get-live-job-transcript \\\n --environment-id <environmentId> \\\n --qa-job-id <qaJobId>',
|
|
20143
20213
|
curlExample: "curl -X GET 'https://api.recursion.labelbox.com/v1/environments/<environmentId>/qa-jobs/<qaJobId>/transcript/live' \\\n -H 'Authorization: Bearer $LABELBOX_API_KEY'",
|
|
20144
20214
|
summary: 'Proxy live transcript from agent service for active QA jobs',
|
|
20145
|
-
description: 'Proxies the
|
|
20215
|
+
description: 'Proxies the event stream from the agent service for an active job, serialized as a JSON array of events; with the after cursor only newer events are returned. Only available while the job is pending, submitting, or running.',
|
|
20146
20216
|
httpMethod: 'get',
|
|
20147
20217
|
path: '/v1/environments/{environmentId}/qa-jobs/{qaJobId}/transcript/live',
|
|
20148
20218
|
requiredPermissions: ['qa:read', 'transcripts:read'],
|
|
@@ -20163,13 +20233,193 @@ export const SDK_REFERENCE = {
|
|
|
20163
20233
|
description: 'Stable QA-job identifier (UUID).',
|
|
20164
20234
|
format: 'uuid',
|
|
20165
20235
|
},
|
|
20236
|
+
{
|
|
20237
|
+
name: 'after',
|
|
20238
|
+
in: 'query',
|
|
20239
|
+
required: false,
|
|
20240
|
+
type: 'string',
|
|
20241
|
+
description: 'Return only events whose sequence is greater than this value. Omit to read the whole transcript.',
|
|
20242
|
+
pattern: '^\\d+$',
|
|
20243
|
+
},
|
|
20244
|
+
{
|
|
20245
|
+
name: 'envelope',
|
|
20246
|
+
in: 'query',
|
|
20247
|
+
required: false,
|
|
20248
|
+
type: 'string',
|
|
20249
|
+
description: 'When true, wrap the events in an object that also carries the generation token of the run they came from. Omit for the bare event array.',
|
|
20250
|
+
enum: ['true', 'false'],
|
|
20251
|
+
},
|
|
20166
20252
|
],
|
|
20167
20253
|
response: {
|
|
20168
20254
|
type: 'string',
|
|
20169
|
-
description: 'Live transcript events as a JSON-encoded array (text/plain)',
|
|
20255
|
+
description: 'Live transcript events as a JSON-encoded array, or a JSON-encoded object with the events and the run generation when the envelope flag is set (text/plain)',
|
|
20170
20256
|
},
|
|
20171
20257
|
responseMediaType: 'text/plain',
|
|
20172
20258
|
},
|
|
20259
|
+
getLiveRunConfigProbeRunTranscript: {
|
|
20260
|
+
operationId: 'getLiveRunConfigProbeRunTranscript',
|
|
20261
|
+
tag: 'run-configs',
|
|
20262
|
+
callPath: ['probeRuns', 'getLiveTranscript'],
|
|
20263
|
+
namespace: 'probeRuns',
|
|
20264
|
+
method: 'getLiveTranscript',
|
|
20265
|
+
signature: 'rl.probeRuns.getLiveTranscript({ runConfigProbeRunId })',
|
|
20266
|
+
example: "const result = await rl.probeRuns.getLiveTranscript({\n runConfigProbeRunId: '<runConfigProbeRunId>',\n // optional: after, envelope\n});",
|
|
20267
|
+
cliInvocation: 'rl probe-runs get-live-transcript',
|
|
20268
|
+
cliExample: 'rl probe-runs get-live-transcript \\\n --run-config-probe-run-id <runConfigProbeRunId>',
|
|
20269
|
+
curlExample: "curl -X GET 'https://api.recursion.labelbox.com/v1/run-config-probe-runs/<runConfigProbeRunId>/transcript/live' \\\n -H 'Authorization: Bearer $LABELBOX_API_KEY'",
|
|
20270
|
+
summary: 'Read the in-flight transcript of a probe-run',
|
|
20271
|
+
description: 'Proxies agent-service transcript events while the probe-run is pending or running; with the after cursor only newer events are returned.',
|
|
20272
|
+
httpMethod: 'get',
|
|
20273
|
+
path: '/v1/run-config-probe-runs/{runConfigProbeRunId}/transcript/live',
|
|
20274
|
+
requiredPermissions: ['run-configs:read'],
|
|
20275
|
+
params: [
|
|
20276
|
+
{
|
|
20277
|
+
name: 'runConfigProbeRunId',
|
|
20278
|
+
in: 'path',
|
|
20279
|
+
required: true,
|
|
20280
|
+
type: 'string',
|
|
20281
|
+
description: 'Stable probe-run identifier (UUID). Probe runs validate a run-config version before locking.',
|
|
20282
|
+
format: 'uuid',
|
|
20283
|
+
},
|
|
20284
|
+
{
|
|
20285
|
+
name: 'after',
|
|
20286
|
+
in: 'query',
|
|
20287
|
+
required: false,
|
|
20288
|
+
type: 'string',
|
|
20289
|
+
description: 'Return only events whose sequence is greater than this value. Omit to read the whole transcript.',
|
|
20290
|
+
pattern: '^\\d+$',
|
|
20291
|
+
},
|
|
20292
|
+
{
|
|
20293
|
+
name: 'envelope',
|
|
20294
|
+
in: 'query',
|
|
20295
|
+
required: false,
|
|
20296
|
+
type: 'string',
|
|
20297
|
+
description: 'When true, wrap the events in an object that also carries the generation token of the run they came from. Omit for the bare event array.',
|
|
20298
|
+
enum: ['true', 'false'],
|
|
20299
|
+
},
|
|
20300
|
+
],
|
|
20301
|
+
response: {
|
|
20302
|
+
type: 'AgentRunEventListDto | LiveTranscriptEnvelopeDto',
|
|
20303
|
+
variants: [
|
|
20304
|
+
{
|
|
20305
|
+
name: 'variant 1',
|
|
20306
|
+
type: 'AgentRunEventListDto',
|
|
20307
|
+
description: 'Agent-service transcript events, ordered by sequence ascending.',
|
|
20308
|
+
items: {
|
|
20309
|
+
type: 'object',
|
|
20310
|
+
description: 'Single event emitted by the agent-service while running a solver or grader.',
|
|
20311
|
+
fields: [
|
|
20312
|
+
{
|
|
20313
|
+
name: 'sequence',
|
|
20314
|
+
required: true,
|
|
20315
|
+
type: 'number',
|
|
20316
|
+
description: 'Monotonically increasing sequence number assigned by the agent-service.',
|
|
20317
|
+
},
|
|
20318
|
+
{
|
|
20319
|
+
name: 'event_type',
|
|
20320
|
+
required: true,
|
|
20321
|
+
type: 'string',
|
|
20322
|
+
description: 'Category of the event: lifecycle markers (started, launched, done, error), stdio (stdout, stderr), structured event payloads (event), agent observations (observation), and setup/snapshot phases.',
|
|
20323
|
+
enum: [
|
|
20324
|
+
'started',
|
|
20325
|
+
'stdout',
|
|
20326
|
+
'stderr',
|
|
20327
|
+
'event',
|
|
20328
|
+
'observation',
|
|
20329
|
+
'process_exited',
|
|
20330
|
+
'snapshotting',
|
|
20331
|
+
'launched',
|
|
20332
|
+
'setup_started',
|
|
20333
|
+
'setup_completed',
|
|
20334
|
+
'input_delivered',
|
|
20335
|
+
'done',
|
|
20336
|
+
'error',
|
|
20337
|
+
],
|
|
20338
|
+
},
|
|
20339
|
+
{
|
|
20340
|
+
name: 'data',
|
|
20341
|
+
required: true,
|
|
20342
|
+
type: 'object',
|
|
20343
|
+
description: 'Payload of the event; shape varies by event_type.',
|
|
20344
|
+
},
|
|
20345
|
+
{
|
|
20346
|
+
name: 'created_at',
|
|
20347
|
+
required: true,
|
|
20348
|
+
type: 'string',
|
|
20349
|
+
description: 'Timestamp when the agent-service emitted the event (ISO-8601, UTC).',
|
|
20350
|
+
},
|
|
20351
|
+
],
|
|
20352
|
+
},
|
|
20353
|
+
},
|
|
20354
|
+
{
|
|
20355
|
+
name: 'variant 2',
|
|
20356
|
+
type: 'LiveTranscriptEnvelopeDto',
|
|
20357
|
+
description: 'Live transcript events together with the generation token of the run they came from.',
|
|
20358
|
+
fields: [
|
|
20359
|
+
{
|
|
20360
|
+
name: 'events',
|
|
20361
|
+
required: true,
|
|
20362
|
+
type: 'object[]',
|
|
20363
|
+
description: 'Live transcript events, ordered by sequence ascending.',
|
|
20364
|
+
items: {
|
|
20365
|
+
type: 'object',
|
|
20366
|
+
description: 'Single event emitted by the agent-service while running a solver or grader.',
|
|
20367
|
+
fields: [
|
|
20368
|
+
{
|
|
20369
|
+
name: 'sequence',
|
|
20370
|
+
required: true,
|
|
20371
|
+
type: 'number',
|
|
20372
|
+
description: 'Monotonically increasing sequence number assigned by the agent-service.',
|
|
20373
|
+
},
|
|
20374
|
+
{
|
|
20375
|
+
name: 'event_type',
|
|
20376
|
+
required: true,
|
|
20377
|
+
type: 'string',
|
|
20378
|
+
description: 'Category of the event: lifecycle markers (started, launched, done, error), stdio (stdout, stderr), structured event payloads (event), agent observations (observation), and setup/snapshot phases.',
|
|
20379
|
+
enum: [
|
|
20380
|
+
'started',
|
|
20381
|
+
'stdout',
|
|
20382
|
+
'stderr',
|
|
20383
|
+
'event',
|
|
20384
|
+
'observation',
|
|
20385
|
+
'process_exited',
|
|
20386
|
+
'snapshotting',
|
|
20387
|
+
'launched',
|
|
20388
|
+
'setup_started',
|
|
20389
|
+
'setup_completed',
|
|
20390
|
+
'input_delivered',
|
|
20391
|
+
'done',
|
|
20392
|
+
'error',
|
|
20393
|
+
],
|
|
20394
|
+
},
|
|
20395
|
+
{
|
|
20396
|
+
name: 'data',
|
|
20397
|
+
required: true,
|
|
20398
|
+
type: 'object',
|
|
20399
|
+
description: 'Payload of the event; shape varies by event_type.',
|
|
20400
|
+
},
|
|
20401
|
+
{
|
|
20402
|
+
name: 'created_at',
|
|
20403
|
+
required: true,
|
|
20404
|
+
type: 'string',
|
|
20405
|
+
description: 'Timestamp when the agent-service emitted the event (ISO-8601, UTC).',
|
|
20406
|
+
},
|
|
20407
|
+
],
|
|
20408
|
+
},
|
|
20409
|
+
},
|
|
20410
|
+
{
|
|
20411
|
+
name: 'generation',
|
|
20412
|
+
required: true,
|
|
20413
|
+
type: 'string',
|
|
20414
|
+
description: 'Opaque token identifying the run the events came from. It changes when the run is resubmitted and sequences restart, so a client holding an after cursor should discard what it holds and re-read; null while the job has no run yet.',
|
|
20415
|
+
nullable: true,
|
|
20416
|
+
},
|
|
20417
|
+
],
|
|
20418
|
+
},
|
|
20419
|
+
],
|
|
20420
|
+
description: 'Live transcript events, or wrapped with the run generation when the envelope flag is set',
|
|
20421
|
+
},
|
|
20422
|
+
},
|
|
20173
20423
|
getLiveSynthesizerRunTranscript: {
|
|
20174
20424
|
operationId: 'getLiveSynthesizerRunTranscript',
|
|
20175
20425
|
tag: 'synthesizer',
|
|
@@ -20177,12 +20427,12 @@ export const SDK_REFERENCE = {
|
|
|
20177
20427
|
namespace: 'synthesizerRuns',
|
|
20178
20428
|
method: 'getLiveTranscript',
|
|
20179
20429
|
signature: 'rl.synthesizerRuns.getLiveTranscript({ problemVersionId, synthesizerRunId })',
|
|
20180
|
-
example: "const result = await rl.synthesizerRuns.getLiveTranscript({\n problemVersionId: '<problemVersionId>',\n synthesizerRunId: '<synthesizerRunId>',\n});",
|
|
20430
|
+
example: "const result = await rl.synthesizerRuns.getLiveTranscript({\n problemVersionId: '<problemVersionId>',\n synthesizerRunId: '<synthesizerRunId>',\n // optional: after, envelope\n});",
|
|
20181
20431
|
cliInvocation: 'rl synthesizer-runs get-live-transcript',
|
|
20182
20432
|
cliExample: 'rl synthesizer-runs get-live-transcript \\\n --problem-version-id <problemVersionId> \\\n --synthesizer-run-id <synthesizerRunId>',
|
|
20183
20433
|
curlExample: "curl -X GET 'https://api.recursion.labelbox.com/v1/versions/<problemVersionId>/synthesizer-runs/<synthesizerRunId>/transcript/live' \\\n -H 'Authorization: Bearer $LABELBOX_API_KEY'",
|
|
20184
20434
|
summary: 'Proxy live transcript from agent service for active synthesizer runs',
|
|
20185
|
-
description: 'Proxies the
|
|
20435
|
+
description: 'Proxies the event stream from the agent service for an active run, serialized as a JSON array of events; with the after cursor only newer events are returned. Only available while the run is pending or running.',
|
|
20186
20436
|
httpMethod: 'get',
|
|
20187
20437
|
path: '/v1/versions/{problemVersionId}/synthesizer-runs/{synthesizerRunId}/transcript/live',
|
|
20188
20438
|
requiredPermissions: ['versions:read', 'transcripts:read'],
|
|
@@ -20203,10 +20453,26 @@ export const SDK_REFERENCE = {
|
|
|
20203
20453
|
description: 'Stable synthesizer-run identifier (UUID). One execution of a synthesizer job.',
|
|
20204
20454
|
format: 'uuid',
|
|
20205
20455
|
},
|
|
20456
|
+
{
|
|
20457
|
+
name: 'after',
|
|
20458
|
+
in: 'query',
|
|
20459
|
+
required: false,
|
|
20460
|
+
type: 'string',
|
|
20461
|
+
description: 'Return only events whose sequence is greater than this value. Omit to read the whole transcript.',
|
|
20462
|
+
pattern: '^\\d+$',
|
|
20463
|
+
},
|
|
20464
|
+
{
|
|
20465
|
+
name: 'envelope',
|
|
20466
|
+
in: 'query',
|
|
20467
|
+
required: false,
|
|
20468
|
+
type: 'string',
|
|
20469
|
+
description: 'When true, wrap the events in an object that also carries the generation token of the run they came from. Omit for the bare event array.',
|
|
20470
|
+
enum: ['true', 'false'],
|
|
20471
|
+
},
|
|
20206
20472
|
],
|
|
20207
20473
|
response: {
|
|
20208
20474
|
type: 'string',
|
|
20209
|
-
description: 'Live transcript events as a JSON-encoded array (text/plain)',
|
|
20475
|
+
description: 'Live transcript events as a JSON-encoded array, or a JSON-encoded object with the events and the run generation when the envelope flag is set (text/plain)',
|
|
20210
20476
|
},
|
|
20211
20477
|
responseMediaType: 'text/plain',
|
|
20212
20478
|
},
|
|
@@ -20217,12 +20483,12 @@ export const SDK_REFERENCE = {
|
|
|
20217
20483
|
namespace: 'problemRuns',
|
|
20218
20484
|
method: 'getLiveTranscript',
|
|
20219
20485
|
signature: 'rl.problemRuns.getLiveTranscript({ problemRunId })',
|
|
20220
|
-
example: "const result = await rl.problemRuns.getLiveTranscript({\n problemRunId: '<problemRunId>',\n});",
|
|
20486
|
+
example: "const result = await rl.problemRuns.getLiveTranscript({\n problemRunId: '<problemRunId>',\n // optional: after, envelope\n});",
|
|
20221
20487
|
cliInvocation: 'rl problem-runs get-live-transcript',
|
|
20222
20488
|
cliExample: 'rl problem-runs get-live-transcript \\\n --problem-run-id <problemRunId>',
|
|
20223
20489
|
curlExample: "curl -X GET 'https://api.recursion.labelbox.com/v1/problem-runs/<problemRunId>/transcript/live' \\\n -H 'Authorization: Bearer $LABELBOX_API_KEY'",
|
|
20224
20490
|
summary: 'Stream the in-flight transcript for an active run',
|
|
20225
|
-
description: 'Returns a JSON array of AgentRunEvent objects — proxied from agent-service for native runs (pending/running) and from Taiga for taiga-provenance runs (pending/running/grading). The active-status set widens for taiga rows because the task transcript on Taiga is fully written by the time the run is in grading.',
|
|
20491
|
+
description: 'Returns a JSON array of AgentRunEvent objects — proxied from agent-service for native runs (pending/running) and from Taiga for taiga-provenance runs (pending/running/grading). The active-status set widens for taiga rows because the task transcript on Taiga is fully written by the time the run is in grading. Native runs honour the after cursor and return only newer events; Taiga runs always return the whole transcript.',
|
|
20226
20492
|
httpMethod: 'get',
|
|
20227
20493
|
path: '/v1/problem-runs/{problemRunId}/transcript/live',
|
|
20228
20494
|
requiredPermissions: ['transcripts:read'],
|
|
@@ -20235,10 +20501,143 @@ export const SDK_REFERENCE = {
|
|
|
20235
20501
|
description: 'Stable problem-run identifier (UUID). One solver attempt at one problem version.',
|
|
20236
20502
|
format: 'uuid',
|
|
20237
20503
|
},
|
|
20504
|
+
{
|
|
20505
|
+
name: 'after',
|
|
20506
|
+
in: 'query',
|
|
20507
|
+
required: false,
|
|
20508
|
+
type: 'string',
|
|
20509
|
+
description: 'Return only events whose sequence is greater than this value. Omit to read the whole transcript.',
|
|
20510
|
+
pattern: '^\\d+$',
|
|
20511
|
+
},
|
|
20512
|
+
{
|
|
20513
|
+
name: 'envelope',
|
|
20514
|
+
in: 'query',
|
|
20515
|
+
required: false,
|
|
20516
|
+
type: 'string',
|
|
20517
|
+
description: 'When true, wrap the events in an object that also carries the generation token of the run they came from. Omit for the bare event array.',
|
|
20518
|
+
enum: ['true', 'false'],
|
|
20519
|
+
},
|
|
20238
20520
|
],
|
|
20239
20521
|
response: {
|
|
20240
|
-
type: '
|
|
20241
|
-
|
|
20522
|
+
type: 'AgentRunEventListDto | LiveTranscriptEnvelopeDto',
|
|
20523
|
+
variants: [
|
|
20524
|
+
{
|
|
20525
|
+
name: 'variant 1',
|
|
20526
|
+
type: 'AgentRunEventListDto',
|
|
20527
|
+
description: 'Agent-service transcript events, ordered by sequence ascending.',
|
|
20528
|
+
items: {
|
|
20529
|
+
type: 'object',
|
|
20530
|
+
description: 'Single event emitted by the agent-service while running a solver or grader.',
|
|
20531
|
+
fields: [
|
|
20532
|
+
{
|
|
20533
|
+
name: 'sequence',
|
|
20534
|
+
required: true,
|
|
20535
|
+
type: 'number',
|
|
20536
|
+
description: 'Monotonically increasing sequence number assigned by the agent-service.',
|
|
20537
|
+
},
|
|
20538
|
+
{
|
|
20539
|
+
name: 'event_type',
|
|
20540
|
+
required: true,
|
|
20541
|
+
type: 'string',
|
|
20542
|
+
description: 'Category of the event: lifecycle markers (started, launched, done, error), stdio (stdout, stderr), structured event payloads (event), agent observations (observation), and setup/snapshot phases.',
|
|
20543
|
+
enum: [
|
|
20544
|
+
'started',
|
|
20545
|
+
'stdout',
|
|
20546
|
+
'stderr',
|
|
20547
|
+
'event',
|
|
20548
|
+
'observation',
|
|
20549
|
+
'process_exited',
|
|
20550
|
+
'snapshotting',
|
|
20551
|
+
'launched',
|
|
20552
|
+
'setup_started',
|
|
20553
|
+
'setup_completed',
|
|
20554
|
+
'input_delivered',
|
|
20555
|
+
'done',
|
|
20556
|
+
'error',
|
|
20557
|
+
],
|
|
20558
|
+
},
|
|
20559
|
+
{
|
|
20560
|
+
name: 'data',
|
|
20561
|
+
required: true,
|
|
20562
|
+
type: 'object',
|
|
20563
|
+
description: 'Payload of the event; shape varies by event_type.',
|
|
20564
|
+
},
|
|
20565
|
+
{
|
|
20566
|
+
name: 'created_at',
|
|
20567
|
+
required: true,
|
|
20568
|
+
type: 'string',
|
|
20569
|
+
description: 'Timestamp when the agent-service emitted the event (ISO-8601, UTC).',
|
|
20570
|
+
},
|
|
20571
|
+
],
|
|
20572
|
+
},
|
|
20573
|
+
},
|
|
20574
|
+
{
|
|
20575
|
+
name: 'variant 2',
|
|
20576
|
+
type: 'LiveTranscriptEnvelopeDto',
|
|
20577
|
+
description: 'Live transcript events together with the generation token of the run they came from.',
|
|
20578
|
+
fields: [
|
|
20579
|
+
{
|
|
20580
|
+
name: 'events',
|
|
20581
|
+
required: true,
|
|
20582
|
+
type: 'object[]',
|
|
20583
|
+
description: 'Live transcript events, ordered by sequence ascending.',
|
|
20584
|
+
items: {
|
|
20585
|
+
type: 'object',
|
|
20586
|
+
description: 'Single event emitted by the agent-service while running a solver or grader.',
|
|
20587
|
+
fields: [
|
|
20588
|
+
{
|
|
20589
|
+
name: 'sequence',
|
|
20590
|
+
required: true,
|
|
20591
|
+
type: 'number',
|
|
20592
|
+
description: 'Monotonically increasing sequence number assigned by the agent-service.',
|
|
20593
|
+
},
|
|
20594
|
+
{
|
|
20595
|
+
name: 'event_type',
|
|
20596
|
+
required: true,
|
|
20597
|
+
type: 'string',
|
|
20598
|
+
description: 'Category of the event: lifecycle markers (started, launched, done, error), stdio (stdout, stderr), structured event payloads (event), agent observations (observation), and setup/snapshot phases.',
|
|
20599
|
+
enum: [
|
|
20600
|
+
'started',
|
|
20601
|
+
'stdout',
|
|
20602
|
+
'stderr',
|
|
20603
|
+
'event',
|
|
20604
|
+
'observation',
|
|
20605
|
+
'process_exited',
|
|
20606
|
+
'snapshotting',
|
|
20607
|
+
'launched',
|
|
20608
|
+
'setup_started',
|
|
20609
|
+
'setup_completed',
|
|
20610
|
+
'input_delivered',
|
|
20611
|
+
'done',
|
|
20612
|
+
'error',
|
|
20613
|
+
],
|
|
20614
|
+
},
|
|
20615
|
+
{
|
|
20616
|
+
name: 'data',
|
|
20617
|
+
required: true,
|
|
20618
|
+
type: 'object',
|
|
20619
|
+
description: 'Payload of the event; shape varies by event_type.',
|
|
20620
|
+
},
|
|
20621
|
+
{
|
|
20622
|
+
name: 'created_at',
|
|
20623
|
+
required: true,
|
|
20624
|
+
type: 'string',
|
|
20625
|
+
description: 'Timestamp when the agent-service emitted the event (ISO-8601, UTC).',
|
|
20626
|
+
},
|
|
20627
|
+
],
|
|
20628
|
+
},
|
|
20629
|
+
},
|
|
20630
|
+
{
|
|
20631
|
+
name: 'generation',
|
|
20632
|
+
required: true,
|
|
20633
|
+
type: 'string',
|
|
20634
|
+
description: 'Opaque token identifying the run the events came from. It changes when the run is resubmitted and sequences restart, so a client holding an after cursor should discard what it holds and re-read; null while the job has no run yet.',
|
|
20635
|
+
nullable: true,
|
|
20636
|
+
},
|
|
20637
|
+
],
|
|
20638
|
+
},
|
|
20639
|
+
],
|
|
20640
|
+
description: 'Live transcript events as a JSON array, or wrapped with the run generation when the envelope flag is set',
|
|
20242
20641
|
},
|
|
20243
20642
|
},
|
|
20244
20643
|
getMarketplaceImage: {
|
|
@@ -25209,13 +25608,6 @@ export const SDK_REFERENCE = {
|
|
|
25209
25608
|
},
|
|
25210
25609
|
],
|
|
25211
25610
|
},
|
|
25212
|
-
{
|
|
25213
|
-
name: 'liveTranscript',
|
|
25214
|
-
required: true,
|
|
25215
|
-
type: 'string',
|
|
25216
|
-
description: 'JSON-encoded array of agent-service events observed so far while the probe is in flight. Null when no live events are available or the probe is terminal.',
|
|
25217
|
-
nullable: true,
|
|
25218
|
-
},
|
|
25219
25611
|
{
|
|
25220
25612
|
name: 'createdAt',
|
|
25221
25613
|
required: true,
|
|
@@ -28599,6 +28991,14 @@ export const SDK_REFERENCE = {
|
|
|
28599
28991
|
description: 'Stable evaluation identifier (UUID). An evaluation is a multi-problem comparison run.',
|
|
28600
28992
|
format: 'uuid',
|
|
28601
28993
|
},
|
|
28994
|
+
{
|
|
28995
|
+
name: 'kind',
|
|
28996
|
+
required: false,
|
|
28997
|
+
type: 'string',
|
|
28998
|
+
description: 'Which evaluation shape this is. Defaults to solve-and-grade for pre-kind records.',
|
|
28999
|
+
enum: ['solve_and_grade', 'grade_only'],
|
|
29000
|
+
default: 'solve_and_grade',
|
|
29001
|
+
},
|
|
28602
29002
|
{
|
|
28603
29003
|
name: 'name',
|
|
28604
29004
|
required: true,
|
|
@@ -37647,13 +38047,6 @@ export const SDK_REFERENCE = {
|
|
|
37647
38047
|
},
|
|
37648
38048
|
],
|
|
37649
38049
|
},
|
|
37650
|
-
{
|
|
37651
|
-
name: 'liveTranscript',
|
|
37652
|
-
required: true,
|
|
37653
|
-
type: 'string',
|
|
37654
|
-
description: 'JSON-encoded array of agent-service events observed so far while the probe is in flight. Null when no live events are available or the probe is terminal.',
|
|
37655
|
-
nullable: true,
|
|
37656
|
-
},
|
|
37657
38050
|
{
|
|
37658
38051
|
name: 'createdAt',
|
|
37659
38052
|
required: true,
|