Skip to content

Interface: ScribeTransportOptions

Defined in: scribe.ts:160

Properties

connectUrl

connectUrl: () => Promise<string>

Defined in: scribe.ts:167

One call = one connect: returns a ready-to-open socket URL with a FRESH single-use token riding the query string (aiui-cf-creds/stt's scribeConnectUrl, or a channel mint route). Single-use by construction — there is nowhere to hold a token wrong.

Returns

Promise<string>


keyterms?

optional keyterms?: readonly string[]

Defined in: scribe.ts:172

Domain-bias terms — repeated PLAIN keyterms params (the bracket form is silently dropped by the server).


language?

optional language?: string

Defined in: scribe.ts:169

ISO-639 language hint (language_code); absent → Scribe auto-detects.


modelId?

optional modelId?: string

Defined in: scribe.ts:177

Override the model on the connect URL (default: what the URL carries, i.e. DEFAULT_SCRIBE_MODEL from the credential side).


noVerbatim?

optional noVerbatim?: boolean

Defined in: scribe.ts:174

Collapse disfluencies/false-starts (no_verbatim). Default true.


now?

optional now?: () => number

Defined in: scribe.ts:181

Injected clock (tests).

Returns

number


socketFactory?

optional socketFactory?: SttSocketFactory

Defined in: scribe.ts:179

Injected socket (tests); defaults to the platform WebSocket.