Files
crawl4ai/CHANGELOG.md
unclecode 68e9144ce3 feat: Enhance crawling control and LLM extraction flexibility
- Add before_retrieve_html hook and delay_before_return_html option
- Implement flexible page_timeout for smart_wait function
- Support extra_args and custom headers in LLM extraction
- Allow arbitrary kwargs in AsyncWebCrawler initialization
- Improve perform_completion_with_backoff for custom API calls
- Update examples with new features and diverse LLM providers
2024-10-12 14:48:22 +08:00

10 KiB

Changelog

[v0.3.6] - 2024-10-12 - Part 1

1. Improved Crawling Control

  • New Hook: Added before_retrieve_html hook in AsyncPlaywrightCrawlerStrategy.
  • Delayed HTML Retrieval: Introduced delay_before_return_html parameter to allow waiting before retrieving HTML content.
    • Useful for pages with delayed content loading.
  • Flexible Timeout: smart_wait function now uses page_timeout (default 60 seconds) instead of a fixed 30-second timeout.
    • Provides better handling for slow-loading pages.

2. Enhanced LLM Extraction Strategy

  • Custom Arguments: Added support for passing extra arguments to LLM providers via extra_args parameter.
  • Custom Headers: Users can now pass custom headers to the extraction strategy.
    • Enables more flexibility when interacting with different LLM APIs.

3. AsyncWebCrawler Improvements

  • Flexible Initialization: AsyncWebCrawler now accepts arbitrary keyword arguments.
    • These are passed directly to the crawler strategy, allowing for more customized setups.

4. Utility Function Enhancements

  • Improved API Interaction: perform_completion_with_backoff function now supports additional arguments.
    • Allows for more customized API calls to LLM providers.

Examples and Documentation

  • Updated quickstart_async.py with examples of using custom headers in LLM extraction.
  • Added more diverse examples of LLM provider usage, including OpenAI, Hugging Face, and Ollama.

Developer Notes

  • Refactored code for better maintainability and flexibility.
  • Enhanced error handling and logging for improved debugging experience.

[v0.3.6] - 2024-10-12 - Part 2

1. Screenshot Capture

  • What's new: Added ability to capture screenshots during crawling.
  • Why it matters: You can now visually verify the content of crawled pages, which is useful for debugging and content verification.
  • How to use: Set screenshot=True when calling crawler.arun().

2. Delayed Content Retrieval

  • What's new: Introduced get_delayed_content method in AsyncCrawlResponse.
  • Why it matters: Allows you to retrieve content after a specified delay, useful for pages that load content dynamically.
  • How to use: Access result.get_delayed_content(delay_in_seconds) after crawling.

3. Custom Page Timeout

  • What's new: Added page_timeout parameter to control page load timeout.
  • Why it matters: Gives you more control over crawling behavior, especially for slow-loading pages.
  • How to use: Set page_timeout=your_desired_timeout (in milliseconds) when calling crawler.arun().

4. Enhanced LLM Support

  • What's new: Added support for multiple LLM providers (OpenAI, Hugging Face, Ollama).
  • Why it matters: Provides more flexibility in choosing AI models for content extraction.
  • How to use: Specify the desired provider when using LLMExtractionStrategy.

Improvements

1. Database Schema Auto-updates

  • What's new: Automatic database schema updates.
  • Why it matters: Ensures your database stays compatible with the latest version without manual intervention.

2. Enhanced Error Handling

  • What's new: Improved error messages and logging.
  • Why it matters: Makes debugging easier with more informative error messages.

3. Optimized Image Processing

  • What's new: Refined image handling in WebScrappingStrategy.
  • Why it matters: Improves the accuracy of content extraction for pages with images.

Bug Fixes

  • Fixed an issue where image tags were being prematurely removed during content extraction.

Developer Notes

  • Added examples for using different LLM providers in quickstart_async.py.
  • Enhanced type hinting throughout the codebase for better development experience.

[v0.3.5] - 2024-09-02

Enhance AsyncWebCrawler with smart waiting and screenshot capabilities

  • Implement smart_wait function in AsyncPlaywrightCrawlerStrategy
  • Add screenshot support to AsyncCrawlResponse and AsyncWebCrawler
  • Improve error handling and timeout management in crawling process
  • Fix typo in CrawlResult model (responser_headers -> response_headers)

[v0.2.77] - 2024-08-04

Significant improvements in text processing and performance:

  • 🚀 Dependency reduction: Removed dependency on spaCy model for text chunk labeling in cosine extraction strategy.
  • 🤖 Transformer upgrade: Implemented text sequence classification using a transformer model for labeling text chunks.
  • Performance enhancement: Improved model loading speed due to removal of spaCy dependency.
  • 🔧 Future-proofing: Laid groundwork for potential complete removal of spaCy dependency in future versions.

These changes address issue #68 and provide a foundation for faster, more efficient text processing in Crawl4AI.

[v0.2.76] - 2024-08-02

Major improvements in functionality, performance, and cross-platform compatibility! 🚀

  • 🐳 Docker enhancements: Significantly improved Dockerfile for easy installation on Linux, Mac, and Windows.
  • 🌐 Official Docker Hub image: Launched our first official image on Docker Hub for streamlined deployment.
  • 🔧 Selenium upgrade: Removed dependency on ChromeDriver, now using Selenium's built-in capabilities for better compatibility.
  • 🖼️ Image description: Implemented ability to generate textual descriptions for extracted images from web pages.
  • Performance boost: Various improvements to enhance overall speed and performance.

A big shoutout to our amazing community contributors:

  • @aravindkarnam for developing the textual description extraction feature.
  • @FractalMind for creating the first official Docker Hub image and fixing Dockerfile errors.
  • @ketonkss4 for identifying Selenium's new capabilities, helping us reduce dependencies.

Your contributions are driving Crawl4AI forward! 🙌

[v0.2.75] - 2024-07-19

Minor improvements for a more maintainable codebase:

  • 🔄 Fixed typos in chunking_strategy.py and crawler_strategy.py to improve code readability
  • 🔄 Removed .test_pads/ directory from .gitignore to keep our repository clean and organized

These changes may seem small, but they contribute to a more stable and sustainable codebase. By fixing typos and updating our .gitignore settings, we're ensuring that our code is easier to maintain and scale in the long run.

[v0.2.74] - 2024-07-08

A slew of exciting updates to improve the crawler's stability and robustness! 🎉

  • 💻 UTF encoding fix: Resolved the Windows "charmap" error by adding UTF encoding.
  • 🛡️ Error handling: Implemented MaxRetryError exception handling in LocalSeleniumCrawlerStrategy.
  • 🧹 Input sanitization: Improved input sanitization and handled encoding issues in LLMExtractionStrategy.
  • 🚮 Database cleanup: Removed existing database file and initialized a new one.

[v0.2.73] - 2024-07-03

💡 In this release, we've bumped the version to v0.2.73 and refreshed our documentation to ensure you have the best experience with our project.

  • Supporting website need "with-head" mode to crawl the website with head.
  • Fixing the installation issues for setup.py and dockerfile.
  • Resolve multiple issues.

[v0.2.72] - 2024-06-30

This release brings exciting updates and improvements to our project! 🎉

  • 📚 Documentation Updates: Our documentation has been revamped to reflect the latest changes and additions.
  • 🚀 New Modes in setup.py: We've added support for three new modes in setup.py: default, torch, and transformers. This enhances the project's flexibility and usability.
  • 🐳 Docker File Updates: The Docker file has been updated to ensure seamless compatibility with the new modes and improvements.
  • 🕷️ Temporary Solution for Headless Crawling: We've implemented a temporary solution to overcome issues with crawling websites in headless mode.

These changes aim to improve the overall user experience, provide more flexibility, and enhance the project's performance. We're thrilled to share these updates with you and look forward to continuing to evolve and improve our project!

[0.2.71] - 2024-06-26

Improved Error Handling and Performance 🚧

  • 🚫 Refactored crawler_strategy.py to handle exceptions and provide better error messages, making it more robust and reliable.
  • 💻 Optimized the get_content_of_website_optimized function in utils.py for improved performance, reducing potential bottlenecks.
  • 💻 Updated utils.py with the latest changes, ensuring consistency and accuracy.
  • 🚫 Migrated to ChromeDriverManager to resolve Chrome driver download issues, providing a smoother user experience.

These changes focus on refining the existing codebase, resulting in a more stable, efficient, and user-friendly experience. With these improvements, you can expect fewer errors and better performance in the crawler strategy and utility functions.

[0.2.71] - 2024-06-25

Fixed

  • Speed up twice the extraction function.

[0.2.6] - 2024-06-22

Fixed

  • Fix issue #19: Update Dockerfile to ensure compatibility across multiple platforms.

[0.2.5] - 2024-06-18

Added

  • Added five important hooks to the crawler:
    • on_driver_created: Called when the driver is ready for initializations.
    • before_get_url: Called right before Selenium fetches the URL.
    • after_get_url: Called after Selenium fetches the URL.
    • before_return_html: Called when the data is parsed and ready.
    • on_user_agent_updated: Called when the user changes the user_agent, causing the driver to reinitialize.
  • Added an example in quickstart.py in the example folder under the docs.
  • Enhancement issue #24: Replaced inline HTML tags (e.g., DEL, INS, SUB, ABBR) with textual format for better context handling in LLM.
  • Maintaining the semantic context of inline tags (e.g., abbreviation, DEL, INS) for improved LLM-friendliness.
  • Updated Dockerfile to ensure compatibility across multiple platforms (Hopefully!).

[0.2.4] - 2024-06-17

Fixed

  • Fix issue #22: Use MD5 hash for caching HTML files to handle long URLs