Skip to content

Type Alias: CreateScenarioResponse

@kortexya/reasoninglayer


@kortexya/reasoninglayer / Scenarios / CreateScenarioResponse

Type Alias: 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:106

Response for scenario creation. Discriminated by the status field.

Type Declaration

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

questions

questions: ClarificationQuestionDto[]

Clarification questions.

sessionId

sessionId: string

Session ID for continuation.

status

status: "needs_clarification"

Discriminant: needs_clarification.

understood

understood: object

What the system understood so far.

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

agentId?

optional agentId: string

Agent ID (if an agent was created).

cycleOutcome?

optional cycleOutcome: CycleOutcomeSummaryDto

Summary of a cognitive cycle outcome.

groundingsApplied

groundingsApplied: number

Number of groundings applied.

materialization

materialization: MaterializationSummaryDto

Summary of materialization results.

scenario

scenario: object

Full generated scenario (JSON object).

scenarioId

scenarioId: string

Unique scenario identifier.

status

status: "complete"

Discriminant: complete.

totalTimeMs

totalTimeMs: number

Total processing time in milliseconds.

Remarks

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