docs: enhance README with key features and add flight info extraction example#79
Merged
pierrevalade merged 6 commits intomainfrom Apr 1, 2025
Merged
Conversation
There was a problem hiding this comment.
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
commented
Mar 31, 2025
Contributor
Author
|
@guillaq ready for review, thanks! |
Contributor
Author
|
@guillaq ready for review again, thanks. |
guillaq
approved these changes
Apr 1, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR enhances the project documentation and adds a new example:
Key Changes:
README Improvements:
New Example:
examples/18_flight_info_extraction.pydemonstrating structured data extractionThe changes make the project more approachable for new users while showcasing its key capabilities through practical examples.