re-gen

src/types/schemas/CaseMaps.ts → src/types/schemas/Case.ts

@@ -2,10 +2,10 @@
  * 🛑 WARNING: DO NOT EDIT! 🛑
  * This file is auto generated and should not be modified directly.
  *
- * CaseMaps
+ * Case
  */
 
 /**
  * A list of maps representing the cases that influenced a react.
  */
-export type CaseMaps = Record<string, any>[];
+export type Case = Record<string, any>[];

src/types/schemas/ConfusionMatrixMap.ts → src/types/schemas/ConfusionMatrix.ts

@@ -2,13 +2,13 @@
  * 🛑 WARNING: DO NOT EDIT! 🛑
  * This file is auto generated and should not be modified directly.
  *
- * ConfusionMatrixMap
+ * ConfusionMatrix
  */
 
 /**
  * The confusion matrix in the form of maps from actual classes to maps of predicted classes to frequencies alongside counts for insignficant predictions.
  */
-export type ConfusionMatrixMap = {
+export type ConfusionMatrix = {
   /**
    * Total number of correct predictions for classes that were not statistically significant.
    */

src/types/schemas/DerivationParameters.ts

@@ -4,7 +4,7 @@
  *
  * DerivationParameters
  */
-import type { FeatureValueMap } from "./FeatureValueMap";
+import type { FeatureMetricIndex } from "./FeatureMetricIndex";
 
 /**
  * A map containing the parameters used in the derivation of a reaction.
@@ -21,15 +21,15 @@ export type DerivationParameters = {
   /**
    * A map of feature names to feature weights.
    */
-  feature_weights?: FeatureValueMap;
+  feature_weights?: FeatureMetricIndex;
   /**
    * The number of most similar cases used to make the prediction.
    */
   k?: number;
   /**
    * A map of nominal feature names to the number of unique classes for each feature.
    */
-  nominal_class_counts?: FeatureValueMap;
+  nominal_class_counts?: FeatureMetricIndex;
   /**
    * The parameter of the Lebesgue space used in the Minkowski distance.
    */

src/types/schemas/FeatureAttributes.ts

@@ -4,7 +4,7 @@
  *
  * FeatureAttributes
  */
-import type { FeatureBoundsMap } from "./FeatureBoundsMap";
+import type { FeatureBounds } from "./FeatureBounds";
 import type { FeatureDataType } from "./FeatureDataType";
 import type { FeatureType } from "./FeatureType";
 
@@ -33,7 +33,7 @@ export type FeatureAttributes = {
      */
     series_id_features?: string[];
   };
-  bounds?: FeatureBoundsMap;
+  bounds?: FeatureBounds;
   /**
    * Cyclic features are set by specifying a `cycle_length` value in the feature attributes. `cycle_length` requires a single value, which is the upper bound of the difference for the cycle range. For example, if `cycle_length` is 360,  then a value of 1 and 359 will have a difference of 2. Cyclic features have no restrictions in the input dataset, however, cyclic features will be output on a scale from 0 to `cycle_length`. To constrain the output to a different range, modify the `min` and `max` `bounds` feature attribute.
    *

src/types/schemas/FeatureBoundsMap.ts → src/types/schemas/FeatureBounds.ts

@@ -2,13 +2,13 @@
  * 🛑 WARNING: DO NOT EDIT! 🛑
  * This file is auto generated and should not be modified directly.
  *
- * FeatureBoundsMap
+ * FeatureBounds
  */
 
 /**
  * A map defining any feature bounds, allowed values, and constraints.
  */
-export type FeatureBoundsMap = {
+export type FeatureBounds = {
   /**
    * Explicitly allowed values to be output.
    */

src/types/schemas/FeatureDataType.ts

@@ -6,7 +6,7 @@
  */
 
 /**
- * Specify the data type for features with a type of nominal or continuous. Default is `string` for nominals and `number` for continuous.
+ * The data type of a feature. Default is `string` for nominals and `number` for continuous.
  *
  * Valid values include:
  * - `string`, `number`, `formatted_date_time`, `json`, `amalgam`, `yaml`: Valid for both nominal and continuous.

src/types/schemas/FeatureValueMap.ts → src/types/schemas/FeatureMetricIndex.ts

@@ -2,10 +2,10 @@
  * 🛑 WARNING: DO NOT EDIT! 🛑
  * This file is auto generated and should not be modified directly.
  *
- * FeatureValueMap
+ * FeatureMetricIndex
  */
 
 /**
  * Map of feature names to numeric values.
  */
-export type FeatureValueMap = Record<string, number>;
+export type FeatureMetricIndex = Record<string, number>;

src/types/schemas/HyperparameterMap.ts

@@ -21,23 +21,23 @@ export type HyperparameterMap = {
   /**
    * Internal map of features to their deviations. Includes null deviations and sparse deviation matrices.
    */
-  featureDeviations?: Record<string, any>;
+  featureDeviations?: Record<string, any> | null;
   /**
    * Internal map of features to various domain attributes.
    */
-  featureDomainAttributes?: Record<string, any>;
+  featureDomainAttributes?: Record<string, any> | null;
   /**
    * Map of ordinal features to their deviations.
    */
   featureOrdinalDeviations?: Record<string, any>;
   /**
    * Map of features to their computed feature residuals.
    */
-  featureResiduals?: Record<string, any>;
+  featureResiduals?: Record<string, number>;
   /**
    * Map of features to feature weights used in the distance metric.
    */
-  featureWeights?: Record<string, any>;
+  featureWeights?: Record<string, number> | null;
   /**
    * Error computed during the grid search in analysis.
    */
@@ -49,7 +49,7 @@ export type HyperparameterMap = {
   /**
    * Map of features to null uncertainties which describes the distances in the context of missing values.
    */
-  nullUncertainties?: Record<string, any>;
+  nullUncertainties?: Record<string, (number | null)[]>;
   /**
    * The parameter of the Lebesgue space.
    */

src/types/schemas/FullHyperparameterMap.ts → src/types/schemas/HyperparameterMapTree.ts

@@ -2,8 +2,8 @@
  * 🛑 WARNING: DO NOT EDIT! 🛑
  * This file is auto generated and should not be modified directly.
  *
- * FullHyperparameterMap
+ * HyperparameterMapTree
  */
 import type { HyperparameterMap } from "./HyperparameterMap";
 
-export type FullHyperparameterMap = Record<string, Record<string, Record<string, Record<string, HyperparameterMap>>>>;
+export type HyperparameterMapTree = Record<string, Record<string, Record<string, Record<string, HyperparameterMap>>>>;

src/types/schemas/OutlyingFeatureValues.ts → src/types/schemas/OutlyingFeatureValuesIndex.ts

@@ -2,13 +2,13 @@
  * 🛑 WARNING: DO NOT EDIT! 🛑
  * This file is auto generated and should not be modified directly.
  *
- * OutlyingFeatureValues
+ * OutlyingFeatureValuesIndex
  */
 
 /**
  * Map of feature name to map indicating the case value and the maximum or minimum value of the feature observed in the most similar cases.
  */
-export type OutlyingFeatureValues = Record<
+export type OutlyingFeatureValuesIndex = Record<
   string,
   {
     /**

src/types/schemas/React.ts

@@ -8,7 +8,7 @@
  */
 import type { CaseIndices } from "./CaseIndices";
 import type { DesiredConviction } from "./DesiredConviction";
-import type { FeatureBoundsMap } from "./FeatureBoundsMap";
+import type { FeatureBounds } from "./FeatureBounds";
 import type { GenerateNewCases } from "./GenerateNewCases";
 import type { ReactDetails } from "./ReactDetails";
 import type { UseCaseWeights } from "./UseCaseWeights";
@@ -281,7 +281,7 @@ export type ReactRequest = {
    *  Only used when desired_conviction is specified
    * @default {}
    */
-  feature_bounds_map?: Record<string, FeatureBoundsMap>;
+  feature_bounds_map?: Record<string, FeatureBounds>;
 
   /**
    * Enum, acceptable values are:

src/types/schemas/ReactAggregate.ts

@@ -7,7 +7,7 @@
  * Computes, caches, and returns specified details and feature prediction statistics such as Mean Decrease in Accuracy (MDA), residuals (accuracy, Mean Absolute Error),
  *  precision, recall, etc. Returns details and feature prediction stats for all features in the format of feature -> assoc stat -> value
  */
-import type { ConfusionMatrixMap } from "./ConfusionMatrixMap";
+import type { ConfusionMatrix } from "./ConfusionMatrix";
 import type { ReactAggregateDetails } from "./ReactAggregateDetails";
 import type { UseCaseWeights } from "./UseCaseWeights";
 
@@ -201,7 +201,7 @@ export type ReactAggregateResponse = Record<
      * The symmetric mean absolute percentage error with added the min gap / 2 to the actual and predicted values.
      */
     adjusted_smape?: number | null;
-    confusion_matrix?: ConfusionMatrixMap;
+    confusion_matrix?: ConfusionMatrix;
     /**
      * The mean difference of predicting the specified action feature with and without this feature while using the full set of remaining context features.
      */

src/types/schemas/ReactDetails.ts

@@ -16,7 +16,7 @@ export type ReactDetails = {
    */
   boundary_cases_familiarity_convictions?: boolean;
   /**
-   * If true outputs each influential case's differences between the
+   * If true outputs each influential case's differences between the predicted action feature value and the predicted action feature value if each individual case were not included. Uses only the context features of the reacted case to determine that area. Uses full calculations, which uses leave-one-out for cases for computations.
    */
   case_contributions_full?: boolean;
   /**

src/types/schemas/ReactSeries.ts

@@ -10,7 +10,7 @@
  */
 import type { CaseIndices } from "./CaseIndices";
 import type { DesiredConviction } from "./DesiredConviction";
-import type { FeatureBoundsMap } from "./FeatureBoundsMap";
+import type { FeatureBounds } from "./FeatureBounds";
 import type { GenerateNewCases } from "./GenerateNewCases";
 import type { NewCaseThreshold } from "./NewCaseThreshold";
 import type { ReactDetails } from "./ReactDetails";
@@ -113,7 +113,7 @@ export type ReactSeriesRequest = {
    *     allow_null - default is true, if true nulls may be generated per their distribution in the data
    * @default {}
    */
-  feature_bounds_map?: Record<string, FeatureBoundsMap>;
+  feature_bounds_map?: Record<string, FeatureBounds>;
 
   /**
    * Time step values at which to end synthesis for each series, applicable only for time series.