@smartspectra/node-sdk 3.4.0-rc.2 → 3.4.0-rc.4

package/js/messages/generated.d.ts

@@ -936,13 +936,27 @@ export namespace presage {
         /** Properties of a Breathing. */
         interface IBreathing {
 
-            /** Respiratory rate measurements with confidence scores */
+            /**
+             * Respiratory rate measurements with confidence scores. `stable` marks
+             * confidence at or above the minimum accepted accuracy standard for breathing
+             * rate (+/-1 br/min), which corresponds to confidence >= 45; see the
+             * [breathing model card](https://vandv.presagetech.com/breathing_model_card.html)
+             * for the confidence-to-error mapping.
+             */
             rate?: (presage.smartspectra.IMeasurementWithConfidence[]|null);
 
-            /** Chest breathing movement trace measurements */
+            /**
+             * Chest breathing movement trace measurements. The trace has no confidence of
+             * its own; `stable` is inherited from the breathing rate verdict (>= 45); see
+             * the [breathing model card](https://vandv.presagetech.com/breathing_model_card.html).
+             */
             upperTrace?: (presage.smartspectra.IMeasurement[]|null);
 
-            /** Abdominal breathing movement trace measurements */
+            /**
+             * Abdominal breathing movement trace measurements. The trace has no confidence
+             * of its own; `stable` is inherited from the breathing rate verdict (>= 45); see
+             * the [breathing model card](https://vandv.presagetech.com/breathing_model_card.html).
+             */
             lowerTrace?: (presage.smartspectra.IMeasurement[]|null);
 
             /** Breathing amplitude measurements */
@@ -979,13 +993,27 @@ export namespace presage {
              */
             constructor(properties?: presage.smartspectra.IBreathing);
 
-            /** Respiratory rate measurements with confidence scores */
+            /**
+             * Respiratory rate measurements with confidence scores. `stable` marks
+             * confidence at or above the minimum accepted accuracy standard for breathing
+             * rate (+/-1 br/min), which corresponds to confidence >= 45; see the
+             * [breathing model card](https://vandv.presagetech.com/breathing_model_card.html)
+             * for the confidence-to-error mapping.
+             */
             public rate: presage.smartspectra.IMeasurementWithConfidence[];
 
-            /** Chest breathing movement trace measurements */
+            /**
+             * Chest breathing movement trace measurements. The trace has no confidence of
+             * its own; `stable` is inherited from the breathing rate verdict (>= 45); see
+             * the [breathing model card](https://vandv.presagetech.com/breathing_model_card.html).
+             */
             public upperTrace: presage.smartspectra.IMeasurement[];
 
-            /** Abdominal breathing movement trace measurements */
+            /**
+             * Abdominal breathing movement trace measurements. The trace has no confidence
+             * of its own; `stable` is inherited from the breathing rate verdict (>= 45); see
+             * the [breathing model card](https://vandv.presagetech.com/breathing_model_card.html).
+             */
             public lowerTrace: presage.smartspectra.IMeasurement[];
 
             /** Breathing amplitude measurements */
@@ -1432,12 +1460,12 @@ export namespace presage {
         /** Properties of an Eda. */
         interface IEda {
 
-            /** EDA trace measurements over time */
+            /** EDA Proxy trace measurements over time */
             trace?: (presage.smartspectra.IMeasurement[]|null);
         }
 
         /**
-         * Electrodermal Activity (EDA) measurements.
+         * EDA Proxy (electrodermal activity) measurements.
          * Tracks skin conductance changes related to autonomic nervous system activity.
          */
         class Eda implements IEda {
@@ -1448,7 +1476,7 @@ export namespace presage {
              */
             constructor(properties?: presage.smartspectra.IEda);
 
-            /** EDA trace measurements over time */
+            /** EDA Proxy trace measurements over time */
             public trace: presage.smartspectra.IMeasurement[];
 
             /**
@@ -1532,13 +1560,31 @@ export namespace presage {
         /** Properties of a Cardio. */
         interface ICardio {
 
-            /** Heart rate measurements with confidence scores */
+            /**
+             * Heart rate measurements with confidence scores. `stable` marks confidence
+             * at or above the minimum accepted accuracy standard for heart rate
+             * (+/-3 bpm), which corresponds to confidence >= 40; see the
+             * [arterial pressure model card](https://vandv.presagetech.com/arterial_pressure_model_card.html)
+             * for the confidence-to-error mapping. Heart rate is derived from the same signal.
+             */
             pulseRate?: (presage.smartspectra.IMeasurementWithConfidence[]|null);
 
-            /** Arterial pressure trace (uncalibrated, unitless) measurements with confidence scores */
+            /**
+             * Arterial pressure trace (uncalibrated, unitless) measurements with confidence
+             * scores. `stable` uses the same threshold as heart rate -- the minimum accepted
+             * accuracy standard (+/-3 bpm), confidence >= 40 -- since both derive from the
+             * arterial pressure signal; see the
+             * [arterial pressure model card](https://vandv.presagetech.com/arterial_pressure_model_card.html).
+             */
             arterialPressureTrace?: (presage.smartspectra.IMeasurementWithConfidence[]|null);
 
-            /** Heart rate variability measurements with confidence scores */
+            /**
+             * Heart rate variability measurements with confidence scores. `stable` marks
+             * confidence at or above the minimum accepted accuracy standard for HRV
+             * (+/-5 ms), which corresponds to confidence >= 50; see the
+             * [HRV model card](https://vandv.presagetech.com/hrv_model_card.html)
+             * for the confidence-to-error mapping.
+             */
             hrv?: (presage.smartspectra.IHrv[]|null);
         }
 
@@ -1551,13 +1597,31 @@ export namespace presage {
              */
             constructor(properties?: presage.smartspectra.ICardio);
 
-            /** Heart rate measurements with confidence scores */
+            /**
+             * Heart rate measurements with confidence scores. `stable` marks confidence
+             * at or above the minimum accepted accuracy standard for heart rate
+             * (+/-3 bpm), which corresponds to confidence >= 40; see the
+             * [arterial pressure model card](https://vandv.presagetech.com/arterial_pressure_model_card.html)
+             * for the confidence-to-error mapping. Heart rate is derived from the same signal.
+             */
             public pulseRate: presage.smartspectra.IMeasurementWithConfidence[];
 
-            /** Arterial pressure trace (uncalibrated, unitless) measurements with confidence scores */
+            /**
+             * Arterial pressure trace (uncalibrated, unitless) measurements with confidence
+             * scores. `stable` uses the same threshold as heart rate -- the minimum accepted
+             * accuracy standard (+/-3 bpm), confidence >= 40 -- since both derive from the
+             * arterial pressure signal; see the
+             * [arterial pressure model card](https://vandv.presagetech.com/arterial_pressure_model_card.html).
+             */
             public arterialPressureTrace: presage.smartspectra.IMeasurementWithConfidence[];
 
-            /** Heart rate variability measurements with confidence scores */
+            /**
+             * Heart rate variability measurements with confidence scores. `stable` marks
+             * confidence at or above the minimum accepted accuracy standard for HRV
+             * (+/-5 ms), which corresponds to confidence >= 50; see the
+             * [HRV model card](https://vandv.presagetech.com/hrv_model_card.html)
+             * for the confidence-to-error mapping.
+             */
             public hrv: presage.smartspectra.IHrv[];
 
             /**
@@ -1647,7 +1711,7 @@ export namespace presage {
             /** Micro-motion analysis results */
             micromotion?: (presage.smartspectra.IMicroMotion|null);
 
-            /** Electrodermal activity measurements. Note: processing needs to run for over 35 seconds to generate the first EDA result. */
+            /** EDA Proxy (electrodermal activity) measurements. Note: processing needs to run for over 35 seconds to generate the first EDA Proxy result. */
             eda?: (presage.smartspectra.IEda|null);
 
             /** Facial analysis results */
@@ -1675,7 +1739,7 @@ export namespace presage {
             /** Micro-motion analysis results */
             public micromotion?: (presage.smartspectra.IMicroMotion|null);
 
-            /** Electrodermal activity measurements. Note: processing needs to run for over 35 seconds to generate the first EDA result. */
+            /** EDA Proxy (electrodermal activity) measurements. Note: processing needs to run for over 35 seconds to generate the first EDA Proxy result. */
             public eda?: (presage.smartspectra.IEda|null);
 
             /** Facial analysis results */