Interface ScenarioExecutionLike

Readonlymessages

ReadonlythreadId

agent

• agent(content?: string | CoreMessage): Promise<void>

  Adds an agent message to the conversation. If no content is provided, the agent under test will generate a message.

  Parameters

  • Optionalcontent: string | CoreMessage

    The content of the agent message.

  Returns Promise<void>

fail

• fail(reasoning?: string): Promise<ScenarioResult>

  Ends the scenario with a failure.

  Parameters

  • Optionalreasoning: string

    Optional reasoning for the failure.

  Returns Promise<ScenarioResult>

  The final result of the scenario.

judge

• judge(content?: string | CoreMessage): Promise<null | ScenarioResult>

  Invokes the judge agent to evaluate the current state.

  Parameters

  • Optionalcontent: string | CoreMessage

    Optional message to the judge.

  Returns Promise<null | ScenarioResult>

  The result of the scenario if the judge makes a final decision.

message

• message(message: CoreMessage): Promise<void>

  Adds a message to the conversation.

  Parameters

  • message: CoreMessage

    The message to add.

  Returns Promise<void>

proceed

• proceed(
      turns?: number,
      onTurn?: (state: ScenarioExecutionStateLike) => void | Promise<void>,
      onStep?: (state: ScenarioExecutionStateLike) => void | Promise<void>,
  ): Promise<null | ScenarioResult>

  Proceeds with the scenario automatically for a number of turns.

  Parameters

  • Optionalturns: number

    The number of turns to proceed. Defaults to running until the scenario ends.
  • OptionalonTurn: (state: ScenarioExecutionStateLike) => void | Promise<void>

    Optional callback executed at the end of each turn.
  • OptionalonStep: (state: ScenarioExecutionStateLike) => void | Promise<void>

    Optional callback executed after each agent interaction.

  Returns Promise<null | ScenarioResult>

  The result of the scenario if it ends.

succeed

• succeed(reasoning?: string): Promise<ScenarioResult>

  Ends the scenario with a success.

  Parameters

  • Optionalreasoning: string

    Optional reasoning for the success.

  Returns Promise<ScenarioResult>

  The final result of the scenario.

user

• user(content?: string | CoreMessage): Promise<void>

  Adds a user message to the conversation. If no content is provided, the user simulator will generate a message.

  Parameters

  • Optionalcontent: string | CoreMessage

    The content of the user message.

  Returns Promise<void>