Version 1.0.0

Changes

• kor is now compatible with both pydantic v2 and v1
• pydantic v2 had significant breaking changes w/ respect to v1, so a major version bump was used in kor as a precaution to warn users about potential breaking changes.

Main things to watch out for when bumping to new pydantic version and new kor:

1. Use a default value for any Optional fields if using pydantic v2 for validation.

class MusicRequest(BaseModel):
    song: Optional[List[str]] = Field(
        default=None,
        description="The song(s) that the user would like to be played."
    )

2. Kor schema is typed checked using pydantic. Pydantic v2 is stricter, and may
   catch issues that were hiding in existing user code that was using the kor
   library.

3. Serialization has not yet been implemented with pydantic v2.

Other changes

node ids are not longer required to be valid identifiers. This helps when using node ids which are attribute names written in other languages (e.g., chinese).

What's Changed

• Update docs to use run by @eyurtsev in #197
• update workflow by @eyurtsev in #208
• Pydantic v1 and v2 support by @eyurtsev in #213
• Fix release workflow by @eyurtsev in #214
• Update notebooks by @eyurtsev in #215
• Update README for pydantic v2 by @eyurtsev in #216
• Update workflow to run pydantic compatibility by @eyurtsev in #217
• Update poetry lock file by @eyurtsev in #218
• Version 1.0.0 release by @eyurtsev in #223

Full Changelog: 0.13.0...1.0.0

Version 0.13.0

What's Changed

• BREAKING CHANGE Use run instead of predict_and_parse by @BorisWilhelms in #188

Attaches parser directly to extraction chain, allowing usage of the run method and deprecating usage of predict_and_parse (and async variants respectively).

• Release 0.13.0 by @eyurtsev in #192

Full Changelog: 0.12.0...0.13.0

Version 0.12.0

What's Changed

• Feature/schema to json by @BorisWilhelms in #184

Full Changelog: 0.11.0...0.12.0

Version 0.11.0

What's Changed

• Load schema from JSON by @BorisWilhelms in #178
• fix(docs): typo by @Seb0 in #167
• Fix typo in apis.ipynb by @eltociear in #175

New Contributors

• @Seb0 made their first contribution in #167
• @eltociear made their first contribution in #175
• @BorisWilhelms made their first contribution in #178

Full Changelog: 0.10.0...0.11.0

Version 0.10.0

What's Changed

• Add boolean type by @eyurtsev in #165
• Version 0.10.0 by @eyurtsev in #166

Full Changelog: 0.9.2...0.10.0

Version 0.9.2

What's Changed

Fix for JSON encoding when extracting non English text (#152)

• Fix to allow encoding non ascii in JSON by @eyurtsev in #153
• Add kor to sys path when generating docs by @eyurtsev in #116
• Set default of JSON encoder to ensure_ascii = False by @eyurtsev in #154

Full Changelog: 0.9.1...0.9.2

Version 0.9.1

What's Changed

• Fix for breaking change in langchain by @eyurtsev in #147

Full Changelog: 0.9.0...0.9.1

Version 0.9.0

What's Changed

Propagating verbosity flag to allow users to set verbosity on the extraction chain: @eyurtsev in #137

Full Changelog: 0.8.1...0.9.0

Version 0.8.1

What's Changed

• Bug fix for object examples: @eyurtsev in #131

Fix for this issue: #130 -- If the examples that were defined on an object were a list of dicts with each dict containing exactly 2 items, then the list of dicts was incorrectly coerced by pydantic into a dict

Full Changelog: 0.8.0...0.8.1

Version 0.8.0

What's Changed

Support for extracting from longer documents see documentation: https://eyurtsev.github.io/kor/document_extraction.html

• Add simple extraction workflow by @eyurtsev in #124
• Add minimal HTML processing by @eyurtsev in #123

Full Changelog: 0.7.0...0.8.0