amber-javascript-sdk 1.0.43

amber-javascript-sdk

1.0.43

amber-javascript-sdk
AmberUserException
AmberHttpException
AmberClientClass ▸
- Instance members
- #listSensors
- #getSensor
- #createSensor
- #updateLabel
- #configureSensor
- #getConfig
- #deleteSensor
- #postOutage
- #streamSensor
- #getStatus
- #pretrainSensor
- #pretrainSensorXL
- #getPretrainState
- #getRootCause
- #configureFusion
- #streamFusion
- #enableLearning
- #getVersion

Need help reading this?

amber-javascript-sdk

Amber Javascript SDK

amber-javascript-sdk

AmberUserException

AmberUserException is used when an AmberClient object can't be created. (bad json, missing required fields, etc)

new AmberUserException(amber_message: any, error: any)

Extends Error

Parameters

amber_message (any)

error

(any
            = null)

AmberHttpException

AmberHttpException is used when a an API request fails

new AmberHttpException(amber_message: any, error: any)

Extends Error

Parameters

amber_message (any)

error

(any
            = null)

AmberClientClass

AmberClient

new AmberClientClass(licenseId: any, licenseFile: any, verify: any, cert: any, timeout: any)

Parameters

licenseId

(any
            = 'default')

licenseFile

(any
            = '~/.Amber.license')

verify

(any
            = true)

cert

(any
            = null)

timeout

(any
            = 300)

Instance Members

▸ listSensors()

List all sensor instances currently associated with Amber account

listSensors()

▸ getSensor(sensorId)

Get info about a sensor

getSensor(sensorId: any)

Parameters

sensorId (any)

▸ createSensor(label)

Create a new sensor instance

createSensor(label: any)

Parameters

label

(any
            = undefined)

▸ updateLabel(sensorId, label)

Update the label of a sensor instance

updateLabel(sensorId: any, label: any)

Parameters

sensorId (any) sensor identifier

label (any) new label to assign to sensor

▸ configureSensor(sensorId, featureCount, streamingWindowSize, samplesToBuffer, learningRateNumerator, learningRateDenominator, learningMaxClusters, learningMaxSamples, anomalyHistoryWindow, features, percentVariationOverride, anomaly_history_window)

Configure an amber sensor instance

configureSensor(sensorId: any, featureCount: any, streamingWindowSize: any, samplesToBuffer: any, learningRateNumerator: any, learningRateDenominator: any, learningMaxClusters: any, learningMaxSamples: any, anomalyHistoryWindow: any, features: any, percentVariationOverride: any, anomaly_history_window: any): Promise<unknown>

Parameters

sensorId (any)

featureCount

(any
            = 1)

streamingWindowSize

(any
            = 25)

samplesToBuffer

(any
            = 10000)

learningRateNumerator

(any
            = 10)

learningRateDenominator

(any
            = 10000)

learningMaxClusters

(any
            = 1000)

learningMaxSamples

(any
            = 1000000)

anomalyHistoryWindow

(any
            = 10000)

features

(any
            = [])

percentVariationOverride

(any
            = null)

anomaly_history_window (any)

Returns

Promise<unknown>:

▸ getConfig(sensorId)

Get current sensor configuration

getConfig(sensorId: any): Promise<unknown>

Parameters

sensorId (any)

Returns

Promise<unknown>:

▸ deleteSensor(sensorId)

Delete an amber sensor instance

deleteSensor(sensorId: any): Promise<unknown>

Parameters

sensorId (any)

Returns

Promise<unknown>:

▸ postOutage(sensorId)

Post a known outage for a specified Amber sensor

postOutage(sensorId: any): Promise<unknown>

Parameters

sensorId (any)

Returns

Promise<unknown>:

▸ streamSensor(sensorId, csv, saveImage)

Stream data to an amber sensor and return the inference result

streamSensor(sensorId: any, csv: any, saveImage: any): Promise<unknown>

Parameters

sensorId (any)

csv (any)

saveImage

(any
            = true)

Returns

Promise<unknown>:

▸ getStatus(sensorId)

Get sensor status

getStatus(sensorId: any): Promise<unknown>

Parameters

sensorId (any)

Returns

Promise<unknown>:

▸ pretrainSensor(sensorId, csv, autotuneConfig)

Pretrain data to an amber sensor

pretrainSensor(sensorId: any, csv: any, autotuneConfig: any): Promise<unknown>

Parameters

sensorId (any)

csv (any)

autotuneConfig (any)

Returns

Promise<unknown>:

▸ pretrainSensorXL(sensorId, csv, autotuneConfig)

Pretrain large data sets to an amber sensor

pretrainSensorXL(sensorId: any, csv: any, autotuneConfig: any): Promise<unknown>

Parameters

sensorId (any)

csv (any)

autotuneConfig (any)

Returns

Promise<unknown>:

▸ getPretrainState(sensorId)

Get pretrain status

getPretrainState(sensorId: any): Promise<unknown>

Parameters

sensorId (any)

Returns

Promise<unknown>:

▸ getRootCause(sensorId, clusterId, pattern)

Get rootcause

getRootCause(sensorId: any, clusterId: any, pattern: any): Promise<unknown>

Parameters

sensorId (any)

clusterId (any)

pattern (any)

Returns

Promise<unknown>:

▸ configureFusion(sensorId, features)

Configure sensor fusion vector

configureFusion(sensorId: any, features: any): Promise<unknown>

Parameters

sensorId (any)

features (any)

Returns

Promise<unknown>:

▸ streamFusion(sensorId, vector, rule)

Stream to fusion vector

streamFusion(sensorId: any, vector: any, rule: any): Promise<unknown>

Parameters

sensorId (any)

vector (any)

rule (any)

Returns

Promise<unknown>:

▸ enableLearning(sensorId, learningRateNumerator, learningRateDenominator, learningMaxClusters, learningMaxSamples)

Enable learning on existing sensor

enableLearning(sensorId: any, learningRateNumerator: any, learningRateDenominator: any, learningMaxClusters: any, learningMaxSamples: any): Promise<unknown>

Parameters

sensorId (any)

learningRateNumerator

(any
            = null)

learningRateDenominator

(any
            = null)

learningMaxClusters

(any
            = null)

learningMaxSamples

(any
            = null)

Returns

Promise<unknown>:

▸ getVersion()

Get version information for Amber server

getVersion(): Promise<unknown>

Returns

Promise<unknown>: