ImageToText

To import this module:

from python3_capsolver.image_to_text import ImageToText

class python3_capsolver.image_to_text.ImageToText(api_key: str, captcha_type: CaptchaTypeEnm | str = CaptchaTypeEnm.ImageToTextTask, **kwargs)

The class is used to work with Capsolver Image captcha solving method.

Parameters:

• api_key (str) – Capsolver API key

• captcha_type (CaptchaTypeEnm | str) – Captcha type name, like ImageToTextTask and etc.

• kwargs –

  additional params for client, like captcha waiting time available keys:

  • sleep_time: int - captcha solution waintig time in sec

  • request_url: str - API address for sending requests,

    else official will be used

Examples

>>> from python3_capsolver.image_to_text import ImageToText
>>> from python3_capsolver.core.captcha_instrument import FileInstrument
>>> body = FileInstrument().file_processing(captcha_file="captcha_example.jpeg")
>>> ImageToText(api_key="CAI-12345....").captcha_handler(
...                     task_payload={"body": body, "module": "common"}
...                    )
{
   "errorId":0,
   "errorCode":"None",
   "errorDescription":"None",
   "taskId":"db0a3153-621d-4f5e-8554-a1c032597ee7",
   "status":"ready",
   "solution":{
      "confidence":0.9585,
      "text":"gcphjd"
   }
}

>>> import asyncio
>>> from python3_capsolver.image_to_text import ImageToText
>>> from python3_capsolver.core.captcha_instrument import FileInstrument
>>> body = FileInstrument().file_processing(captcha_file="captcha_example.jpeg")
>>> asyncio.run(ImageToText(api_key="CAI-12345....").aio_captcha_handler(
...                     task_payload={"body": body, "module": "common"}
...                     )
...         )
{
   "errorId":0,
   "errorCode":"None",
   "errorDescription":"None",
   "taskId":"db0a3153-621d-4f5e-8554-a1c032597ee7",
   "status":"ready",
   "solution":{
      "confidence":0.9585,
      "text":"gcphjd"
   }
}

>>> from python3_capsolver.image_to_text import ImageToText
>>> from python3_capsolver.core.captcha_instrument import FileInstrument
>>> body = FileInstrument().file_processing(captcha_file="captcha_example.jpeg")
>>> ImageToText(api_key="CAI-12345....").captcha_handler(
...                     task_payload={"body": body,
...                                     "module": "common",
...                                     "score": 0.92}
...                     )
{
   "errorId":0,
   "errorCode":"None",
   "errorDescription":"None",
   "taskId":"db0a3153-621d-4f5e-8554-a1c032597ee7",
   "status":"ready",
   "solution":{
      "confidence":0.9585,
      "text":"gcphjd"
   }
}

Notes

https://docs.capsolver.com/guide/recognition/ImageToTextTask.html

async aio_captcha_handler(task_payload: Dict) → Dict[str, Any]

Asynchronous method for captcha solving

Parameters:

task_payload (Dict) – Some additional parameters that will be used in creating the task and will be passed to the payload under task key. Like websiteURL, image, proxyPassword, websiteKey and etc. more info in service docs

Returns:

Dict with full server response

Return type:

Dict[str, Any]

Notes

Check class docstirng for more info

captcha_handler(task_payload: Dict) → Dict[str, Any]

Synchronous method for captcha solving

Parameters:

task_payload (Dict) – Some additional parameters that will be used in creating the task and will be passed to the payload under task key. Like websiteURL, image, proxyPassword, websiteKey and etc. more info in service docs

Returns:

Dict with full server response

Return type:

Dict[str, Any]

Notes

Check class docstirng for more info