providerDynamicCapabilitiesSchema

const providerDynamicCapabilitiesSchema: object

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

Type Declaration

$comment

readonly $comment: "streamingAvailable and cancellationAvailable are tri-state on purpose: true, false, or absent. Absent means 'inherit the static declaration' and is a distinct state from both booleans. They must never become nullable: null would be a fourth state no consumer handles, and bridges omit the key specifically to preserve 'absent'."

$defs

readonly $defs: object

$defs.readiness

readonly readiness: object

$defs.readiness.description

readonly description: "How ready something is to run (ADR 019). 'ready': it runs now at full speed. 'cold': it runs now, but its first run is slow. 'not_prepared': it cannot run until prepare() has run. 'preparing': it is being prepared now and cannot run yet."

$defs.readiness.enum

readonly enum: readonly ["ready", "cold", "not_prepared", "preparing"]

$defs.readiness.title

readonly title: "ProviderReadiness"

$defs.taskAvailability

readonly taskAvailability: object

$defs.taskAvailability.additionalProperties

readonly additionalProperties: true

$defs.taskAvailability.description

readonly description: "The live check for one task kind."

$defs.taskAvailability.properties

readonly properties: object

$defs.taskAvailability.properties.available

readonly available: object

$defs.taskAvailability.properties.available.description

readonly description: "Whether the task can run on this host right now. Absent inherits the provider-level available. Never null."

$defs.taskAvailability.properties.available.type

readonly type: "boolean"

$defs.taskAvailability.properties.cancellationAvailable

readonly cancellationAvailable: object

$defs.taskAvailability.properties.cancellationAvailable.description

readonly description: "Whether cancellation is honored for this task right now. Absent inherits. Never null."

$defs.taskAvailability.properties.cancellationAvailable.type

readonly type: "boolean"

$defs.taskAvailability.properties.kind

readonly kind: object

$defs.taskAvailability.properties.kind.description

readonly description: "The task kind this entry describes."

$defs.taskAvailability.properties.kind.minLength

readonly minLength: 1

$defs.taskAvailability.properties.kind.type

readonly type: "string"

$defs.taskAvailability.properties.locales

readonly locales: object

$defs.taskAvailability.properties.locales.description

readonly description: "BCP 47 locales available for this task right now. Absent means the provider cannot enumerate them."

$defs.taskAvailability.properties.locales.items

readonly items: object

$defs.taskAvailability.properties.locales.items.minLength

readonly minLength: 1

$defs.taskAvailability.properties.locales.items.type

readonly type: "string"

$defs.taskAvailability.properties.locales.type

readonly type: "array"

$defs.taskAvailability.properties.readiness

readonly readiness: object

$defs.taskAvailability.properties.readiness.$ref

readonly $ref: "#/$defs/readiness"

$defs.taskAvailability.properties.readiness.description

readonly description: "How ready the task is to run. Absent means 'ready'. With available false, 'not_prepared' or 'preparing' means 'not yet' rather than 'not on this device'; this entry then decides even when the provider-level available is false."

$defs.taskAvailability.properties.reason

readonly reason: object

$defs.taskAvailability.properties.reason.description

readonly description: "Why the task is unavailable, when available is false."

$defs.taskAvailability.properties.reason.minLength

readonly minLength: 1

$defs.taskAvailability.properties.reason.type

readonly type: "string"

$defs.taskAvailability.properties.streamingAvailable

readonly streamingAvailable: object

$defs.taskAvailability.properties.streamingAvailable.description

readonly description: "Whether the task can stream on this host right now. Absent inherits. Never null."

$defs.taskAvailability.properties.streamingAvailable.type

readonly type: "boolean"

$defs.taskAvailability.properties.streamingUnavailableReason

readonly streamingUnavailableReason: object

$defs.taskAvailability.properties.streamingUnavailableReason.description

readonly description: "Why streaming is unavailable for this task, when streamingAvailable is false."

$defs.taskAvailability.properties.streamingUnavailableReason.minLength

readonly minLength: 1

$defs.taskAvailability.properties.streamingUnavailableReason.type

readonly type: "string"

$defs.taskAvailability.properties.voices

readonly voices: object

$defs.taskAvailability.properties.voices.description

readonly description: "Every voice available for this task right now, one entry per voice. Absent means the provider cannot enumerate them; a request that requires a voice then never routes to it."

$defs.taskAvailability.properties.voices.items

readonly items: object

$defs.taskAvailability.properties.voices.items.$ref

readonly $ref: "#/$defs/voice"

$defs.taskAvailability.properties.voices.type

readonly type: "array"

$defs.taskAvailability.required

readonly required: readonly ["kind"]

$defs.taskAvailability.title

readonly title: "ProviderTaskAvailability"

$defs.taskAvailability.type

readonly type: "object"

$defs.voice

readonly voice: object

$defs.voice.additionalProperties

readonly additionalProperties: true

$defs.voice.description

readonly description: "One available voice: its provider-neutral traits, and an id and name for an application that lets someone choose it."

$defs.voice.properties

readonly properties: object

$defs.voice.properties.gender

readonly gender: object

$defs.voice.properties.gender.$ref

readonly $ref: "#/$defs/voiceGender"

$defs.voice.properties.id

readonly id: object

$defs.voice.properties.id.description

readonly description: "Identifies this voice within its provider, for use as speech.voice.id with speech.voice.providerId. Opaque: stable on this device while the voice stays installed, and meaningful nowhere else. Absent when the provider cannot address single voices."

$defs.voice.properties.id.minLength

readonly minLength: 1

$defs.voice.properties.id.type

readonly type: "string"

$defs.voice.properties.locale

readonly locale: object

$defs.voice.properties.locale.description

readonly description: "BCP 47 locale the voice speaks."

$defs.voice.properties.locale.minLength

readonly minLength: 1

$defs.voice.properties.locale.type

readonly type: "string"

$defs.voice.properties.locales

readonly locales: object

$defs.voice.properties.locales.description

readonly description: "Every BCP 47 tag the voice speaks; may repeat `locale`. A request's locale matches `locale` or any entry here."

$defs.voice.properties.locales.items

readonly items: object

$defs.voice.properties.locales.items.minLength

readonly minLength: 1

$defs.voice.properties.locales.items.type

readonly type: "string"

$defs.voice.properties.locales.type

readonly type: "array"

$defs.voice.properties.name

readonly name: object

$defs.voice.properties.name.description

readonly description: "Label for showing the voice to a person, as the platform reports it. Not unique and not localized; never compare it."

$defs.voice.properties.name.minLength

readonly minLength: 1

$defs.voice.properties.name.type

readonly type: "string"

$defs.voice.properties.networkRequired

readonly networkRequired: object

$defs.voice.properties.networkRequired.description

readonly description: "Whether using the voice sends data off the device. Absent inherits the task's privacy posture."

$defs.voice.properties.networkRequired.type

readonly type: "boolean"

$defs.voice.properties.readiness

readonly readiness: object

$defs.voice.properties.readiness.$ref

readonly $ref: "#/$defs/readiness"

$defs.voice.properties.readiness.description

readonly description: "How ready the voice is to speak. Absent means 'ready'."

$defs.voice.required

readonly required: readonly ["locale"]

$defs.voice.title

readonly title: "ProviderVoice"

$defs.voice.type

readonly type: "object"

$defs.voiceGender

readonly voiceGender: object

$defs.voiceGender.description

readonly description: "Perceived gender of a voice, as the platform reports it."

$defs.voiceGender.enum

readonly enum: readonly ["female", "male", "neutral"]

$defs.voiceGender.title

readonly title: "VoiceGender"

$id

readonly $id: "https://schemas.inderun.dev/1.0/provider-dynamic-capabilities.schema.json"

$schema

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

additionalProperties

readonly additionalProperties: true

description

readonly description: "A provider's live capability check, evaluated on the current host when routing or when checkCapabilities() is called. Unlike the descriptor it can change between calls."

properties

readonly properties: object

properties.available

readonly available: object

properties.available.description

readonly description: "Whether the provider is available and functional on this host right now."

properties.available.type

readonly type: "boolean"

properties.cancellationAvailable

readonly cancellationAvailable: object

properties.cancellationAvailable.description

readonly description: "Whether cancellation is honored on this host right now. Absent inherits the static descriptor.cancel value: any value other than 'none' means available. Never null."

properties.cancellationAvailable.type

readonly type: "boolean"

properties.reason

readonly reason: object

properties.reason.description

readonly description: "Why the provider is unavailable, when available is false."

properties.reason.minLength

readonly minLength: 1

properties.reason.type

readonly type: "string"

properties.streamingAvailable

readonly streamingAvailable: object

properties.streamingAvailable.description

readonly description: "Whether the provider can stream (Mode 2) on this host right now. Absent inherits the static descriptor.supports.streaming value; only set it when the host takes streaming away from a provider that otherwise declares it. Never null."

properties.streamingAvailable.type

readonly type: "boolean"

properties.streamingUnavailableReason

readonly streamingUnavailableReason: object

properties.streamingUnavailableReason.description

readonly description: "Why streaming is unavailable, when streamingAvailable is false. Absent lets the route planner synthesize a default message."

properties.streamingUnavailableReason.minLength

readonly minLength: 1

properties.streamingUnavailableReason.type

readonly type: "string"

properties.taskCapabilities

readonly taskCapabilities: object

properties.taskCapabilities.description

readonly description: "Per-task overrides of the provider-level check, for tasks whose availability differs on this host, e.g. a voice that is not installed. Every field of an entry is optional and absent inherits the provider-level value; a false at either level wins."

properties.taskCapabilities.items

readonly items: object

properties.taskCapabilities.items.$ref

readonly $ref: "#/$defs/taskAvailability"

properties.taskCapabilities.type

readonly type: "array"

required

readonly required: readonly ["available"]

title

readonly title: "ProviderDynamicCapabilities"

type

readonly type: "object"