Interface ILearningLayer

The learning layer of one agent or one runtime.

interface ILearningLayer {
    manifest(): Promise<LoopManifest>;
    forLearner(key, context): Promise<ILearnerSession>;
    freeze?(scope, by?): Promise<void>;
    unfreeze?(scope): Promise<void>;
    suspend?(scope, by?): Promise<void>;
    unsuspend?(scope): Promise<void>;
    operatorSet?(input): Promise<LedgerEntry>;
    revert?(ledgerId, by): Promise<LedgerEntry>;
    exportLearnedState?(key): Promise<LearnedStateDocument>;
    importLearnedState?(doc, target?): Promise<ImportReport>;
    forgetUser?(userId, options?): Promise<ForgetReport>;
    close(): Promise<void>;
}

Index

Methods

manifest forLearner freeze? unfreeze? suspend? unsuspend? operatorSet? revert? exportLearnedState? importLearnedState? forgetUser? close

Methods

manifest

manifest(): Promise<LoopManifest>
Which loops this deployment runs, and for each one that is off, why.

Returns Promise<LoopManifest>
- Defined in src/cognition/learning/types.ts:452

forLearner

forLearner(key, context): Promise<ILearnerSession>
A learner session for one session of the host. key names the learner; null, a blank or anonymous user id, or no agent key gives a session with no learner, which renders the authored traits and learns nothing.
Parameters
- key: null | LearnerKey
- context: LearnerContext
Returns Promise<ILearnerSession>
- Defined in src/cognition/learning/types.ts:457

`Optional` freeze

freeze(scope, by?): Promise<void>
Freezes learning for a scope at run time, persisted in the store; every new self-change of the scope is refused.
Parameters
- scope: FreezeScope
- Optional by: string
Returns Promise<void>
- Defined in src/cognition/learning/types.ts:459

`Optional` unfreeze

unfreeze(scope): Promise<void>
Parameters
- scope: FreezeScope
Returns Promise<void>
- Defined in src/cognition/learning/types.ts:460

`Optional` suspend

suspend(scope, by?): Promise<void>
Mode off at run time, persisted like a freeze.
Parameters
- scope: FreezeScope
- Optional by: string
Returns Promise<void>
- Defined in src/cognition/learning/types.ts:462

`Optional` unsuspend

unsuspend(scope): Promise<void>
Parameters
- scope: FreezeScope
Returns Promise<void>
- Defined in src/cognition/learning/types.ts:463

`Optional` operatorSet

operatorSet(input): Promise<LedgerEntry>
Parameters
- input: OperatorSetInput
Returns Promise<LedgerEntry>
- Defined in src/cognition/learning/types.ts:464

`Optional` revert

revert(ledgerId, by): Promise<LedgerEntry>
Parameters
- ledgerId: string
- by: string
Returns Promise<LedgerEntry>
- Defined in src/cognition/learning/types.ts:465

`Optional` exportLearnedState

exportLearnedState(key): Promise<LearnedStateDocument>
Parameters
- key: LearnerKey
Returns Promise<LearnedStateDocument>
- Defined in src/cognition/learning/types.ts:466

`Optional` importLearnedState

importLearnedState(doc, target?): Promise<ImportReport>
Parameters
- doc: LearnedStateDocument
- Optional target: LearnerKey
Returns Promise<ImportReport>
- Defined in src/cognition/learning/types.ts:467

`Optional` forgetUser

forgetUser(userId, options?): Promise<ForgetReport>
Parameters
- userId: string
- Optional options: {
  namespace?: string;
  }
  - Optional namespace?: string
Returns Promise<ForgetReport>
- Defined in src/cognition/learning/types.ts:468

close

close(): Promise<void>
Releases the layer. A session asked for afterwards is refused.

Returns Promise<void>
- Defined in src/cognition/learning/types.ts:470

Interface ILearningLayer

Index

Methods

Methods

manifest

Returns Promise<LoopManifest>

forLearner

Parameters

Returns Promise<ILearnerSession>

Optional freeze

Parameters

Returns Promise<void>

Optional unfreeze

Parameters

Returns Promise<void>

Optional suspend

Parameters

Returns Promise<void>

Optional unsuspend

Parameters

Returns Promise<void>

Optional operatorSet

Parameters

Returns Promise<LedgerEntry>

Optional revert

Parameters

Returns Promise<LedgerEntry>

Optional exportLearnedState

Parameters

Returns Promise<LearnedStateDocument>

Optional importLearnedState

Parameters

Returns Promise<ImportReport>

Optional forgetUser

Parameters

Optional namespace?: string

Returns Promise<ForgetReport>

close

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Optional` freeze

`Optional` unfreeze

`Optional` suspend

`Optional` unsuspend

`Optional` operatorSet

`Optional` revert

`Optional` exportLearnedState

`Optional` importLearnedState

`Optional` forgetUser

`Optional` namespace?: string