Evaluators API

This API allows managing and executing evaluators in the system. It provides endpoints to create, read, update, and delete evaluators, as well as to perform evaluations using configured evaluators.

The Evaluator Object

The Evaluator object represents an evaluator in the system, which can be used to perform evaluations.

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "alias": "credit-score",
  "version": "1.0.0",
  "label": "Credit Score Evaluator",
  "description": "Evaluates the credit score of an applicant",
  "createdAt": "2023-04-01T12:00:00Z",
  "updatedAt": "2023-04-02T14:30:00Z",
  "specs": {...}
}

Attributes

Available Operations

Create a New Evaluator

Creates a new evaluator in the system.

POST /v1/evaluators

Input Parameters:

Request Example:

{
  "label": "Credit Risk Evaluator",
  "alias": "credit-risk-evaluator",
  "version": "1.0.0",
  "description": "Evaluates the credit risk of an applicant",
  "specs": {...}
}

Successful Response:

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Get an Evaluator

Retrieves information about a specific evaluator.

GET /v1/evaluators/:evaluator_id

Path Parameters:

Successful Response:

The response will be a complete Evaluator object, as described above.

Update an Evaluator

Updates information of an existing evaluator.

PATCH /v1/evaluators/:evaluator_id

Path Parameters:

Input Parameters:

Request Example:

{
  "label": "Enhanced Credit Risk Evaluator",
  "description": "Enhanced version of the credit risk evaluator",
  "specs": {...}
}

Successful Response:

The response will be the updated Evaluator object.

Delete an Evaluator

Deletes an evaluator from the system.

DELETE /v1/evaluators/:evaluator_id

Path Parameters:

Successful Response:

Status code 204 (No Content) if the deletion was successful.

List Evaluators

Retrieves a paginated list of evaluators with filtering and sorting options.

GET /v1/evaluators

Query Parameters:

Successful Response:

The response will be a paginated list of Evaluator objects.

Execute an Evaluation

Performs an evaluation using a specific evaluator.

POST /v1/evaluators/:evaluator_id/evaluate

Path Parameters:

Input Parameters:

Request Example:

{
  "instance": {
    "referenceId": "loan-123",
    "referenceDate": "2023-04-01T12:00:00Z",
    "data": {
      "loan_amount": 50000,
      "credit_score": 720
    }
  },
  "entities": [
    {
      "entityId": "borrower-456",
      "borrowerId": "user-789",
      "role": "primary",
      "character": "individual",
      "data": {
        "age": 35,
        "income": 75000
      }
    }
  ]
}

Successful Response:

The response will be an EvaluationEngineOutput object containing the evaluation results.

Error Handling

The API may return the following error codes:

Errors will include a descriptive message in the response body.