PrepareRequest

PrepareRequest = object

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.

Indexable

[property: string]: unknown

Properties

allowDownload?

optional allowDownload?: boolean

Lets this call start a platform’s own download, whatever autoDownload says at registration. Call it from a user’s decision. Absent follows autoDownload.

---

locale?

optional locale?: string

BCP 47 tag of the language to prepare. Absent lets a speech provider use the device’s own language.

---

localeMatch?

optional localeMatch?: LocaleMatch

How locale compares: ‘language’ (default) or ‘exact’.

---

privacy?

optional privacy?: Privacy

The privacy policy of the runs this precedes.

---

requestId?

optional requestId?: string

Fixes the run id, for correlation.

---

tasks?

optional tasks?: string[]

Task kinds to prepare. Absent means every task a registered provider can prepare.

---

voice?

optional voice?: PrepareVoice

A voice to prepare, as for a speech request.