compass.pipeline.collection.steps.SearchEngineDocumentsStep#

class SearchEngineDocumentsStep[source]#

Bases: CollectionStep

Concrete Strategy for search-engine document collection

Methods

collect(workflow)

Collect documents based on a search engine search

Attributes

STEP_NAME

Identifier for step
STEP_NAME = 'search_engine'#

Identifier for step

async collect(workflow)[source]#

Collect documents based on a search engine search

Parameters:

workflow (compass.pipeline.jurisdiction.SingleJurisdictionRun) – The workflow for the jurisdiction being processed, which may or may not have search engine document collection enabled. If search engine document collection is not enabled, this function will return an empty list.

Returns:

list – List of documents collected from search engine results, with jurisdiction verification enabled based on the workflow’s configuration.