Skip to main content
POST
/
api
/
playground
/
sessions
/
{session_id}
/
bias
Analyze Bias
curl --request POST \
  --url https://api.example.com/api/playground/sessions/{session_id}/bias \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "protected_columns": [
    "<string>"
  ],
  "target_column": "<string>"
}
'
{
  "session_id": "<string>",
  "summary": {},
  "distributions": [
    {
      "column": "<string>",
      "distribution": {},
      "entropy": 123,
      "imbalance_ratio": 123,
      "category_count": 123
    }
  ],
  "correlations": [
    {
      "protected": "<string>",
      "target": "<string>",
      "association": 123,
      "is_concerning": true
    }
  ],
  "recommendations": [
    "<string>"
  ],
  "cross_correlations": {
    "columns": [
      "<string>"
    ],
    "matrix": [
      [
        123
      ]
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Path Parameters

session_id
string
required

Cookies

antidote_session
string | null

Body

application/json
protected_columns
string[]
required
Minimum array length: 1
target_column
string | null

Response

Successful Response

session_id
string
required
summary
Summary · object
required
distributions
BiasDistribution · object[]
required
correlations
BiasCorrelation · object[]
required
recommendations
string[]
required
cross_correlations
BiasCrossCorrelations · object