●Change8

Migrating to GraphRAG v2.0.0

Version v2.0.0 introduces 5 breaking changes. This guide details how to update your code.

Released: 2/25/2025

5
Breaking Changes
5
Migration Steps
9
Affected Symbols

⚠️ Check Your Code

If you use any of these symbols, you need to read this guide:

APILLM ManagerLLM Factoryworkflow runnerNLP extractorFastGraphRAGconfig defaultsquery modulefnllm

Breaking Changes

●Issue #1

Rework API to accept callbacks: Existing API calls that relied on the old structure may need updates to pass callbacks.

●Issue #2

Remove config inheritance, hydration, and automatic env var overlays: Configuration loading is now stricter; users must explicitly define configurations instead of relying on implicit inheritance or environment variable overlays.

●Issue #3

Rework the update output storage structure: Code relying on the previous structure for storing workflow outputs will need updates.

●Issue #4

Refactor config defaults from constants to type-safe, hierarchical dataclass: Configuration access patterns might have changed due to the move from constants to dataclasses.

●Issue #5

Remove unused columns and change property document_attribute_columns to metadata: Any code referencing the old property name 'document_attribute_columns' must be updated to use 'metadata'.

Migration Steps

  1. 1
    Review API usage for any changes related to accepting callbacks.
  2. 2
    Update configuration loading logic to explicitly define settings, as automatic inheritance and environment variable overlays have been removed.
  3. 3
    Update code referencing output storage structures based on the rework.
  4. 4
    Update code referencing configuration defaults to use the new dataclass structure.
  5. 5
    Replace usage of 'document_attribute_columns' with 'metadata' in relevant configuration or access points.

Release Summary

Version 2.0.0 introduces major architectural changes, including reworking the API to accept callbacks, reorganizing workflows, and refactoring configuration management into type-safe dataclasses. This release also adds features like LLM provider registration and multi-index querying support.

Need More Details?

View the full release notes and all changes for GraphRAG v2.0.0.

View Full Changelog