Text.Recognition.Antigate

Documentation

type AntigateKey = String

type CaptchaID = Int

data CaptchaConf

See http://antigate.com/panel.php?action=api

Constructors

CaptchaConf

Fields

phrase :: Bool

• False = default value (one word)
• True = captcha has 2-4 words

regsense :: Bool

• False = default value (case is not important)
• True = captcha is case sensitive

numeric :: Maybe Bool

• Nothing = default value
• Just True = captcha consists from numbers only
• Just False = captcha does not have numbers on it

calc :: Bool

• False = default value
• True = numbers on captcha must be summed

min_len :: Word

• 0 = default value
• >0 = minimum length of captcha text workers required to input

max_len :: Word

• 0 = default value (unlimited)
• >0 = maximum length of captcha text workers required to input

is_russian :: Bool

• False = default value
• True = captcha goes to Russian-speaking worker

max_bid :: Maybe Double

Default value is set on bids page. This parameter allows to control maximum bid without setting it on the bids page.

Instances

Read CaptchaConf

Show CaptchaConf

Default CaptchaConf

data UploadResult

Constructors

UPLOAD_OK CaptchaID

result is positive, your captcha is accepted for recognition and its ID follows. You may now attempt to retrieve captcha status with this ID.

ERROR_WRONG_USER_KEY

user authorization key is invalid (its length is not 32 bytes as it should be)

UPLOAD_ERROR_KEY_DOES_NOT_EXIST

you have set wrong user authorization key in request

ERROR_ZERO_BALANCE

account has zero or negative balance

ERROR_NO_SLOT_AVAILABLE

no idle captcha workers are available at the moment, please try a bit later or try increasing your bid

ERROR_ZERO_CAPTCHA_FILESIZE

the size of the captcha you are uploading or pointing to is zero

ERROR_TOO_BIG_CAPTCHA_FILESIZE

your captcha size is exceeding 100kb limit

ERROR_WRONG_FILE_EXTENSION

your captcha file has wrong extension, the only allowed extensions are gif,jpg,jpeg,png

ERROR_IMAGE_TYPE_NOT_SUPPORTED

Could not determine captcha file type, only allowed formats are JPG, GIF, PNG

ERROR_IP_NOT_ALLOWED

Request with current account key is not allowed from your IP. Please refer to IP list section

UPLOAD_ERROR_UNKNOWN String

Instances

Eq UploadResult

Ord UploadResult

Read UploadResult

Show UploadResult

data CheckResult

Constructors

CHECK_OK String

the captcha is recognized, the guessed text follows

CAPCHA_NOT_READY

captcha is not recognized yet, repeat request withing 1-5 seconds

CHECK_ERROR_KEY_DOES_NOT_EXIST

you have set wrong user authorization key in request

ERROR_WRONG_ID_FORMAT

the captcha ID you are sending is non-numeric

CHECK_ERROR_UNKNOWN String

Instances

Eq CheckResult

Ord CheckResult

Read CheckResult

Show CheckResult

High level

data SolveException

Constructors

SolveExceptionUpload UploadResult

SolveExceptionCheck CaptchaID CheckResult

Instances

Show SolveException

Typeable SolveException

Exception SolveException

solveCaptcha

Arguments

:: Int

how much to sleep while waiting for available slot. Microseconds.

-> Int

how much to sleep between captcha checks. Microseconds.

-> AntigateKey

-> CaptchaConf

-> FilePath

image filename (antigate guesses filetype by file extension)

-> ByteString

image contents

-> IO (CaptchaID, String)

High level function to solve captcha, blocks until answer is provided (about 2-10 seconds).

throws SolveException or HttpException when something goes wrong.

solveCaptchaFromFile :: Int -> Int -> AntigateKey -> CaptchaConf -> FilePath -> IO (CaptchaID, String)

Same as solveCaptcha, but read contents from a file.

Core functions

uploadCaptcha :: AntigateKey -> CaptchaConf -> FilePath -> ByteString -> IO UploadResult

upload captcha for recognition

throws HttpException on network errors.

checkCaptcha :: AntigateKey -> CaptchaID -> IO CheckResult

retrieve captcha status

throws HttpException on network errors.

checkCaptchas :: AntigateKey -> [CaptchaID] -> IO [CheckResult]

retrieve multiple captcha status

throws HttpException on network errors.

reportBad :: AntigateKey -> CaptchaID -> IO ()

report bad captcha result

throws HttpException on network errors.

getBalance :: AntigateKey -> IO Double

retrieve your current account balance

throws HttpException on network errors.

Miscellaneous

parseUploadResult :: String -> UploadResult

Parse antigate's upload response

parseCheckResult :: String -> CheckResult

Parse antigate's check response

parseCheckResults :: String -> [CheckResult]

Parse antigate's multi-check response

parseCheckResultNoOK :: String -> CheckResult

Parse antigate's multi-check response

renderUploadResult :: UploadResult -> String

Marshal UploadResult back to its text form

renderCheckResult :: CheckResult -> String

Marshal CheckResult back to its text form