@fdy/faraday-js - npm Package Compare versions

Comparing version 0.1.177 to 0.1.178

CHANGELOG.md

@@ -13,2 +13,8 @@ # Changelog
 
+## [0.10.20] - 2024-06-25
+
+### Added
+
+- `GET /recommenders/{recommender_id}/analysis` to return model performance, feature importance, and more.
+
 ## [0.10.19] - 2024-06-24
@@ -15,0 +21,0 @@

dist/apis/RecommendersApi.d.ts

@@ -13,3 +13,3 @@ /**
 import * as runtime from '../runtime';
-import { Recommender, RecommenderMergePatch, RecommenderPost } from '../models';
+import { Recommender, RecommenderAnalysis, RecommenderMergePatch, RecommenderPost } from '../models';
 export interface CreateRecommenderRequest {
@@ -24,2 +24,5 @@ recommenderFields: RecommenderPost;
 }
+export interface GetRecommenderAnalysisRequest {
+    recommenderId: string;
+}
 export interface UpdateRecommenderRequest {
@@ -62,2 +65,12 @@ recommenderId: string;
     /**
+     * Get details on a specific recommender\'s analysis report on model performance, bias, etc.
+     * Retrieve a recommenders\'s analysis
+     */
+    private getRecommenderAnalysisRaw;
+    /**
+     * Get details on a specific recommender\'s analysis report on model performance, bias, etc.
+     * Retrieve a recommenders\'s analysis
+     */
+    getRecommenderAnalysis(recommenderId: string): Promise<RecommenderAnalysis>;
+    /**
      * Get a list of recommenders defined on the account
@@ -64,0 +77,0 @@ * List recommenders

dist/apis/RecommendersApi.js

@@ -143,2 +143,39 @@ "use strict";
     /**
+     * Get details on a specific recommender\'s analysis report on model performance, bias, etc.
+     * Retrieve a recommenders\'s analysis
+     */
+    getRecommenderAnalysisRaw(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.recommenderId === null || requestParameters.recommenderId === undefined) {
+                throw new runtime.RequiredError('recommenderId', 'Required parameter requestParameters.recommenderId was null or undefined when calling getRecommenderAnalysis.');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearer", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/recommenders/{recommender_id}/analysis`.replace(`{${"recommender_id"}}`, encodeURIComponent(String(requestParameters.recommenderId))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            });
+            return new runtime.JSONApiResponse(response, (jsonValue) => models_1.RecommenderAnalysisFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Get details on a specific recommender\'s analysis report on model performance, bias, etc.
+     * Retrieve a recommenders\'s analysis
+     */
+    getRecommenderAnalysis(recommenderId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getRecommenderAnalysisRaw({ recommenderId: recommenderId });
+            return yield response.value();
+        });
+    }
+    /**
      * Get a list of recommenders defined on the account
@@ -145,0 +182,0 @@ * List recommenders

dist/models/index.d.ts

@@ -15,2 +15,8 @@ export * from './Account';
 export * from './AnalysisDimensionsTraitBinText';
+export * from './AnalysisFeatureDirectionality';
+export * from './AnalysisFeatureDirectionalityBoolean';
+export * from './AnalysisFeatureDirectionalityDate';
+export * from './AnalysisFeatureDirectionalityNumber';
+export * from './AnalysisFeatureDirectionalityText';
+export * from './AnalysisRocCurvePoint';
 export * from './Cohort';
@@ -367,7 +373,2 @@ export * from './CohortAnalysisMembership';
 export * from './OutcomeAnalysisFeature';
-export * from './OutcomeAnalysisFeatureDirectionality';
-export * from './OutcomeAnalysisFeatureDirectionalityBoolean';
-export * from './OutcomeAnalysisFeatureDirectionalityDate';
-export * from './OutcomeAnalysisFeatureDirectionalityNumber';
-export * from './OutcomeAnalysisFeatureDirectionalityText';
 export * from './OutcomeAnalysisOverallFeatures';
@@ -383,3 +384,2 @@ export * from './OutcomeAnalysisOverallPerformance';
 export * from './OutcomePerformanceModel';
-export * from './OutcomePerformanceRocCurvePoint';
 export * from './OutcomePost';
@@ -428,3 +428,12 @@ export * from './OutcomePredictors';
 export * from './Recommender';
+export * from './RecommenderAnalysis';
+export * from './RecommenderAnalysisAccuracyThreshold';
+export * from './RecommenderAnalysisOverallFeatures';
+export * from './RecommenderAnalysisPerformance';
+export * from './RecommenderAnalysisPerformanceMetaModel';
+export * from './RecommenderAnalysisPropertyDistribution';
+export * from './RecommenderAnalysisRocCurvePoint';
+export * from './RecommenderFeatureData';
 export * from './RecommenderMergePatch';
+export * from './RecommenderPerformanceModel';
 export * from './RecommenderPost';
@@ -431,0 +440,0 @@ export * from './RecommenderPut';

dist/models/index.js

@@ -29,2 +29,8 @@ "use strict";
 __exportStar(require("./AnalysisDimensionsTraitBinText"), exports);
+__exportStar(require("./AnalysisFeatureDirectionality"), exports);
+__exportStar(require("./AnalysisFeatureDirectionalityBoolean"), exports);
+__exportStar(require("./AnalysisFeatureDirectionalityDate"), exports);
+__exportStar(require("./AnalysisFeatureDirectionalityNumber"), exports);
+__exportStar(require("./AnalysisFeatureDirectionalityText"), exports);
+__exportStar(require("./AnalysisRocCurvePoint"), exports);
 __exportStar(require("./Cohort"), exports);
@@ -381,7 +387,2 @@ __exportStar(require("./CohortAnalysisMembership"), exports);
 __exportStar(require("./OutcomeAnalysisFeature"), exports);
-__exportStar(require("./OutcomeAnalysisFeatureDirectionality"), exports);
-__exportStar(require("./OutcomeAnalysisFeatureDirectionalityBoolean"), exports);
-__exportStar(require("./OutcomeAnalysisFeatureDirectionalityDate"), exports);
-__exportStar(require("./OutcomeAnalysisFeatureDirectionalityNumber"), exports);
-__exportStar(require("./OutcomeAnalysisFeatureDirectionalityText"), exports);
 __exportStar(require("./OutcomeAnalysisOverallFeatures"), exports);
@@ -397,3 +398,2 @@ __exportStar(require("./OutcomeAnalysisOverallPerformance"), exports);
 __exportStar(require("./OutcomePerformanceModel"), exports);
-__exportStar(require("./OutcomePerformanceRocCurvePoint"), exports);
 __exportStar(require("./OutcomePost"), exports);
@@ -442,3 +442,12 @@ __exportStar(require("./OutcomePredictors"), exports);
 __exportStar(require("./Recommender"), exports);
+__exportStar(require("./RecommenderAnalysis"), exports);
+__exportStar(require("./RecommenderAnalysisAccuracyThreshold"), exports);
+__exportStar(require("./RecommenderAnalysisOverallFeatures"), exports);
+__exportStar(require("./RecommenderAnalysisPerformance"), exports);
+__exportStar(require("./RecommenderAnalysisPerformanceMetaModel"), exports);
+__exportStar(require("./RecommenderAnalysisPropertyDistribution"), exports);
+__exportStar(require("./RecommenderAnalysisRocCurvePoint"), exports);
+__exportStar(require("./RecommenderFeatureData"), exports);
 __exportStar(require("./RecommenderMergePatch"), exports);
+__exportStar(require("./RecommenderPerformanceModel"), exports);
 __exportStar(require("./RecommenderPost"), exports);
@@ -445,0 +454,0 @@ __exportStar(require("./RecommenderPut"), exports);

dist/models/OutcomeAnalysisFeature.d.ts

@@ -12,3 +12,3 @@ /**
  */
-import { OutcomeAnalysisFeatureDirectionality } from './OutcomeAnalysisFeatureDirectionality';
+import { AnalysisFeatureDirectionality } from './AnalysisFeatureDirectionality';
 /**
@@ -22,6 +22,6 @@ * Importance and directionality of a given feature in an outcome.
      *
-     * @type {Array<OutcomeAnalysisFeatureDirectionality>}
+     * @type {Array<AnalysisFeatureDirectionality>}
      * @memberof OutcomeAnalysisFeature
      */
-    directionality: Array<OutcomeAnalysisFeatureDirectionality>;
+    directionality: Array<AnalysisFeatureDirectionality>;
     /**
@@ -28,0 +28,0 @@ * The importance of the feature

dist/models/OutcomeAnalysisFeature.js

@@ -17,3 +17,3 @@ "use strict";
 exports.OutcomeAnalysisFeatureToJSON = exports.OutcomeAnalysisFeatureFromJSONTyped = exports.OutcomeAnalysisFeatureFromJSON = void 0;
-const OutcomeAnalysisFeatureDirectionality_1 = require("./OutcomeAnalysisFeatureDirectionality");
+const AnalysisFeatureDirectionality_1 = require("./AnalysisFeatureDirectionality");
 function OutcomeAnalysisFeatureFromJSON(json) {
@@ -28,3 +28,3 @@ return OutcomeAnalysisFeatureFromJSONTyped(json, false);
     return {
-        'directionality': (json['directionality'].map(OutcomeAnalysisFeatureDirectionality_1.OutcomeAnalysisFeatureDirectionalityFromJSON)),
+        'directionality': (json['directionality'].map(AnalysisFeatureDirectionality_1.AnalysisFeatureDirectionalityFromJSON)),
         'importance': json['importance'],
@@ -44,3 +44,3 @@ 'literate': json['literate'],
     return {
-        'directionality': (value.directionality.map(OutcomeAnalysisFeatureDirectionality_1.OutcomeAnalysisFeatureDirectionalityToJSON)),
+        'directionality': (value.directionality.map(AnalysisFeatureDirectionality_1.AnalysisFeatureDirectionalityToJSON)),
         'importance': value.importance,
@@ -47,0 +47,0 @@ 'literate': value.literate,

dist/models/OutcomePerformanceModel.d.ts

@@ -12,4 +12,4 @@ /**
  */
+import { AnalysisRocCurvePoint } from './AnalysisRocCurvePoint';
 import { OutcomePerformanceLiftCurvePoint } from './OutcomePerformanceLiftCurvePoint';
-import { OutcomePerformanceRocCurvePoint } from './OutcomePerformanceRocCurvePoint';
 import { TabularData } from './TabularData';
@@ -54,6 +54,6 @@ /**
      *
-     * @type {Array<OutcomePerformanceRocCurvePoint>}
+     * @type {Array<AnalysisRocCurvePoint>}
      * @memberof OutcomePerformanceModel
      */
-    roc_curve: Array<OutcomePerformanceRocCurvePoint>;
+    roc_curve: Array<AnalysisRocCurvePoint>;
     /**
@@ -60,0 +60,0 @@ * When the tenure range ends measured in days. The value can be null if no tenure range applies to this model. The value can also be null if the range is unbounded.

dist/models/OutcomePerformanceModel.js

@@ -18,4 +18,4 @@ "use strict";
 const runtime_1 = require("../runtime");
+const AnalysisRocCurvePoint_1 = require("./AnalysisRocCurvePoint");
 const OutcomePerformanceLiftCurvePoint_1 = require("./OutcomePerformanceLiftCurvePoint");
-const OutcomePerformanceRocCurvePoint_1 = require("./OutcomePerformanceRocCurvePoint");
 const TabularData_1 = require("./TabularData");
@@ -36,3 +36,3 @@ function OutcomePerformanceModelFromJSON(json) {
         'roc_auc': json['roc_auc'],
-        'roc_curve': (json['roc_curve'].map(OutcomePerformanceRocCurvePoint_1.OutcomePerformanceRocCurvePointFromJSON)),
+        'roc_curve': (json['roc_curve'].map(AnalysisRocCurvePoint_1.AnalysisRocCurvePointFromJSON)),
         'tenure_end': !runtime_1.exists(json, 'tenure_end') ? undefined : json['tenure_end'],
@@ -56,3 +56,3 @@ 'tenure_start': !runtime_1.exists(json, 'tenure_start') ? undefined : json['tenure_start'],
         'roc_auc': value.roc_auc,
-        'roc_curve': (value.roc_curve.map(OutcomePerformanceRocCurvePoint_1.OutcomePerformanceRocCurvePointToJSON)),
+        'roc_curve': (value.roc_curve.map(AnalysisRocCurvePoint_1.AnalysisRocCurvePointToJSON)),
         'tenure_end': value.tenure_end,
@@ -59,0 +59,0 @@ 'tenure_start': value.tenure_start,

package.json

 {
   "name": "@fdy/faraday-js",
-  "version": "0.1.177",
+  "version": "0.1.178",
   "description": "OpenAPI client for @fdy/faraday-js",
@@ -5,0 +5,0 @@ "author": "@hana.kslr",

src/apis/RecommendersApi.ts

@@ -21,2 +21,5 @@ /* tslint:disable */
     RecommenderToJSON,
+    RecommenderAnalysis,
+    RecommenderAnalysisFromJSON,
+    RecommenderAnalysisToJSON,
     RecommenderMergePatch,
@@ -42,2 +45,6 @@ RecommenderMergePatchFromJSON,
 
+export interface GetRecommenderAnalysisRequest {
+    recommenderId: string;
+}
+
 export interface UpdateRecommenderRequest {
@@ -174,2 +181,42 @@ recommenderId: string;
     /**
+     * Get details on a specific recommender\'s analysis report on model performance, bias, etc.
+     * Retrieve a recommenders\'s analysis
+     */
+    private async getRecommenderAnalysisRaw(requestParameters: GetRecommenderAnalysisRequest, ): Promise<runtime.ApiResponse<RecommenderAnalysis>> {
+        if (requestParameters.recommenderId === null || requestParameters.recommenderId === undefined) {
+            throw new runtime.RequiredError('recommenderId','Required parameter requestParameters.recommenderId was null or undefined when calling getRecommenderAnalysis.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/recommenders/{recommender_id}/analysis`.replace(`{${"recommender_id"}}`, encodeURIComponent(String(requestParameters.recommenderId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        });
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RecommenderAnalysisFromJSON(jsonValue));
+    }
+
+    /**
+     * Get details on a specific recommender\'s analysis report on model performance, bias, etc.
+     * Retrieve a recommenders\'s analysis
+     */
+    async getRecommenderAnalysis(recommenderId: string, ): Promise<RecommenderAnalysis> {
+        const response = await this.getRecommenderAnalysisRaw({ recommenderId: recommenderId }, );
+        return await response.value();
+    }
+
+    /**
      * Get a list of recommenders defined on the account
@@ -176,0 +223,0 @@ * List recommenders

src/models/index.ts

@@ -17,2 +17,8 @@ /* tslint:disable */
 export * from './AnalysisDimensionsTraitBinText';
+export * from './AnalysisFeatureDirectionality';
+export * from './AnalysisFeatureDirectionalityBoolean';
+export * from './AnalysisFeatureDirectionalityDate';
+export * from './AnalysisFeatureDirectionalityNumber';
+export * from './AnalysisFeatureDirectionalityText';
+export * from './AnalysisRocCurvePoint';
 export * from './Cohort';
@@ -369,7 +375,2 @@ export * from './CohortAnalysisMembership';
 export * from './OutcomeAnalysisFeature';
-export * from './OutcomeAnalysisFeatureDirectionality';
-export * from './OutcomeAnalysisFeatureDirectionalityBoolean';
-export * from './OutcomeAnalysisFeatureDirectionalityDate';
-export * from './OutcomeAnalysisFeatureDirectionalityNumber';
-export * from './OutcomeAnalysisFeatureDirectionalityText';
 export * from './OutcomeAnalysisOverallFeatures';
@@ -385,3 +386,2 @@ export * from './OutcomeAnalysisOverallPerformance';
 export * from './OutcomePerformanceModel';
-export * from './OutcomePerformanceRocCurvePoint';
 export * from './OutcomePost';
@@ -430,3 +430,12 @@ export * from './OutcomePredictors';
 export * from './Recommender';
+export * from './RecommenderAnalysis';
+export * from './RecommenderAnalysisAccuracyThreshold';
+export * from './RecommenderAnalysisOverallFeatures';
+export * from './RecommenderAnalysisPerformance';
+export * from './RecommenderAnalysisPerformanceMetaModel';
+export * from './RecommenderAnalysisPropertyDistribution';
+export * from './RecommenderAnalysisRocCurvePoint';
+export * from './RecommenderFeatureData';
 export * from './RecommenderMergePatch';
+export * from './RecommenderPerformanceModel';
 export * from './RecommenderPost';
@@ -433,0 +442,0 @@ export * from './RecommenderPut';

src/models/OutcomeAnalysisFeature.ts

@@ -17,7 +17,7 @@ /* tslint:disable */
 import {
-    OutcomeAnalysisFeatureDirectionality,
-    OutcomeAnalysisFeatureDirectionalityFromJSON,
-    OutcomeAnalysisFeatureDirectionalityFromJSONTyped,
-    OutcomeAnalysisFeatureDirectionalityToJSON,
-} from './OutcomeAnalysisFeatureDirectionality';
+    AnalysisFeatureDirectionality,
+    AnalysisFeatureDirectionalityFromJSON,
+    AnalysisFeatureDirectionalityFromJSONTyped,
+    AnalysisFeatureDirectionalityToJSON,
+} from './AnalysisFeatureDirectionality';
 
@@ -32,6 +32,6 @@ /**
      * 
-     * @type {Array<OutcomeAnalysisFeatureDirectionality>}
+     * @type {Array<AnalysisFeatureDirectionality>}
      * @memberof OutcomeAnalysisFeature
      */
-    directionality: Array<OutcomeAnalysisFeatureDirectionality>;
+    directionality: Array<AnalysisFeatureDirectionality>;
     /**
@@ -67,3 +67,3 @@ * The importance of the feature
         
-        'directionality': ((json['directionality'] as Array<any>).map(OutcomeAnalysisFeatureDirectionalityFromJSON)),
+        'directionality': ((json['directionality'] as Array<any>).map(AnalysisFeatureDirectionalityFromJSON)),
         'importance': json['importance'],
@@ -84,3 +84,3 @@ 'literate': json['literate'],
         
-        'directionality': ((value.directionality as Array<any>).map(OutcomeAnalysisFeatureDirectionalityToJSON)),
+        'directionality': ((value.directionality as Array<any>).map(AnalysisFeatureDirectionalityToJSON)),
         'importance': value.importance,
@@ -87,0 +87,0 @@ 'literate': value.literate,

src/models/OutcomePerformanceModel.ts

@@ -17,2 +17,8 @@ /* tslint:disable */
 import {
+    AnalysisRocCurvePoint,
+    AnalysisRocCurvePointFromJSON,
+    AnalysisRocCurvePointFromJSONTyped,
+    AnalysisRocCurvePointToJSON,
+} from './AnalysisRocCurvePoint';
+import {
     OutcomePerformanceLiftCurvePoint,
@@ -24,8 +30,2 @@ OutcomePerformanceLiftCurvePointFromJSON,
 import {
-    OutcomePerformanceRocCurvePoint,
-    OutcomePerformanceRocCurvePointFromJSON,
-    OutcomePerformanceRocCurvePointFromJSONTyped,
-    OutcomePerformanceRocCurvePointToJSON,
-} from './OutcomePerformanceRocCurvePoint';
-import {
     TabularData,
@@ -75,6 +75,6 @@ TabularDataFromJSON,
      * 
-     * @type {Array<OutcomePerformanceRocCurvePoint>}
+     * @type {Array<AnalysisRocCurvePoint>}
      * @memberof OutcomePerformanceModel
      */
-    roc_curve: Array<OutcomePerformanceRocCurvePoint>;
+    roc_curve: Array<AnalysisRocCurvePoint>;
     /**
@@ -109,3 +109,3 @@ * When the tenure range ends measured in days. The value can be null if no tenure range applies to this model. The value can also be null if the range is unbounded.
         'roc_auc': json['roc_auc'],
-        'roc_curve': ((json['roc_curve'] as Array<any>).map(OutcomePerformanceRocCurvePointFromJSON)),
+        'roc_curve': ((json['roc_curve'] as Array<any>).map(AnalysisRocCurvePointFromJSON)),
         'tenure_end': !exists(json, 'tenure_end') ? undefined : json['tenure_end'],
@@ -130,3 +130,3 @@ 'tenure_start': !exists(json, 'tenure_start') ? undefined : json['tenure_start'],
         'roc_auc': value.roc_auc,
-        'roc_curve': ((value.roc_curve as Array<any>).map(OutcomePerformanceRocCurvePointToJSON)),
+        'roc_curve': ((value.roc_curve as Array<any>).map(AnalysisRocCurvePointToJSON)),
         'tenure_end': value.tenure_end,
@@ -133,0 +133,0 @@ 'tenure_start': value.tenure_start,

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5119911

increased by1.98%

Number of package files

2114

increased by2.17%

Lines of code

133600

increased by1.99%

No dependency changes