Skip to main content

CategoryPredictionDTO

Represents the predicted category for a transaction with confidence and strategy details.

transactionIdinteger<int64>

ID of the transaction that was categorized

Example: 12345
descriptionstring

Description of the transaction

Example: Grocery store payment
categoryIdinteger<int64>

ID of the predicted category

Example: 10
categoryCodestring

Code of the predicted category

Example: FOOD
categoryNamestring

Name of the predicted category

Example: Food & Groceries
confidencenumber<double>

Confidence score of the prediction

Example: 0.92
alternatives object

Alternative category predictions with confidence scores

property name*number<double>

Alternative category predictions with confidence scores

needsVerificationboolean

Indicates whether the result needs human verification

Example: false
strategyTypestring

The strategy used to categorize the transaction

Possible values: [LABEL_BASED, ML_BASED, LLM_BASED]

Example: ML
CategoryPredictionDTO
{
"transactionId": 12345,
"description": "Grocery store payment",
"categoryId": 10,
"categoryCode": "FOOD",
"categoryName": "Food & Groceries",
"confidence": 0.92,
"alternatives": {
"FOOD": 0.92,
"ENTERTAINMENT": 0.07
},
"needsVerification": false,
"strategyType": "ML"
}