Skip to content

Interface: ParamSpec

Defined in: packages/aiui-oracle/src/params.ts:38

Properties

default?

optional default?: string

Defined in: packages/aiui-oracle/src/params.ts:52

The platform's default, as text, for display beside the control.

Here rather than in prose because "what is the default" is the first question anyone tuning this asks, and an answer that lives in a chat log or a doc goes stale silently. Shown as the input's placeholder, so an UNSET control reads as the value it will actually behave as.


group

group: string

Defined in: packages/aiui-oracle/src/params.ts:43

The enclosing object's vendor name — the heading rows sit under, so a row can be labelled type without ambiguity about WHICH type.


hint

hint: string

Defined in: packages/aiui-oracle/src/params.ts:76

One line of vendor semantics — what it does, and the default.


kind

kind: "number" | "boolean" | "range" | "enum" | "text"

Defined in: packages/aiui-oracle/src/params.ts:67


max?

optional max?: number

Defined in: packages/aiui-oracle/src/params.ts:72


min?

optional min?: number

Defined in: packages/aiui-oracle/src/params.ts:71


name

name: string

Defined in: packages/aiui-oracle/src/params.ts:40

The vendor's own name. Also the label — see the module note.


options?

optional options?: readonly (string | null)[]

Defined in: packages/aiui-oracle/src/params.ts:70

For kind: "enum". Values are the vendor's literals; null where the vendor's own spelling for "off" is null.


path

path: string

Defined in: packages/aiui-oracle/src/params.ts:66

Dotted path, rooted at the session object, the constraints object, or — for scope: "aiui" — the config's own behaviour fields.


requires?

optional requires?: object

Defined in: packages/aiui-oracle/src/params.ts:79

Show this row only when another row holds a given value (the server_vad / semantic_vad split).

equals

equals: unknown

path

path: string


scope?

optional scope?: "session" | "aiui"

Defined in: packages/aiui-oracle/src/params.ts:63

Which surface the row belongs to. "session" (the default) is the vendor's own object; "aiui" is a knob WE implement, which has no wire representation at all.

The distinction is load-bearing given the verbatim-names rule: an aiui row cannot claim vendor provenance, so it is marked, grouped separately, and labelled as ours. Mixing the two silently would make the whole table's naming claim untrustworthy.


step?

optional step?: number

Defined in: packages/aiui-oracle/src/params.ts:73


when

when: ParamWhen

Defined in: packages/aiui-oracle/src/params.ts:74