HolographicMemorySystem¶

Constructors¶

Constructor¶

new HolographicMemorySystem(
   dimensions, 
   storagePath?, 
   config?
): HolographicMemorySystem;

Parameters¶

Parameter	Type
`dimensions`	`number`
`storagePath?`	`string` \| `null`
`config?`	`HmsConfigJs` \| `null`

Returns¶

HolographicMemorySystem

Accessors¶

activeGoalCount¶

Get Signature¶

get activeGoalCount(): number;

Returns¶

number

cognitionCycleCount¶

Get Signature¶

get cognitionCycleCount(): number;

Returns¶

number

cognitionEnabled¶

Get Signature¶

get cognitionEnabled(): boolean;

Returns¶

boolean

cognitionInsightCount¶

Get Signature¶

get cognitionInsightCount(): number;

Returns¶

number

cognitionRunning¶

Get Signature¶

get cognitionRunning(): boolean;

Returns¶

boolean

dimensions¶

Get Signature¶

get dimensions(): number;

Returns¶

number

documentIndexTrained¶

Get Signature¶

get documentIndexTrained(): boolean;

Returns¶

boolean

goalCount¶

Get Signature¶

get goalCount(): number;

Returns¶

number

ivfTrained¶

Get Signature¶

get ivfTrained(): boolean;

Returns¶

boolean

meaningEnabled¶

Get Signature¶

get meaningEnabled(): boolean;

Returns¶

boolean

nsgTrained¶

Get Signature¶

get nsgTrained(): boolean;

Returns¶

boolean

pendingProposals¶

Get Signature¶

get pendingProposals(): number;

Returns¶

number

relationCount¶

Get Signature¶

get relationCount(): number;

Returns¶

number

vectorCount¶

Get Signature¶

get vectorCount(): number;

Returns¶

number

Methods¶

activeGoals()¶

activeGoals(): GoalJs[];

Returns¶

GoalJs[]

addGoal()¶

addGoal(
   name, 
   description, 
   relevance, 
   urgency, 
   cost
): number | null;

Parameters¶

Parameter	Type
`name`	`string`
`description`	`string`
`relevance`	`number`
`urgency`	`number`
`cost`	`number`

Returns¶

number | null

addRelation()¶

addRelation(
   sourceId, 
   relationType, 
   targetId, 
   properties?, 
   validFrom?, 
   validTo?
): Promise<void>;

Parameters¶

Parameter	Type
`sourceId`	`string`
`relationType`	`string`
`targetId`	`string`
`properties?`	`string` \| `null`
`validFrom?`	`number` \| `null`
`validTo?`	`number` \| `null`

Returns¶

Promise\<void>

analyzeComponents()¶

analyzeComponents(text): Promise<RetrievalResult[]>;

Parameters¶

Parameter	Type
`text`	`string`

Returns¶

Promise\<RetrievalResult[]>

analyzeText()¶

analyzeText(text): Promise<TextMetrics>;

Parameters¶

Parameter	Type
`text`	`string`

Returns¶

Promise\<TextMetrics>

approveProposal()¶

approveProposal(id): boolean;

Parameters¶

Parameter	Type
`id`	`number`

Returns¶

boolean

auditSince()¶

auditSince(timestampMs): Promise<AuditEntryJs[]>;

Parameters¶

Parameter	Type
`timestampMs`	`number`

Returns¶

Promise\<AuditEntryJs[]>

bundleTexts()¶

bundleTexts(texts): Promise<number[]>;

Bundle multiple text items into a single hypervector. Respects the PrivacyConfig: when dp_enabled, uses epsilon-DP noise.

Parameters¶

Parameter	Type
`texts`	`string`[]

Returns¶

Promise\<number[]>

calculateReadability()¶

calculateReadability(metrics): Promise<number>;

Parameters¶

Parameter	Type
`metrics`	`TextMetrics`

Returns¶

Promise\<number>

chunkDocument()¶

chunkDocument(input): Promise<DocumentChunk[]>;

Parameters¶

Parameter	Type
`input`	`DocumentInput`

Returns¶

Promise\<DocumentChunk[]>

cleanupVector()¶

cleanupVector(vector): Promise<CleanupResultJs | null>;

Parameters¶

Parameter	Type
`vector`	`Float32Array`

Returns¶

Promise\<CleanupResultJs | null>

compact()¶

compact(): Promise<void>;

Returns¶

Promise\<void>

configureMemory()¶

configureMemory(config?): void;

Replaces the memory API's configuration (policies and defaults; see docs/memory-api). Pass nothing to restore the defaults.

Parameters¶

Parameter	Type
`config?`	`any`

Returns¶

void

deactivateGoal()¶

deactivateGoal(name): boolean;

Parameters¶

Parameter	Type
`name`	`string`

Returns¶

boolean

declareCompositionRule()¶

declareCompositionRule(
   name, 
   inputRelations, 
   outputRelation
): void;

Parameters¶

Parameter	Type
`name`	`string`
`inputRelations`	`string`[]
`outputRelation`	`string`

Returns¶

void

declareRelationType()¶

declareRelationType(
   name, 
   transitive?, 
   symmetric?
): void;

Parameters¶

Parameter	Type
`name`	`string`
`transitive?`	`boolean` \| `null`
`symmetric?`	`boolean` \| `null`

Returns¶

void

delete()¶

delete(id): Promise<boolean>;

Parameters¶

Parameter	Type
`id`	`string`

Returns¶

Promise\<boolean>

deleteDocument()¶

deleteDocument(id): Promise<boolean>;

Parameters¶

Parameter	Type
`id`	`string`

Returns¶

Promise\<boolean>

explainQuery()¶

explainQuery(text, k): QueryExplanation;

Parameters¶

Parameter	Type
`text`	`string`
`k`	`number`

Returns¶

QueryExplanation

factorizeDiffusion()¶

factorizeDiffusion(
   productText, 
   domains, 
   maxIter
): Promise<(string | null | undefined)[]>;

Parameters¶

Parameter	Type
`productText`	`string`
`domains`	`string`[][]
`maxIter`	`number`

Returns¶

Promise\<(string | null | undefined)[]>

federatedQuery()¶

federatedQuery(
   peerPaths, 
   text, 
   k
): Promise<RetrievalResult[]>;

Parameters¶

Parameter	Type
`peerPaths`	`string`[]
`text`	`string`
`k`	`number`

Returns¶

Promise\<RetrievalResult[]>

findAnalogy()¶

findAnalogy(
   a, 
   b, 
   c, 
   k?, 
   traceId?
): Promise<RetrievalResult[]>;

Finds an analogy: A is to B as C is to ?.

NOTE: Currently uses character trigram encoding, which has limited semantic understanding. Complex semantic analogies may require higher-level word embeddings (slated for future upgrade).

Parameters¶

Parameter	Type
`a`	`string`
`b`	`string`
`c`	`string`
`k?`	`number` \| `null`
`traceId?`	`string` \| `null`

Returns¶

Promise\<RetrievalResult[]>

flush()¶

flush(): Promise<void>;

Returns¶

Promise\<void>

generateQuestions()¶

generateQuestions(): QuestionJs[];

Returns¶

QuestionJs[]

governMemory()¶

governMemory(): GovernanceReportJs;

Returns¶

GovernanceReportJs

hardwareCapabilities()¶

hardwareCapabilities(): HardwareCapabilities;

Returns¶

HardwareCapabilities

incomingRelations()¶

incomingRelations(
   targetId, 
   relationType?, 
   atTime?
): Promise<Relation[]>;

Parameters¶

Parameter	Type
`targetId`	`string`
`relationType?`	`string` \| `null`
`atTime?`	`number` \| `null`

Returns¶

Promise\<Relation[]>

indexStatus()¶

indexStatus(): IndexStatus;

Returns¶

IndexStatus

maintainIndices()¶

maintainIndices(): Promise<IndexStatus>;

Returns¶

Promise\<IndexStatus>

meaningCleanup()¶

meaningCleanup(text): Promise<CleanupResultJs | null>;

Parameters¶

Parameter	Type
`text`	`string`

Returns¶

Promise\<CleanupResultJs | null>

memorizeBatch()¶

memorizeBatch(items, traceId?): Promise<void>;

Batch memorize multiple id/text pairs in a single native call. Uses rayon for parallel encoding, then inserts sequentially.

Parameters¶

Parameter	Type
`items`	`MemorizeBatchItem`[]
`traceId?`	`string` \| `null`

Returns¶

Promise\<void>

memorizeDocument()¶

memorizeDocument(input): Promise<number>;

Parameters¶

Parameter	Type
`input`	`DocumentInput`

Returns¶

Promise\<number>

memorizeDocuments()¶

memorizeDocuments(inputs): Promise<number[]>;

Parameters¶

Parameter	Type
`inputs`	`DocumentInput`[]

Returns¶

Promise\<number[]>

memorizeFile()¶

memorizeFile(id, filePath): Promise<void>;

Ingest a UTF-8 file (up to 8 MiB) as a chunked document with source offsets. Retrieve passages with searchDocuments and remove them with deleteDocument.

Parameters¶

Parameter	Type
`id`	`string`
`filePath`	`string`

Returns¶

Promise\<void>

memorizeMeaning()¶

memorizeMeaning(id, text): Promise<void>;

Parameters¶

Parameter	Type
`id`	`string`
`text`	`string`

Returns¶

Promise\<void>

memorizeScalar()¶

memorizeScalar(
   id, 
   value, 
   min, 
   max
): Promise<void>;

Parameters¶

Parameter	Type
`id`	`string`
`value`	`number`
`min`	`number`
`max`	`number`

Returns¶

Promise\<void>

memorizeSequence()¶

memorizeSequence(id, sequence): Promise<void>;

Parameters¶

Parameter	Type
`id`	`string`
`sequence`	`string`[]

Returns¶

Promise\<void>

memorizeText()¶

memorizeText(
   id, 
   text, 
   traceId?
): Promise<void>;

Parameters¶

Parameter	Type
`id`	`string`
`text`	`string`
`traceId?`	`string` \| `null`

Returns¶

Promise\<void>

memorizeTextBuffer()¶

memorizeTextBuffer(
   id, 
   text, 
   traceId?
): Promise<void>;

Zero-copy text ingestion from a Node.js Buffer. Avoids the UTF-8 copy that occurs with String parameters by reading bytes in-place.

Parameters¶

Parameter	Type
`id`	`string`
`text`	`Buffer`
`traceId?`	`string` \| `null`

Returns¶

Promise\<void>

memorizeTriplet()¶

memorizeTriplet(
   id, 
   head, 
   relation, 
   tail
): Promise<void>;

Parameters¶

Parameter	Type
`id`	`string`
`head`	`string`
`relation`	`string`
`tail`	`string`

Returns¶

Promise\<void>

memorizeVector()¶

memorizeVector(id, vector): Promise<void>;

Parameters¶

Parameter	Type
`id`	`string`
`vector`	`Float32Array`

Returns¶

Promise\<void>

memoryCall()¶

memoryCall(op, request): Promise<any>;

One memory API operation as JSON in and JSON out: remember, recall, explain, forget, get, history, applyForgetting or consolidate. The typed wrapper is Memory in memory.js.

Parameters¶

Parameter	Type
`op`	`string`
`request`	`any`

Returns¶

Promise\<any>

multiHopQuery()¶

multiHopQuery(startEntity, relations): Promise<MultiHopResultJs[]>;

Parameters¶

Parameter	Type
`startEntity`	`string`
`relations`	`string`[]

Returns¶

Promise\<MultiHopResultJs[]>

outgoingRelations()¶

outgoingRelations(
   sourceId, 
   relationType?, 
   atTime?
): Promise<Relation[]>;

Parameters¶

Parameter	Type
`sourceId`	`string`
`relationType?`	`string` \| `null`
`atTime?`	`number` \| `null`

Returns¶

Promise\<Relation[]>

planGoal()¶

planGoal(
   goal, 
   causalRelations, 
   maxDepth?
): PlanJs;

Parameters¶

Parameter	Type
`goal`	`string`
`causalRelations`	`string`[]
`maxDepth?`	`number` \| `null`

Returns¶

PlanJs

proposeRule()¶

proposeRule(
   name, 
   inputRelations, 
   outputRelation, 
   reason
): number | null;

Parameters¶

Parameter	Type
`name`	`string`
`inputRelations`	`string`[]
`outputRelation`	`string`
`reason`	`string`

Returns¶

number | null

query()¶

query(
   text, 
   k, 
   traceId?
): Promise<RetrievalResult[]>;

Parameters¶

Parameter	Type
`text`	`string`
`k`	`number`
`traceId?`	`string` \| `null`

Returns¶

Promise\<RetrievalResult[]>

queryBatch()¶

queryBatch(texts, k): Promise<RetrievalResult[][]>;

Process multiple text queries in parallel, returning results for each.

Parameters¶

Parameter	Type
`texts`	`string`[]
`k`	`number`

Returns¶

Promise\<RetrievalResult[][]>

queryScalar()¶

queryScalar(
   value, 
   min, 
   max, 
   k
): Promise<RetrievalResult[]>;

Parameters¶

Parameter	Type
`value`	`number`
`min`	`number`
`max`	`number`
`k`	`number`

Returns¶

Promise\<RetrievalResult[]>

querySequence()¶

querySequence(partial, k): Promise<RetrievalResult[]>;

Parameters¶

Parameter	Type
`partial`	`string`[]
`k`	`number`

Returns¶

Promise\<RetrievalResult[]>

queryTriplet()¶

queryTriplet(
   head, 
   relation, 
   k
): Promise<RetrievalResult[]>;

Parameters¶

Parameter	Type
`head`	`string`
`relation`	`string`
`k`	`number`

Returns¶

Promise\<RetrievalResult[]>

queryVector()¶

queryVector(vector, k): Promise<RetrievalResult[]>;

Converts float32→sparse EntangledHVec on JS thread, then queries on background.

Parameters¶

Parameter	Type
`vector`	`Float32Array`
`k`	`number`

Returns¶

Promise\<RetrievalResult[]>

queryVectorBatch()¶

queryVectorBatch(vectors, k): Promise<RetrievalResult[][]>;

Process multiple float32 vector queries in parallel.

Parameters¶

Parameter	Type
`vectors`	`Float32Array`\<`ArrayBufferLike`>[]
`k`	`number`

Returns¶

Promise\<RetrievalResult[][]>

rejectProposal()¶

rejectProposal(id): boolean;

Parameters¶

Parameter	Type
`id`	`number`

Returns¶

boolean

removeRelation()¶

removeRelation(
   sourceId, 
   relationType, 
   targetId
): Promise<boolean>;

Parameters¶

Parameter	Type
`sourceId`	`string`
`relationType`	`string`
`targetId`	`string`

Returns¶

Promise\<boolean>

runCognitionOnce()¶

runCognitionOnce(): number;

Returns¶

number

searchDocuments()¶

searchDocuments(text, options?): Promise<DocumentResult[]>;

Parameters¶

Parameter	Type
`text`	`string`
`options?`	`SearchOptions` \| `null`

Returns¶

Promise\<DocumentResult[]>

securityStatus()¶

securityStatus(): any;

Returns¶

any

startCognition()¶

startCognition(): void;

Returns¶

void

stopCognition()¶

stopCognition(): void;

Returns¶

void

storageHealth()¶

storageHealth(): StorageHealth;

Returns¶

StorageHealth

structuralQuery()¶

structuralQuery(
   knownSubjects, 
   knownRelations, 
   targetRole
): Promise<StructuralResultJs[]>;

Parameters¶

Parameter	Type
`knownSubjects`	`string`[]
`knownRelations`	`string`[]
`targetRole`	`string`

Returns¶

Promise\<StructuralResultJs[]>

synthesizeConcepts()¶

synthesizeConcepts(): Promise<ConceptCandidate[]>;

Returns¶

Promise\<ConceptCandidate[]>

trainDocumentIndex()¶

trainDocumentIndex(): Promise<void>;

Returns¶

Promise\<void>

trainIvf()¶

trainIvf(): Promise<void>;

Returns¶

Promise\<void>

trainNsg()¶

trainNsg(): Promise<void>;

Returns¶

Promise\<void>

traverse()¶

traverse(
   startId, 
   relationType?, 
   maxDepth?, 
   atTime?
): Promise<GraphPath[]>;

Parameters¶

Parameter	Type
`startId`	`string`
`relationType?`	`string` \| `null`
`maxDepth?`	`number` \| `null`
`atTime?`	`number` \| `null`

Returns¶

Promise\<GraphPath[]>