What's Changed

• Fix release to use main branch by @eyurtsev in https://github.com/eyurtsev/kor/pull/224
• Updating model kwargs usage in documentation by @smwitkowski in https://github.com/eyurtsev/kor/pull/227
• Bump urllib3 from 2.0.4 to 2.0.7 by @dependabot in https://github.com/eyurtsev/kor/pull/241
• Bump langchain from 0.0.283 to 0.0.317 by @dependabot in https://github.com/eyurtsev/kor/pull/242
• Bump langchain from 0.0.317 to 0.0.325 by @dependabot in https://github.com/eyurtsev/kor/pull/245
• upgrade langchain by @chaimt in https://github.com/eyurtsev/kor/pull/257
• Version 1.0.1 by @eyurtsev in https://github.com/eyurtsev/kor/pull/258
• Update README.md by @eyurtsev in https://github.com/eyurtsev/kor/pull/271
• Bump langchain from 0.1.4 to 0.1.11 by @dependabot in https://github.com/eyurtsev/kor/pull/269
• Update README.md by @eyurtsev in https://github.com/eyurtsev/kor/pull/272
• Bump langchain-core from 0.1.29 to 0.1.30 by @dependabot in https://github.com/eyurtsev/kor/pull/273
• Upgrade dependencies by @eyurtsev in https://github.com/eyurtsev/kor/pull/287
• re-run notebooks by @eyurtsev in https://github.com/eyurtsev/kor/pull/302
• kor: update constraints for min dependencies by @eyurtsev in https://github.com/eyurtsev/kor/pull/304
• Release 1.0.2 by @eyurtsev in https://github.com/eyurtsev/kor/pull/303
• Remove deprecated chain by @Sachin-Bhat in https://github.com/eyurtsev/kor/pull/306
• Specify type on parser by @eyurtsev in https://github.com/eyurtsev/kor/pull/308
• update notebooks by @eyurtsev in https://github.com/eyurtsev/kor/pull/309
• Depend only on langchain-core by @eyurtsev in https://github.com/eyurtsev/kor/pull/310
• Release 2.0.0 by @eyurtsev in https://github.com/eyurtsev/kor/pull/311

New Contributors

• @smwitkowski made their first contribution in https://github.com/eyurtsev/kor/pull/227
• @dependabot made their first contribution in https://github.com/eyurtsev/kor/pull/241
• @chaimt made their first contribution in https://github.com/eyurtsev/kor/pull/257
• @Sachin-Bhat made their first contribution in https://github.com/eyurtsev/kor/pull/306

Full Changelog: https://github.com/eyurtsev/kor/compare/1.0.0...2.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 https://github.com/eyurtsev/kor/pull/197
• update workflow by @eyurtsev in https://github.com/eyurtsev/kor/pull/208
• Pydantic v1 and v2 support by @eyurtsev in https://github.com/eyurtsev/kor/pull/213
• Fix release workflow by @eyurtsev in https://github.com/eyurtsev/kor/pull/214
• Update notebooks by @eyurtsev in https://github.com/eyurtsev/kor/pull/215
• Update README for pydantic v2 by @eyurtsev in https://github.com/eyurtsev/kor/pull/216
• Update workflow to run pydantic compatibility by @eyurtsev in https://github.com/eyurtsev/kor/pull/217
• Update poetry lock file by @eyurtsev in https://github.com/eyurtsev/kor/pull/218
• Version 1.0.0 release by @eyurtsev in https://github.com/eyurtsev/kor/pull/223

Full Changelog: https://github.com/eyurtsev/kor/compare/0.13.0...1.0.0

What's Changed

• BREAKING CHANGE Use run instead of predict_and_parse by @BorisWilhelms in https://github.com/eyurtsev/kor/pull/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 https://github.com/eyurtsev/kor/pull/192

Full Changelog: https://github.com/eyurtsev/kor/compare/0.12.0...0.13.0

What's Changed

• Feature/schema to json by @BorisWilhelms in https://github.com/eyurtsev/kor/pull/184

Full Changelog: https://github.com/eyurtsev/kor/compare/0.11.0...0.12.0

What's Changed

• Load schema from JSON by @BorisWilhelms in https://github.com/eyurtsev/kor/pull/178
• fix(docs): typo by @Seb0 in https://github.com/eyurtsev/kor/pull/167
• Fix typo in apis.ipynb by @eltociear in https://github.com/eyurtsev/kor/pull/175

New Contributors

• @Seb0 made their first contribution in https://github.com/eyurtsev/kor/pull/167
• @eltociear made their first contribution in https://github.com/eyurtsev/kor/pull/175
• @BorisWilhelms made their first contribution in https://github.com/eyurtsev/kor/pull/178

Full Changelog: https://github.com/eyurtsev/kor/compare/0.10.0...0.11.0

What's Changed

• Add boolean type by @eyurtsev in https://github.com/eyurtsev/kor/pull/165
• Version 0.10.0 by @eyurtsev in https://github.com/eyurtsev/kor/pull/166

Full Changelog: https://github.com/eyurtsev/kor/compare/0.9.2...0.10.0

What's Changed

Fix for JSON encoding when extracting non English text (https://github.com/eyurtsev/kor/issues/152)

• Fix to allow encoding non ascii in JSON by @eyurtsev in https://github.com/eyurtsev/kor/pull/153
• Add kor to sys path when generating docs by @eyurtsev in https://github.com/eyurtsev/kor/pull/116
• Set default of JSON encoder to ensure_ascii = False by @eyurtsev in https://github.com/eyurtsev/kor/pull/154

Full Changelog: https://github.com/eyurtsev/kor/compare/0.9.1...0.9.2

What's Changed

• Fix for breaking change in langchain by @eyurtsev in https://github.com/eyurtsev/kor/pull/147

Full Changelog: https://github.com/eyurtsev/kor/compare/0.9.0...0.9.1

What's Changed

Propagating verbosity flag to allow users to set verbosity on the extraction chain: @eyurtsev in https://github.com/eyurtsev/kor/pull/137

Full Changelog: https://github.com/eyurtsev/kor/compare/0.8.1...0.9.0

What's Changed

• Bug fix for object examples: @eyurtsev in https://github.com/eyurtsev/kor/pull/131

Fix for this issue: https://github.com/eyurtsev/kor/issues/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: https://github.com/eyurtsev/kor/compare/0.8.0...0.8.1

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 https://github.com/eyurtsev/kor/pull/124
• Add minimal HTML processing by @eyurtsev in https://github.com/eyurtsev/kor/pull/123

Full Changelog: https://github.com/eyurtsev/kor/compare/0.7.0...0.8.0

What's Changed

• All the internal schema relies on pydantic for validation! This change may cause your code to crash if you've had typos!
  @eyurtsev in https://github.com/eyurtsev/kor/pull/117

• Allow customizing the prompt by @eyurtsev in https://github.com/eyurtsev/kor/pull/121

from langchain.prompts import PromptTemplate

DEFAULT_PROMPT_TEMPLATE = PromptTemplate(
    input_variables=["format_instructions", "type_description"],
    template=(
        "Write some stuff here n\n"
        "{type_description}\n\n"
        "{format_instructions}"
        "Suffix heren\n"
    ),
)


chain = create_extraction_chain(llm, schema, instruction_template=DEFAULT_PROMPT_TEMPLATE)

print(chain.prompt.format_prompt(text='hello').to_string())

Full Changelog: https://github.com/eyurtsev/kor/compare/0.6.1...0.7.0

What's Changed

Bug fixes:

• Apply input formatter to user text, not only examples by @eyurtsev in https://github.com/eyurtsev/kor/pull/119

New Contributors

• @rishabhjain1198 made their first contribution in https://github.com/eyurtsev/kor/pull/118

Full Changelog: https://github.com/eyurtsev/kor/compare/0.6.0...0.6.1

What's Changed

• Visitors accept **kwargs
• Type-descriptors have been changed to be immutable
• Added more documentation

Full Changelog: https://github.com/eyurtsev/kor/compare/0.5.1...0.6.0

What's Changed

• Add input formatting argument to create_extraction_chain. This may help make the extraction more robust for text containing a lot of whitespace / multiple paragraphs.
• Added kor.version
• Added more sphinx documentation

Full Changelog: https://github.com/eyurtsev/kor/compare/0.5.0...0.5.1

What's Changed

• Added a pydantic adapter (https://github.com/eyurtsev/kor/pull/91) which can be used to generate schema and to do validation.
• The adapter handles only a few common primitives for schema.
• Example usage here: https://eyurtsev.github.io/kor/validation.html

Full Changelog: https://github.com/eyurtsev/kor/compare/0.4.0...0.5.0

What's Changed

• Integration with Langchain via an LLMChain
• Added support for CSV, JSON encodings
• Swapped default encoding to use CSV (less flexible, but anecdotally more accurate)
• All schema nodes are no longer assumed to be lists by default. Instead the many attribute has been set to False
• However, due to lack of validation and details of XML encoding, XML encoding will still output everything as lists.
• Renamed type descriptors

Breaking Changes

Public API for extraction has changed completely to instead expose an LLMChain.

New Contributors

• @tomdyson made their first contribution in https://github.com/eyurtsev/kor/pull/74

Full Changelog: https://github.com/eyurtsev/kor/compare/0.3.0...0.4.0

What's Changed

• Integrated with langchain
• Added test coverage for code in preparation for feature work

Breaking changes

• Removed kor adapters on top of open AI models, these will be maintained by langchain.

New Contributors

• @vbarda made their first contribution in https://github.com/eyurtsev/kor/pull/26
• @hwchase17 made their first contribution in https://github.com/eyurtsev/kor/pull/57

Full Changelog: https://github.com/eyurtsev/kor/compare/0.2.0...0.3.0

Added documentation and cleaned up some old code.
Small feature set to gauge interest.
Code is hardly tested at the moment.

Draft release only available for a few folks. Has some documentation and a somewhat stabilized API.