@uservane/copilotkit: AgentController

Class: AgentController

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:151

Constructors

Constructor

new AgentController(deps?): AgentController

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:187

Parameters

deps?

AgentControllerDeps

Returns

AgentController

Methods

afterTurn()

afterTurn(n): void

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:261

Arm afterTurn(n). Only fires in nonBlocking mode (mechanical trigger). Barred while a task is open (impossible in blocking mode by the state machine).

Parameters

n

number

Returns

void

allowsModelRequestedFeedback()

allowsModelRequestedFeedback(surveyId?): boolean

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:244

True when at least one bound show-token attests issuer opt-in (amr). The model cannot self-enable; only a server-minted allowModelRequested token satisfies this.

Parameters

surveyId?

string

Returns

boolean

bind()

bind(binding): void

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:216

Install a server-minted bound show-token for a survey.

Call after the host server runs mintFeedbackToken (secret-key path) and threads the token + correlation ids to the client. When this survey is shown, the bound token is used and submit carries the bound ids so the response lands linked. Multiple surveys may each have one binding.

Pass sessionId for a conversation (session-level) score; pass traceId + observationId for a per-step observation score. Framework auto-read of those ids remains deferred (developer-provided only).

Without a bind for the survey, the unbound bootstrap token path still works (stored unlinked).

Parameters

binding

BoundTokenBinding

Returns

void

complete()

complete(result): void

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:270

Submit a response with the show-token, identity kind, and correlation snapshotted at show time (never re-read here).

Parameters

result

CompleteOptions

Returns

void

deferAsk()

deferAsk(opts?): void

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:236

Alias for resolveTask({ defer: true, … }). Out-of-band / async ask.

Parameters

opts?

Omit<ResolveTaskOptions, "defer">

Returns

void

dismiss()

dismiss(): void

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:265

Returns

void

getActive()

getActive(): ActiveAsk

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:189

Returns

ActiveAsk

getDefaultSurveySlug()

getDefaultSurveySlug(): string

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:238

Default survey slug from init (used by the agent tool and resolveTask).

Returns

string

getIdentityKind()

getIdentityKind(): IdentityKind

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:273

Returns

IdentityKind

getRespondentId()

getRespondentId(): string

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:274

Returns

string

getState()

getState(): object

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:278

Inspect for tests.

Returns

object

active

active: ActiveAsk

apiBase

apiBase: string

blockingCapable

blockingCapable: boolean

boundSurveyIds

boundSurveyIds: string[]

debug

debug: boolean

defaultSurveySlug

defaultSurveySlug: string

identityKind

identityKind: IdentityKind

key

key: string

localSuppression

localSuppression: Set<string>

nonBlocking

nonBlocking: boolean

pendingSurveys

pendingSurveys: string[]

rules

rules: BootstrapResponse

rulesFailed

rulesFailed: boolean

rulesLoaded

rulesLoaded: boolean

sessionShown

sessionShown: Set<string>

taskOpen

taskOpen: boolean

traits

traits: object

Index Signature

[x: string]: unknown

turnCount

turnCount: number

userId

userId: string

hide()

hide(): void

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:272

Clear the active ask without submitting (after thanks, or host-driven hide).

Returns

void

identify()

identify(opts?): void

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:222

Parameters

opts?

AgentIdentifyOptions

Returns

void

init()

init(opts): void

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:221

Parameters

opts

AgentInitOptions

Returns

void

isTaskOpen()

isTaskOpen(): boolean

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:190

Returns

boolean

noteUserTurn()

noteUserTurn(): void

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:256

Record a user turn. In blocking mode, re-opens the task after a prior resolve so mechanical mid-task asks stay barred. In nonBlocking mode, advances afterTurn(n) evaluation.

Returns

void

onSessionEnd()

onSessionEnd(): void

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:263

Session-end mechanical trigger. Only in nonBlocking mode.

Returns

void

requestModelFeedback()

requestModelFeedback(slug): boolean

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:250

Trigger a model-requested ask for the survey slug (agent tool path). Caller must have checked isTaskOpen and allowsModelRequestedFeedback. Returns true when an ask became active.

Parameters

slug

string

Returns

boolean

resetForTests()

resetForTests(): void

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:301

Returns

void

resolveTask()

resolveTask(opts?): void

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:232

Mark the current task resolved and run the onTaskResolved show-decision. Makes the agent blocking-capable (default-open thereafter on next turn).

When defer: true (deferAsk / off-platform async resolution): closes the task so in-session asks are barred for this resolution, but does NOT render InlineFeedback. Deliver the ask later via mintDeferredAskLink on the customer’s channel. UserVane does not send email/SMS.

Parameters

opts?

ResolveTaskOptions

Returns

void

setCorrelationSource()

setCorrelationSource(source): void

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:200

Install a correlation reader. Snapshot is taken at show-decision time when no bound token is installed for the survey. Prefer bind() for the production linked path (server-minted token + developer-provided ids).

Observation-level scores are supported via developer-provided traceId+observationId on bind/mint; only framework auto-READ is deferred (NEEDS CEO VERIFICATION).

Parameters

source

CorrelationSource

Returns

void

setFetchImpl()

setFetchImpl(fetchImpl): void

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:276

Test hook: replace fetch implementation on a live controller.

Parameters

fetchImpl

(input, init?) => Promise<Response>

Returns

void

setHeadlessContract()

setHeadlessContract(contract): void

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:220

Bind or clear the headless host contract.

Parameters

contract

HeadlessContract

Returns

void

subscribe(listener): () => void

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:188

Parameters

listener

AgentControllerListener

Returns

() => void

survey()

survey(slug): void

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:264

Parameters

slug

string

Returns

void

unbind()

unbind(surveyId?): void

Defined in: @[email protected]/node_modules/@uservane/agent-core/dist/index.d.ts:218

Clear a single survey binding, or all bindings when surveyId is omitted.

Parameters

surveyId?

string

Returns

void