Package `aivis_engine_v2_cn_sdk_python`

This document describes the syntax of aivis Constraint Navigator using the Python SDK. For getting started with aivis Constraint Navigator and for a high-level understanding of the concepts, please have a look at the Constraint Navigator User Guide.

JSON Structures

DtoAbstractSignalInterpreter

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.

DtoDefaultSignalInterpreter

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.

DtoNumericalSignalInterpreter

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.

DtoCategoricalSignalInterpreter

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.

DtoOscillatorySignalInterpreter

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.

DtoCyclicSignalInterpreter

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.

DtoColumnConfig

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.

DtoAbstractColumnInterpreter

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.

DtoNumericalColumnInterpreter

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.

DtoCategoricalColumnInterpreter

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.

DtoDefaultColumnInterpreter

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.

DtoDataType

Specification of the type of data.

Type: String
Enum: BOOLEAN, FLOAT, STRING

DtoDataFilter

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.

DtoDataFilterRange

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.

DtoInterval

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.

DtoIntervalBeforeIncident

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.

DtoIntervalWithoutIncident

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.

DtoDataReport

Information about the data.

Type: Object

Property	Type	Markers	Description
`signals`	DtoAbstractSignalDataReport[]	-	Information on all signals in the data.

DtoAbstractSignalDataReport

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.

DtoRawSignalDataReport

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.

DtoSynthesizedSignalDataReport

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.

DtoInferenceDataSpecification

Specification for the data needed at the inference.

Type: Object

Property	Type	Markers	Description
`signals`	DtoAbstractInferenceSignalSpecification[]	-	Specification for all signals needed at the inference.

DtoAbstractInferenceSignalSpecification

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.

DtoInferenceRawSignalSpecification

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.

DtoInferenceSynthesizedSignalSpecification

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.

DtoFeatureFilter

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.

DtoTabularDataFilter

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.

DtoTimeseriesFilesReaderConfig

Type: Object

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.

DtoAbstractTimeseriesDataFilter

@abstract

Type: Object
Sub-Types: DtoDefaultTimeseriesDataFilter, DtoInferenceTimeseriesDataFilter
Discriminator: _type

Property	Type	Markers	Description
`_type`	String	-	Type of this object

DtoDefaultTimeseriesDataFilter

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.

DtoInferenceTimeseriesDataFilter

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[]	-	-

DtoTimeseriesDataTypesConfig

Type: Object

Property	Type	Markers	Description
`defaultType`	DtoDataType	optional, default: `FLOAT`	-
`floatSignals`	DtoSignalId[]	optional	-
`stringSignals`	DtoSignalId[]	optional	-
`booleanSignals`	DtoSignalId[]	optional	-

DtoTabularFilesReaderConfig

Type: Object

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.

DtoTabularDataTypesConfig

Type: Object

Property	Type	Markers	Description
`defaultType`	DtoDataType	optional, default: `FLOAT`	-
`floatColumns`	DtoColumnId[]	optional	-
`stringColumns`	DtoColumnId[]	optional	-
`booleanColumns`	DtoColumnId[]	optional	-

DtoFilesFilter

Type: Object

Property	Type	Markers	Description
`includeFiles`	String[]	optional	files to read from the folder and its sub-folders, perhaps regex
`excludeFiles`	String[]	optional	files to exclude from the folder and its sub-folders, perhaps regex.

DtoAbstractFunction

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.

DtoSignalFunction

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.

DtoLagFunction

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)".

DtoLtiFilterFunction

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.

DtoCategoryEqualsFunction

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.

DtoFourierTransformFunction

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.

DtoPowerSpectrumFunction

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.

DtoPhaseSpectrumFunction

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.

DtoSinFunction

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.

DtoCosFunction

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.

DtoScaleFunction

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	-	-

DtoPrincipalDirectionFunction

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.

DtoLogisticFunction

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.

DtoReluFunction

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.

DtoIdentityFunction

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.

DtoMollifierFunction

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.

DtoIdCategoryMapFunction

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)

DtoIdCategoryProbaMapFunction

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)

DtoIdCategoryEntry

Type: Object

Property	Type	Markers	Description
`id`	DtoFunctionId	-	The key.
`category`	DtoAbstractCategory	-	The category the key is mapped to.

DtoSumFunction

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.

DtoLogSumExpFunction

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

DtoMaxFunction

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.

DtoArgMaxFunction

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.

DtoProductFunction

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.

DtoConstantFunction

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	-	-

DtoStepFunction

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.

DtoLogarithmFunction

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.

DtoExponentialFunction

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.

DtoGaussCdfFunction

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.

DtoAggregatedNumericalFunction

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.

DtoNumericalFunctionEvalType

Available evalution types.

@experimental: Might change in future releases.

Type: String
Enum: MIN, MAX, RANGE, MEAN, SLOPE

DtoAggregatedCategoricalFunction

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.

DtoCategoricalFunctionEvalType

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

DtoAggregationType

Specify aggregated features to add.

Type: String
Enum: ALL, MIN, MAX, RANGE, MEAN, SLOPE, POSITIVE_STATE_WAS_PRESENT, DURATION_OF_POSITIVE_STATES, POSITIVE_STATE_CHANGE_COUNT, DURATION_OF_LAST_POSITIVE_STATE

DtoKernelModelFunction

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.

DtoKernelType

Engine internal.

Type: String
Enum: LAPLACE, GAUSSIAN, QUADRATIC, LINEAR, MATERN

DtoKernelModelComponent

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.

DtoFeatureValue

Feature value with featureId and its value.

Type: Object

Property	Type	Markers	Description
`feature`	DtoFunctionId	-	Engine internal.
`value`	DtoFloat	-	Engine internal.

DtoFeature

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.

DtoTreeModelFunction

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.

DtoTreeNode

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.

DtoPredicate

Engine internal.

Type: Object

Property	Type	Markers	Description
`sourceFunction`	DtoFunctionId	-	Engine internal.
`min`	DtoFloat	optional	Engine internal.
`max`	DtoFloat	optional	Engine internal.

DtoProducer

Identifying information on the engine.

Type: Object

Property	Type	Markers	Description
`name`	String	-	Name of the engine.
`version`	String	-	Engine version.

DtoAbstractError

Base error type, generated by the engine.

@abstract

Property	Type	Markers	Description
`_type`	String	-	Type discriminator.
`message`	String	-	Error message.
`details`	DtoErrorParam[]	-	List of named parameters used in this error's message.

DtoErrorParam

Named parameters used in error messages.

Type: Object

Property	Type	Markers	Description
`key`	String	-	-
`value`	Any	-	-

DtoTargetSignalNotFoundError

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.

DtoTargetSignalLowQualityError

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.

DtoTargetSignalDataTypeUnexpectedError

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.

DtoTargetSignalTooManyCategoriesError

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.

DtoSignalNotFoundError

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.

DtoSignalDataTypeUnexpectedError

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.

DtoSignalInterpreterAmbiguousError

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.

DtoOscillatorySignalInterpretationFailure

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.

DtoColumnNotFoundError

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.

DtoColumnDataTypeUnexpectedError

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.

DtoColumnInterpreterAmbiguousError

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.

DtoWeightColumnNegativeValueError

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.

DtoSignalIdAlreadyInUseError

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.

DtoColumnIdAlreadyInUseError

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.

DtoSegmentNotFoundError

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.

DtoInferenceOutputTypeUnexpectedError

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.

DtoInferenceDataTypeUnexpectedError

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.

DtoInferenceDataPredecessorMissingError

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.

DtoInferenceOutputTargetInterpreterTypeUnexpectedError

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.

DtoDataConcurrentModificationError

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.

DtoDataQuantityInsufficientError

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.

DtoDataQualityInsufficientError

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.

DtoHandleDanglingError

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.

DtoHandleTypeUnexpectedError

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.

DtoPointerForeignError

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.

DtoPointerTypeUnexpectedError

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.

DtoStringEncodingInvalidError

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.

DtoExpressionSyntaxFailureError

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.

DtoExpressionRuntimeFailureError

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.

DtoExpressionResultDataTypeUnexpectedError

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.

DtoLicenseServerCommunicationFailureError

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.

DtoLicenseApiKeyNotFoundError

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.

DtoLicenseInsufficientError

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.

DtoIncrementalLearningModelCorruptedError

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.

DtoIncrementalLearningDataQualityInsufficientError

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.

DtoSignalConstraintInterpreterUnexpectedError

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.

DtoModelConstraintNotFoundError

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.

DtoConstraintNavigatorHubModelUnsuitedError

Model with model ID {id} is not differentiable. Can't be used for constraint inference.

Type: Object
Super-Types: DtoAbstractError
Discriminator: _type
Discriminator-Value: ConstraintNavigatorHubModelUnsuited

Property	Type	Markers	Description
`_type`	String	-	Type discriminator.
`message`	String	-	Error message.
`details`	DtoErrorParam[]	-	List of named parameters used in this error's message.

DtoMissingConstraintsError

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.

DtoJsonParseFailureError

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.

DtoJsonValidationFailureError

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.

DtoInferenceRawSignalSpecificationDataTypeAmbiguousError

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.

DtoOperativeSignalMissingTrueValuesError

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.

DtoInternalEngineFailureError

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.

DtoArgumentValidationError

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.

DtoAbstractCategory

@abstract

Type: Object
Sub-Types: DtoStringCategory, DtoFloatCategory, DtoBooleanCategory
Discriminator: _type

Property	Type	Markers	Description
`_type`	String	-	Type discriminator

DtoStringCategory

Type: Object
Super-Types: DtoAbstractCategory
Discriminator: _type
Discriminator-Value: String

Property	Type	Markers	Description
`_type`	String	-	Type discriminator
`value`	String	-	-

DtoFloatCategory

Type: Object
Super-Types: DtoAbstractCategory
Discriminator: _type
Discriminator-Value: Float

Property	Type	Markers	Description
`_type`	String	-	Type discriminator
`value`	DtoFloat	-	-

DtoBooleanCategory

Type: Object
Super-Types: DtoAbstractCategory
Discriminator: _type
Discriminator-Value: Boolean

Property	Type	Markers	Description
`_type`	String	-	Type discriminator
`value`	Boolean	-	-

DtoAbstractColumnValue

@abstract

Type: Object
Sub-Types: DtoStringColumnValue, DtoFloatColumnValue, DtoBooleanColumnValue
Discriminator: _type

Property	Type	Markers	Description
`_type`	String	-	Type discriminator

DtoStringColumnValue

Type: Object
Super-Types: DtoAbstractColumnValue
Discriminator: _type
Discriminator-Value: String

Property	Type	Markers	Description
`_type`	String	-	Type discriminator
`value`	String	-	-

DtoFloatColumnValue

Type: Object
Super-Types: DtoAbstractColumnValue
Discriminator: _type
Discriminator-Value: Float

Property	Type	Markers	Description
`_type`	String	-	Type discriminator
`value`	DtoFloat	-	-

DtoBooleanColumnValue

Type: Object
Super-Types: DtoAbstractColumnValue
Discriminator: _type
Discriminator-Value: Boolean

Property	Type	Markers	Description
`_type`	String	-	Type discriminator
`value`	Boolean	-	-

DtoSymmetricMatrix

Type: Object

Property	Type	Markers	Description
`rows`	DtoPositiveInteger	-	-
`entries`	DtoFloat[]	-	-

DtoSymmetricBlockDiagonalMatrix

Type: Object

Property	Type	Markers	Description
`entries`	DtoSymmetricMatrix[]	-	-

DtoTime

Type: Number
Restrictions: int64, >= 0.0

DtoSegmentId

Type: Number
Restrictions: int64

DtoSignalId

Type: String
Restrictions: size >= 1

DtoModelId

Type: String
Restrictions: size >= 1

DtoColumnId

Type: String
Restrictions: size >= 1

DtoClusterId

Type: Number
Restrictions: int32, >= 0.0

DtoControlPointId

Type: Number
Restrictions: int32, >= 0.0

DtoExpression

Type: String
Restrictions: size >= 1

DtoPositiveDuration

Type: Number
Restrictions: int64, >= 1.0

DtoNonNegativeDuration

Type: Number
Restrictions: int64, >= 0.0

DtoPositiveInteger

Type: Number
Restrictions: int32, >= 1.0

DtoNonNegativeInteger

Type: Number
Restrictions: int32, >= 0.0

DtoFloat

Type: Number
Restrictions: double

DtoNonNegativeFloat

Type: Number
Restrictions: double, >= 0.0

DtoPositiveFloat

Type: Number
Restrictions: double, >= 0.0

DtoFunctionId

Type: Number
Restrictions: int64, >= 0.0

DtoFeatureId

Type: Number
Restrictions: int64, >= 0.0

DtoTreeNodeId

Type: Number
Restrictions: int64, >= 0.0

DtoCorrelation

Type: Number
Restrictions: double, >= 0.0, <= 1.0

DtoPercentage

Type: Number
Restrictions: double, >= 0.0, <= 1.0

DtoUuid

A version 4 Uuid.

Type: String
Restrictions: exp = [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

DtoHubConfig

Necessary input configuration to build a model hub. Right now it is empty and merely a place holder for future developments.

Type: Object

DtoHubModel

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.

DtoModelSpecification

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.

DtoInferenceConfig

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.

DtoFloatNextNormalConfig

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.

DtoAbstractCost

@abstract

Type: Object
Sub-Types: DtoL1DistanceCost, DtoL2DistanceCost, DtoModelCost
Discriminator: _type

Property	Type	Markers	Description
`_type`	String	-	-

DtoL1DistanceCost

L1 distance function.

Type: Object
Super-Types: DtoAbstractCost
Discriminator: _type
Discriminator-Value: L1Distance

Property	Type	Markers	Description
`_type`	String	-	-

DtoL2DistanceCost

L2 distance function, i.e. Euclidean distance.

Type: Object
Super-Types: DtoAbstractCost
Discriminator: _type
Discriminator-Value: L2Distance

Property	Type	Markers	Description
`_type`	String	-	-

DtoModelCost

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.

DtoOptimizationInterest

Specification if one wants to minimize or maximize the cost given by the model.

Type: String
Enum: MIN, MAX

DtoModelConstraint

Type: Object

Property	Type	Markers	Description
`model`	DtoModelId	-	ID of the model.
`condition`	DtoAbstractCondition	-	Condition imposed on the model.

DtoSignalConstraint

Type: Object

Property	Type	Markers	Description
`signal`	DtoSignalId	-	ID of the signal.
`condition`	DtoAbstractCondition	-	Condition imposed on the signal.

DtoAbstractCondition

@abstract

Type: Object
Sub-Types: DtoStaticNumericalCondition, DtoDynamicNumericalCondition
Discriminator: _type

Property	Type	Markers	Description
`_type`	String	-	-

DtoStaticNumericalCondition

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.

DtoDynamicNumericalCondition

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.

DtoHubReport

Information from model hub creation relevant for report generation.

Type: Object

Property	Type	Markers	Description
`targetAspects`	DtoAbstractTargetAspectReport[]	-	-

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.

DtoNumericalTargetAspectReport

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.

DtoSignalReport

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.

DtoAbstractSignalAspectReport

@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.

DtoNumericalSignalAspectReport

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.

DtoCategoricalSignalAspectReport

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	-	-

DtoOscillatoryPowerSignalAspectReport

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.

DtoOscillatoryPhaseSignalAspectReport

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.

DtoCyclicSignalAspectReport

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.

DtoAbstractFeatureReport

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.

DtoLagFeatureReport

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.

DtoLtiFilterFeatureReport

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.

DtoAggregatedNumericalFeatureReport

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.

DtoAggregatedCategoricalFeatureReport

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.

Sub-modules

aivis_engine_v2_cn_sdk_python.data
aivis_engine_v2_cn_sdk_python.hub
aivis_engine_v2_cn_sdk_python.inference
aivis_engine_v2_cn_sdk_python.model_context
aivis_engine_v2_cn_sdk_python.setup