Skip to content

ChatTurnOptions

Property Type Description Inherited from
clientMsgId? string - SendChatOptions.clientMsgId
conversationId? string - SendChatOptions.conversationId
onDelta? (text) => void Called with each streamed chunk of assistant text, in order. -
onToolActivity? (activity) => void Called for each tool start/completion as the agent works. -
pollIntervalMs? number Poll interval while waiting on the poll fallback (default 1000ms). -
quietProbeMs? number How long the stream may go quiet before the turn’s state is read back from the server rather than waited on (default 30000ms, floored at 1000ms). Lower it to notice a half-open socket sooner, at the cost of a /chat/sync read per interval during a long tool call. -
signal? AbortSignal Abandon the wait when this aborts, raising AuraTurnCancelledError. Aborting stops the waiting only — pair it with AuraClient.cancel to stop the turn server-side. -
timeoutMs? number Give up after this long (default 900000ms — 15 minutes). -