Retrieve a recommenders's analysis

gethttps://api.faraday.ai/v1/recommenders/{recommender_id}/analysis

Get details on a specific recommender's analysis report on model performance, bias, etc.

Authentication

Bearer Authentication

Provide your API key in the Authorization header. You can find your API key in the Settings page of the dashboard.

Authorization: Bearer YOUR_TOKEN

path parameters

recommender_idstring<uuid>required

The UUID of a recommender

Responses

200Information about the recommender analysis

overall_featuresobject

Properties of object

new_and_recognized_individualsarray[object]

Items of array[object]

categorystringrequired

The category of the feature.

directionalityarray[object]required

importancenumberrequired

The importance of the feature

literatestringrequired

The human-readable description of the feature.

namestringrequired

The identifier for the feature.

typestringrequired

The human-readable name of the feature.

new_and_unrecognized_individualsarray[object]

Items of array[object]

categorystringrequired

The category of the feature.

directionalityarray[object]required

importancenumberrequired

The importance of the feature

literatestringrequired

The human-readable description of the feature.

namestringrequired

The identifier for the feature.

typestringrequired

The human-readable name of the feature.

repeat_and_recognized_individualsarray[object]

Items of array[object]

categorystringrequired

The category of the feature.

directionalityarray[object]required

importancenumberrequired

The importance of the feature

literatestringrequired

The human-readable description of the feature.

namestringrequired

The identifier for the feature.

typestringrequired

The human-readable name of the feature.

repeat_and_unrecognized_individualsarray[object]

Items of array[object]

categorystringrequired

The category of the feature.

directionalityarray[object]required

importancenumberrequired

The importance of the feature

literatestringrequired

The human-readable description of the feature.

namestringrequired

The identifier for the feature.

typestringrequired

The human-readable name of the feature.

performanceobject

Properties of object

meta_modelobjectrequired

Properties of object

new_and_recognized_individualsobject

Properties of object

accuracy_per_thresholdarray[object]required

Items of array[object]

accuracynumberrequired

The cumulative accuracy of the model at the given threshold.

Example: 0.35

thresholdnumberrequired

The threshold (i.e. top N recommendations to consider) to evaluate the model's accuracy.

For example, if the threshold is 10, the model's accuracy is calculated by considering the top 10 recommendati...

avg_rank_true_labelnumber

Average rank of the true label in the cross-validation dataset for a given property.

Example: 1.23

property_distributionarray[object]required

Items of array[object]

avg_ranknumberrequired

Average rank of a given property in the cross-validation dataset.

Example: 1.23

avg_rank_true_labelnumber

Average rank of the true label in the cross-validation dataset for a given property.

Example: 1.23

propertystringrequired

Name of a property.

proportionnumberrequired

Fraction of the cross-validation identities assigned a given property as top property.

Example: 0.17

roc_aucnumberrequired

The area under the receiver operating characteristic curve.

Example: 0.75

roc_curvearray[object]required

Items of array[object]

xnumberrequired

A given false positive rate.

Example: 0.5

ynumberrequired

The estimated true positive rate corresponding to x.

Example: 0.75

new_and_unrecognized_individualsobject

Properties of object

accuracy_per_thresholdarray[object]required

Items of array[object]

accuracynumberrequired

The cumulative accuracy of the model at the given threshold.

Example: 0.35

thresholdnumberrequired

The threshold (i.e. top N recommendations to consider) to evaluate the model's accuracy.

For example, if the threshold is 10, the model's accuracy is calculated by considering the top 10 recommendati...

avg_rank_true_labelnumber

Average rank of the true label in the cross-validation dataset for a given property.

Example: 1.23

property_distributionarray[object]required

Items of array[object]

avg_ranknumberrequired

Average rank of a given property in the cross-validation dataset.

Example: 1.23

avg_rank_true_labelnumber

Average rank of the true label in the cross-validation dataset for a given property.

Example: 1.23

propertystringrequired

Name of a property.

proportionnumberrequired

Fraction of the cross-validation identities assigned a given property as top property.

Example: 0.17

roc_aucnumberrequired

The area under the receiver operating characteristic curve.

Example: 0.75

roc_curvearray[object]required

Items of array[object]

xnumberrequired

A given false positive rate.

Example: 0.5

ynumberrequired

The estimated true positive rate corresponding to x.

Example: 0.75

overallobjectrequired

Properties of object

accuracy_per_thresholdarray[object]required

Items of array[object]

accuracynumberrequired

The cumulative accuracy of the model at the given threshold.

Example: 0.35

thresholdnumberrequired

The threshold (i.e. top N recommendations to consider) to evaluate the model's accuracy.

For example, if the threshold is 10, the model's accuracy is calculated by considering the top 10 recommendati...

avg_rank_true_labelnumber

Average rank of the true label in the cross-validation dataset for a given property.

Example: 1.23

property_distributionarray[object]required

Items of array[object]

avg_ranknumberrequired

Average rank of a given property in the cross-validation dataset.

Example: 1.23

avg_rank_true_labelnumber

Average rank of the true label in the cross-validation dataset for a given property.

Example: 1.23

propertystringrequired

Name of a property.

proportionnumberrequired

Fraction of the cross-validation identities assigned a given property as top property.

Example: 0.17

roc_aucnumberrequired

The area under the receiver operating characteristic curve.

Example: 0.75

roc_curvearray[object]required

Items of array[object]

xnumberrequired

A given false positive rate.

Example: 0.5

ynumberrequired

The estimated true positive rate corresponding to x.

Example: 0.75

repeat_and_recognized_individualsobject

Properties of object

accuracy_per_thresholdarray[object]required

Items of array[object]

accuracynumberrequired

The cumulative accuracy of the model at the given threshold.

Example: 0.35

thresholdnumberrequired

The threshold (i.e. top N recommendations to consider) to evaluate the model's accuracy.

For example, if the threshold is 10, the model's accuracy is calculated by considering the top 10 recommendati...

avg_rank_true_labelnumber

Average rank of the true label in the cross-validation dataset for a given property.

Example: 1.23

property_distributionarray[object]required

Items of array[object]

avg_ranknumberrequired

Average rank of a given property in the cross-validation dataset.

Example: 1.23

avg_rank_true_labelnumber

Average rank of the true label in the cross-validation dataset for a given property.

Example: 1.23

propertystringrequired

Name of a property.

proportionnumberrequired

Fraction of the cross-validation identities assigned a given property as top property.

Example: 0.17

roc_aucnumberrequired

The area under the receiver operating characteristic curve.

Example: 0.75

roc_curvearray[object]required

Items of array[object]

xnumberrequired

A given false positive rate.

Example: 0.5

ynumberrequired

The estimated true positive rate corresponding to x.

Example: 0.75

repeat_and_unrecognized_individualsobject

Properties of object

accuracy_per_thresholdarray[object]required

Items of array[object]

accuracynumberrequired

The cumulative accuracy of the model at the given threshold.

Example: 0.35

thresholdnumberrequired

The threshold (i.e. top N recommendations to consider) to evaluate the model's accuracy.

For example, if the threshold is 10, the model's accuracy is calculated by considering the top 10 recommendati...

avg_rank_true_labelnumber

Average rank of the true label in the cross-validation dataset for a given property.

Example: 1.23

property_distributionarray[object]required

Items of array[object]

avg_ranknumberrequired

Average rank of a given property in the cross-validation dataset.

Example: 1.23

avg_rank_true_labelnumber

Average rank of the true label in the cross-validation dataset for a given property.

Example: 1.23

propertystringrequired

Name of a property.

proportionnumberrequired

Fraction of the cross-validation identities assigned a given property as top property.

Example: 0.17

roc_aucnumberrequired

The area under the receiver operating characteristic curve.

Example: 0.75

roc_curvearray[object]required

Items of array[object]

xnumberrequired

A given false positive rate.

Example: 0.5

ynumberrequired

The estimated true positive rate corresponding to x.

Example: 0.75

400The request was invalid.

errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

BAD_REQUEST: The request could not be validated.
FORBIDDEN: You do not have permission to access the specified resour...

Example: "ERROR_TYPE"

Allowed values:

BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT

idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"

notestringrequired

A human-readable description of the error.

Example: "An error occurred"

validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]

contextobjectrequired

More information about the error.

Properties of object

errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

401No API key was supplied.

errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

BAD_REQUEST: The request could not be validated.
FORBIDDEN: You do not have permission to access the specified resour...

Example: "ERROR_TYPE"

Allowed values:

BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT

idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"

notestringrequired

A human-readable description of the error.

Example: "An error occurred"

validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]

contextobjectrequired

More information about the error.

Properties of object

errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

403Access to this resource was forbidden.

errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

BAD_REQUEST: The request could not be validated.
FORBIDDEN: You do not have permission to access the specified resour...

Example: "ERROR_TYPE"

Allowed values:

BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT

idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"

notestringrequired

A human-readable description of the error.

Example: "An error occurred"

validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]

contextobjectrequired

More information about the error.

Properties of object

errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

404The requested resource ID was not found.

errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

BAD_REQUEST: The request could not be validated.
FORBIDDEN: You do not have permission to access the specified resour...

Example: "ERROR_TYPE"

Allowed values:

BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT

idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"

notestringrequired

A human-readable description of the error.

Example: "An error occurred"

validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]

contextobjectrequired

More information about the error.

Properties of object

errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

500An internal server error occurred.

errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

BAD_REQUEST: The request could not be validated.
FORBIDDEN: You do not have permission to access the specified resour...

Example: "ERROR_TYPE"

Allowed values:

BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT

idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"

notestringrequired

A human-readable description of the error.

Example: "An error occurred"

validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]

contextobjectrequired

More information about the error.

Properties of object

errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

Tags

recommenders

Test request

Request snippet

curl -X GET 'https://api.faraday.ai/v1/recommenders/{recommender_id}/analysis' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example response

application/json

{
  "overall_features": {
    "new_and_recognized_individuals": [
      {
        "category": "string",
        "directionality": [
          {
            "data_type": "boolean",
            "density": 0.75,
            "impact": 0,
            "value": true
          }
        ],
        "importance": 0,
        "literate": "string",
        "name": "string",
        "type": "string"
      }
    ],
    "new_and_unrecognized_individuals": [
      {
        "category": "string",
        "directionality": [
          {
            "data_type": "boolean",
            "density": 0.75,
            "impact": 0,
            "value": true
          }
        ],
        "importance": 0,
        "literate": "string",
        "name": "string",
        "type": "string"
      }
    ],
    "repeat_and_recognized_individuals": [
      {
        "category": "string",
        "directionality": [
          {
            "data_type": "boolean",
            "density": 0.75,
            "impact": 0,
            "value": true
          }
        ],
        "importance": 0,
        "literate": "string",
        "name": "string",
        "type": "string"
      }
    ],
    "repeat_and_unrecognized_individuals": [
      {
        "category": "string",
        "directionality": [
          {
            "data_type": "boolean",
            "density": 0.75,
            "impact": 0,
            "value": true
          }
        ],
        "importance": 0,
        "literate": "string",
        "name": "string",
        "type": "string"
      }
    ]
  },
  "performance": {
    "meta_model": {
      "new_and_recognized_individuals": {
        "accuracy_per_threshold": [
          {
            "accuracy": 0.35,
            "threshold": 0
          }
        ],
        "avg_rank_true_label": 1.23,
        "property_distribution": [
          {
            "avg_rank": 1.23,
            "avg_rank_true_label": 1.23,
            "property": "string",
            "proportion": 0.17
          }
        ],
        "roc_auc": 0.75,
        "roc_curve": [
          {
            "x": 0.5,
            "y": 0.75
          }
        ]
      },
      "new_and_unrecognized_individuals": {
        "accuracy_per_threshold": [
          {
            "accuracy": 0.35,
            "threshold": 0
          }
        ],
        "avg_rank_true_label": 1.23,
        "property_distribution": [
          {
            "avg_rank": 1.23,
            "avg_rank_true_label": 1.23,
            "property": "string",
            "proportion": 0.17
          }
        ],
        "roc_auc": 0.75,
        "roc_curve": [
          {
            "x": 0.5,
            "y": 0.75
          }
        ]
      },
      "overall": {
        "accuracy_per_threshold": [
          {
            "accuracy": 0.35,
            "threshold": 0
          }
        ],
        "avg_rank_true_label": 1.23,
        "property_distribution": [
          {
            "avg_rank": 1.23,
            "avg_rank_true_label": 1.23,
            "property": "string",
            "proportion": 0.17
          }
        ],
        "roc_auc": 0.75,
        "roc_curve": [
          {
            "x": 0.5,
            "y": 0.75
          }
        ]
      },
      "repeat_and_recognized_individuals": {
        "accuracy_per_threshold": [
          {
            "accuracy": 0.35,
            "threshold": 0
          }
        ],
        "avg_rank_true_label": 1.23,
        "property_distribution": [
          {
            "avg_rank": 1.23,
            "avg_rank_true_label": 1.23,
            "property": "string",
            "proportion": 0.17
          }
        ],
        "roc_auc": 0.75,
        "roc_curve": [
          {
            "x": 0.5,
            "y": 0.75
          }
        ]
      },
      "repeat_and_unrecognized_individuals": {
        "accuracy_per_threshold": [
          {
            "accuracy": 0.35,
            "threshold": 0
          }
        ],
        "avg_rank_true_label": 1.23,
        "property_distribution": [
          {
            "avg_rank": 1.23,
            "avg_rank_true_label": 1.23,
            "property": "string",
            "proportion": 0.17
          }
        ],
        "roc_auc": 0.75,
        "roc_curve": [
          {
            "x": 0.5,
            "y": 0.75
          }
        ]
      }
    }
  }
}