Class HumanInteractionManager

Implementation of the Human-in-the-Loop Manager.

Features:

Approval requests with severity levels
Clarification requests with options
Output review and editing
Escalation handling
Workflow checkpoints
Feedback collection for learning

Implements

IHumanInteractionManager

Index

Constructors

constructor

Methods

requestApproval submitApprovalDecision requestClarification submitClarification requestEdit submitEdit escalate submitEscalationDecision checkpoint submitCheckpointDecision recordFeedback getFeedbackHistory getPendingRequests cancelRequest getStatistics setNotificationHandler

Constructors

constructor

new HumanInteractionManager(config?): HumanInteractionManager
Creates a new HumanInteractionManager instance.
Parameters
- config: HumanInteractionManagerConfig = {}
  Configuration options
Returns HumanInteractionManager
- Defined in core/hitl/HumanInteractionManager.ts:124

Methods

requestApproval

requestApproval(action): Promise<ApprovalDecision>
Requests human approval before executing an action.
Parameters
- action: PendingAction
Returns Promise<ApprovalDecision>
Implementation of IHumanInteractionManager.requestApproval
- Defined in core/hitl/HumanInteractionManager.ts:141

submitApprovalDecision

submitApprovalDecision(decision): Promise<void>
Submits an approval decision.
Parameters
- decision: ApprovalDecision
Returns Promise<void>
Implementation of IHumanInteractionManager.submitApprovalDecision
- Defined in core/hitl/HumanInteractionManager.ts:196

requestClarification

requestClarification(request): Promise<ClarificationResponse>
Requests clarification from a human.
Parameters
- request: ClarificationRequest
Returns Promise<ClarificationResponse>
Implementation of IHumanInteractionManager.requestClarification
- Defined in core/hitl/HumanInteractionManager.ts:232

submitClarification

submitClarification(response): Promise<void>
Submits a clarification response.
Parameters
- response: ClarificationResponse
Returns Promise<void>
Implementation of IHumanInteractionManager.submitClarification
- Defined in core/hitl/HumanInteractionManager.ts:273

requestEdit

requestEdit(draft): Promise<EditedOutput>
Requests human review and potential editing of agent output.
Parameters
- draft: DraftOutput
Returns Promise<EditedOutput>
Implementation of IHumanInteractionManager.requestEdit
- Defined in core/hitl/HumanInteractionManager.ts:298

submitEdit

submitEdit(edited): Promise<void>
Submits an edited output.
Parameters
- edited: EditedOutput
Returns Promise<void>
Implementation of IHumanInteractionManager.submitEdit
- Defined in core/hitl/HumanInteractionManager.ts:348

escalate

escalate(context): Promise<EscalationDecision>
Escalates a situation to human control.
Parameters
- context: EscalationContext
Returns Promise<EscalationDecision>
Implementation of IHumanInteractionManager.escalate
- Defined in core/hitl/HumanInteractionManager.ts:373

submitEscalationDecision

submitEscalationDecision(escalationId, decision): Promise<void>
Submits an escalation decision.
Parameters
- escalationId: string
- decision: EscalationDecision
Returns Promise<void>
Implementation of IHumanInteractionManager.submitEscalationDecision
- Defined in core/hitl/HumanInteractionManager.ts:409

checkpoint

checkpoint(checkpoint): Promise<CheckpointDecision>
Creates a checkpoint for human review.
Parameters
- checkpoint: WorkflowCheckpoint
Returns Promise<CheckpointDecision>
Implementation of IHumanInteractionManager.checkpoint
- Defined in core/hitl/HumanInteractionManager.ts:435

submitCheckpointDecision

submitCheckpointDecision(decision): Promise<void>
Submits a checkpoint decision.
Parameters
- decision: CheckpointDecision
Returns Promise<void>
Implementation of IHumanInteractionManager.submitCheckpointDecision
- Defined in core/hitl/HumanInteractionManager.ts:466

recordFeedback

recordFeedback(feedback): Promise<void>
Records human feedback for agent improvement.
Parameters
- feedback: HumanFeedback
Returns Promise<void>
Implementation of IHumanInteractionManager.recordFeedback
- Defined in core/hitl/HumanInteractionManager.ts:487

getFeedbackHistory

getFeedbackHistory(agentId, options?): Promise<HumanFeedback[]>
Gets feedback history for an agent.
Parameters
- agentId: string
- Optional options: {
      limit?: number;
      since?: Date;
      type?: "correction" | "praise" | "guidance" | "preference" | "complaint";
  }
  - Optional limit?: number
  - Optional since?: Date
  - Optional type?: "correction" | "praise" | "guidance" | "preference" | "complaint"
Returns Promise<HumanFeedback[]>
Implementation of IHumanInteractionManager.getFeedbackHistory
- Defined in core/hitl/HumanInteractionManager.ts:505

getPendingRequests

getPendingRequests(): Promise<{
    approvals: PendingAction[];
    clarifications: ClarificationRequest[];
    edits: DraftOutput[];
    escalations: EscalationContext[];
    checkpoints: WorkflowCheckpoint[];
}>
Gets all pending requests awaiting human response.

Returns Promise<{
    approvals: PendingAction[];
    clarifications: ClarificationRequest[];
    edits: DraftOutput[];
    escalations: EscalationContext[];
    checkpoints: WorkflowCheckpoint[];
}>
Implementation of IHumanInteractionManager.getPendingRequests
- Defined in core/hitl/HumanInteractionManager.ts:537

cancelRequest

cancelRequest(requestId, reason): Promise<void>
Cancels a pending request.
Parameters
- requestId: string
- reason: string
Returns Promise<void>
Implementation of IHumanInteractionManager.cancelRequest
- Defined in core/hitl/HumanInteractionManager.ts:556

getStatistics

getStatistics(): HITLStatistics
Gets HITL interaction statistics.

Returns HITLStatistics
Implementation of IHumanInteractionManager.getStatistics
- Defined in core/hitl/HumanInteractionManager.ts:602

setNotificationHandler

setNotificationHandler(handler): void
Sets the notification handler.
Parameters
- handler: HITLNotificationHandler
Returns void
Implementation of IHumanInteractionManager.setNotificationHandler
- Defined in core/hitl/HumanInteractionManager.ts:609

Class HumanInteractionManager

Implements

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns HumanInteractionManager

Methods

requestApproval

Parameters

Returns Promise<ApprovalDecision>

submitApprovalDecision

Parameters

Returns Promise<void>

requestClarification

Parameters

Returns Promise<ClarificationResponse>

submitClarification

Parameters

Returns Promise<void>

requestEdit

Parameters

Returns Promise<EditedOutput>

submitEdit

Parameters

Returns Promise<void>

escalate

Parameters

Returns Promise<EscalationDecision>

submitEscalationDecision

Parameters

Returns Promise<void>

checkpoint

Parameters

Returns Promise<CheckpointDecision>

submitCheckpointDecision

Parameters

Returns Promise<void>

recordFeedback

Parameters

Returns Promise<void>

getFeedbackHistory

Parameters

Optional limit?: number

Optional since?: Date

Optional type?: "correction" | "praise" | "guidance" | "preference" | "complaint"

Returns Promise<HumanFeedback[]>

getPendingRequests

Returns Promise<{ approvals: PendingAction[]; clarifications: ClarificationRequest[]; edits: DraftOutput[]; escalations: EscalationContext[]; checkpoints: WorkflowCheckpoint[]; }>

cancelRequest

Parameters

Returns Promise<void>

getStatistics

Returns HITLStatistics

setNotificationHandler

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

`Optional` limit?: number

`Optional` since?: Date

`Optional` type?: "correction" | "praise" | "guidance" | "preference" | "complaint"

Returns Promise<{
approvals: PendingAction[];
clarifications: ClarificationRequest[];
edits: DraftOutput[];
escalations: EscalationContext[];
checkpoints: WorkflowCheckpoint[];
}>