Skip to main content
View module source on GitHub

​
create_data_structure

Create and validate a data structure. Takes a data structure, sanitizes it to ensure it meets validation requirements, and returns the sanitized data structure. Arguments: Returns: Raises:
  • Exception - If the data structure contains validation errors (e.g., multiple input columns, multiple expected output columns, or multiple context to evaluate columns).

​
sanitize_data_structure

Sanitize and validate a data structure for correctness. Ensures that the data structure contains at most one of each required column type:
  • InputColumn: Only one input column is allowed
  • ExpectedOutputColumn: Only one expected output column is allowed
  • ContextToEvaluateColumn: Only one context to evaluate column is allowed
Arguments: Can be None, in which case no validation is performed. Raises:
  • Exception - If the data structure contains more than one input column, more than one expected output column, or more than one context to evaluate column. The exception includes the full data structure for debugging purposes.

​
validate_data_structure

Validate that a data structure matches the expected structure schema. Ensures that all keys present in the provided data structure also exist in the reference data structure (typically from the platform/dataset). This prevents attempting to use columns that don’t exist in the target dataset. Arguments: to validate against (e.g., from the platform dataset). Raises:
  • Exception - If the provided data structure contains any keys that are not present in the reference data structure. The exception includes both the provided keys and the expected keys for debugging.