For a high-level understanding of the concepts of this engine, please have a look at the Constraint Navigator User Guide.
The following is a description how to setup and configure this service. All configuration classes are described here.
Failures of the application can lead to following errors:
Configuration, DtoAbstractCategory, DtoAbstractColumnInterpreter, DtoAbstractColumnValue, DtoAbstractCondition, DtoAbstractCost, DtoAbstractError, DtoAbstractFeatureReport, DtoAbstractFunction, DtoAbstractInferenceSignalSpecification, DtoAbstractModelRef, DtoAbstractNotificationBackendConfig, DtoAbstractSignalAspectReport, DtoAbstractSignalDataReport, DtoAbstractSignalInterpreter, DtoAbstractTargetAspectReport, DtoAbstractTimeseries, DtoAbstractTimeseriesDataFilter, DtoAbstractTimestampsConfig, DtoAdditionalTimeseries, DtoAggregatedCategoricalFeatureReport, DtoAggregatedCategoricalFunction, DtoAggregatedNumericalFeatureReport, DtoAggregatedNumericalFunction, DtoAggregationType, DtoAnomalyDetectionModelRef, DtoAppInfo, DtoArgMaxFunction, DtoArgumentValidationError, DtoAtNextSignalValueTimestampsConfig, DtoAwsSqsNotificationBackendConfig, DtoBooleanCategory, DtoBooleanCategoryWithProbability, DtoBooleanCell, DtoBooleanColumnValue, DtoBooleanDataPoint, DtoBooleanDataPointWithAvailability, DtoBooleanDataPointWithCategoryProbabilities, DtoBooleanTimeseries, DtoBooleanWithCategoryProbabilitiesTimeseries, DtoBuildInfo, DtoCategoricalColumnInterpreter, DtoCategoricalFunctionEvalType, DtoCategoricalSignalAspectReport, DtoCategoricalSignalInterpreter, DtoCategoryEqualsFunction, DtoClusterId, DtoColumnConfig, DtoColumnDataTypeUnexpectedError, DtoColumnId, DtoColumnIdAlreadyInUseError, DtoColumnInterpreterAmbiguousError, DtoColumnNotFoundError, DtoConstantFunction, DtoConstraint, DtoConstraintNavigatorHubModelUnsuitedError, DtoControlPointId, DtoCorrelation, DtoCosFunction, DtoCyclicSignalAspectReport, DtoCyclicSignalInterpreter, DtoDataConcurrentModificationError, DtoDataFilter, DtoDataFilterRange, DtoDataQualityInsufficientError, DtoDataQuantityInsufficientError, DtoDataReport, DtoDataType, DtoDefaultColumnInterpreter, DtoDefaultSignalInterpreter, DtoDefaultTimeseriesDataFilter, DtoDynamicNumericalCondition, DtoEngineException, DtoEquidistantTimestampsConfig, DtoErrorParam, DtoException, DtoExponentialFunction, DtoExpression, DtoExpressionInfo, DtoExpressionResultDataTypeUnexpectedError, DtoExpressionRuntimeFailureError, DtoExpressionSyntaxFailureError, DtoFeature, DtoFeatureFilter, DtoFeatureId, DtoFeatureValue, DtoFeatureValueWithNextNormal, DtoFileNotFoundException, DtoFilesFilter, DtoFloat, DtoFloatCategory, DtoFloatCategoryWithProbability, DtoFloatCell, DtoFloatColumnValue, DtoFloatConstraintValue, DtoFloatConstraintValueWithNextNormal, DtoFloatConstraintValues, DtoFloatConstraintValuesWithNextNormal, DtoFloatCostValue, DtoFloatCostValueWithNextNormal, DtoFloatDataPoint, DtoFloatDataPointWithAvailability, DtoFloatDataPointWithCategoryProbabilities, DtoFloatDataPointWithNextNormal, DtoFloatNextNormalConfig, DtoFloatTimeseries, DtoFloatWithCategoryProbabilitiesTimeseries, DtoFloatWithNextNormalTimeseries, DtoFourierTransformFunction, DtoFunctionId, DtoGaussCdfFunction, DtoHandleDanglingError, DtoHandleTypeUnexpectedError, DtoHref, DtoHubConfig, DtoHubConfigNode, DtoHubModel, DtoHubReport, DtoId, DtoIdCategoryEntry, DtoIdCategoryMapFunction, DtoIdCategoryProbaMapFunction, DtoIdentityFunction, DtoIncrementalLearningDataQualityInsufficientError, DtoIncrementalLearningModelCorruptedError, DtoInferenceConfig, DtoInferenceConfigWithModel, DtoInferenceDataPredecessorMissingError, DtoInferenceDataSpecification, DtoInferenceDataTypeUnexpectedError, DtoInferenceOutputTargetInterpreterTypeUnexpectedError, DtoInferenceOutputTypeUnexpectedError, DtoInferenceRawSignalSpecification, DtoInferenceRawSignalSpecificationDataTypeAmbiguousError, DtoInferenceSynthesizedSignalSpecification, DtoInferenceTimeseriesDataFilter, DtoInteger, DtoInternalEngineFailureError, DtoInternalServerException, DtoInterruptedException, DtoInterval, DtoIntervalBeforeIncident, DtoIntervalWithoutIncident, DtoJsonParseFailureError, DtoJsonValidationFailureError, DtoKernelModelComponent, DtoKernelModelFunction, DtoKernelType, DtoL1DistanceCost, DtoL2DistanceCost, DtoLagFeatureReport, DtoLagFunction, DtoLicenseApiKeyNotFoundError, DtoLicenseInsufficientError, DtoLicenseServerCommunicationFailureError, DtoLogSumExpFunction, DtoLogarithmFunction, DtoLogisticFunction, DtoLongString, DtoLtiFilterFeatureReport, DtoLtiFilterFunction, DtoMaxFunction, DtoMediumString, DtoMissingConstraintsError, DtoModelConstraint, DtoModelConstraintNotFoundError, DtoModelCost, DtoModelId, DtoModelSpecification, DtoMollifierFunction, DtoNonNegativeDuration, DtoNonNegativeFloat, DtoNonNegativeInteger, DtoNoneNotificationBackendConfig, DtoNotification, DtoNumericalColumnInterpreter, DtoNumericalFunctionEvalType, DtoNumericalSignalAspectReport, DtoNumericalSignalInterpreter, DtoNumericalTargetAspectReport, DtoOperativeSignalMissingTrueValuesError, DtoOptimizationInterest, DtoOscillatoryPhaseSignalAspectReport, DtoOscillatoryPowerSignalAspectReport, DtoOscillatorySignalInterpretationFailure, DtoOscillatorySignalInterpreter, DtoOutputConfig, DtoOutputConfigNode, DtoParseException, DtoPath, DtoPercentage, DtoPhaseSpectrumFunction, DtoPointerForeignError, DtoPointerTypeUnexpectedError, DtoPositiveDuration, DtoPositiveFloat, DtoPositiveInteger, DtoPowerSpectrumFunction, DtoPredicate, DtoPrincipalDirectionFunction, DtoProducer, DtoProductFunction, DtoRawSignalDataReport, DtoReluFunction, DtoScaleFunction, DtoSegmentFloatValue, DtoSegmentFloatValueWithNextNormal, DtoSegmentId, DtoSegmentNotFoundError, DtoSegmentsFloatDataPoint, DtoSegmentsFloatDataPointWithNextNormal, DtoSegmentsFloatTimeseries, DtoSegmentsFloatWithNextNormalTimeseries, DtoSemVer, DtoSha1, DtoSignalConstraint, DtoSignalConstraintInterpreterUnexpectedError, DtoSignalDataTypeUnexpectedError, DtoSignalFunction, DtoSignalId, DtoSignalIdAlreadyInUseError, DtoSignalInterpreterAmbiguousError, DtoSignalNotFoundError, DtoSignalPredictionModelRef, DtoSignalReport, DtoSignalTemperature, DtoSinFunction, DtoStateChangedNotification, DtoStateDetectionModelRef, DtoStaticNumericalCondition, DtoStepFunction, DtoStringCategory, DtoStringCategoryWithProbability, DtoStringCell, DtoStringColumnValue, DtoStringDataPoint, DtoStringDataPointWithAvailability, DtoStringDataPointWithCategoryProbabilities, DtoStringEncodingInvalidError, DtoStringTimeseries, DtoStringWithCategoryProbabilitiesTimeseries, DtoSumFunction, DtoSymmetricBlockDiagonalMatrix, DtoSymmetricMatrix, DtoSynthesizedSignalConfig, DtoSynthesizedSignalDataReport, DtoTabularDataConfig, DtoTabularDataFilter, DtoTabularDataTypesConfig, DtoTabularFilesReaderConfig, DtoTabularOutputConfig, DtoTargetSignalDataTypeUnexpectedError, DtoTargetSignalLowQualityError, DtoTargetSignalNotFoundError, DtoTargetSignalTooManyCategoriesError, DtoTemperaturesDataPoint, DtoTemperaturesTimeseries, DtoTenantId, DtoTime, DtoTimeseriesDataConfig, DtoTimeseriesDataTypesConfig, DtoTimeseriesFilesReaderConfig, DtoTreeModelFunction, DtoTreeNode, DtoTreeNodeId, DtoUuid, DtoValidationException, DtoWebserverConfig, DtoWeightColumnNegativeValueError
Root configuration for this application.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
webServer |
DtoWebserverConfig | optional | Configuration for web server application. |
notificationBackend |
DtoAbstractNotificationBackendConfig | optional | Configuration for push notifications. |
hub |
DtoHubConfigNode | - | Configuring Hub and Model Context |
output |
DtoOutputConfigNode | - | Configure the output of the hub worker which is to be stored in a folder. |
Abstract type for any kind of exception.
Type: Object
Sub-Types: DtoValidationException, DtoParseException, DtoInterruptedException, DtoInternalServerException, DtoFileNotFoundException, DtoEngineException
Discriminator: _type
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
title |
DtoMediumString | - | - |
message |
DtoLongString | - | - |
The validation of an object failed.
Type: Object
Super-Types: DtoException
Discriminator: _type
Discriminator-Value: DtoValidationException
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
title |
DtoMediumString | - | - |
message |
DtoLongString | - | - |
constraints |
DtoConstraint[] | - | - |
A given object couldn't be interpreted.
Type: Object
Super-Types: DtoException
Discriminator: _type
Discriminator-Value: DtoParseException
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
title |
DtoMediumString | - | - |
message |
DtoLongString | - | - |
The process was interrupted.
Type: Object
Super-Types: DtoException
Discriminator: _type
Discriminator-Value: Interrupted
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
title |
DtoMediumString | - | - |
message |
DtoLongString | - | - |
Something went wrong (This can be considered as a bug)
Type: Object
Super-Types: DtoException
Discriminator: _type
Discriminator-Value: InternalServer
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
title |
DtoMediumString | - | - |
message |
DtoLongString | - | - |
Information about this application
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
id |
DtoId | - | Unique id |
label |
DtoMediumString | - | Display name |
project |
DtoId | - | Parent project name |
build |
DtoBuildInfo | optional | Additional build information |
A message from a docker container
Type: Object
Sub-Types: DtoStateChangedNotification
Discriminator: _type
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
sender |
DtoLongString | - | - |
context |
DtoLongString | - | - |
timestamp |
DtoTime | - | - |
A message from a docker containers about the state it just entered
Type: Object
Super-Types: DtoNotification
Discriminator: _type
Discriminator-Value: StateChanged
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
sender |
DtoLongString | - | - |
context |
DtoLongString | - | - |
timestamp |
DtoTime | - | - |
index |
DtoInteger | - | - |
name |
DtoLongString | - | - |
count |
DtoInteger | - | - |
error |
DtoException | optional | - |
Configuration for web server application.
@configurationNode: webServer
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
host |
Stringexp = ^(?!\s*$).+ |
default: 0.0.0.0 |
Name of host or IP this web server is running on. |
port |
Numberint32 , >= 1.0 |
default: 8080 |
Number of port this web server should be bound to. |
contextPath |
Stringexp = ^/[a-zA-Z0-9]*$ |
default: /app |
The context path defines the URL that users will access the application from, e.g. http://host :port /contextPath . |
Configuration for push notifications.
@configurationNode: notificationBackend
Type: Object
Sub-Types: DtoNoneNotificationBackendConfig, DtoAwsSqsNotificationBackendConfig
Discriminator: _type
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
Type: Object
Super-Types: DtoAbstractNotificationBackendConfig
Discriminator: _type
Discriminator-Value: None
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
Type: Object
Super-Types: DtoAbstractNotificationBackendConfig
Discriminator: _type
Discriminator-Value: AwsSqs
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
queueArn |
String | - | - |
sender |
String | - | - |
context |
String | - | - |
No file could be found at the configured path.
Type: Object
Super-Types: DtoException
Discriminator: _type
Discriminator-Value: FileNotFound
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
title |
DtoMediumString | - | - |
message |
DtoLongString | - | - |
Interprets the signal values and derives aspects from them.
@abstract
Type: Object
Sub-Types: DtoDefaultSignalInterpreter, DtoNumericalSignalInterpreter, DtoCategoricalSignalInterpreter, DtoOscillatorySignalInterpreter, DtoCyclicSignalInterpreter
Discriminator: _type
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
Interprets float signals via DtoNumericalSignalInterpreter and string and boolean signals via DtoCategoricalSignalInterpreter.
Type: Object
Super-Types: DtoAbstractSignalInterpreter
Discriminator: _type
Discriminator-Value: Default
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
Interprets the signal as being numerical. The natural order of the different values is taken into account.
Type: Object
Super-Types: DtoAbstractSignalInterpreter
Discriminator: _type
Discriminator-Value: Numerical
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
Interprets the different signal values as categories, which have no order. For every category a categorical boolean aspect is derived, which yields true if the signal value equals that category. This is the only allowed interpreter for string and boolean signals.
Type: Object
Super-Types: DtoAbstractSignalInterpreter
Discriminator: _type
Discriminator-Value: Categorical
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
Interprets the signal as an oscillatory wave. It is transformed from time- to frequency-domain.
Type: Object
Super-Types: DtoAbstractSignalInterpreter
Discriminator: _type
Discriminator-Value: Oscillatory
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
windowLength |
DtoPositiveDuration | - | Length of the time window the frequency spectra are calculated for. The underlying discrete Fourier transform is based on the data at "t", "t - mesh", "t - 2*mesh", ... stopping before "t - windowLength". |
mesh |
DtoPositiveDuration | - | Time resolution of the source signal that is used in window for computing Fourier transform. Timestamps with gaps of more than 2*mesh in their Fourier window are skipped. Mesh must not be bigger than window_length. |
Interprets the signal as a cyclic variable, based on their residue after division. An important example are angles with a cycle length of 360 degrees. The wrapping at the cycle length is continuous, e.g. 2 degree are considered close to 357 degrees.
Type: Object
Super-Types: DtoAbstractSignalInterpreter
Discriminator: _type
Discriminator-Value: Cyclic
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
cycleLength |
DtoPositiveFloat | - | Divisor used to calculate the residue. All signal values are mapped into the interval from 0 to cycle length. |
Handling of a specific column.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
column |
DtoColumnId | - | ID of the column. |
interpreter |
DtoAbstractColumnInterpreter | optional, default: {"_type":"Default"} |
Controls how this column will be interpreted. |
Interprets the column values and splits them into different categories
@abstract
Type: Object
Sub-Types: DtoNumericalColumnInterpreter, DtoCategoricalColumnInterpreter, DtoDefaultColumnInterpreter
Discriminator: _type
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
Interprets the column as being numerical. The natural order of the different values is taken into account. The engine will split the values of this column into ranges. This interpreter is only allowed for float columns.
Type: Object
Super-Types: DtoAbstractColumnInterpreter
Discriminator: _type
Discriminator-Value: Numerical
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
quantileCount |
DtoPositiveInteger | optional, default: 20 |
Split the value range into this many quantiles. Values in the same quantile will not be differntiated by the engine. |
Interprets the different column values as categories, which have no order. The engine will consider DtoCategorySetPredicates for this column. This is the only allowed interpreter for string and boolean column.
Type: Object
Super-Types: DtoAbstractColumnInterpreter
Discriminator: _type
Discriminator-Value: Categorical
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
Interprets float columns via DtoNumericalColumnInterpreter and string and boolean columns via DtoCategoricalColumnInterpreter.
Type: Object
Super-Types: DtoAbstractColumnInterpreter
Discriminator: _type
Discriminator-Value: Default
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
Limits the use of the data based on certain criteria.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
includeSignals |
DtoDataFilterRange[] | optional | If present, restrict to these signal ranges. |
excludeSignals |
DtoDataFilterRange[] | optional | If present, exclude all these signal ranges. |
includeRanges |
DtoInterval[] | optional | If present, restrict to these ranges for all signals. |
excludeRanges |
DtoInterval[] | optional | If present, exclude these ranges for all signals. |
startTime |
DtoTime | optional | If present, exclude all data before this time. If both startTime and endTime are present we require startTime ≤ endTime. |
endTime |
DtoTime | optional | If present, exclude all data at or after this time. If both startTime and endTime are present we require startTime ≤ endTime. |
Time range of a specific signal.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
signal |
DtoSignalId | - | ID of the signal. |
startTime |
DtoTime | optional | If present, the range only includes times at or after this time. If both startTime and endTime are present we require startTime ≤ endTime. |
endTime |
DtoTime | optional | If present, the range only includes times before this time. If both startTime and endTime are present we require startTime ≤ endTime. |
Interval used to exclude/include data.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
startTime |
DtoTime | optional | If present, the range only includes times at or after this time. If both startTime and endTime are present we require startTime ≤ endTime. |
endTime |
DtoTime | optional | If present, the range only includes times before this time. If both startTime and endTime are present we require startTime ≤ endTime. |
Interval used to exclude/include data with an annotation denoting an estimated origin for an incident. This interval type is used for storing intervals before events (or incidents) for the state detection engine.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
startTime |
DtoTime | optional | If present, the range only includes times at or after this time. If both startTime and endTime are present we require startTime ≤ endTime. |
endTime |
DtoTime | optional | If present, the range only includes times before this time. If both startTime and endTime are present we require startTime ≤ endTime. |
Interval used to exclude/include data with an annotation denoting an estimated origin for an incident. This interval type is used for storing intervals before events (or incidents) for the state detection engine.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
startTime |
DtoTime | optional | If present, the range only includes times at or after this time. If both startTime and endTime are present we require startTime ≤ endTime. |
endTime |
DtoTime | optional | If present, the range only includes times before this time. If both startTime and endTime are present we require startTime ≤ endTime. |
Information about the data.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
signals |
DtoAbstractSignalDataReport[] | - | Information on all signals in the data. |
Information on a specific signal in the data.
@abstract
Type: Object
Sub-Types: DtoRawSignalDataReport, DtoSynthesizedSignalDataReport
Discriminator: _type
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
signal |
DtoSignalId | - | ID of the signal. |
dataType |
DtoDataType | - | Data type of the signal. |
Information on a specific signal in the data, whose values were added directly.
Type: Object
Super-Types: DtoAbstractSignalDataReport
Discriminator: _type
Discriminator-Value: Raw
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
signal |
DtoSignalId | - | ID of the signal. |
dataType |
DtoDataType | - | Data type of the signal. |
Information on a specific signal in the data, whose values were calculated by an expression (synthesized).
Type: Object
Super-Types: DtoAbstractSignalDataReport
Discriminator: _type
Discriminator-Value: Synthesized
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
signal |
DtoSignalId | - | ID of the signal. |
dataType |
DtoDataType | - | Data type of the signal. |
expression |
String | - | Expression by which this signal was synthesized. |
involvedSignals |
DtoSignalId[] | - | Source signals that were used in the expression to synthesize the signal. |
Specification for the data needed at the inference.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
signals |
DtoAbstractInferenceSignalSpecification[] | - | Specification for all signals needed at the inference. |
Specification for a specific signal needed at the inference.
@abstract
Type: Object
Sub-Types: DtoInferenceRawSignalSpecification, DtoInferenceSynthesizedSignalSpecification
Discriminator: _type
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
signal |
DtoSignalId | - | ID of the signal. |
dataType |
DtoDataType | - | Data type of the signal. |
Specification for a specific signal needed at the inference, whose values were added directly.
Type: Object
Super-Types: DtoAbstractInferenceSignalSpecification
Discriminator: _type
Discriminator-Value: Raw
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
signal |
DtoSignalId | - | ID of the signal. |
dataType |
DtoDataType | - | Data type of the signal. |
startLag |
DtoNonNegativeDuration | - | Start of the time window measured as duration until the inference timestamp. |
endLag |
DtoNonNegativeDuration | - | End of the time window (inclusive), measured as duration until the inference timestamp. |
Specification for a specific signal needed at the inference, whose values were calculated by an expression (synthesized).
Type: Object
Super-Types: DtoAbstractInferenceSignalSpecification
Discriminator: _type
Discriminator-Value: Synthesized
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
signal |
DtoSignalId | - | ID of the signal. |
dataType |
DtoDataType | - | Data type of the signal. |
expression |
String | - | Expression by which this signal was synthesized. |
involvedSignals |
DtoSignalId[] | - | Source signals that were used in the expression to synthesize the signal. |
Limits the use of features based on certain criteria.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
includeFeatures |
DtoFunctionId[] | optional | If present, restrict to these features. |
excludeFeatures |
DtoFunctionId[] | optional | If present, exclude all these features. |
includeSignals |
DtoSignalId[] | optional | If present, restrict to the features created by these signals. |
excludeSignals |
DtoSignalId[] | optional | If present, exclude all features created by these signals. |
Limits the use of the data based on certain criteria.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
includeColumns |
DtoColumnId[] | optional | If present, include only these columns. |
excludeColumns |
DtoColumnId[] | optional | If present, exclude all these columns. |
Type: Object
Sub-Types: DtoTimeseriesDataConfig
Property | Type | Markers | Description |
---|---|---|---|
folder |
String | - | Path to the archive folder |
filesFilter |
DtoFilesFilter | optional | files to include and/or exclude from the folder |
dataFilter |
DtoAbstractTimeseriesDataFilter | optional | - |
dataTypes |
DtoTimeseriesDataTypesConfig | optional | - |
ignoreSignalAvailabilities |
Boolean | optional, default: false |
Availability timestamps of inference data are considered or not. If no availabilities are given, this configuration is irrelevant. |
dev |
Any | optional | Unstable and undocumented configuration options. Developers only. |
@abstract
Type: Object
Sub-Types: DtoDefaultTimeseriesDataFilter, DtoInferenceTimeseriesDataFilter
Discriminator: _type
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object |
Type: Object
Super-Types: DtoAbstractTimeseriesDataFilter
Discriminator: _type
Discriminator-Value: Default
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object |
includeSignals |
DtoDataFilterRange[] | optional | If present, restrict to these signal ranges. |
excludeSignals |
DtoDataFilterRange[] | optional | If present, exclude all these signal ranges. |
includeRanges |
DtoInterval[] | optional | If present, restrict to these ranges for all signals. |
excludeRanges |
DtoInterval[] | optional | If present, exclude these ranges for all signals. |
startTime |
DtoTime | optional | If present, exclude all data before this time. If both startTime and endTime are present we require startTime ≤ endTime. |
endTime |
DtoTime | optional | If present, exclude all data at or after this time. If both startTime and endTime are present we require startTime ≤ endTime. |
Type: Object
Super-Types: DtoAbstractTimeseriesDataFilter
Discriminator: _type
Discriminator-Value: Inference
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object |
dataSpecifications |
DtoInferenceDataSpecification[] | - | At least one must be given |
additionalSignals |
DtoSignalId[] | optional, default: [] |
additional signals to read |
inferenceTimeRanges |
DtoInterval[] | - | - |
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
defaultType |
DtoDataType | optional, default: FLOAT |
- |
floatSignals |
DtoSignalId[] | optional | - |
stringSignals |
DtoSignalId[] | optional | - |
booleanSignals |
DtoSignalId[] | optional | - |
Type: Object
Sub-Types: DtoTabularDataConfig
Property | Type | Markers | Description |
---|---|---|---|
folder |
String | - | Path to the archive folder |
filesFilter |
DtoFilesFilter | optional | files to include and/or exclude from the folder |
dataFilter |
DtoTabularDataFilter | optional | - |
dataTypes |
DtoTabularDataTypesConfig | optional | - |
dev |
Any | optional | Unstable and undocumented configuration options. Developers only. |
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
defaultType |
DtoDataType | optional, default: FLOAT |
- |
floatColumns |
DtoColumnId[] | optional | - |
stringColumns |
DtoColumnId[] | optional | - |
booleanColumns |
DtoColumnId[] | optional | - |
Parts of the formula describing the calculation while inference. Functions are succesively evaluated on signals and other functions to derive a final inference result.
@abstract
Type: Object
Sub-Types: DtoSignalFunction, DtoLagFunction, DtoLtiFilterFunction, DtoCategoryEqualsFunction, DtoFourierTransformFunction, DtoPowerSpectrumFunction, DtoPhaseSpectrumFunction, DtoSinFunction, DtoCosFunction, DtoScaleFunction, DtoPrincipalDirectionFunction, DtoLogisticFunction, DtoReluFunction, DtoIdentityFunction, DtoMollifierFunction, DtoIdCategoryMapFunction, DtoIdCategoryProbaMapFunction, DtoSumFunction, DtoLogSumExpFunction, DtoMaxFunction, DtoArgMaxFunction, DtoProductFunction, DtoConstantFunction, DtoStepFunction, DtoLogarithmFunction, DtoExponentialFunction, DtoGaussCdfFunction, DtoAggregatedNumericalFunction, DtoAggregatedCategoricalFunction, DtoKernelModelFunction, DtoTreeModelFunction
Discriminator: _type
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
Wraps a signal into a function.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: Signal
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
signal |
DtoSignalId | - | The ID of the signal to be used as function. |
Lags the values of the source function by some fixed delay.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: Lag
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
source |
DtoFunctionId | - | ID of the function whose values are lagged. |
lag |
DtoNonNegativeDuration | - | The delay. The value of the resulting function at time "t" is given by "source(t - lag)". |
An LtiFilterFunction is the convolution of a moving time window of the input with some fixed function. Numeric input and output.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: LtiFilter
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
source |
DtoFunctionId | - | FunctionId of the only input function. |
parameters |
DtoFloat[] | - | Parameters of the lti-filter function. The value of the resulting function at time t is given by "sum_i source(t - mesh * (parameters.size - i -1)) * parameters[i]". |
mesh |
DtoPositiveDuration | - | Time resolution of the source used in this function. |
A CategoricalEqualsFunction applied to a categorical function yields a 0/1-function for one of the function's categories. Numeric, string or boolean input and numeric output.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: CategoryEquals
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
category |
DtoFunctionId | - | FunctionId of the only input function. |
testValue |
DtoAbstractCategory | - | The category (=value) of the categorical source for which this 0/1-function is created. The function is 1 when the source evaluates to this value. Otherwise, the function evaluates to 0. |
catCount |
DtoPositiveInteger | optional | The number of unique categories within the source signal. |
A DtoFourierTransformFunction performs a Fourier transform on the input. Numeric input and complex vector output.
@experimental: Might change in future releases.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: FourierTransform
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
argument |
DtoFunctionId | - | FunctionId of the only input function. |
windowLength |
DtoPositiveDuration | - | At time "t", frequency spectra are calculated for the time window from after "t - windowLength" to "t" using a step size given by mesh. |
mesh |
DtoPositiveDuration | - | Time resolution of the source used in creation of this function. Mesh must not be bigger than window_length. |
A DtoPowerSpectrumFunction returns the logarithm of the power in some frequency band. Complex vector input and numeric output.
@experimental: Might change in future releases.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: PowerSpectrum
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
spectrum |
DtoFunctionId | - | FunctionId of the only input function. |
minFrequency |
DtoNonNegativeInteger | - | The lowest frequency included in the frequency band. Frequencies are enumerated by successive integers starting with 0. Frequency k means a period of windowLength/k; (frequency 0 means mean over windowLenght); windowLength is given in the underlying DtoFourierTransformFunction. |
maxFrequency |
DtoNonNegativeInteger | - | Exclusive upper bound of the frequency band. Frequencies are enumerated by successive integers starting with 0. Frequency k means a period of windowLength/k; (frequency 0 means mean over windowLenght); windowLength is given in the underlying DtoFourierTransformFunction. |
A DtoPhaseSpectrumFunction represents a phase of a complex frequency spectrum. Complex vector input and numeric output (cycle 2 pi).
@experimental: Might change in future releases.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: PhaseSpectrum
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
spectrum |
DtoFunctionId | - | FunctionId of the only input function. |
frequency |
DtoNonNegativeInteger | - | The frequency to which the phase belongs. Frequencies are enumerated by successive integers starting with 0. Frequency k means a period of windowLength/k; (frequency 0 means mean over windowLenght); windowLength is given in the underlying DtoFourierTransformFunction. |
The sin function. Numeric input and output.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: Sin
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
argument |
DtoFunctionId | - | FunctionId of the only input function. |
The cos function. Numeric input and output.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: Cos
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
argument |
DtoFunctionId | - | FunctionId of the only input function. |
Returns the input multiplied by the factor. Numeric input and output.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: Scale
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
argument |
DtoFunctionId | - | FunctionId of the only input function. |
factor |
DtoFloat | - | - |
A DtoPrincipalDirectionFunction is a linear combination of other functions. Numeric input and output.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: PrincipalDirection
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
coefficients |
DtoFeatureValue[] | - | The weights of the functions in the linear combination that form this function. |
The logistic function. Numeric input and output.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: Logistic
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
argument |
DtoFunctionId | - | FunctionId of the only input function. |
The rectified linear unit. Numeric input and output.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: Relu
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
argument |
DtoFunctionId | - | FunctionId of the only input function. |
Identity function. Numeric input and output.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: Identity
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
argument |
DtoFunctionId | - | FunctionId of the only input function. |
A mollifier function. Numeric input and output.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: Mollifier
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
argument |
DtoFunctionId | - | FunctionId of the only input function. |
Assigns each input value a result based on a dictionary. DtoFunctionId input and float or string or boolean output.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: IdCategoryMap
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
argument |
DtoFunctionId | - | FunctionId of the only input function (whose return type is DtoFunctionId). |
entries |
DtoIdCategoryEntry[] | - | The key-value-pairs of this dictionary (all entries should have the same value type) |
Assigns each input value a result based on a dictionary and its probability.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: IdCategoryProbaMap
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
sources |
DtoFunctionId[] | - | FunctionIds of the only input functions. |
entries |
DtoIdCategoryEntry[] | - | The key-value-pairs of this dictionary (all entries should have the same value type) |
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
id |
DtoFunctionId | - | The key. |
category |
DtoAbstractCategory | - | The category the key is mapped to. |
Sum over all input functions. Numeric input and output.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: Sum
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
summands |
DtoFunctionId[] | - | The values of these functions are used as input. |
Smooth max function. Approximates the maximum of the elements of the vector used as input.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: LogSumExp
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
sources |
DtoFunctionId[] | - | The values of these functions are used as input. |
scale |
DtoFloat | - | Scales the inputs and makes the function sharper around the maximum. |
absArgument |
Boolean | - | Take the absolute values of the sources |
Returns the largest function value among the source functions at a given timestamp. Numeric input and output.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: Max
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
sources |
DtoFunctionId[] | - | The values of these functions are used as input. |
Returns the id of the function with the largest result. Multiple numeric inputs and DtoFunctionId output.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: ArgMax
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
arguments |
DtoFunctionId[] | - | The values of these functions are used as input. |
Product over all input functions. Numeric input and output.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: Product
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
factors |
DtoFunctionId[] | - | The values of these functions are used as input. |
Returns the constant value provided. Numeric input and output.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: Constant
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
argument |
DtoFunctionId | - | FunctionId of the only input function. |
constant |
DtoFloat | - | - |
Step function. Returns 0 if argument value is negative else 1. Numeric input and output.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: Step
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
argument |
DtoFunctionId | - | FunctionId of the only input function. |
Natural logarithm function. Numeric input and output.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: Logarithm
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
argument |
DtoFunctionId | - | FunctionId of the only input function. |
Exponential function. Numeric input and output.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: Exponential
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
argument |
DtoFunctionId | - | FunctionId of the only input function. |
Gaussian cummulative distribution function. Numeric input and output.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: GaussCdf
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
argument |
DtoFunctionId | - | FunctionId of the only input function. |
mean |
DtoFloat | - | Mean of Gaussian. |
std |
DtoFloat | - | Standard deviation of Gaussian. |
Aggregating a numerical signal over the time window given by min and max lags. Numeric input and ouput.
@experimental: Might change in future releases.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: AggregatedNumerical
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
source |
DtoFunctionId | - | FunctionId of the only input function. |
evalType |
DtoNumericalFunctionEvalType | - | Evalution type of aggregated numerical function |
maxLag |
DtoNonNegativeDuration | - | Start of the time window. |
minLag |
DtoNonNegativeDuration | - | End of the time window. |
mesh |
DtoPositiveDuration | - | Time resolution of the source used in this function. |
Aggregating a categorical signal over the time window given by min and max lags. The source of the function is DtoCategoryEqualsFunction. Numeric input and ouput.
@experimental: Might change in future releases.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: AggregatedCategorical
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
source |
DtoFunctionId | - | FunctionId of the only input function. |
evalType |
DtoCategoricalFunctionEvalType | - | Evalution type of aggregated categorical function |
maxLag |
DtoNonNegativeDuration | - | Start of the time window. |
minLag |
DtoNonNegativeDuration | - | End of the time window. |
Available evalution types. Positive state is a state at which the source function (DtoCategoricalEqualsFunction) returns 1.0, i.e., true.
@experimental: Might change in future releases.
Type: String
Enum: POSITIVE_STATE_WAS_PRESENT
, DURATION_OF_POSITIVE_STATES
, POSITIVE_STATE_CHANGE_COUNT
, DURATION_OF_LAST_POSITIVE_STATE
A KernelModel is a kernel regressor fine-tuned with the training data. Numeric input and output.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: KernelModel
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | ID of the function. |
kernelType |
DtoKernelType | - | Engine internal. |
category |
DtoAbstractCategory | - | Engine internal. |
scaleFactors |
DtoFeatureValue[] | - | Engine internal. |
components |
DtoKernelModelComponent[] | - | Engine internal. |
noise |
DtoFloat | - | Engine internal. |
Engine internal.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
controlPoint |
DtoFeatureValue[] | - | Engine internal. |
coefficient |
DtoFloat | - | Engine internal. |
id |
DtoControlPointId | optional | Engine internal. |
isSobolPoint |
Boolean | optional | Engine internal. |
Value
Feature value with featureId and its value.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
feature |
DtoFunctionId | - | Engine internal. |
value |
DtoFloat | - | Engine internal. |
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
feature |
DtoFeatureId | - | - |
mean |
DtoFloat | - | Mean of the feature values computed based on inducing points. |
std |
DtoFloat | - | Standard deviation of the feature values computed based on inducing points. |
min |
DtoFloat | optional | Min of the feature values computed based on inducing points. |
max |
DtoFloat | optional | Max of the feature values computed based on inducing points. |
A TreeModel is a tree regressor fine-tuned with the training data. Numeric input and output.
Type: Object
Super-Types: DtoAbstractFunction
Discriminator: _type
Discriminator-Value: TreeModel
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type of this object. |
id |
DtoFunctionId | - | Engine internal. |
sources |
DtoFunctionId[] | - | Engine internal. |
tree |
DtoTreeNode[] | - | Engine internal. |
root |
DtoTreeNodeId | - | Engine internal. |
Engine internal.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
id |
DtoTreeNodeId | - | Engine internal. |
parent |
DtoTreeNodeId | optional | Engine internal, |
children |
DtoTreeNodeId[] | - | Engine internal. |
predicate |
DtoPredicate | optional | Engine internal. |
labelMean |
DtoFloat | - | Engine internal. |
count |
DtoNonNegativeInteger | - | Engine internal. |
labelMeanInRoot |
DtoFloat | - | Engine internal. |
rating |
DtoFloat | - | Engine internal. |
pvalue |
DtoNonNegativeFloat | optional | Engine internal. |
Engine internal.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
sourceFunction |
DtoFunctionId | - | Engine internal. |
min |
DtoFloat | optional | Engine internal. |
max |
DtoFloat | optional | Engine internal. |
Base error type, generated by the engine.
@abstract
Type: Object
Sub-Types: DtoTargetSignalNotFoundError, DtoTargetSignalLowQualityError, DtoTargetSignalDataTypeUnexpectedError, DtoTargetSignalTooManyCategoriesError, DtoSignalNotFoundError, DtoSignalDataTypeUnexpectedError, DtoSignalInterpreterAmbiguousError, DtoOscillatorySignalInterpretationFailure, DtoColumnNotFoundError, DtoColumnDataTypeUnexpectedError, DtoColumnInterpreterAmbiguousError, DtoWeightColumnNegativeValueError, DtoSignalIdAlreadyInUseError, DtoColumnIdAlreadyInUseError, DtoSegmentNotFoundError, DtoInferenceOutputTypeUnexpectedError, DtoInferenceDataTypeUnexpectedError, DtoInferenceDataPredecessorMissingError, DtoInferenceOutputTargetInterpreterTypeUnexpectedError, DtoDataConcurrentModificationError, DtoDataQuantityInsufficientError, DtoDataQualityInsufficientError, DtoHandleDanglingError, DtoHandleTypeUnexpectedError, DtoPointerForeignError, DtoPointerTypeUnexpectedError, DtoStringEncodingInvalidError, DtoExpressionSyntaxFailureError, DtoExpressionRuntimeFailureError, DtoExpressionResultDataTypeUnexpectedError, DtoLicenseServerCommunicationFailureError, DtoLicenseApiKeyNotFoundError, DtoLicenseInsufficientError, DtoIncrementalLearningModelCorruptedError, DtoIncrementalLearningDataQualityInsufficientError, DtoSignalConstraintInterpreterUnexpectedError, DtoModelConstraintNotFoundError, DtoConstraintNavigatorHubModelUnsuitedError, DtoMissingConstraintsError, DtoJsonParseFailureError, DtoJsonValidationFailureError, DtoInferenceRawSignalSpecificationDataTypeAmbiguousError, DtoOperativeSignalMissingTrueValuesError, DtoInternalEngineFailureError, DtoArgumentValidationError
Discriminator: _type
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Failed to find target signal with ID {id}
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: TargetSignalNotFound
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Signal with ID {id} cannot be used as target due to its low information quality. Error: {error}
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: TargetSignalLowQuality
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Target signal with ID {id} is expected to be any data type of {expected} but was of data type {actual}
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: TargetSignalDataTypeUnexpected
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Target signal with ID {id} of data type Float contains too many unique values: {numb_of_cats}. Categorical interpreter with target of data type Float allows maximally 42 unique values. If you want to use target nevertheless ingest with data type String.
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: TargetSignalTooManyCategories
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Failed to find signal with ID {id}
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: SignalNotFound
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Signal with ID {id} is expected to be any data type of {expected} but was of data type {actual}
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: SignalDataTypeUnexpected
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Signal with ID {id} has ambiguous interpreters
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: SignalInterpreterAmbiguous
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Unable to resolve oscillatory interpretation of signal {id} at time t {timestamp} due to too sparse data
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: OscillatorySignalInterpretationFailure
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Failed to find column with ID {id}
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: ColumnNotFound
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Column with ID {id} is expected to be any data type of {expected} but was of data type {actual}
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: ColumnDataTypeUnexpected
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Column with ID {id} has ambiguous interpreters
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: ColumnInterpreterAmbiguous
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Weight column with ID {id} has negative value in row with ID {row_id}. All weights must be >=0.
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: WeightColumnNegative
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Signal ID {id} is already in use
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: SignalIdAlreadyInUse
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Column ID {id} is already in use
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: ColumnIdAlreadyInUse
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Failed to find segment with ID {id}
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: SegmentNotFound
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Inference output specification is expected to be of data type {expected} but was of data type {actual}
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: InferenceOutputTypeUnexpected
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Inference data specification for signal with ID {id} is expected to be of data type {expected} but was of data type {actual}
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: InferenceDataTypeUnexpected
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Inference data is expected to include information on signal {id} at or before timestamp {timestamp}
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: InferenceDataPredecessorMissing
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Inference output specification is expected to be of target interpreter type {expected} but was {actual}
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: InferenceOutputTypeUnexpected
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Failed to modify data with handle '{handle}' due to concurrent usage
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: DataConcurrentModification
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Data with handle '{handle}' does not contain any training signals
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: DataQuantityInsufficient
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Data with handle '{handle}' does not contain any training signals after data removal
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: DataQualityInsufficient
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Failed to dereference handle '{handle}'
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: HandleDangling
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Handle '{handle}' is expected to be of type '{expected}' but was of type '{actual}'
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: HandleTypeUnexpected
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Pointer was not created by this engine instance
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: PointerForeign
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Pointer has unexpected type
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: PointerTypeUnexpected
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Pointer failed to be decoded as string: {error}
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: StringEncodingInvalid
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Failed to compile expression {expression}: {error}
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: ExpressionSyntaxFailure
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Failed to evaluate expression {expression} at timestamp '{timestamp}': {error}
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: ExpressionRuntimeFailure
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Result of expression {expression} is expected to be of data type {expected} but was of type {actual} at timestamp '{timestamp}'
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: ExpressionResultDataTypeUnexpected
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Failed to communicate with license server: {error}
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: LicenseServerCommunicationFailure
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Failed to find license api key
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: LicenseApiKeyNotFound
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
License terms insufficient
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: LicenseInsufficient
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
DtoIncremental data does not match remaining model data: {error}
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: IncrementalLearningModelCorrupted
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Insufficient data quality of signals at label timestamps
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: IncrementalLearningDataQualityInsufficient
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Constraint on signal with not supported interpreter
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: SignalConstraintInterpreterUnexpected
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Model ID {id} not part of the hub model
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: ModelConstraintNotFound
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Model constraints must be provided in the inference_config in order to call the endpoint infer_float_with_next_normal.
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: MissingConstraints
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Failed to parse json: {error}
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: JsonParseFailure
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Failed to validate json: {error}
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: JsonValidationFailure
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Data type of signal {id} is ambiguous in inference data specification
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: InferenceRawSignalSpecificationDataTypeAmbiguous
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Failed to identify operative periods: the operative signal must contain at least one 'true' value.
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: OperativeSignalMissingTrueValues
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Internal engine failure: {error}
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: InternalEngineFailure
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
Failed to validate argument: {error}
Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: ArgumentValidationError
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator. |
message |
String | - | Error message. |
details |
DtoErrorParam[] | - | List of named parameters used in this error's message. |
@abstract
Type: Object
Sub-Types: DtoStringCategory, DtoFloatCategory, DtoBooleanCategory
Discriminator: _type
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator |
Type: Object
Super-Types: DtoAbstractCategory
Discriminator: _type
Discriminator-Value: String
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator |
value |
String | - | - |
Type: Object
Super-Types: DtoAbstractCategory
Discriminator: _type
Discriminator-Value: Float
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator |
value |
DtoFloat | - | - |
Type: Object
Super-Types: DtoAbstractCategory
Discriminator: _type
Discriminator-Value: Boolean
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator |
value |
Boolean | - | - |
@abstract
Type: Object
Sub-Types: DtoStringColumnValue, DtoFloatColumnValue, DtoBooleanColumnValue
Discriminator: _type
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator |
Type: Object
Super-Types: DtoAbstractColumnValue
Discriminator: _type
Discriminator-Value: String
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator |
value |
String | - | - |
Type: Object
Super-Types: DtoAbstractColumnValue
Discriminator: _type
Discriminator-Value: Float
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator |
value |
DtoFloat | - | - |
Type: Object
Super-Types: DtoAbstractColumnValue
Discriminator: _type
Discriminator-Value: Boolean
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator |
value |
Boolean | - | - |
Single data point with timestamp and boolean value.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
timestamp |
DtoTime | - | Detection timestamp of this data point. |
value |
Boolean | - | Boolean value of this data point. |
Single data point with timestamp, availability and floating point value.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
timestamp |
DtoTime | - | Detection timestamp of this data point. |
availability |
DtoTime | - | Availability timestamp of this data point. |
value |
DtoFloat | - | Floating point value of this data point. |
Single data point with timestamp and string value.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
timestamp |
DtoTime | - | Detection timestamp of this data point. |
value |
String | - | String value of this data point. |
Dependency information of synthesized signal.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
involvedSignalIds |
DtoSignalId[] | - | List of used signals. |
Single cell with row id and floating point value.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
id |
String | - | Row id of this cell. |
value |
DtoFloat | - | Floating point value of this cell. |
Enhanced data point with timestamp and list of DtoFloatConstraintValue.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
timestamp |
DtoTime | - | Detection timestamp for this data point. |
cost |
DtoFloatCostValue | - | Evaluation of cost function. |
constraints |
DtoFloatConstraintValue[] | - | Evaluations of constraint models. |
Tuple with cost_type and value of the cost function.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
costType |
String | - | Type of cost function. |
value |
DtoFloat | - | Evaluation of cost function. |
Tuple with id of model and evaluation of model.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
model |
String | - | Model id. |
value |
DtoFloat | - | Evaluation of model. |
Enhanced data point with timestamp, DtoFloatCostValueWithNextNormal, list of DtoFloatConstraintValueWithNextNormal and list of DtoFeatureValueWithNextNormal.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
timestamp |
DtoTime | - | Detection timestamp for this data point. |
cost |
DtoFloatCostValueWithNextNormal | - | Evaluation of cost function before and after optimization. |
constraints |
DtoFloatConstraintValueWithNextNormal[] | - | Evaluations of constraint models. |
features |
DtoFeatureValueWithNextNormal[] | - | Next normal feature values and rating of underlying features. |
Triplet with cost_type, value of the cost function before and after optimization.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
costType |
String | - | Type of cost function. |
value |
DtoFloat | - | Evaluation of cost function before optimization. |
nextNormalValue |
DtoFloat | - | Evaluation of cost function after optimization. |
Enhanced data point with timestamp, floating point value, list of DtoFeatureValueWithNextNormal.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
timestamp |
DtoTime | - | Detection timestamp for this data point. |
value |
DtoFloat | - | Prediction value of this data point. |
nextNormalValue |
DtoFloat | - | Prediction value of the next normal feature values. |
features |
DtoFeatureValueWithNextNormal[] | - | Next normal feature values and rating of underlying features. |
Quadruple with id of feature, observed value of feature, next normal value of feature, rating.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
feature |
DtoFunctionId | - | Feature id. |
value |
DtoFloat | - | Observed feature value. |
nextNormalValue |
DtoFloat | - | Next normal feature value. |
rating |
DtoFloat | - | Rating how much value differs from next_normal_value. |
Enhanced data point with timestamp and list of float-valued category-probability pairs.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
timestamp |
DtoTime | - | Detection timestamp for this data point. |
categories |
DtoFloatCategoryWithProbability[] | - | List of category-probability pairs. |
Enhanced data point with timestamp and list of string-valued category-probability pairs.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
timestamp |
DtoTime | - | Detection timestamp for this data point. |
categories |
DtoStringCategoryWithProbability[] | - | List of category-probability pairs. |
Enhanced data point with timestamp and list of boolean-valued category-probability pairs.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
timestamp |
DtoTime | - | Detection timestamp for this data point. |
categories |
DtoBooleanCategoryWithProbability[] | - | List of category-probability pairs. |
Category-probability pair with string-valued category.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
category |
String | - | Category. |
probability |
DtoFloat | - | Probability of category. |
Category-probability pair with boolean-valued category.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
category |
Boolean | - | Category. |
probability |
DtoFloat | - | Probability of category. |
Tuple containing an ID and a float value.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
segmentId |
DtoSegmentId | - | Segment ID of this SegmentFloatValue. |
value |
DtoFloat | - | Floating point value of this SegmentFloatValue. |
Single data point consisting in a timestamp and a list of DtoSegmentFloatValue.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
timestamp |
DtoTime | - | Timestamp of this data point. |
values |
DtoSegmentFloatValue[] | - | SegmentFloatValues of this data point. |
Triple containing an ID, a float value, and a list of DtoFeatureValueWithNextNormal.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
segmentId |
DtoSegmentId | - | Segment ID. |
value |
DtoFloat | - | Segment score. |
nextNormalValue |
DtoFloat | - | Segment score of the next normal feature values. |
features |
DtoFeatureValueWithNextNormal[] | - | Next normal feature values and rating of underlying features. |
Single data point consisting of a timestamp and a list of DtoSegmentFloatValueWithNextNormal.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
timestamp |
DtoTime | - | Timestamp of this data point. |
valuesWithNextNormal |
DtoSegmentFloatValueWithNextNormal[] | - | List of SegmentFloatValueWithNextNormal of this data point. |
Configure the source and handling of timeseries input data. The data is read exactly as specified - except if NO data filter is given here, then the Suite constructs one suitable to the calculation. E.g. for a model training, it uses the model training config's data filter. For a inference worker, only the signals inside of the inferred model are read.
Type: Object
Super-Types: DtoTimeseriesFilesReaderConfig
Property | Type | Markers | Description |
---|---|---|---|
folder |
String | - | Path to the archive folder |
filesFilter |
DtoFilesFilter | optional | files to include and/or exclude from the folder |
dataFilter |
DtoAbstractTimeseriesDataFilter | optional | - |
dataTypes |
DtoTimeseriesDataTypesConfig | optional | - |
ignoreSignalAvailabilities |
Boolean | optional, default: false |
Availability timestamps of inference data are considered or not. If no availabilities are given, this configuration is irrelevant. |
dev |
Any | optional | Unstable and undocumented configuration options. Developers only. |
synthesizedSignals |
DtoSynthesizedSignalConfig[] | optional, default: [] |
Signals to synthesize. Synthesized Signals must arrive in a synthesizable order, i.e. a signal above in the list must not have a involved signal which is a synthesized signal from down in the list. |
How a signal is to be synthesized (expression) and named (signalId).
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
expression |
String | - | Expression of the synthesized signal |
signal |
DtoSignalId | - | Id of the synthesized signal |
dataType |
DtoDataType | - | Data Type of the synthesized signal |
Configure the source and handling of tabular input data.
Type: Object
Super-Types: DtoTabularFilesReaderConfig
Property | Type | Markers | Description |
---|---|---|---|
folder |
String | - | Path to the archive folder |
filesFilter |
DtoFilesFilter | optional | files to include and/or exclude from the folder |
dataFilter |
DtoTabularDataFilter | optional | - |
dataTypes |
DtoTabularDataTypesConfig | optional | - |
dev |
Any | optional | Unstable and undocumented configuration options. Developers only. |
Configure timestamps an inference is made at
Type: Object
Sub-Types: DtoEquidistantTimestampsConfig, DtoAtNextSignalValueTimestampsConfig
Discriminator: _type
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
startTime |
DtoTime | - | First timestamp an inference may be made, depending on the timing configuration. |
endTime |
DtoTime | - | Last timestamp, excluded, where an inference may be made, depending on the timing configuration. |
operativeSignal |
DtoSignalId | optional | Id of a boolean signal. If this is set, inferences are only made where this signal is true. |
Inference timestamps are chosen in fixed intervals
Type: Object
Super-Types: DtoAbstractTimestampsConfig
Discriminator: _type
Discriminator-Value: Equidistant
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
startTime |
DtoTime | - | First timestamp an inference may be made, depending on the timing configuration. |
endTime |
DtoTime | - | Last timestamp, excluded, where an inference may be made, depending on the timing configuration. |
operativeSignal |
DtoSignalId | optional | Id of a boolean signal. If this is set, inferences are only made where this signal is true. |
interval |
DtoPositiveDuration | - | Fixed distance of the chosen timestamps. |
Inference timestamps are chosen only where another signal has a value
Type: Object
Super-Types: DtoAbstractTimestampsConfig
Discriminator: _type
Discriminator-Value: AtNextSignalValue
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
startTime |
DtoTime | - | First timestamp an inference may be made, depending on the timing configuration. |
endTime |
DtoTime | - | Last timestamp, excluded, where an inference may be made, depending on the timing configuration. |
operativeSignal |
DtoSignalId | optional | Id of a boolean signal. If this is set, inferences are only made where this signal is true. |
minimumInterval |
DtoNonNegativeDuration | optional, default: 0 |
Not all of the signal's timestamps are chosen as inference timestamp, but this minimum interval is assured. Choose this if the signal has too many values and the number of inferences would be too much to handle. |
signal |
DtoSignalId | - | Id of the signal, typically the target signal |
Configure the output of the inference worker which is to be stored in a folder.
Type: Object
Sub-Types: DtoOutputConfigNode
Property | Type | Markers | Description |
---|---|---|---|
folder |
String | - | Path to the folder where the output files are to be stored. |
additionalSignals |
DtoSignalId[] | optional, default: [] |
Additional timeseries to write, typically synthesized signals for the report. In case of training/analysis workers, they are filtered by the data filter and then written. In case of inference workers, they are only written between start and end time of a timestamps config. |
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
functions |
DtoAbstractFunction[] | - | A list of all functions necessary for hub model inference. |
inferenceDataSpecification |
DtoInferenceDataSpecification | - | Specification of the data that is needed for a subsequent inference with this hub model. |
modelSpecifications |
DtoModelSpecification[] | - | List of all models and their properties used to build this model hub. |
features |
DtoFeature[] | - | A list of all feature ids of the hub model. |
Specification of model
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
model |
DtoModelId | - | ID of the model. |
resultFunction |
DtoFunctionId | - | Function ID within hub model that provides prediction of the model. |
mean |
DtoFloat | - | Mean of the predictions of the model. |
std |
DtoFloat | - | Standard deviation of the predictions of the model. |
Necessary input configuration to make inferences using a hub model.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
dataFilter |
DtoDataFilter | optional, default: {} |
Restrictions on the data used. Determines which signals to use and for which time ranges. |
skipOnInsufficientData |
Boolean | - | This flag controls the behaviour for missing data at inference. Inference is only possible if the data adheres the inference data specification. If the flag is set to true, timestamps for which data are insufficient are skipped. If set to false, an error is thrown if data is not sufficient for some timestamp. |
cost |
DtoAbstractCost | - | The cost function being optimized when making inference with next normal. |
modelConstraints |
DtoModelConstraint[] | optional, default: [] |
List of models and conditions used as constraints when making inference with next normal. |
signalConstraints |
DtoSignalConstraint[] | optional, default: [] |
List of signals and conditions used as constraints when making inference with next normal. |
Input configuration needed to make constraint navigator inference with next normal.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
featureFilter |
DtoFeatureFilter | optional, default: {} |
Constrains the allowed feature space for next normal points. The next normal and the observed data point are allowed to differ only in the specified features. |
@abstract
Type: Object
Sub-Types: DtoL1DistanceCost, DtoL2DistanceCost, DtoModelCost
Discriminator: _type
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
L1 distance function.
Type: Object
Super-Types: DtoAbstractCost
Discriminator: _type
Discriminator-Value: L1Distance
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
L2 distance function, i.e. Euclidean distance.
Type: Object
Super-Types: DtoAbstractCost
Discriminator: _type
Discriminator-Value: L2Distance
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
Cost function which stems from a model within the hub model.
Type: Object
Super-Types: DtoAbstractCost
Discriminator: _type
Discriminator-Value: Model
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
model |
DtoModelId | - | ID of the model in question. Must be part of the hub model. |
optimizationInterest |
DtoOptimizationInterest | - | Specification if one wants to minimize or maximize the cost given by the model. |
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
model |
DtoModelId | - | ID of the model. |
condition |
DtoAbstractCondition | - | Condition imposed on the model. |
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
signal |
DtoSignalId | - | ID of the signal. |
condition |
DtoAbstractCondition | - | Condition imposed on the signal. |
@abstract
Type: Object
Sub-Types: DtoStaticNumericalCondition, DtoDynamicNumericalCondition
Discriminator: _type
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
Lower and upper threshold.
Type: Object
Super-Types: DtoAbstractCondition
Discriminator: _type
Discriminator-Value: StaticNumerical
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
upperThreshold |
DtoFloat | optional | Upper threshold. |
lowerThreshold |
DtoFloat | optional | Lower threshold. |
Lower and upper threshold signals being used to obtain lower and upper threshold when evaluating these signals at timestamps of interest.
Type: Object
Super-Types: DtoAbstractCondition
Discriminator: _type
Discriminator-Value: DynamicNumerical
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
upperThresholdSignal |
DtoSignalId | optional | Signal ID of signal which constitutes of upper threshold. |
lowerThresholdSignal |
DtoSignalId | optional | Signal ID of signal which constitutes of lower threshold. |
Information from model hub creation relevant for report generation.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
targetAspects |
DtoAbstractTargetAspectReport[] | - | - |
Information about one aspect of the target.
@abstract
Type: Object
Sub-Types: DtoNumericalTargetAspectReport
Discriminator: _type
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator |
signals |
DtoSignalReport[] | - | Includes information about the signals and signal aspects. |
features |
DtoAbstractFeatureReport[] | optional | Features used in the model. Features are auto-engineered from signal aspects. |
Type: Object
Super-Types: DtoAbstractTargetAspectReport
Discriminator: _type
Discriminator-Value: Numerical
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator |
signals |
DtoSignalReport[] | - | Includes information about the signals and signal aspects. |
features |
DtoAbstractFeatureReport[] | optional | Features used in the model. Features are auto-engineered from signal aspects. |
Wrapper for signal and its aspects.
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
signal |
DtoSignalId | - | ID of the signal. |
aspects |
DtoAbstractSignalAspectReport[] | - | Relevant aspects derived from the signal. |
@abstract
Type: Object
Sub-Types: DtoNumericalSignalAspectReport, DtoCategoricalSignalAspectReport, DtoOscillatoryPowerSignalAspectReport, DtoOscillatoryPhaseSignalAspectReport, DtoCyclicSignalAspectReport
Discriminator: _type
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator |
aspect |
DtoFunctionId | optional | Id of this aspect. |
Type: Object
Super-Types: DtoAbstractSignalAspectReport
Discriminator: _type
Discriminator-Value: Numerical
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator |
aspect |
DtoFunctionId | optional | Id of this aspect. |
Type: Object
Super-Types: DtoAbstractSignalAspectReport
Discriminator: _type
Discriminator-Value: Categorical
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator |
aspect |
DtoFunctionId | optional | Id of this aspect. |
category |
DtoAbstractCategory | - | - |
Type: Object
Super-Types: DtoAbstractSignalAspectReport
Discriminator: _type
Discriminator-Value: OscillatoryPower
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator |
aspect |
DtoFunctionId | optional | Id of this aspect. |
minFrequency |
DtoNonNegativeFloat | - | The lowest frequency included in the frequency band. |
maxFrequency |
DtoNonNegativeFloat | - | Exclusive upper bound of the frequency band. |
Type: Object
Super-Types: DtoAbstractSignalAspectReport
Discriminator: _type
Discriminator-Value: OscillatoryPhase
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator |
aspect |
DtoFunctionId | optional | Id of this aspect. |
frequency |
DtoNonNegativeFloat | - | The frequency to which the phase belongs. |
Type: Object
Super-Types: DtoAbstractSignalAspectReport
Discriminator: _type
Discriminator-Value: Cyclic
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator |
aspect |
DtoFunctionId | optional | Id of this aspect. |
Information about a feature.
@abstract
Type: Object
Sub-Types: DtoLagFeatureReport, DtoLtiFilterFeatureReport, DtoAggregatedNumericalFeatureReport, DtoAggregatedCategoricalFeatureReport
Discriminator: _type
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator |
feature |
DtoFunctionId | - | Id of this feature. |
Feature created from source aspect by delaying it by some lag.
Type: Object
Super-Types: DtoAbstractFeatureReport
Discriminator: _type
Discriminator-Value: Lag
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator |
feature |
DtoFunctionId | - | Id of this feature. |
source |
DtoFunctionId | - | Id of the source aspect of this feature. |
lag |
DtoNonNegativeDuration | - | Lag applied to source aspect to create feature. |
Feature created from source aspect by applying a Lti filter to it.
Type: Object
Super-Types: DtoAbstractFeatureReport
Discriminator: _type
Discriminator-Value: LtiFilter
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator |
feature |
DtoFunctionId | - | Id of this feature. |
source |
DtoFunctionId | - | Id of the source aspect of this feature. |
A feature created from a source aspect by applying a numerical aggregated function to it.
@experimental: Might change in future releases.
Type: Object
Super-Types: DtoAbstractFeatureReport
Discriminator: _type
Discriminator-Value: AggregatedNumerical
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator |
feature |
DtoFunctionId | - | Id of this feature. |
source |
DtoFunctionId | - | Id of the source aspect of this feature. |
evalType |
DtoNumericalFunctionEvalType | - | Evaluation type applied to source aspect to create the aggregated feature. |
A feature created from a source aspect by applying a categorical aggregated function to it.
@experimental: Might change in future releases.
Type: Object
Super-Types: DtoAbstractFeatureReport
Discriminator: _type
Discriminator-Value: AggregatedCategorical
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | Type discriminator |
feature |
DtoFunctionId | - | Id of this feature. |
source |
DtoFunctionId | - | Id of the source aspect of this feature. |
evalType |
DtoCategoricalFunctionEvalType | - | Evaluation type applied to source aspect to create the aggregated feature. |
A set of timestamp-value-pairs
Type: Object
Sub-Types: DtoFloatTimeseries, DtoStringTimeseries, DtoBooleanTimeseries, DtoFloatWithNextNormalTimeseries, DtoTemperaturesTimeseries, DtoFloatWithCategoryProbabilitiesTimeseries, DtoStringWithCategoryProbabilitiesTimeseries, DtoBooleanWithCategoryProbabilitiesTimeseries, DtoSegmentsFloatTimeseries, DtoSegmentsFloatWithNextNormalTimeseries
Discriminator: _type
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
A set of simple timestamp-value-pairs where the value is a float
Type: Object
Super-Types: DtoAbstractTimeseries
Discriminator: _type
Discriminator-Value: Float
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
dataPoints |
DtoFloatDataPoint[] | - | - |
A set of simple timestamp-value-pairs where the value is a string
Type: Object
Super-Types: DtoAbstractTimeseries
Discriminator: _type
Discriminator-Value: String
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
dataPoints |
DtoStringDataPoint[] | - | - |
A set of simple timestamp-value-pairs where the value is a boolean
Type: Object
Super-Types: DtoAbstractTimeseries
Discriminator: _type
Discriminator-Value: Boolean
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
dataPoints |
DtoBooleanDataPoint[] | - | - |
A set of simple timestamp-value-pairs where the value is a float with next normal (from anomaly detection)
Type: Object
Super-Types: DtoAbstractTimeseries
Discriminator: _type
Discriminator-Value: FloatWithNextNormal
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
dataPoints |
DtoFloatDataPointWithNextNormal[] | - | - |
A value-signal-pair
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
signal |
DtoSignalId | - | - |
value |
DtoFloat | - | - |
A set of value-signal-pairs at a certain timestamp
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
timestamp |
DtoTime | - | - |
signalTemperatures |
DtoSignalTemperature[] | - | - |
A set of simple timestamp-value-pairs where the value is a temperatures data point (from state detection)
Type: Object
Super-Types: DtoAbstractTimeseries
Discriminator: _type
Discriminator-Value: Temperatures
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
dataPoints |
DtoTemperaturesDataPoint[] | - | - |
A set of timestamp-value-pairs with a fixed id (i.e. signal name)
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
id |
DtoSignalId | - | - |
timeseries |
DtoAbstractTimeseries | - | - |
A set of simple timestamp-value-pairs where the value is a float with category probabilities (from signal prediction / classification)
Type: Object
Super-Types: DtoAbstractTimeseries
Discriminator: _type
Discriminator-Value: FloatWithCategoryProbabilities
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
dataPoints |
DtoFloatDataPointWithCategoryProbabilities[] | - | - |
A set of simple timestamp-value-pairs where the value is a string with category probabilities (from signal prediction / classification)
Type: Object
Super-Types: DtoAbstractTimeseries
Discriminator: _type
Discriminator-Value: StringWithCategoryProbabilities
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
dataPoints |
DtoStringDataPointWithCategoryProbabilities[] | - | - |
A set of simple timestamp-value-pairs where the value is a boolean with category probabilities (from signal prediction / classification)
Type: Object
Super-Types: DtoAbstractTimeseries
Discriminator: _type
Discriminator-Value: BooleanWithCategoryProbabilities
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
dataPoints |
DtoBooleanDataPointWithCategoryProbabilities[] | - | - |
A set of timestamp-value-pairs where the value is a segments float data point
Type: Object
Super-Types: DtoAbstractTimeseries
Discriminator: _type
Discriminator-Value: SegmentsFloat
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
dataPoints |
DtoSegmentsFloatDataPoint[] | - | - |
A set of timestamp-value-pairs where the value is a segments float data point with next normal
Type: Object
Super-Types: DtoAbstractTimeseries
Discriminator: _type
Discriminator-Value: SegmentsFloatWithNextNormal
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
dataPoints |
DtoSegmentsFloatDataPointWithNextNormal[] | - | - |
Exception from the Engine / Core.
Type: Object
Super-Types: DtoException
Discriminator: _type
Discriminator-Value: Engine
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
title |
DtoMediumString | - | - |
message |
DtoLongString | - | - |
errors |
DtoAbstractError[] | - | List of errors occurred while processing an engine task |
Configuring Hub and Model Context
@configurationNode: hub
Type: Object
Property | Type | Markers | Description |
---|---|---|---|
config |
DtoHubConfig | optional | Config of the hub as defined in constraint navigator core |
models |
DtoAbstractModelRef[] | - | List of models to be added to the model context |
Configure the output of the hub worker which is to be stored in a folder.
@configurationNode: output
Type: Object
Super-Types: DtoOutputConfig
Property | Type | Markers | Description |
---|---|---|---|
folder |
String | - | Path to the folder where the output files are to be stored. |
additionalSignals |
DtoSignalId[] | optional, default: [] |
Additional timeseries to write, typically synthesized signals for the report. In case of training/analysis workers, they are filtered by the data filter and then written. In case of inference workers, they are only written between start and end time of a timestamps config. |
Referencing a model to be added to the model context
Type: Object
Sub-Types: DtoSignalPredictionModelRef, DtoAnomalyDetectionModelRef, DtoStateDetectionModelRef
Discriminator: _type
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
id |
String | - | id of the ModelRef |
Referencing a signal prediction model to be added to the model context
Type: Object
Super-Types: DtoAbstractModelRef
Discriminator: _type
Discriminator-Value: SignalPrediction
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
id |
String | - | id of the ModelRef |
file |
String | - | The path where the signal prediction model json is located. |
Referencing an anomaly detection model to be added to the model context
Type: Object
Super-Types: DtoAbstractModelRef
Discriminator: _type
Discriminator-Value: AnomalyDetection
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
id |
String | - | id of the ModelRef |
file |
String | - | The path where the anomaly detection model json is located. |
Referencing a state detection model's segment to be added to the model context
Type: Object
Super-Types: DtoAbstractModelRef
Discriminator: _type
Discriminator-Value: StateDetection
Property | Type | Markers | Description |
---|---|---|---|
_type |
String | - | - |
id |
String | - | id of the ModelRef |
file |
String | - | The path where the state detection model json is located. |
segmentId |
DtoSegmentId | - | Id of the segment |