Skip to content

v4.24.0: SSL Fixes and Skills API Improvements

Choose a tag to compare

View all tags
@dgunning dgunning released this 01 Nov 00:39
· 1988 commits to main since this release
v4.24.0
e4cfc24

Release v4.24.0: SSL Fixes and Skills API Improvements

This release focuses on reliability improvements and AI agent documentation quality.

🔧 Fixed

SSL Error Handling

  • Implemented fail-fast retry behavior for SSL errors
  • Added specific handling for SSL protocol errors (WRONG_VERSION_NUMBER, TLSV1_ALERT_PROTOCOL_VERSION)
  • Prevents unnecessary retry attempts on unrecoverable SSL errors
  • Impact: Faster failure detection, better error messages

Critical Skills API Documentation Fixes

Form4 Wrong API Fix

  • Fixed 3 examples showing non-existent .transactions attribute
  • Documented correct DataFrame API: .common_stock_sales, .common_stock_purchases
  • Added 80+ lines of comprehensive DataFrame documentation
  • Impact: Q4 test score improvement from 7.0 → 9.5 (+35.7%)

Search Method Confusion Fix

  • Added warnings distinguishing content search vs API search
    • filing.search(query) - search filing text (BM25 content search)
    • filing.docs.search(query) - search Filing API documentation
  • Impact: Q2 test score improvement from 7.6 → 9.4 (+23.7%)

Overall Impact: Average Skills API test score improved from 7.5 → 8.1 (+8%)

📚 Added

New Skills API Documentation Files

  • edgar/ai/skills/sec_analysis/data-objects.md - Comprehensive data objects documentation
  • edgar/ai/skills/sec_analysis/form-types-reference.md - Form types reference
  • edgar/ai/skills/sec_analysis/quickstart-by-task.md - Task-oriented quickstart guide

⚡ Changed

XBRL.text() Optimization for AI Consumption

  • Replaced visual repr() format with compact Markdown-KV format
  • Performance: 64.7% token reduction (~450 vs ~1,275 tokens)
  • Added structured sections:
    • Entity information (name, ticker, CIK, form type)
    • Fiscal period details (year, period, end date)
    • Data volume metrics (facts count, contexts count)
    • Period coverage summary (annual/quarterly periods)
    • Available statements categorization (core vs other)
    • Compact common actions section with usage examples
  • Impact: Improved token efficiency while maintaining information completeness

📊 Testing Results

Skills API validation showed significant improvements:

  • Average Score: 7.5 → 8.1 (+8%)
  • Q2 (Search): 7.6 → 9.4 (+23.7%)
  • Q4 (Form4): 7.0 → 9.5 (+35.7%)
  • Token Efficiency: 5,500 avg (45% below 10,000 target)

🔗 Full Changelog

See CHANGELOG.md for complete details.

📦 Installation

pip install --upgrade edgartools

🙏 Contributors

Thanks to all contributors who helped with this release!

Assets 2
Loading