Utilities

The GetAQAnnotation and GetCATAnnotation and utility classes have been developed to create an AQAnnotation from the archive format (CATAnnotation) and vise versa. When creating the AQAnnotation, the ampersand separated string of name-value pairs in the CATAnnotation other field is mapped to a Map in the AQAnnotation record. To minimize memory consumption and increase performance, you can specify which name-value pairs to include in the Map. For more details on the implementation, view the corresponding class for each function in the AQPython Utilities module. For usage examples, view the GetAQAnnotation and GetCATAnnotation classes in the test_utilities module.

GetAQAnnotations(df[, props, lcProps, …])	This function converts a Dataframe of CATAnnotations to a Dataframe of AQAnnotations.
GetCATAnnotations(df[, props, encodeProps])	This function converts a Dataframe of AQAnnotations to a Dataframe of CATAnnotations.
Hydrate(df, txtPath[, excludes])	This function will retrieve the text for each AQAnnotation in the passed Dataframe of AQAnnotations, populate the text property with this value in the AQAnnotation, and return a Dataframe of AQAnnotations with the text property populated.