compass.pipeline.coordinator.run_compass

async run_compass(request)

Run the requested pipeline mode

Parameters:

request (compass.pipeline.data_classes.BaseRequest) – The request object containing all user-specified settings and configurations for the pipeline run. This should be an instance of one of the specific request types (e.g., ProcessRequest, CollectionRequest, ExtractionRequest) that inherit from BaseRequest, and should include all necessary information such as the mode to run in, output directories, jurisdiction information, model configurations, and any other relevant settings.

Returns:

str – A summary message of the pipeline run, including key information such as the number of jurisdictions processed, documents found, total cost, and output locations. The exact content of the message may vary depending on the mode that was run and the results of the processing.

Raises:

COMPASSValueError – If the request object is not of the expected type, or if it contains invalid configurations (e.g., no collection steps enabled in collection mode).