Skip to content

docs: enhance README with key features and add flight info extraction example#79

Merged
pierrevalade merged 6 commits intomainfrom
pierre-readme-key-feature-code-example
Apr 1, 2025
Merged

docs: enhance README with key features and add flight info extraction example#79
pierrevalade merged 6 commits intomainfrom
pierre-readme-key-feature-code-example

Conversation

@pierrevalade
Copy link
Contributor

This PR enhances the project documentation and adds a new example:

Key Changes:

  1. README Improvements:

    • Added comprehensive list of key features (model-agnostic, observability, cost tracking, etc.)
    • Included a practical example of a flight information extraction agent
    • Added links to documentation and web application
    • Improved overall formatting and organization
  2. New Example:

    • Added examples/18_flight_info_extraction.py demonstrating structured data extraction
    • Shows how to use Pydantic models for type-safe output
    • Includes a realistic email parsing scenario
    • Added corresponding playground screenshot

The changes make the project more approachable for new users while showcasing its key capabilities through practical examples.

@pierrevalade pierrevalade requested review from Copilot and guillaq March 31, 2025 21:42
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR enhances project documentation by updating the README with key feature highlights and by adding a new example demonstrating flight information extraction using Pydantic and the WorkflowAI SDK.

  • Updated README with detailed key features and an embedded, runnable flight info extraction example.
  • Added a new example file (examples/18_flight_info_extraction.py) showcasing how to build an agent for parsing flight details from emails.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
examples/18_flight_info_extraction.py New example demonstrating flight info extraction using Pydantic and WorkflowAI.
README.md Enhanced documentation with key features, an embedded example, and a screenshot.

@pierrevalade pierrevalade self-assigned this Mar 31, 2025
@pierrevalade
Copy link
Contributor Author

@guillaq ready for review, thanks!

guillaq
guillaq previously approved these changes Apr 1, 2025
Copy link
Collaborator

@guillaq guillaq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀 🚀 🚀 🚀

@pierrevalade
Copy link
Contributor Author

@guillaq ready for review again, thanks.

@pierrevalade pierrevalade merged commit b248aca into main Apr 1, 2025
5 checks passed
@pierrevalade pierrevalade deleted the pierre-readme-key-feature-code-example branch April 1, 2025 14:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants