Skip to main content

Automation browser error detection and screen detection with AI fallback and cache

Project description

Automation Error Detector

🚀 Automation Error Detector là một Python package giúp bạn phát hiện và phân loại lỗi màn hình trình duyệt trong automation, sử dụng OpenAI API chỉ một lần, sau đó cache kết quả để tái sử dụng mà không cần AI nữa.

Package được thiết kế theo DDD + Clean Architecture, cho phép bạn tự do lưu cache ở bất kỳ đâu (Redis, PostgreSQL, file, cloud, v.v.) thông qua callback.


✨ Features

  • ✅ Phát hiện lỗi từ text trên màn hình trình duyệt
  • 🤖 AI fallback (OpenAI) chỉ dùng khi cache miss
  • ⚡ Cache thông minh bằng signature từ keywords
  • 🔌 Pluggable cache callback (Redis, Postgres, JSON, custom)
  • 🧱 Kiến trúc DDD + Clean Architecture
  • 📦 Sẵn sàng publish & reuse qua PyPI
  • 🧪 Dễ test, dễ mở rộng, production-ready

📦 Installation

pip install automation-error-detector

🔐 Environment Variables

Name Required Description
OPENAI_API_KEY OpenAI API key
OPENAI_MODEL Model name (default: gpt-4.1-mini)
ERROR_CACHE_FILE Cache file path (JSON adapter)
export OPENAI_API_KEY="sk-xxxx"

🚀 Quick Start

from application.use_cases.detect_error_use_case import DetectErrorUseCase
from infrastructure.ai.openai_client import OpenAIClient
from infrastructure.cache.json_cache_callback import JsonCacheCallback

cache = JsonCacheCallback()
ai = OpenAIClient()

use_case = DetectErrorUseCase(
    cache_callback=cache,
    ai_client=ai
)

screen_text = """
Your session has expired.
Please log in again.
"""

result = use_case.execute(screen_text)
print(result.to_dict())

🌐 OpenAI Proxy (Instance-based)

Package KHÔNG dùng HTTP_PROXY / HTTPS_PROXY của OS. Proxy được inject theo từng OpenAIClient instance.

HTTP / HTTPS Proxy

proxy = {
    "https": "http://127.0.0.1:8080"
}

ai = OpenAIClient(proxy=proxy)

SOCKS5 Proxy

proxy = {
    "socks": "socks5://127.0.0.1:1080"
}

ai = OpenAIClient(proxy=proxy)

🔌 Custom Cache Callback

Bạn có thể lưu cache ở bất kỳ đâu bằng cách implement callback.

from domain.services.cache_callback import CacheSaveCallback

class CacheSaveCallback:
    def load(self, signature: str) -> dict | None:
        pass

    def save(self, signature: str, data: dict) -> None:
        pass

⚙️ Configuration API

from config import AppConfig

AppConfig.openai_api_key
AppConfig.openai_model
AppConfig.cache_file

🔒 Security Notes

  • Không hard-code API key
  • Không commit .env
  • Luôn dùng ENV variables

📄 License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

automation_error_detector-1.2.0.tar.gz (10.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

automation_error_detector-1.2.0-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

Details for the file automation_error_detector-1.2.0.tar.gz.

File metadata

File hashes

Hashes for automation_error_detector-1.2.0.tar.gz
Algorithm Hash digest
SHA256 55de18e1905cb71a5c7d767c2e4d3f4d6484c05688ede2d8bc50569ea2eae01c
MD5 ddb86ae614313c90cde72bd6f210c1a7
BLAKE2b-256 1700e68c626fd08f690bd8541d21587f2275671e1d20ecf0cce7989b1d367059

See more details on using hashes here.

File details

Details for the file automation_error_detector-1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for automation_error_detector-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e725e9e311352c75c1062d200d80ce4c25d70dc2e7c1c445db3491ad98ec9fea
MD5 0595c82ae38d512e4a26615c8828f2a7
BLAKE2b-256 49ecdabfce384859a2b94ebf71ba382d65695363f04e944a1decc0099bdf9ca9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page