Apply assessment enable property to granular assessment

Author: Bob Strahan

CHANGELOG.md

@@ -20,27 +20,18 @@ SPDX-License-Identifier: MIT-0
   - **Cost Optimization**: When disabled, no LLM API calls or S3 operations are performed
   - **Configuration Example**: Set `assessment.enabled: false` to disable, `enabled: true` to enable (default)
 
-### Changed  
-- **State Machine Simplification**: Removed `SummarizationChoice` and `AssessmentChoice` conditional states from all patterns (Pattern 2, 3) for cleaner workflows
-- **Service Logic Enhancement**: SummarizationService and AssessmentService now check configuration `enabled` flag at the beginning of processing methods
-- **Configuration Schema Updates**: Added `enabled` boolean property to summarization and assessment sections in all CloudFormation template schemas
-- Updated all sample configurations to include `summarization.enabled: true` and `assessment.enabled: true`
-- Updated configuration documentation with new summarization and assessment control approaches
-
 ### Removed
 - **CloudFormation Parameters**: Removed `IsSummarizationEnabled` and `IsAssessmentEnabled` parameters from all pattern templates
 - **Related Conditions**: Removed parameter conditions and state machine definition substitutions for both features
 - **Conditional Logic**: Eliminated complex conditional logic from state machine definitions for summarization and assessment steps
 
-### Fixed
-- **CloudFormation Template Deployment Error**: Fixed "Template format error: Unresolved resource dependencies [IsAssessmentEnabled]" by removing final parameter reference in main template PATTERN3STACK parameters
-- **State Machine Logic**: Simplified conditional assessment/summarization steps that were causing complex workflow logic
-- **Parameter Dependencies**: Cleaned up all CloudFormation parameter dependencies and references
-
-### Documentation
-- **Updated Documentation**: Enhanced docs/configuration.md, docs/architecture.md, and all pattern-specific docs (pattern-1.md, pattern-2.md, pattern-3.md)
-- **Service Documentation**: Updated lib/idp_common_pkg/idp_common/summarization/README.md with configuration examples and behavior details
-- **Migration Guidance**: Added migration notes about the CloudFormation parameter removal
+### ⚠️ Breaking Changes
+- **Configuration Migration Required**: When updating a stack that previously had `IsSummarizationEnabled` or `IsAssessmentEnabled` set to `false`, these features will now default to `enabled: true` after the update. To maintain the disabled behavior:
+  1. Update your configuration file to set `summarization.enabled: false` and/or `assessment.enabled: false` as needed
+  2. Save the configuration changes immediately after the stack update
+  3. This ensures continued cost optimization by preventing unexpected LLM API calls
+- **Action Required**: Review your current CloudFormation parameter settings before updating and update your configuration accordingly to preserve existing behavior
+
 
 ## [0.3.11]
 

lib/idp_common_pkg/idp_common/assessment/__init__.py

@@ -15,6 +15,8 @@
 import logging
 from typing import Any, Dict
 
+from idp_common.utils import normalize_boolean_value
+
 from .granular_service import GranularAssessmentService
 from .models import AssessmentResult, AttributeAssessment
 from .service import AssessmentService as OriginalAssessmentService
@@ -58,24 +60,6 @@ def _format_attribute_descriptions(self, attributes):
         return self._service._format_attribute_descriptions(attributes)
 
 
-def _normalize_boolean_value(value: Any) -> bool:
-    """
-    Normalize a value to a boolean, handling string representations.
-
-    Args:
-        value: Value to normalize (can be bool, str, or other)
-
-    Returns:
-        Boolean value
-    """
-    if isinstance(value, bool):
-        return value
-    elif isinstance(value, str):
-        return value.lower() in ("true", "1", "yes", "on")
-    else:
-        return bool(value)
-
-
 def create_assessment_service(region: str = None, config: Dict[str, Any] = None):
     """
     Factory function to create the appropriate assessment service based on configuration.
@@ -97,7 +81,7 @@ def create_assessment_service(region: str = None, config: Dict[str, Any] = None)
     granular_enabled_raw = granular_config.get("enabled", False)
 
     # Normalize the enabled value to handle both boolean and string values
-    granular_enabled = _normalize_boolean_value(granular_enabled_raw)
+    granular_enabled = normalize_boolean_value(granular_enabled_raw)
 
     logger.info(
         f"Granular assessment enabled check: raw_value={granular_enabled_raw} (type: {type(granular_enabled_raw)}), normalized={granular_enabled}"

lib/idp_common_pkg/idp_common/assessment/granular_service.py

@@ -998,6 +998,15 @@ def process_document_section(self, document: Document, section_id: str) -> Docum
         Returns:
             Document: Updated Document object with assessment results appended to extraction results
         """
+        # Check if assessment is enabled in configuration
+        assessment_config = self.config.get("assessment", {})
+        from idp_common.utils import normalize_boolean_value
+
+        enabled = normalize_boolean_value(assessment_config.get("enabled", True))
+        if not enabled:
+            logger.info("Assessment is disabled via configuration")
+            return document
+
         # Validate input document
         if not document:
             logger.error("No document provided")

lib/idp_common_pkg/idp_common/assessment/service.py

@@ -600,7 +600,10 @@ def process_document_section(self, document: Document, section_id: str) -> Docum
         """
         # Check if assessment is enabled in configuration
         assessment_config = self.config.get("assessment", {})
-        if not assessment_config.get("enabled", True):
+        from idp_common.utils import normalize_boolean_value
+
+        enabled = normalize_boolean_value(assessment_config.get("enabled", True))
+        if not enabled:
             logger.info("Assessment is disabled via configuration")
             return document
 

lib/idp_common_pkg/idp_common/summarization/service.py

@@ -395,9 +395,10 @@ def process_document(
         """
         # Check if summarization is enabled in configuration
         summarization_config = self.config.get("summarization", {})
-        if not summarization_config.get(
-            "enabled", True
-        ):  # Default to True for backward compatibility
+        from idp_common.utils import normalize_boolean_value
+
+        enabled = normalize_boolean_value(summarization_config.get("enabled", True))
+        if not enabled:
             logger.info(
                 f"Summarization is disabled in configuration for document {document.id}, skipping processing"
             )

lib/idp_common_pkg/idp_common/utils/__init__.py

@@ -235,6 +235,28 @@ def extract_json_from_text(text: str) -> str:
     return text
 
 
+def normalize_boolean_value(value: Any) -> bool:
+    """
+    Normalize a value to a boolean, handling string representations.
+
+    This function is useful for configuration values that may come as strings
+    (e.g., from JSON config files or environment variables) but need to be
+    treated as booleans.
+
+    Args:
+        value: Value to normalize (can be bool, str, or other)
+
+    Returns:
+        Boolean value
+    """
+    if isinstance(value, bool):
+        return value
+    elif isinstance(value, str):
+        return value.lower() in ("true", "1", "yes", "on")
+    else:
+        return bool(value)
+
+
 def extract_yaml_from_text(text: str) -> str:
     """
     Extract YAML string from LLM response text with robust multi-strategy handling.

lib/idp_common_pkg/tests/unit/assessment/test_assessment_enabled_property.py

@@ -37,7 +37,6 @@ def setUp(self):
                     classification="Invoice",
                     page_ids=["1"],
                     extraction_result_uri="s3://test-bucket/test-doc/extraction-1.json",
-                    status=Status.COMPLETED,
                 )
             ],
             status=Status.EXTRACTING,