taskOutputSchema

const taskOutputSchema: object

The JSON Schemas those models were generated from, for runtime use.

Type Declaration

$id

readonly $id: "https://schemas.inderun.dev/1.0/task-output.schema.json"

$schema

readonly $schema: "https://json-schema.org/draft/2020-12/schema"

additionalProperties

readonly additionalProperties: true

allOf

readonly allOf: readonly [{ if: { properties: { type: { const: "text"; }; }; }; then: { required: readonly ["text"]; }; }, { if: { properties: { type: { const: "playback"; }; }; }; then: { required: readonly ["playback"]; }; }, { if: { properties: { type: { const: "artifact"; }; }; }; then: { required: readonly ["artifact"]; }; }, { if: { properties: { type: { const: "prepared"; }; }; }; then: { required: readonly ["preparation"]; }; }]

description

readonly description: "The normalized output of a run, shared by TaskResult and the completed and cancelled stream terminal outcomes (ADR 016). 'type' describes the content representation, not the task: 'text' carries inline text, 'playback' reports a managed, audible effect that has no retrievable bytes, and 'artifact' references retrievable media (ADR 017). A playback output is never an artifact, and an artifact output never implies that anything was played."

properties

readonly properties: object

properties.artifact

readonly artifact: object

properties.artifact.$ref

readonly $ref: "media-artifact.schema.json"

properties.artifact.description

readonly description: "The retrievable media the run produced. Required when type is 'artifact'."

properties.playback

readonly playback: object

properties.playback.additionalProperties

readonly additionalProperties: true

properties.playback.description

readonly description: "Completion of managed playback. Required when type is 'playback'. Carries no media."

properties.playback.properties

readonly properties: object

properties.playback.properties.timing

readonly timing: object

properties.playback.properties.timing.additionalProperties

readonly additionalProperties: true

properties.playback.properties.timing.description

readonly description: "What the provider measured about the playback. Absent when it measured nothing. 'firstAudioMs' and 'firstChunkMs' count from the same origin: the moment the provider's run() or stream() started handling the request, so their difference is the provider's output latency. The span includes everything the provider does after it starts handling the request (queue wait, voice lookup, a cold model load) and excludes routing."

properties.playback.properties.timing.properties

readonly properties: object

properties.playback.properties.timing.properties.durationMs

readonly durationMs: object

properties.playback.properties.timing.properties.durationMs.description

readonly description: "How long audible playback lasted, in milliseconds. For a cancelled run, how long it played before it was stopped, when the provider reports it."

properties.playback.properties.timing.properties.durationMs.minimum

readonly minimum: 0

properties.playback.properties.timing.properties.durationMs.type

readonly type: "number"

properties.playback.properties.timing.properties.firstAudioMs

readonly firstAudioMs: object

properties.playback.properties.timing.properties.firstAudioMs.description

readonly description: "Milliseconds from the provider receiving the request until the platform's first audible-output callback (for a system voice, its first word callback) or the first audio frame leaving the output. Absent when nothing reports it."

properties.playback.properties.timing.properties.firstAudioMs.minimum

readonly minimum: 0

properties.playback.properties.timing.properties.firstAudioMs.type

readonly type: "number"

properties.playback.properties.timing.properties.firstChunkMs

readonly firstChunkMs: object

properties.playback.properties.timing.properties.firstChunkMs.description

readonly description: "Milliseconds from the provider receiving the request until its first playable PCM chunk existed. Absent when the provider does not synthesize PCM itself."

properties.playback.properties.timing.properties.firstChunkMs.minimum

readonly minimum: 0

properties.playback.properties.timing.properties.firstChunkMs.type

readonly type: "number"

properties.playback.properties.timing.title

readonly title: "PlaybackTiming"

properties.playback.properties.timing.type

readonly type: "object"

properties.playback.title

readonly title: "PlaybackOutput"

properties.playback.type

readonly type: "object"

properties.preparation

readonly preparation: object

properties.preparation.description

readonly description: "What a prepare() run did, one item per provider and task. Required when type is 'prepared'. One failed item does not fail the run."

properties.preparation.items

readonly items: object

properties.preparation.items.additionalProperties

readonly additionalProperties: true

properties.preparation.items.properties

readonly properties: object

properties.preparation.items.properties.providerId

readonly providerId: object

properties.preparation.items.properties.providerId.description

readonly description: "The provider this item belongs to."

properties.preparation.items.properties.providerId.minLength

readonly minLength: 1

properties.preparation.items.properties.providerId.type

readonly type: "string"

properties.preparation.items.properties.reason

readonly reason: object

properties.preparation.items.properties.reason.description

readonly description: "Why the item was skipped or failed."

properties.preparation.items.properties.reason.minLength

readonly minLength: 1

properties.preparation.items.properties.reason.type

readonly type: "string"

properties.preparation.items.properties.status

readonly status: object

properties.preparation.items.properties.status.description

readonly description: "'prepared': this run made it ready. 'already_ready': nothing was needed. 'skipped': it needs a download that neither autoDownload nor allowDownload permits. 'failed': see reason."

properties.preparation.items.properties.status.enum

readonly enum: readonly ["prepared", "already_ready", "skipped", "failed"]

properties.preparation.items.properties.status.title

readonly title: "PreparationStatus"

properties.preparation.items.properties.task

readonly task: object

properties.preparation.items.properties.task.description

readonly description: "The task kind this item belongs to."

properties.preparation.items.properties.task.minLength

readonly minLength: 1

properties.preparation.items.properties.task.type

readonly type: "string"

properties.preparation.items.properties.voiceId

readonly voiceId: object

properties.preparation.items.properties.voiceId.description

readonly description: "The voice this item prepared, when one was bound."

properties.preparation.items.properties.voiceId.minLength

readonly minLength: 1

properties.preparation.items.properties.voiceId.type

readonly type: "string"

properties.preparation.items.required

readonly required: readonly ["providerId", "task", "status"]

properties.preparation.items.title

readonly title: "PreparationItem"

properties.preparation.items.type

readonly type: "object"

properties.preparation.type

readonly type: "array"

properties.speech

readonly speech: object

properties.speech.additionalProperties

readonly additionalProperties: true

properties.speech.description

readonly description: "The locale and voice a text-to-speech run actually used, so an unmet preference is visible without being an error."

properties.speech.properties

readonly properties: object

properties.speech.properties.locale

readonly locale: object

properties.speech.properties.locale.description

readonly description: "BCP 47 tag of the locale that was spoken."

properties.speech.properties.locale.minLength

readonly minLength: 1

properties.speech.properties.locale.type

readonly type: "string"

properties.speech.properties.voice

readonly voice: object

properties.speech.properties.voice.additionalProperties

readonly additionalProperties: true

properties.speech.properties.voice.description

readonly description: "The voice that spoke, as the catalog lists it."

properties.speech.properties.voice.properties

readonly properties: object

properties.speech.properties.voice.properties.gender

readonly gender: object

properties.speech.properties.voice.properties.gender.$ref

readonly $ref: "provider-dynamic-capabilities.schema.json#/$defs/voiceGender"

properties.speech.properties.voice.properties.id

readonly id: object

properties.speech.properties.voice.properties.id.description

readonly description: "The voice's id, when its provider lists one."

properties.speech.properties.voice.properties.id.minLength

readonly minLength: 1

properties.speech.properties.voice.properties.id.type

readonly type: "string"

properties.speech.properties.voice.properties.name

readonly name: object

properties.speech.properties.voice.properties.name.description

readonly description: "The voice's display label, when its provider lists one."

properties.speech.properties.voice.properties.name.minLength

readonly minLength: 1

properties.speech.properties.voice.properties.name.type

readonly type: "string"

properties.speech.properties.voice.title

readonly title: "SpeechOutputVoice"

properties.speech.properties.voice.type

readonly type: "object"

properties.speech.required

readonly required: readonly ["locale"]

properties.speech.title

readonly title: "SpeechOutput"

properties.speech.type

readonly type: "object"

properties.text

readonly text: object

properties.text.description

readonly description: "The text the run produced. Required when type is 'text'."

properties.text.type

readonly type: "string"

properties.type

readonly type: object

properties.type.description

readonly description: "The content representation: 'text', 'playback' or 'artifact'. 'prepared' ends a prepare() run, carries no content, and lists each item in 'preparation'."

properties.type.enum

readonly enum: readonly ["text", "playback", "artifact", "prepared"]

properties.type.title

readonly title: "TaskOutputType"

required

readonly required: readonly ["type"]

title

readonly title: "TaskOutput"

type

readonly type: "object"