README.md

@ector/core

@ector/core is the chat core of ECTOR.

Usage

const ECTOR = require('@ector/core');

let ector = {
    name: 'ECTOR',
    username: 'Guy'
};

ector = ECTOR.addEntry('Hello ECTOR!');
ector = ECTOR.generateResponse(ector);
const response = ECTOR.getResponse(ector);
console.log(response);

should give

Hello Guy!

Functions

Table of Contents

• ECTOR
  • Properties
• addEntry
  • Parameters
• choseToken
  • Parameters
• generateForwards
  • Parameters
• generateBackwards
  • Parameters
• generateResponse
  • Parameters
• linkNodesToLastSentence
  • Parameters
• getResponse
  • Parameters

ECTOR

Type: Object<string, any>

Properties

• name string? name of the bot
• username string? name of the user
• cn ConceptNetwork?
• cns Object<string, ConceptNetworkState>? One state per username
• lastSentenceLabel string? Label of the last entry first sentence
• lastTokenLabels Array<string>? Labels of the last entry tokens
• response string? Generated response
• responseLabels Array<string>? Nodes of the response

addEntry

Add an entry to ector's model.

Parameters

• ector ECTOR
• entry string

Returns (ECTOR | Error)

choseToken

Chose one token label from the activated ones.

Parameters

• state ConceptNetworkState
• temperature number

Returns string The chosen token

generateForwards

Generate the end of a sentence, adding tokens to the list of token nodes in phrase.

Parameters

• cn ConceptNetwork Network of tokens
• cns ConceptNetworkState State of the network (activation values)
• phraseNodes Array<{id: string, weight: number}> array of token nodes
• temperature number

Returns Array<{id: string, weight: number}> array of token nodes (end of phrase) *

generateBackwards

Generate the begining of a sentence, adding tokens to the list of token nodes in phrase.

Parameters

• cn ConceptNetwork Network of tokens
• cns ConceptNetworkState State of the network (activation values)
• phraseNodes Array<{id: string, weight: number}> array of token nodes
• temperature number

Returns Array<{id: string, weight: number}> array of token nodes (end of phrase) *

generateResponse

Generate a response from the activated nodes.

Parameters

• ector ECTOR

Returns ECTOR

linkNodesToLastSentence

Link nodes to the previous sentence node label (this is automatically set by addEntry, it is the node label of the first sentence of the entry).

Used with the nodes returned by addEntry.

Parameters

• ector ECTOR
• nodeLabels Array<string> Array of nodes labels. (optional, default [])

Returns ECTOR *

getResponse

Get the response already generated with generateResponse.

Parameters

• ector ECTOR

Returns string