prepareRequestSchema

const prepareRequestSchema: object

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

Type Declaration

$id

readonly $id: "https://schemas.inderun.dev/1.0/prepare-request.schema.json"

$schema

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

additionalProperties

readonly additionalProperties: true

description

readonly description: "Optional scope for IndeRunApi.prepare (ADR 019). Every field is optional: an empty request covers every registered provider and task. It carries no user content."

properties

readonly properties: object

properties.allowDownload

readonly allowDownload: object

properties.allowDownload.description

readonly description: "Lets this call start a platform's own download, whatever autoDownload says at registration. Call it from a user's decision. Absent follows autoDownload."

properties.allowDownload.type

readonly type: "boolean"

properties.locale

readonly locale: object

properties.locale.description

readonly description: "BCP 47 tag of the language to prepare. Absent lets a speech provider use the device's own language."

properties.locale.minLength

readonly minLength: 1

properties.locale.type

readonly type: "string"

properties.localeMatch

readonly localeMatch: object

properties.localeMatch.description

readonly description: "How locale compares: 'language' (default) or 'exact'."

properties.localeMatch.enum

readonly enum: readonly ["exact", "language"]

properties.localeMatch.title

readonly title: "LocaleMatch"

properties.privacy

readonly privacy: object

properties.privacy.description

readonly description: "The privacy policy of the runs this precedes."

properties.privacy.enum

readonly enum: readonly ["local_required", "local_preferred", "cloud_allowed", "cloud_required"]

properties.requestId

readonly requestId: object

properties.requestId.description

readonly description: "Fixes the run id, for correlation."

properties.requestId.minLength

readonly minLength: 1

properties.requestId.type

readonly type: "string"

properties.tasks

readonly tasks: object

properties.tasks.description

readonly description: "Task kinds to prepare. Absent means every task a registered provider can prepare."

properties.tasks.items

readonly items: object

properties.tasks.items.minLength

readonly minLength: 1

properties.tasks.items.type

readonly type: "string"

properties.tasks.type

readonly type: "array"

properties.voice

readonly voice: object

properties.voice.additionalProperties

readonly additionalProperties: true

properties.voice.dependentRequired

readonly dependentRequired: object

properties.voice.dependentRequired.id

readonly id: readonly ["providerId"]

properties.voice.description

readonly description: "A voice to prepare, as for a speech request."

properties.voice.properties

readonly properties: object

properties.voice.properties.gender

readonly gender: object

properties.voice.properties.gender.$ref

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

properties.voice.properties.id

readonly id: object

properties.voice.properties.id.description

readonly description: "A voice id read from listVoices()."

properties.voice.properties.id.minLength

readonly minLength: 1

properties.voice.properties.id.type

readonly type: "string"

properties.voice.properties.providerId

readonly providerId: object

properties.voice.properties.providerId.description

readonly description: "The provider that listed id."

properties.voice.properties.providerId.minLength

readonly minLength: 1

properties.voice.properties.providerId.type

readonly type: "string"

properties.voice.title

readonly title: "PrepareVoice"

properties.voice.type

readonly type: "object"

title

readonly title: "PrepareRequest"

type

readonly type: "object"