--- title: "Semantic Extract Module" description: "Named entity recognition, relation extraction, event detection, and triplet generation." icon: "magnifying-glass-chart" --- `semantica.semantic_extract` extracts structured information from unstructured text — the foundation of every knowledge graph in Semantica. All extractors support three modes: pattern-based (no API key), ML-based, and LLM-based. ## Exported Classes `NamedEntityRecognizer` is the high-level coordinator with confidence thresholding and overlap merging. `NERExtractor` is the lower-level implementation. For most use cases, start with `NERExtractor` for simplicity or `NamedEntityRecognizer` for fine-grained control. | Class | Role | | --- | --- | | `NamedEntityRecognizer` | High-level NER with confidence thresholding and overlap merging | | `NERExtractor` | Core NER implementation — use directly for simplicity | | `RelationExtractor` | Typed relationship extraction (`founded_by`, `located_in`, ...) | | `TripletExtractor` | Direct `(subject, predicate, object)` triplet generation for RDF output | | `EventDetector` | Event detection with participants, temporal context, and confidence scores | | `CoreferenceResolver` | Resolve "Apple" and "the company" to the same canonical entity | | `Entity` | `{id, text, type, confidence, start, end}` | | `Relation` | `{subject, predicate, object, confidence}` | | `Event` | `{type, participants, temporal, location, confidence}` | ## Quick Start ```python from semantica.semantic_extract import NERExtractor, RelationExtractor, TripletExtractor from semantica.llms import Groq import os text = "Apple Inc. was founded by Steve Jobs in Cupertino in 1976." llm = Groq(model="llama-3.3-70b-versatile", api_key=os.getenv("GROQ_API_KEY")) entities = NERExtractor(method="llm", llm_provider=llm).extract(text) relationships = RelationExtractor(method="llm", llm_provider=llm).extract(text, entities=entities) triplets = TripletExtractor(method="llm", llm_provider=llm).extract(text) ``` Semantic extraction pipeline: raw text fans into NER, Relation, and Coreference extractors, then merges into a Triplet Generator ## Extractor Methods | Method | Returns | Description | | ------ | ------- | ----------- | | `extract(text)` | `List[Entity]` / `List[Relation]` / `List[Triplet]` / `List[Event]` | Extract from single text input | | `extract_batch(texts, batch_size)` | `List[List[...]]` | Process multiple texts in parallel | ## NERExtractor ```python from semantica.semantic_extract import NERExtractor from semantica.llms import Groq import os # Pattern-based — fast, no API key, good for standard entity types ner = NERExtractor(method="pattern") entities = ner.extract("Apple Inc. was founded by Steve Jobs in Cupertino.") # ML-based — higher accuracy, no API cost ner = NERExtractor(method="ml", model="dslim/bert-large-NER") entities = ner.extract(text) # LLM-based — best accuracy, handles complex schemas and custom types llm = Groq(model="llama-3.3-70b-versatile", api_key=os.getenv("GROQ_API_KEY")) ner = NERExtractor(method="llm", llm_provider=llm, max_retries=3) entities = ner.extract(text) ``` Output format: ```python [ {"text": "Apple Inc.", "type": "ORGANIZATION", "confidence": 0.98, "start": 0, "end": 10}, {"text": "Steve Jobs", "type": "PERSON", "confidence": 0.99, "start": 27, "end": 37}, {"text": "Cupertino", "type": "LOCATION", "confidence": 0.97, "start": 41, "end": 50} ] ``` ### Custom Entity Types ```python ner = NERExtractor( method="pattern", custom_entities={ "DRUG": ["aspirin", "ibuprofen", "metformin"], "GENE": ["BRCA1", "TP53", "EGFR"] } ) ``` **v0.5.0 fix:** `NERExtractor(method="llm")` no longer silently falls back to pattern extraction on custom gateways. The `response_format=json_object` parameter is now conditionally omitted for incompatible gateways, with a plain `generate()` + JSON parsing fallback applied automatically. ## RelationExtractor ```python from semantica.semantic_extract import RelationExtractor rel = RelationExtractor(method="llm", llm_provider=llm, max_retries=3) relationships = rel.extract(text, entities=entities) ``` Output format: ```python [ {"subject": "Steve Jobs", "predicate": "founded", "object": "Apple Inc.", "confidence": 0.92}, {"subject": "Apple Inc.", "predicate": "located_in", "object": "Cupertino", "confidence": 0.89} ] ``` Available methods: `"rule"` (pattern-based), `"ml"` (REBEL model), `"llm"`. ## TripletExtractor Generate RDF-ready `(subject, predicate, object)` triplets directly from text: ```python from semantica.semantic_extract import TripletExtractor trip = TripletExtractor(method="llm", llm_provider=llm) triplets = trip.extract(text) # → [{"subject": "Steve Jobs", "predicate": "founded", "object": "Apple Inc.", ...}] ``` Triplets are suitable for loading directly into a triplet store or knowledge graph. ## EventDetector Detect events with participants and temporal context: ```python from typing import List from semantica.semantic_extract import EventDetector, Event extractor = EventDetector(method="llm", llm_provider=llm) events: List[Event] = extractor.extract(text) for event in events: print(f"Event type: {event.type}") print(f"Participants: {event.participants}") print(f"Temporal: {event.temporal}") print(f"Confidence: {event.confidence:.2f}") ``` Output fields per event: `type`, `participants` (with roles), `temporal`, `location`, and `confidence`. ## CoreferenceResolver Resolve pronoun and alias references to canonical entities before extraction: ```python from semantica.semantic_extract import CoreferenceResolver resolver = CoreferenceResolver() resolved_text = resolver.resolve( "Apple Inc. was founded in 1976. The company is headquartered in Cupertino." ) # "Apple Inc." replaces "The company" for consistent downstream extraction ``` ## Batch Processing All extractors support batch input for efficient large-scale processing: ```python texts = ["Text 1...", "Text 2...", "Text 3..."] ner = NERExtractor(method="llm", llm_provider=llm) batch_results = ner.extract_batch(texts, batch_size=10) ``` ## Using All Extractors Together The standard extraction pipeline — entities → relationships → triplets: ```python from semantica.semantic_extract import NERExtractor, RelationExtractor, TripletExtractor from semantica.llms import Groq import os llm = Groq(model="llama-3.3-70b-versatile", api_key=os.getenv("GROQ_API_KEY")) ner = NERExtractor(method="llm", llm_provider=llm, max_retries=3) rel = RelationExtractor(method="llm", llm_provider=llm, max_retries=3) trip = TripletExtractor(method="llm", llm_provider=llm, max_retries=3) entities = ner.extract(text) relationships = rel.extract(text, entities=entities) triplets = trip.extract(text) ``` ## Extraction Method Comparison | Method | Speed | Cost | Accuracy | Custom Types | | ------ | ----- | ---- | -------- | ------------ | | `pattern` | Very fast | Free | Medium | Yes (dictionary) | | `ml` | Fast | Free | High | Limited | | `llm` | Medium | API cost | Highest | Yes (schema) | Configure which LLM is used for extraction. Build graphs from extracted entities and relationships. Parse documents before extraction. Resolve duplicate entities after extraction.