Skip to content

Type Alias: CreateScenarioResponse

@kortexya/reasoninglayer


@kortexya/reasoninglayer / CreateScenarioResponse

CreateScenarioResponse = { questions: ClarificationQuestionDto[]; sessionId: string; status: "needs_clarification"; understood: object; } | { agentId?: string; cycleOutcome?: CycleOutcomeSummaryDto; groundingsApplied: number; materialization: MaterializationSummaryDto; scenario: object; scenarioId: string; status: "complete"; totalTimeMs: number; }

Defined in: src/types/scenarios.ts:129

Response for scenario creation. Discriminated by the status field.

{ questions: ClarificationQuestionDto[]; sessionId: string; status: "needs_clarification"; understood: object; }

questions: ClarificationQuestionDto[]

Clarification questions.

sessionId: string

Session ID for continuation.

status: "needs_clarification"

Discriminant: needs_clarification.

understood: object

What the system understood so far.


{ agentId?: string; cycleOutcome?: CycleOutcomeSummaryDto; groundingsApplied: number; materialization: MaterializationSummaryDto; scenario: object; scenarioId: string; status: "complete"; totalTimeMs: number; }

optional agentId?: string

Agent ID (if an agent was created).

optional cycleOutcome?: CycleOutcomeSummaryDto

Summary of a cognitive cycle outcome.

groundingsApplied: number

Number of groundings applied.

materialization: MaterializationSummaryDto

Summary of materialization results.

scenario: object

Full generated scenario (JSON object).

scenarioId: string

Unique scenario identifier.

status: "complete"

Discriminant: complete.

totalTimeMs: number

Total processing time in milliseconds.

When status is "needs_clarification", contains clarification questions. When status is "complete", contains the materialized scenario.