graphrag/v1-breaking-changes.md
JunHo Kim (김준호) 8d8c67d503
fix typo. Update documentation URLs for consistency (#1298)
Update documentation URLs for consistency

Revised links in documentation files to remove the "posts" subdirectory for consistency and correctness.

Co-authored-by: Alonso Guevara <alonsog@microsoft.com>
2024-10-21 17:24:17 -06:00

1.1 KiB

Config Breaking Changes

Deprecate timestamp paths

Change

  • Remove support for timestamp paths, those using ${timestamp} directory nesting.
  • Use the same directory for storage output and reporting output.

Migration

  • Ensure output directories no longer use ${timestamp} directory nesting.

Using Environment Variables

  • Ensure GRAPHRAG_STORAGE_BASE_DIR is set to a static directory, e.g., output instead of output/${timestamp}/artifacts.
  • Ensure GRAPHRAG_REPORTING_BASE_DIR is set to a static directory, e.g., output instead of output/${timestamp}/reports

Full docs on using environment variables for configuration.

Using Configuration File

# rest of settings.yaml file
# ...

storage:
  type: file
  base_dir: "output" # changed from "output/${timestamp}/artifacts"

reporting:
  type: file
  base_dir: "output" # changed from "output/${timestamp}/reports"

Full docs on using JSON or YAML files for configuration.