Setting the confidence threshold for text CAPTCHA recognition
How to set the confidence threshold
In our service, the likelihood of successfully recognizing a captcha depends on its complexity. Funds are only deducted for correctly solved captchas. If the system's confidence in the answer is below the user-defined threshold, no funds will be deducted.
The recognizingThreshold parameter applies only to ImageToTextTask (text captchas). For other types of captchas (ReCaptcha, Turnstile, etc.) this parameter is not used and does not affect the result.
To ensure that CapMonster Cloud returns a guaranteed correct result, you can include the recognizingThreshold parameter with your captcha recognition request, with a value from 0 to 100. This parameter sets the system’s confidence threshold for a correct captcha solution and defines the minimum value below which no funds will be deducted from your balance.
Example
POST
https://api.capmonster.cloud/createTask
{
"task": {
...
"recognizingThreshold" : 70
},
"clientKey":"API_KEY",
"softId" : 345
}
In this case, if the parameter is set to 70, only answers in which our system is more than 70% confident will be returned; for all other tasks, an error "ERROR_CAPTCHA_UNSOLVABLE" will be returned.
The confidence threshold is an internal metric used by the system to assess the likelihood that the recognized text is correct. The higher the threshold, the more accurate the responses, but the more frequently tasks may be considered unsolvable (ERROR_CAPTCHA_UNSOLVABLE).
Another way to pass a threshold is to use only the field to specify the ApiKey. You can add threshold information in the following format: {apikey}__recognizingthreshold_{value}
For example, “API_KEY__recognizingthreshold_70”
You can also enter the name of the module with the key in the following format: {apikey}__module-name.
The key, the confidence threshold and the name of the module are indicated with the underscore “__”
Example: “API_KEY__solvemedia__recognizingthreshold_70”
If you are unable to set the response confidence threshold, please contact our support team, and we will assist you with the setup!
