Skip to main content

AiTurnHandle

interface

A handle to one in-flight or finished turn. Returned by AiSessionHandle.send when you need to watch a turn as it runs or cancel it. `completion()` resolves once the turn reaches a terminal state, whether it succeeded, failed, or was cancelled.

interface AiTurnHandle

Import

import { AiTurnHandle } from '@modular/sdk/view';

Members7

sessionId
string & $brand<'SessionId'>
submissionId
string & $brand<'SubmissionId'>
cancel
() => Promise<AiTurnTerminalSnapshot>
completion
() => Promise<AiTurnTerminalSnapshot>
fork
(config?: AiSessionForkConfig) => Promise<AiSessionHandle>

Fork this session immediately after this completed turn.

get
() => Promise<AiTurnSnapshot>
observe
(listener: (snapshot: AiTurnSnapshot) => void) => Disposable

Notes

category
AI