class squirro.lib.nlp.steps.filters.SquirroEntityFilter(config)

Bases: squirro.lib.nlp.steps.filters.Filter

Takes a set of fields and creates Squirro entities

  • entity_name (str, None) – Name of entity (defaults to entity_type)

  • entity_name_field (str, None) – Field with entity name (defaults to entity_name if None)

  • entity_type (str) – Type of entity

  • excluded_values (list, []) – Values that will not be added as entity properties

  • extract_field (str) – Field with list of text extracts

  • format_values (bool, False) – Whether or not to format string values as titles

  • global_property_field_map (dict, {}) – Map for fields with properties that are copied in from the item

  • output_field (str, 'entities') – Field to write resulting entities

  • property_field_map (dict, {}) – Map for fields with properties that match the number of extracts

  • property_value_map (dict, {}) – Map for renaming values of fields with properties that match the number of extracts

  • static_properties (dict, {}) – Map of static property values to attach to entities

  • required_properties (list, []) – Properties that must exist (after exclusion) for the entity to be added

  • source_field (str, '') – Field where extracted text originated

  • source_fields (list, []) – List of fields where extracted text originated

Methods Summary


Process a document

Methods Documentation


Process a document


doc (Document) – Document


Processed document

Return type