Skip to content
v9.1.1
Français

DecideOptions

import type { DecideOptions } from "@elie-laloum/outpost";

Parameters and properties

Section titled “Parameters and properties”
  • providerRequired
    DecisionProvider
    Decision provider that performs this evaluation.
  • modelRequired
    string
    Nonempty decision model name, without generation or reasoning settings.
  • decisionRequired
    Decision<Q>
    Frozen typed question declaration created with defineDecision.
  • stateRequired
    DecisionState
    Text, object or array validated as lossless JSON before the request.
  • signalOptional
    AbortSignal | undefined
    Optional caller cancellation signal forwarded to the decision provider.
  • observationOptional
    ObservationHub | undefined
    Optional scoped observation hub; detailed state and answers require verbose mode.
  • allowTruncatedOptional
    boolean | undefined
    False by default; true accepts a reported truncation while retaining its flag in the result.

Signature

Section titled “Signature”
export interface DecideOptions<
  Q extends DecisionQuestions = DecisionQuestions,
> {
  readonly provider: DecisionProvider;
  readonly model: string;
  readonly decision: Decision<Q>;
  readonly state: DecisionState;
  readonly signal?: AbortSignal;
  readonly observation?: ObservationHub;
  readonly allowTruncated?: boolean;
}
Section titled “Related contracts”