Class GenericJob<TInput, TOutput>

constructor

• new GenericJob<TInput, TOutput>(
      input: TInput,
      streamingEnabled?: boolean,
      executor: (
          input: TInput,
          ctx: MultiModalExecutionContext,
          signal?: AbortSignal,
          onChunk?: (
              chunk: JobChunk<TOutput>,
              internalChunk?: AIResponseChunk<TOutput>,
          ) => void,
      ) => Promise<AIResponse<TOutput>>,
      hooks?: JobLifecycleHooks<TOutput>,
      maxStoredResponseChunks?: number,
      executionMetadata?: {
          capability?: CapabilityKeyType;
          maxRawBytesPerJob?: number;
          providerChain?: ProviderRef[];
          storeRawResponses?: boolean;
          stripBinaryPayloadsInSnapshotsAndTimeline?: boolean;
      },
  ): GenericJob<TInput, TOutput>

  Constructs a new GenericJob instance.

  Type Parameters

  • TInput

    Input type accepted by the job executor.

  • TOutput

    Output type returned by the job executor.

  Parameters

  • input: TInput

    The job input payload.

  • OptionalstreamingEnabled: boolean = false

    Whether the executor emits streaming chunks.

  • executor: (
        input: TInput,
        ctx: MultiModalExecutionContext,
        signal?: AbortSignal,
        onChunk?: (
            chunk: JobChunk<TOutput>,
            internalChunk?: AIResponseChunk<TOutput>,
        ) => void,
    ) => Promise<AIResponse<TOutput>>

    The function that performs the capability execution.

  • Optionalhooks: JobLifecycleHooks<TOutput>

    Optional lifecycle hooks invoked during execution.

  • OptionalmaxStoredResponseChunks: number

    Maximum number of streamed chunks retained in memory.

  • OptionalexecutionMetadata: {
        capability?: CapabilityKeyType;
        maxRawBytesPerJob?: number;
        providerChain?: ProviderRef[];
        storeRawResponses?: boolean;
        stripBinaryPayloadsInSnapshotsAndTimeline?: boolean;
    }

    Optional execution metadata persisted with snapshots.

  Returns GenericJob<TInput, TOutput>

  Throws

  Thrown when maxStoredResponseChunks or maxRawBytesPerJob is invalid.

Readonlyinput

OptionalonChunk

OptionalonStatusChange

durationMs

• get durationMs(): number | undefined

  Returns number | undefined

error

• get error(): Error | undefined

  Returns Error | undefined

id

• get id(): `${string}-${string}-${string}-${string}-${string}`

  Returns `${string}-${string}-${string}-${string}-${string}`

output

• get output(): TOutput | undefined

  Returns TOutput | undefined

response

• get response(): AIResponse<TOutput> | undefined

  Internal diagnostic view of final orchestration response (read-only).

  Returns AIResponse<TOutput> | undefined

responseChunks

• get responseChunks(): readonly AIResponseChunk<TOutput>[]

  Internal diagnostic view of orchestration chunks (read-only snapshot copy).

  Returns readonly AIResponseChunk<TOutput>[]

status

• get status(): JobStatus

  Returns JobStatus

getCompletionPromise

• getCompletionPromise(): Promise<TOutput>

  Returns a promise that settles when the job reaches a terminal state.

  Returns Promise<TOutput>

  A promise that resolves with the final job output or rejects with the terminal error.

isAborted

• isAborted(): boolean

  Returns boolean

isCompleted

• isCompleted(): boolean

  Returns boolean

isErrored

• isErrored(): boolean

  Returns boolean

isPending

• isPending(): boolean

  Returns boolean

isRunning

• isRunning(): boolean

  Returns boolean

markAborted

• markAborted(reason?: Error): void

  Marks the job as aborted without invoking the executor.

  Parameters

  • Optionalreason: Error

    Optional abort reason to retain as the terminal error.

  Returns void

  Nothing.

reset

• reset(): void

  Resets transient state so the job can be executed again from its original input.

  Returns void

  Nothing.

restoreFromSnapshot

• restoreFromSnapshot(snapshot: JobSnapshot<TInput, TOutput>): void

  Hydrate this job from a persisted snapshot. Internal response envelopes/chunks are intentionally not restored because rerun semantics are deterministic replay from input + executor, not raw resume.

  Parameters

  • snapshot: JobSnapshot<TInput, TOutput>

    The persisted snapshot to restore from.

  Returns void

  Nothing.

run

• run(
      ctx: MultiModalExecutionContext,
      signal?: AbortSignal,
      onChunk?: (chunk: JobChunk<TOutput>) => void,
  ): Promise<void>

  Run the job. NOTE: Consumers should typically call JobManager.runJob() instead of invoking this directly, to ensure proper concurrency management, hooks, and persistence.

  Parameters

  • ctx: MultiModalExecutionContext

    The execution context supplied by the caller or job manager.

  • Optionalsignal: AbortSignal

    Optional abort signal for cancellation.

  • OptionalonChunk: (chunk: JobChunk<TOutput>) => void

    Optional chunk callback that overrides the job-level handler.

  Returns Promise<void>

  Resolves when the run attempt finishes and terminal state has been recorded.

toSnapshot

• toSnapshot(): JobSnapshot<TInput, TOutput>

  Serializes the current in-memory job state into a persistence-friendly snapshot.

  Returns JobSnapshot<TInput, TOutput>

  A snapshot representing the current job state.