DecisionModel
Defined in: src/decisions/decision-model.ts:21
Abstract base for anything that can answer closed questions.
The public ask opens a decision span, validates the question map, delegates
to the subclass _ask, records usage, the question ids, and the answer set as span
attributes, and closes the span. Content goes on span attributes rather than span
events because OpenTelemetry has deprecated the span-event recording API. Every
implementation is traced identically. Given an invocationContext, ask also adds
the reported usage to that request once _ask returns.
Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DecisionModel(): DecisionModel;Returns
Section titled “Returns”DecisionModel
Methods
Section titled “Methods”ask<Q>( state, questions, options?): Promise<DecisionResult<Q>>;Defined in: src/decisions/decision-model.ts:36
Ask one or more closed questions over the given state.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
Q extends Record<string, Question<"boolean" | readonly string[]>> |
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
state | DecisionInput | A plain string, a one-shot content list, or a message history. |
questions | Q | Map of identifier → question. The returned answers object is keyed off this same map and statically narrowed per question. |
options? | AskOptions | Per-call options, such as the request to add the decision’s usage to, or a cancelSignal that aborts the underlying call. |
Returns
Section titled “Returns”Promise<DecisionResult<Q>>
A DecisionResult whose answers are statically narrowed from
each question’s choices.
Throws
Section titled “Throws”Error if questions is empty or contains an invalid question,
choices, or uncertainty.
Throws
Section titled “Throws”TypeError if options.invocationContext was not created by the SDK.
_ask()
Section titled “_ask()”abstract protected _ask<Q>( state, questions, options): Promise<DecisionResult<Q>>;Defined in: src/decisions/decision-model.ts:89
Implementation-specific decision logic. Must return a complete
DecisionResult, including metadata.latencyMs sourced from the
underlying model provider. Implementations should forward options.cancelSignal
to any cancellable work they start. The request’s invocationContext is not
passed: ask records the reported usage itself.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
Q extends Record<string, Question<"boolean" | readonly string[]>> |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
state | DecisionInput |
questions | Q |
options | DecisionCallOptions |
Returns
Section titled “Returns”Promise<DecisionResult<Q>>