@labelbox/rl-sdk 0.0.0

package/dist/reference/concepts.js

@@ -0,0 +1,354 @@
+/**
+ * Authoritative concept registry. A concept exists because it is declared here;
+ * an optional `apps/recursion/web/public/docs/concepts/<id>.md` file enriches its rendered
+ * body and search text but never controls membership or metadata.
+ */
+export const CONCEPT_REFERENCE = {
+    'anatomy-of-a-problem-version': {
+        id: 'anatomy-of-a-problem-version',
+        title: 'Anatomy of a problem version',
+        domain: 'problems',
+        related: [
+            'concept:problem-lifecycle',
+            'concept:run-config-roles',
+            'resource:problem-versions',
+            'resource:problems',
+        ],
+    },
+    'authentication-and-access': {
+        id: 'authentication-and-access',
+        title: 'Authentication and access',
+        domain: 'platform',
+        related: ['concept:the-permission-model', 'concept:organizations-and-users'],
+    },
+    computes: {
+        id: 'computes',
+        title: 'Computes',
+        domain: 'run-configs',
+        related: [
+            'concept:run-config-anatomy',
+            'concept:snapshot-solvers-on-compute',
+            'resource:computes',
+        ],
+    },
+    'container-images-and-the-marketplace': {
+        id: 'container-images-and-the-marketplace',
+        title: 'Container images and the marketplace',
+        domain: 'run-configs',
+        related: [
+            'concept:computes',
+            'recipe:browse-images-and-models',
+            'resource:images',
+            'resource:marketplace',
+            'resource:models',
+        ],
+    },
+    'cost-accounting': {
+        id: 'cost-accounting',
+        title: 'How cost is accounted',
+        domain: 'cost',
+        related: [
+            'resource:cost-limits',
+            'resource:problem-runs',
+            'resource:evaluations',
+            'concept:cost-limits-and-budgets',
+            'concept:the-cost-explorer',
+        ],
+    },
+    'cost-limits-and-budgets': {
+        id: 'cost-limits-and-budgets',
+        title: 'Cost limits and budgets',
+        domain: 'cost',
+        related: [
+            'recipe:set-a-per-problem-cost-limit',
+            'recipe:set-an-environment-cost-limit',
+            'recipe:remove-a-cost-limit',
+            'resource:cost-limits',
+            'concept:cost-accounting',
+        ],
+    },
+    'designing-an-evaluation': {
+        id: 'designing-an-evaluation',
+        title: 'Designing an evaluation',
+        domain: 'evaluations',
+        related: [
+            'concept:evaluation-vs-problem-run',
+            'recipe:run-an-evaluation',
+            'recipe:export-evaluation-results',
+            'resource:evaluations',
+        ],
+    },
+    'environment-files': {
+        id: 'environment-files',
+        title: 'Environment files',
+        domain: 'environments',
+        related: ['resource:environment-files', 'concept:problem-files', 'resource:environments'],
+    },
+    'environment-snapshots-and-duplication': {
+        id: 'environment-snapshots-and-duplication',
+        title: 'Environment duplication',
+        domain: 'integrations',
+        related: [
+            'concept:exporting-and-reusing-an-environment',
+            'recipe:export-an-environment',
+            'resource:environments',
+        ],
+    },
+    'environment-templates-and-defaults': {
+        id: 'environment-templates-and-defaults',
+        title: 'Environment templates and defaults',
+        domain: 'environments',
+        related: ['resource:environments', 'resource:run-configs', 'resource:forms'],
+    },
+    'evaluation-vs-problem-run': {
+        id: 'evaluation-vs-problem-run',
+        title: 'Evaluations vs. problem runs',
+        domain: 'evaluations',
+        related: ['resource:evaluations', 'resource:problem-runs', 'recipe:run-an-evaluation'],
+    },
+    'exporting-and-reusing-an-environment': {
+        id: 'exporting-and-reusing-an-environment',
+        title: 'Exporting and reusing an environment',
+        domain: 'environments',
+        related: [
+            'recipe:export-an-environment',
+            'concept:environment-templates-and-defaults',
+            'concept:environment-snapshots-and-duplication',
+            'resource:exports',
+            'resource:environments',
+        ],
+    },
+    'forms-and-structured-capture': {
+        id: 'forms-and-structured-capture',
+        title: 'Forms and structured capture',
+        domain: 'problems',
+        related: ['resource:forms', 'resource:form-answers'],
+    },
+    'grading-strategies': {
+        id: 'grading-strategies',
+        title: 'Grading strategies',
+        domain: 'review-qa',
+        related: [
+            'resource:rubrics',
+            'resource:problem-versions',
+            'recipe:create-and-grade-a-problem',
+            'recipe:grade-with-a-rubric-grader',
+            'recipe:grade-with-an-agentic-grader',
+            'recipe:grade-with-a-programmatic-grader',
+            'recipe:grade-with-a-composite-grader',
+        ],
+    },
+    'guided-tours': {
+        id: 'guided-tours',
+        title: 'Guided tours',
+        domain: 'authoring-aids',
+        related: ['recipe:set-up-a-guided-tour', 'concept:anatomy-of-a-problem-version'],
+    },
+    'how-async-work-runs': {
+        id: 'how-async-work-runs',
+        title: 'How async work runs',
+        domain: 'jobs-observability',
+        related: [
+            'recipe:run-a-job-and-read-results',
+            'recipe:cancel-a-job',
+            'resource:jobs',
+            'resource:problem-runs',
+            'concept:runs-transcripts-and-results',
+        ],
+    },
+    'how-grading-works': {
+        id: 'how-grading-works',
+        title: 'How grading works',
+        domain: 'review-qa',
+        related: [
+            'concept:grading-strategies',
+            'concept:run-config-roles',
+            'recipe:add-and-refine-a-rubric',
+            'recipe:create-and-grade-a-problem',
+            'resource:rubrics',
+            'resource:rubric-scores',
+        ],
+    },
+    'human-review-and-issues': {
+        id: 'human-review-and-issues',
+        title: 'Human review and issues',
+        domain: 'review-qa',
+        related: ['recipe:submit-and-review-a-problem', 'resource:issues', 'resource:issue-comments'],
+    },
+    'importing-problems-and-claiming': {
+        id: 'importing-problems-and-claiming',
+        title: 'Importing problems and claiming',
+        domain: 'problems',
+        related: ['recipe:import-problems', 'resource:imports', 'resource:problems'],
+    },
+    'interfaces-ui-cli-sdk-api': {
+        id: 'interfaces-ui-cli-sdk-api',
+        title: 'Interfaces: UI, CLI, SDK, and API',
+        domain: 'platform',
+        related: ['resource:problems', 'resource:environments'],
+    },
+    'monitoring-and-health': {
+        id: 'monitoring-and-health',
+        title: 'Monitoring and health',
+        domain: 'jobs-observability',
+        related: ['concept:how-async-work-runs'],
+    },
+    'organizations-and-users': {
+        id: 'organizations-and-users',
+        title: 'Organizations and users',
+        domain: 'administration',
+        related: [
+            'concept:the-permission-model',
+            'concept:platform-architecture',
+            'concept:cost-accounting',
+            'resource:environments',
+        ],
+    },
+    'platform-architecture': {
+        id: 'platform-architecture',
+        title: 'Platform architecture',
+        domain: 'platform',
+        related: [
+            'concept:problem-lifecycle',
+            'concept:run-config-roles',
+            'concept:how-async-work-runs',
+            'resource:environments',
+            'resource:problems',
+        ],
+    },
+    'problem-files': {
+        id: 'problem-files',
+        title: 'Problem files',
+        domain: 'problems',
+        related: [
+            'recipe:attach-a-file',
+            'recipe:detach-and-download-a-file',
+            'recipe:set-gold-standard-and-tags',
+            'resource:files',
+            'concept:environment-files',
+        ],
+    },
+    'problem-lifecycle': {
+        id: 'problem-lifecycle',
+        title: 'The problem lifecycle',
+        domain: 'problems',
+        related: ['resource:problems', 'resource:problem-versions', 'resource:problem-runs'],
+    },
+    'public-environments': {
+        id: 'public-environments',
+        title: 'Public environments',
+        domain: 'integrations',
+        related: ['concept:organizations-and-users', 'resource:environments'],
+    },
+    'quality-gates-and-qa': {
+        id: 'quality-gates-and-qa',
+        title: 'Quality gates and QA',
+        domain: 'review-qa',
+        related: ['recipe:gate-a-stage-on-qa', 'resource:qa', 'resource:qa-gates'],
+    },
+    'run-config-anatomy': {
+        id: 'run-config-anatomy',
+        title: 'Anatomy of a run config',
+        domain: 'run-configs',
+        related: [
+            'concept:run-config-roles',
+            'concept:verifying-with-the-probe',
+            'concept:secrets-and-credentials',
+            'recipe:configure-a-run-config',
+            'recipe:create-a-claude-code-run-config',
+            'resource:run-configs',
+        ],
+    },
+    'run-config-roles': {
+        id: 'run-config-roles',
+        title: 'Run config roles and scopes',
+        domain: 'run-configs',
+        related: [
+            'concept:snapshot-solvers-on-compute',
+            'resource:run-configs',
+            'recipe:configure-a-run-config',
+            'recipe:bind-a-run-config-to-an-environment',
+        ],
+    },
+    'runs-transcripts-and-results': {
+        id: 'runs-transcripts-and-results',
+        title: 'Runs, transcripts, and results',
+        domain: 'jobs-observability',
+        related: [
+            'recipe:inspect-run-history-and-transcript',
+            'resource:transcripts',
+            'resource:problem-runs',
+            'concept:how-async-work-runs',
+        ],
+    },
+    'secrets-and-credentials': {
+        id: 'secrets-and-credentials',
+        title: 'Secrets and credentials',
+        domain: 'administration',
+        related: [
+            'recipe:attach-a-customer-secret',
+            'concept:run-config-anatomy',
+            'resource:run-configs',
+        ],
+    },
+    'snapshot-solvers-on-compute': {
+        id: 'snapshot-solvers-on-compute',
+        title: 'Snapshot solvers and compute runs',
+        domain: 'run-configs',
+        related: [
+            'concept:run-config-roles',
+            'concept:computes',
+            'concept:grading-strategies',
+            'resource:run-configs',
+            'recipe:create-and-grade-a-problem',
+            'recipe:run-a-job-and-read-results',
+        ],
+    },
+    tags: {
+        id: 'tags',
+        title: 'Tags',
+        domain: 'problems',
+        related: ['recipe:set-gold-standard-and-tags', 'resource:problems'],
+    },
+    'the-cost-explorer': {
+        id: 'the-cost-explorer',
+        title: 'The cost explorer',
+        domain: 'cost',
+        related: ['concept:cost-accounting', 'resource:cost-limits'],
+    },
+    'the-permission-model': {
+        id: 'the-permission-model',
+        title: 'The permission model',
+        domain: 'administration',
+        related: ['concept:organizations-and-users', 'concept:authentication-and-access'],
+    },
+    'the-synthesizer': {
+        id: 'the-synthesizer',
+        title: 'The synthesizer',
+        domain: 'synthesizer',
+        related: [
+            'resource:synthesizer',
+            'recipe:improve-a-problem-with-the-synthesizer',
+            'recipe:cancel-a-synthesizer-run',
+            'concept:run-config-roles',
+        ],
+    },
+    'the-taiga-integration': {
+        id: 'the-taiga-integration',
+        title: 'The Taiga integration',
+        domain: 'integrations',
+        related: ['resource:environments', 'resource:jobs'],
+    },
+    'verifying-with-the-probe': {
+        id: 'verifying-with-the-probe',
+        title: 'Verifying a run config with the probe',
+        domain: 'run-configs',
+        related: ['concept:run-config-roles', 'concept:run-config-anatomy', 'resource:run-configs'],
+    },
+    'worldsim-authoring': {
+        id: 'worldsim-authoring',
+        title: 'Worldsim authoring',
+        domain: 'authoring-aids',
+        related: ['concept:run-config-anatomy'],
+    },
+};

package/dist/reference/domains.d.ts

@@ -0,0 +1,65 @@
+export interface Domain {
+    /** Stable kebab-case id; the value carried by recipes, concepts, and resource roots. */
+    readonly id: string;
+    /** Human-facing section label in the docs nav. */
+    readonly title: string;
+    /** Nav order within How-to / Explanation (ascending). */
+    readonly order: number;
+}
+export declare const DOMAINS: readonly [{
+    readonly id: "platform";
+    readonly title: "Platform & interfaces";
+    readonly order: 1;
+}, {
+    readonly id: "environments";
+    readonly title: "Environments";
+    readonly order: 2;
+}, {
+    readonly id: "problems";
+    readonly title: "Problems";
+    readonly order: 3;
+}, {
+    readonly id: "authoring-aids";
+    readonly title: "Authoring aids";
+    readonly order: 4;
+}, {
+    readonly id: "run-configs";
+    readonly title: "Run configs";
+    readonly order: 5;
+}, {
+    readonly id: "evaluations";
+    readonly title: "Evaluations";
+    readonly order: 6;
+}, {
+    readonly id: "synthesizer";
+    readonly title: "Synthesizer";
+    readonly order: 7;
+}, {
+    readonly id: "tuning";
+    readonly title: "Tuning";
+    readonly order: 8;
+}, {
+    readonly id: "review-qa";
+    readonly title: "Review & QA";
+    readonly order: 9;
+}, {
+    readonly id: "jobs-observability";
+    readonly title: "Jobs & observability";
+    readonly order: 10;
+}, {
+    readonly id: "cost";
+    readonly title: "Cost";
+    readonly order: 11;
+}, {
+    readonly id: "administration";
+    readonly title: "Administration";
+    readonly order: 12;
+}, {
+    readonly id: "integrations";
+    readonly title: "Integrations";
+    readonly order: 13;
+}];
+/** Union of the thirteen canonical domain ids. */
+export type DomainId = (typeof DOMAINS)[number]['id'];
+/** Runtime guard: is `value` one of the canonical domain ids? */
+export declare function isDomainId(value: unknown): value is DomainId;

package/dist/reference/domains.js

@@ -0,0 +1,32 @@
+// Canonical **product-domain taxonomy** — the single source of truth for the
+// docs information architecture. The How-to (recipes) and Explanation (concepts)
+// quadrants group their entries under these thirteen flat domains; Reference keeps
+// its own deep, spec-derived tree (it is not domain-grouped).
+//
+// Consumed by the frontend docs nav, the `rl` CLI, and the dx generators. The
+// backend cannot import this (the spec → sdk-ts flow is one-way), so the
+// backend `x-docs-resource.domain` stays a plain string and the
+// `resources:generate` membership guard enforces that every value here is a
+// real `DomainId`.
+//
+// Pure data — no dependency. Order is the nav order (top → bottom).
+export const DOMAINS = [
+    { id: 'platform', title: 'Platform & interfaces', order: 1 },
+    { id: 'environments', title: 'Environments', order: 2 },
+    { id: 'problems', title: 'Problems', order: 3 },
+    { id: 'authoring-aids', title: 'Authoring aids', order: 4 },
+    { id: 'run-configs', title: 'Run configs', order: 5 },
+    { id: 'evaluations', title: 'Evaluations', order: 6 },
+    { id: 'synthesizer', title: 'Synthesizer', order: 7 },
+    { id: 'tuning', title: 'Tuning', order: 8 },
+    { id: 'review-qa', title: 'Review & QA', order: 9 },
+    { id: 'jobs-observability', title: 'Jobs & observability', order: 10 },
+    { id: 'cost', title: 'Cost', order: 11 },
+    { id: 'administration', title: 'Administration', order: 12 },
+    { id: 'integrations', title: 'Integrations', order: 13 },
+];
+const DOMAIN_IDS = new Set(DOMAINS.map((d) => d.id));
+/** Runtime guard: is `value` one of the canonical domain ids? */
+export function isDomainId(value) {
+    return typeof value === 'string' && DOMAIN_IDS.has(value);
+}

package/dist/reference/recipes-reference.generated.d.ts

@@ -0,0 +1,11 @@
+/**
+ * AUTO-GENERATED by 'yarn dx recipes:generate'.
+ * Do not edit manually — changes will be overwritten.
+ *
+ * Recipe reference, keyed by recipe id. Derived from the declarative
+ * recipe folders under `tests/smoke/recipes/`: each step's inputs and
+ * captures are statically validated against the SDK reference, then composed
+ * into runnable SDK/CLI/cURL examples.
+ */
+import type { RecipeReferenceEntry } from './recipes-schema.js';
+export declare const RECIPE_REFERENCE: Record<string, RecipeReferenceEntry>;