●Change8

v1.11.0

Breaking Changes
📦 instructorView on GitHub →
⚠ 2 breaking✨ 5 features🐛 3 fixes⚡ 1 deprecations🔧 8 symbols

Summary

This release introduces a major modular reorganization of the codebase, adds support for xAI, OpenRouter, and Truefoundry providers, and implements in-memory batching.

⚠️ Breaking Changes

  • The codebase has been reorganized from a flat structure to a modular architecture, which may affect internal imports.
  • Backward compatibility modules have been removed. Users relying on legacy import paths must update to the current modular structure.

Migration Steps

  1. Update import statements to reflect the new modular architecture if you were importing from internal utility paths.
  2. Remove usage of legacy backward compatibility modules.
  3. Update Pydantic models from 'class Config' to 'model_config = ConfigDict(...)'.

✨ New Features

  • Added xAI utility patterns and support for _raw_response functionality.
  • Added in-memory batching support with improved error handling.
  • Added Truefoundry AI Gateway integration.
  • Added OpenRouter provider support to auto_client routing.
  • Added litellm provider support in from_provider.

🐛 Bug Fixes

  • Implemented missing hooks: completion:error and completion:last_attempt.
  • Fixed broken tutorials navigation link in documentation.
  • Resolved Pydantic v2 deprecation warnings by migrating to ConfigDict.

🔧 Affected Symbols

instructor.from_providerinstructor.utilsinstructor.batchinstructor.hooksinstructor.auto_clientConfigDictcompletion:errorcompletion:last_attempt

⚡ Deprecations

  • Pydantic v2 'class Config' is deprecated in favor of 'ConfigDict'.