README

Resolución de captchas del SAT usando Inteligencia Artificial

🇺🇸 The documentation of this project is in spanish as this is the natural language for the intended audience.

Acerca de

Esta librería permite resolver captchas del SAT usando un modelo Onnx de Inteligencia Artificial. El modelo de AI está basado en Onnx y ha sido alimentado con los captchas de tipo mancha de color.

El modelo ha sido entrenado por BOX Factura y se encuentra disponible en el repositorio BoxFactura/sat-captcha-ai-model.

Esta implementación está directamente relacionada con phpcfdi/image-captcha-resolver al tratarse de un resolvedor adicional para este proyecto.

Instalación

Usa composer

composer require phpcfdi/image-captcha-resolver-boxfactura-ai

Instalación del modelo

El modelo que permite resolver los captchas se encuentra en el proyecto BoxFactura/sat-captcha-ai-model. En este repositorio está el script de BASH bin/download-model que descarga los archivos necesarios.

El siguiente comando instala el modelo en el directorio storage/sat-captcha-ai-model.

bin/download-model storage/sat-captcha-ai-model

Ejemplos de uso

Resolver un captcha con phpcfdi/image-captcha-resolver

Para este ejemplo se asume que la imagen del captcha se encuentra como imagen embedida y su contenido en $theImgElementSrcAtributte. También asume que el archivo de configuraciones del modelo está en storage/sat-captcha-ai-model/configs.yaml.

<?php

use PhpCfdi\ImageCaptchaResolver\BoxFacturaAI\BoxFacturaAIResolver;
use PhpCfdi\ImageCaptchaResolver\CaptchaImage;
use PhpCfdi\ImageCaptchaResolver\UnableToResolveCaptchaException;

/** @var string $theImgElementSrcAtributte */
$image = CaptchaImage::newFromInlineHtml($theImgElementSrcAtributte);

// Creación del resolvedor
$configsFile = 'storage/sat-captcha-ai-model/configs.yaml';
$resolver = BoxFacturaAIResolver::createFromConfigs($configsFile);

try {
    $answer = $resolver->resolve($image);
} catch (UnableToResolveCaptchaException $exception) {
    echo "No se pudo resolver el captcha: {$exception->getMessage()}", PHP_EOL;
    return;
}

echo "Respuesta del captcha: {$answer->getValue()}", PHP_EOL;

Uso fuera de phpcfdi/image-captcha-resolver

Se puede utilizar este proyecto fuera de la librería phpcfdi/image-captcha-resolver. Para lograrlo hay que utilizar directamente el objeto Procesor con los métodos resolveImageFile o resolveImageContent, que reciben una ruta a un archivo o el contenido de un archivo, y devuelven el texto que contiene el captcha.

use PhpCfdi\ImageCaptchaResolver\BoxFacturaAI\BoxFacturaAIResolver;
use PhpCfdi\ImageCaptchaResolver\BoxFacturaAI\ConfigsReader;
use PhpCfdi\ImageCaptchaResolver\BoxFacturaAI\Processor;
use PhpCfdi\ImageCaptchaResolver\BoxFacturaAI\Settings;

$configsFile = 'storage/sat-captcha-ai-model/configs.yaml';
$reader = new ConfigsReader();
$settings = $reader->settingsFromFile($configsFile);
$processor = Processor::createFromSettings($settings);

$image = 'storage/captcha.png';
$result = $processor->resolveImageFile($image);

Uso de la herramienta CLI

Con esta herramienta se agrega un script de ejecución por línea de comandos, con la que se le da uno o más archivos de imágenes de captcha y devuelve la resolución para cada uno, o un error si no se pudo obtener.

php bin/resolve.php --config model/configs.yaml samples/*.png samples/non-existent.png
samples/14YYHT.png: 14YYHT
samples/SSKTQC.png: SSKTQC
samples/INVALID.png: [ERROR] Unable to open image samples/INVALID.png
samples/non-existent.png: [ERROR] File samples/non-existent.png does not exist.

Configuración de libonnxruntime

Se recomienda utilizar la librería libonnxruntime que se instala automáticamente con el componente ankane/onnxruntime.

Sin embargo, se puede utilizar la librería instalada en su sistema, por ejemplo:

\OnnxRuntime\FFI::$lib = '/usr/lib/x86_64-linux-gnu/libonnxruntime.so';

De igual forma, se puede utilizar otra librería que no sea GD para procesar imágenes, sin embargo, en las pruebas de desarrollo se encontró que es mucho más rápida que las soluciones basadas en Imagick. También se puede activar el soporte de GPU para Onnx.

El siguiente ejemplo muestra ambos casos:

use Imagine\Imagick\Imagine as ImagineImagick;
use PhpCfdi\ImageCaptchaResolver\BoxFacturaAI\BoxFacturaAIResolver;
use PhpCfdi\ImageCaptchaResolver\BoxFacturaAI\ConfigsReader;
use PhpCfdi\ImageCaptchaResolver\BoxFacturaAI\Processor;
use PhpCfdi\ImageCaptchaResolver\BoxFacturaAI\Settings;
use OnnxRuntime\InferenceSession;

\OnnxRuntime\FFI::$lib = '/usr/lib/x86_64-linux-gnu/libonnxruntime.so';

$configsFile = 'storage/sat-captcha-ai-model/configs.yaml';
$reader = new ConfigsReader();
$settings = $reader->settingsFromFile($configsFile);
$onnxSession = new InferenceSession($settings->onnxModel, providers: ['CUDAExecutionProvider']);
$imagineEngine = new ImagineImagick();
$processor = new Processor(
    $settings->imageWidth,
    $settings->imageHeight,
    $settings->alphabetArray,
    $onnxSession,
    $imagineEngine;
);
$resolver = new BoxFacturaAIResolver($processor);

Soporte

Puedes obtener soporte abriendo un ticket en GitHub.

Adicionalmente, esta librería pertenece a la comunidad PhpCfdi, así que puedes usar los mismos canales de comunicación para obtener ayuda de algún miembro de la comunidad.

Compatibilidad

Esta librería se mantendrá compatible con al menos la versión con soporte activo de PHP más reciente.

También utilizamos Versionado Semántico 2.0.0 por lo que puedes usar esta librería sin temor a romper tu aplicación.

Contribuciones

Las contribuciones con bienvenidas. Por favor lee CONTRIBUTING para más detalles y recuerda revisar el archivo de tareas pendientes TODO y el archivo CHANGELOG.

BOX Factura

Ofreciendo soluciones premium en descarga, recepción y resguardo de CFDI para empresas modernas, la suite de herramientas de Box Factura le ha permitido tanto a usuarios finales como especialistas en IT simplificar las labores administrativas a través de bóveda digital, descarga masiva diaria, portal de proveedores, gestión de viáticos y monitor de cancelaciones, además de API que permitan desarrollos e implementaciones personalizadas.

Agradecemos a Box Factura la creación libre del modelo de inteligencia artificial que permite resolver los captchas y esperamos poder contribuir con sus proyectos.

Copyright and License

The phpcfdi/image-captcha-resolver-boxfactura-ai library is copyright © PhpCfdi and licensed for use under the MIT License (MIT). Please see LICENSE for more information.