corp-extractor 0.4.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

statement_extractor/plugins/base.py

@@ -0,0 +1,446 @@
+"""
+Base plugin classes for the extraction pipeline.
+
+Defines the abstract interfaces for each pipeline stage:
+- BaseSplitterPlugin: Stage 1 - Text → RawTriple
+- BaseExtractorPlugin: Stage 2 - RawTriple → PipelineStatement
+- BaseQualifierPlugin: Stage 3 - Entity → EntityQualifiers
+- BaseCanonicalizerPlugin: Stage 4 - QualifiedEntity → CanonicalMatch
+- BaseLabelerPlugin: Stage 5 - Statement → StatementLabel
+- BaseTaxonomyPlugin: Stage 6 - Statement → TaxonomyResult
+"""
+
+from abc import ABC, abstractmethod
+from enum import Flag, auto
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ..pipeline.context import PipelineContext
+    from ..models import (
+        RawTriple,
+        PipelineStatement,
+        ExtractedEntity,
+        EntityQualifiers,
+        QualifiedEntity,
+        CanonicalMatch,
+        CanonicalEntity,
+        StatementLabel,
+        TaxonomyResult,
+        EntityType,
+    )
+
+
+class PluginCapability(Flag):
+    """Flags indicating plugin capabilities."""
+    NONE = 0
+    BATCH_PROCESSING = auto()   # Can process multiple items at once
+    ASYNC_PROCESSING = auto()   # Supports async execution
+    EXTERNAL_API = auto()       # Uses external API (may have rate limits)
+    LLM_REQUIRED = auto()       # Requires an LLM model
+    CACHING = auto()            # Supports result caching
+
+
+class BasePlugin(ABC):
+    """
+    Base class for all pipeline plugins.
+
+    All plugins must implement the name property and can optionally
+    override priority and capabilities.
+    """
+
+    @property
+    @abstractmethod
+    def name(self) -> str:
+        """Unique name for this plugin (used for registration and CLI)."""
+        ...
+
+    @property
+    def priority(self) -> int:
+        """
+        Plugin priority (lower = higher priority, runs first).
+
+        Default is 100. Use lower values (e.g., 10, 20) for critical plugins
+        that should run before others.
+        """
+        return 100
+
+    @property
+    def capabilities(self) -> PluginCapability:
+        """Plugin capabilities (flags)."""
+        return PluginCapability.NONE
+
+    @property
+    def description(self) -> str:
+        """Human-readable description of this plugin."""
+        return ""
+
+
+class BaseSplitterPlugin(BasePlugin):
+    """
+    Stage 1 plugin: Split text into atomic triples.
+
+    Takes raw text and produces RawTriple objects containing
+    subject/predicate/object text and source sentence.
+    """
+
+    @abstractmethod
+    def split(
+        self,
+        text: str,
+        context: "PipelineContext",
+    ) -> list["RawTriple"]:
+        """
+        Split text into atomic triples.
+
+        Args:
+            text: Input text to split
+            context: Pipeline context for accessing metadata and config
+
+        Returns:
+            List of RawTriple objects
+        """
+        ...
+
+
+class BaseExtractorPlugin(BasePlugin):
+    """
+    Stage 2 plugin: Refine triples into statements with typed entities.
+
+    Takes RawTriple objects and produces PipelineStatement objects
+    with ExtractedEntity subjects/objects that have types, spans,
+    and confidence scores.
+    """
+
+    @abstractmethod
+    def extract(
+        self,
+        raw_triples: list["RawTriple"],
+        context: "PipelineContext",
+    ) -> list["PipelineStatement"]:
+        """
+        Extract statements from raw triples.
+
+        Args:
+            raw_triples: Raw triples from Stage 1
+            context: Pipeline context
+
+        Returns:
+            List of PipelineStatement objects with typed entities
+        """
+        ...
+
+
+class BaseQualifierPlugin(BasePlugin):
+    """
+    Stage 3 plugin: Add qualifiers and identifiers to entities.
+
+    Processes entities of specific types and adds semantic qualifiers
+    (role, org) or external identifiers (LEI, company number).
+    """
+
+    @property
+    @abstractmethod
+    def supported_entity_types(self) -> set["EntityType"]:
+        """Entity types this plugin can qualify (e.g., {ORG, PERSON})."""
+        ...
+
+    @property
+    def supported_identifier_types(self) -> list[str]:
+        """
+        Identifier types this plugin can use for lookup.
+
+        For example, GLEIFQualifier can lookup by 'lei'.
+        """
+        return []
+
+    @property
+    def provided_identifier_types(self) -> list[str]:
+        """
+        Identifier types this plugin can provide.
+
+        For example, GLEIFQualifier provides 'lei', 'jurisdiction'.
+        """
+        return []
+
+    @abstractmethod
+    def qualify(
+        self,
+        entity: "ExtractedEntity",
+        context: "PipelineContext",
+    ) -> "EntityQualifiers | None":
+        """
+        Add qualifiers to an entity.
+
+        Args:
+            entity: The entity to qualify
+            context: Pipeline context (for accessing source text, other entities)
+
+        Returns:
+            EntityQualifiers with added information, or None if nothing to add
+        """
+        ...
+
+
+class BaseCanonicalizerPlugin(BasePlugin):
+    """
+    Stage 4 plugin: Resolve entities to canonical forms.
+
+    Takes qualified entities and finds their canonical representations
+    using various matching strategies (identifier, name, fuzzy, LLM).
+    """
+
+    @property
+    @abstractmethod
+    def supported_entity_types(self) -> set["EntityType"]:
+        """Entity types this plugin can canonicalize."""
+        ...
+
+    @abstractmethod
+    def find_canonical(
+        self,
+        entity: "QualifiedEntity",
+        context: "PipelineContext",
+    ) -> "CanonicalMatch | None":
+        """
+        Find canonical form for an entity.
+
+        Args:
+            entity: Qualified entity to canonicalize
+            context: Pipeline context
+
+        Returns:
+            CanonicalMatch if found, None otherwise
+        """
+        ...
+
+    def format_fqn(
+        self,
+        entity: "QualifiedEntity",
+        match: "CanonicalMatch | None",
+    ) -> str:
+        """
+        Format the fully qualified name for display.
+
+        Can be overridden by subclasses for custom formatting.
+        Default implementation uses CanonicalEntity._generate_fqn.
+        """
+        from ..models import CanonicalEntity
+        return CanonicalEntity._generate_fqn(entity, match)
+
+
+class ClassificationSchema:
+    """
+    Schema for simple multi-choice classification (2-20 choices).
+
+    Handled by GLiNER2 `.classification()` in a single pass.
+
+    Examples:
+        - sentiment: ["positive", "negative", "neutral"]
+        - certainty: ["certain", "uncertain", "speculative"]
+        - temporality: ["past", "present", "future"]
+    """
+
+    def __init__(
+        self,
+        label_type: str,
+        choices: list[str],
+        description: str = "",
+        scope: str = "statement",  # "statement", "subject", "object", "predicate"
+    ):
+        self.label_type = label_type
+        self.choices = choices
+        self.description = description
+        self.scope = scope
+
+    def __repr__(self) -> str:
+        return f"ClassificationSchema({self.label_type!r}, choices={self.choices!r})"
+
+
+class TaxonomySchema:
+    """
+    Schema for large taxonomy labeling (100s of values).
+
+    Too many choices for GLiNER2 classification. Requires MNLI or similar:
+    - MNLI zero-shot with label descriptions
+    - Embedding-based nearest neighbor search
+    - Hierarchical classification (category → subcategory)
+
+    Examples:
+        - industry_code: NAICS/SIC codes (1000+ values)
+        - relation_type: detailed relation ontology (100+ types)
+        - job_title: standardized job taxonomy
+    """
+
+    def __init__(
+        self,
+        label_type: str,
+        values: list[str] | dict[str, list[str]],  # flat list or hierarchical dict
+        description: str = "",
+        scope: str = "statement",  # "statement", "subject", "object", "predicate"
+        label_descriptions: dict[str, str] | None = None,  # descriptions for MNLI
+    ):
+        self.label_type = label_type
+        self.values = values
+        self.description = description
+        self.scope = scope
+        self.label_descriptions = label_descriptions  # e.g., {"NAICS:5112": "Software Publishers"}
+
+    @property
+    def is_hierarchical(self) -> bool:
+        """Check if taxonomy is hierarchical (dict) vs flat (list)."""
+        return isinstance(self.values, dict)
+
+    @property
+    def all_values(self) -> list[str]:
+        """Get all taxonomy values (flattened if hierarchical)."""
+        if isinstance(self.values, list):
+            return self.values
+        # Flatten hierarchical dict
+        result = []
+        for category, subcategories in self.values.items():
+            result.append(category)
+            result.extend(subcategories)
+        return result
+
+    def __repr__(self) -> str:
+        count = len(self.all_values)
+        return f"TaxonomySchema({self.label_type!r}, {count} values)"
+
+
+class BaseLabelerPlugin(BasePlugin):
+    """
+    Stage 5 plugin: Apply labels to statements.
+
+    Adds classification labels (sentiment, relation type, confidence)
+    to the final labeled statements.
+
+    Labelers can provide a classification_schema that extractors will use
+    to run classification in a single model pass. The results are stored
+    in the pipeline context for the labeler to retrieve.
+    """
+
+    @property
+    @abstractmethod
+    def label_type(self) -> str:
+        """
+        The type of label this plugin produces.
+
+        Examples: 'sentiment', 'relation_type', 'confidence'
+        """
+        ...
+
+    @property
+    def classification_schema(self) -> ClassificationSchema | None:
+        """
+        Simple multi-choice classification schema (2-20 choices).
+
+        If provided, GLiNER2 extractor will run `.classification()` and store
+        results in context for this labeler to retrieve.
+
+        Returns:
+            ClassificationSchema or None
+        """
+        return None
+
+    @property
+    def taxonomy_schema(self) -> TaxonomySchema | None:
+        """
+        Large taxonomy schema (100s of values).
+
+        If provided, requires MNLI or embedding-based classification.
+        Results stored in context for this labeler to retrieve.
+
+        Returns:
+            TaxonomySchema or None
+        """
+        return None
+
+    @abstractmethod
+    def label(
+        self,
+        statement: "PipelineStatement",
+        subject_canonical: "CanonicalEntity",
+        object_canonical: "CanonicalEntity",
+        context: "PipelineContext",
+    ) -> "StatementLabel | None":
+        """
+        Apply a label to a statement.
+
+        Args:
+            statement: The statement to label
+            subject_canonical: Canonicalized subject entity
+            object_canonical: Canonicalized object entity
+            context: Pipeline context (check context.classification_results for pre-computed labels)
+
+        Returns:
+            StatementLabel if applicable, None otherwise
+        """
+        ...
+
+
+class BaseTaxonomyPlugin(BasePlugin):
+    """
+    Stage 6 plugin: Classify statements against a taxonomy.
+
+    Taxonomy classification is separate from labeling because:
+    - It operates on large taxonomies (100s-1000s of labels)
+    - It requires specialized models (MNLI, embeddings)
+    - It's computationally heavier than simple labeling
+
+    Taxonomy plugins produce TaxonomyResult objects that are stored
+    in the pipeline context.
+    """
+
+    @property
+    @abstractmethod
+    def taxonomy_name(self) -> str:
+        """
+        Name of the taxonomy this plugin classifies against.
+
+        Examples: 'esg_topics', 'industry_codes', 'relation_types'
+        """
+        ...
+
+    @property
+    def taxonomy_schema(self) -> TaxonomySchema | None:
+        """
+        The taxonomy schema this plugin uses.
+
+        Returns:
+            TaxonomySchema describing the taxonomy structure
+        """
+        return None
+
+    @property
+    def supported_categories(self) -> list[str]:
+        """
+        List of taxonomy categories this plugin supports.
+
+        Returns empty list if all categories are supported.
+        """
+        return []
+
+    @abstractmethod
+    def classify(
+        self,
+        statement: "PipelineStatement",
+        subject_canonical: "CanonicalEntity",
+        object_canonical: "CanonicalEntity",
+        context: "PipelineContext",
+    ) -> list["TaxonomyResult"]:
+        """
+        Classify a statement against the taxonomy.
+
+        Returns all labels above the confidence threshold. A single statement
+        may have multiple applicable taxonomy labels.
+
+        Args:
+            statement: The statement to classify
+            subject_canonical: Canonicalized subject entity
+            object_canonical: Canonicalized object entity
+            context: Pipeline context
+
+        Returns:
+            List of TaxonomyResult objects (empty if none above threshold)
+        """
+        ...

statement_extractor/plugins/canonicalizers/__init__.py

@@ -0,0 +1,17 @@
+"""
+Canonicalizer plugins for Stage 4 (Canonicalization).
+
+Resolves entities to their canonical forms.
+"""
+
+from .base import BaseCanonicalizerPlugin
+from .organization import OrganizationCanonicalizer
+from .person import PersonCanonicalizer
+from .location import LocationCanonicalizer
+
+__all__ = [
+    "BaseCanonicalizerPlugin",
+    "OrganizationCanonicalizer",
+    "PersonCanonicalizer",
+    "LocationCanonicalizer",
+]

statement_extractor/plugins/canonicalizers/base.py

@@ -0,0 +1,9 @@
+"""
+Base class for canonicalizer plugins.
+
+Re-exports BaseCanonicalizerPlugin from the main plugins module.
+"""
+
+from ..base import BaseCanonicalizerPlugin
+
+__all__ = ["BaseCanonicalizerPlugin"]

statement_extractor/plugins/canonicalizers/location.py

@@ -0,0 +1,219 @@
+"""
+LocationCanonicalizer - Resolves location entities to canonical forms.
+
+Uses:
+1. ISO country code exact match
+2. Known city/country mappings
+3. Geohash matching for coordinates (if available)
+"""
+
+import logging
+from typing import Optional
+
+from ..base import BaseCanonicalizerPlugin, PluginCapability
+from ...pipeline.context import PipelineContext
+from ...pipeline.registry import PluginRegistry
+from ...models import QualifiedEntity, CanonicalMatch, EntityType
+
+logger = logging.getLogger(__name__)
+
+# Common country name variations
+COUNTRY_ALIASES = {
+    "usa": "United States",
+    "us": "United States",
+    "united states of america": "United States",
+    "u.s.": "United States",
+    "u.s.a.": "United States",
+    "america": "United States",
+    "uk": "United Kingdom",
+    "u.k.": "United Kingdom",
+    "great britain": "United Kingdom",
+    "britain": "United Kingdom",
+    "england": "United Kingdom",
+    "uae": "United Arab Emirates",
+    "prc": "China",
+    "peoples republic of china": "China",
+    "people's republic of china": "China",
+}
+
+# ISO 3166-1 alpha-2 codes for common countries
+ISO_CODES = {
+    "united states": "US",
+    "united kingdom": "GB",
+    "china": "CN",
+    "germany": "DE",
+    "france": "FR",
+    "japan": "JP",
+    "canada": "CA",
+    "australia": "AU",
+    "india": "IN",
+    "brazil": "BR",
+    "russia": "RU",
+    "italy": "IT",
+    "spain": "ES",
+    "mexico": "MX",
+    "south korea": "KR",
+    "netherlands": "NL",
+    "switzerland": "CH",
+    "singapore": "SG",
+    "hong kong": "HK",
+    "ireland": "IE",
+}
+
+# Well-known cities to countries
+CITY_COUNTRY_MAP = {
+    "new york": ("New York", "United States"),
+    "nyc": ("New York", "United States"),
+    "london": ("London", "United Kingdom"),
+    "paris": ("Paris", "France"),
+    "tokyo": ("Tokyo", "Japan"),
+    "beijing": ("Beijing", "China"),
+    "shanghai": ("Shanghai", "China"),
+    "san francisco": ("San Francisco", "United States"),
+    "sf": ("San Francisco", "United States"),
+    "los angeles": ("Los Angeles", "United States"),
+    "la": ("Los Angeles", "United States"),
+    "chicago": ("Chicago", "United States"),
+    "berlin": ("Berlin", "Germany"),
+    "sydney": ("Sydney", "Australia"),
+    "toronto": ("Toronto", "Canada"),
+    "singapore": ("Singapore", "Singapore"),
+    "hong kong": ("Hong Kong", "China"),
+    "mumbai": ("Mumbai", "India"),
+    "bangalore": ("Bangalore", "India"),
+    "dublin": ("Dublin", "Ireland"),
+    "amsterdam": ("Amsterdam", "Netherlands"),
+    "zurich": ("Zurich", "Switzerland"),
+}
+
+
+def normalize_location(name: str) -> str:
+    """Normalize a location name for matching."""
+    return name.strip().lower().replace(".", "")
+
+
+@PluginRegistry.canonicalizer
+class LocationCanonicalizer(BaseCanonicalizerPlugin):
+    """
+    Canonicalizer for location entities (GPE, LOC).
+
+    Uses standardized country codes and known city mappings.
+    """
+
+    @property
+    def name(self) -> str:
+        return "location_canonicalizer"
+
+    @property
+    def priority(self) -> int:
+        return 10
+
+    @property
+    def capabilities(self) -> PluginCapability:
+        return PluginCapability.CACHING
+
+    @property
+    def description(self) -> str:
+        return "Resolves location entities using ISO codes and known mappings"
+
+    @property
+    def supported_entity_types(self) -> set[EntityType]:
+        return {EntityType.GPE, EntityType.LOC}
+
+    def find_canonical(
+        self,
+        entity: QualifiedEntity,
+        context: PipelineContext,
+    ) -> Optional[CanonicalMatch]:
+        """
+        Find canonical form for a location entity.
+
+        Args:
+            entity: Qualified entity to canonicalize
+            context: Pipeline context
+
+        Returns:
+            CanonicalMatch if found
+        """
+        normalized = normalize_location(entity.original_text)
+
+        # Check country aliases
+        if normalized in COUNTRY_ALIASES:
+            canonical_name = COUNTRY_ALIASES[normalized]
+            iso_code = ISO_CODES.get(canonical_name.lower())
+
+            return CanonicalMatch(
+                canonical_id=iso_code,
+                canonical_name=canonical_name,
+                match_method="name_exact",
+                match_confidence=1.0,
+                match_details={"match_type": "country_alias"},
+            )
+
+        # Check ISO codes directly
+        if normalized in ISO_CODES:
+            canonical_name = normalized.title()
+            iso_code = ISO_CODES[normalized]
+
+            return CanonicalMatch(
+                canonical_id=iso_code,
+                canonical_name=canonical_name,
+                match_method="name_exact",
+                match_confidence=1.0,
+                match_details={"match_type": "country_name"},
+            )
+
+        # Check city mappings
+        if normalized in CITY_COUNTRY_MAP:
+            city_name, country_name = CITY_COUNTRY_MAP[normalized]
+            iso_code = ISO_CODES.get(country_name.lower())
+
+            return CanonicalMatch(
+                canonical_id=iso_code,
+                canonical_name=city_name,
+                match_method="name_exact",
+                match_confidence=0.95,
+                match_details={"match_type": "city_mapping", "country": country_name},
+            )
+
+        # Check qualifiers for country info
+        if entity.qualifiers.country:
+            country_normalized = normalize_location(entity.qualifiers.country)
+            if country_normalized in ISO_CODES:
+                return CanonicalMatch(
+                    canonical_id=ISO_CODES[country_normalized],
+                    canonical_name=entity.original_text,
+                    match_method="identifier",
+                    match_confidence=0.9,
+                    match_details={"match_type": "qualifier_country"},
+                )
+
+        return None
+
+    def format_fqn(
+        self,
+        entity: QualifiedEntity,
+        match: Optional[CanonicalMatch],
+    ) -> str:
+        """Format FQN for a location."""
+        base_name = match.canonical_name if match else entity.original_text
+
+        parts = []
+
+        # Add country if it's a city
+        if match and match.match_details:
+            country = match.match_details.get("country")
+            if country:
+                parts.append(country)
+
+        # Add ISO code
+        if match and match.canonical_id:
+            parts.append(match.canonical_id)
+
+        if parts:
+            return f"{base_name} ({', '.join(parts)})"
+        return base_name
+
+
+# Allow importing without decorator for testing
+LocationCanonicalizerClass = LocationCanonicalizer