Clustering

Methods

(async) addClusterLabel(documentDb, input) → {Promise.<Object>}

Description:

• returns a success message if the cluster label was inserted successfully.

Source:

• Services/Clustering.js, line 96

Example

const mdx = require("@nvidia-mdx/web-api-core");
const elastic = new mdx.Utils.Elasticsearch({node: "elasticsearch-url"},databaseConfigMap);
let input = {sensorId: "abc", modelVersion: "2", clusterIndex: "1", label: "left"};
let clusteringObject = new mdx.Services.Clustering();
let result = await clusteringObject.addClusterLabel(elastic,input);

Parameters:

Returns:

Type

Promise.<Object>

(async) doesClusterLabelExist(documentDb, input) → {Promise.<boolean>}

Description:

• returns if a cluster label already exists.

Source:

• Services/Clustering.js, line 78

Example

const mdx = require("@nvidia-mdx/web-api-core");
const elastic = new mdx.Utils.Elasticsearch({node: "elasticsearch-url"},databaseConfigMap);
let input = {sensorId: "abc", modelVersion: "2", label: "left"};
let clusteringObject = new mdx.Services.Clustering();
let clusterLabelExists = await clusteringObject.doesClusterLabelExist(elastic,input);

Parameters:

Returns:

Type

Promise.<boolean>

(async) getClusterLabels(documentDb, input) → {Promise.<Map.<string, string>>}

Description:

• returns a map containing clusterIndex and the latest cluster label associated to it.

Source:

• Services/Clustering.js, line 24

Example

const mdx = require("@nvidia-mdx/web-api-core");
const elastic = new mdx.Utils.Elasticsearch({node: "elasticsearch-url"},databaseConfigMap);
let input = {sensorId: "abc", modelVersion: "2"};
let clusteringObject = new mdx.Services.Clustering();
let labelMap = await clusteringObject.getClusterLabels(elastic,input);

Parameters:

Returns:

Type

Promise.<Map.<string, string>>

(async) getSampledBehaviorClusters(documentDb, input) → {Promise.<Object>}

Description:

• returns sampled behaviors for each cluster.

Source:

• Services/Clustering.js, line 44

Example

const mdx = require("@nvidia-mdx/web-api-core");
const elastic = new mdx.Utils.Elasticsearch({node: "elasticsearch-url"},databaseConfigMap);
let input = {sensorId: "abc", fromTimestamp: "2023-01-12T11:20:10.000Z", toTimestamp: "2023-01-12T14:20:10.000Z"};
let clusteringObject = new mdx.Services.Clustering();
let clusters = await clusteringObject.getSampledBehaviorClusters(elastic,input);

Parameters:

Returns:

Type

Promise.<Object>

(async) isValidCluster(documentDb, input) → {Promise.<boolean>}

Description:

• returns if a cluster is valid.

Source:

• Services/Clustering.js, line 61

Example

const mdx = require("@nvidia-mdx/web-api-core");
const elastic = new mdx.Utils.Elasticsearch({node: "elasticsearch-url"},databaseConfigMap);
let input = {sensorId: "abc", modelVersion: "2", clusterIndex: "1"};
let clusteringObject = new mdx.Services.Clustering();
let validCluster = await clusteringObject.isValidCluster(elastic,input);

Parameters:

Returns:

Type

Promise.<boolean>