cognee/cognee/infrastructure/entities/BaseEntityExtractor.py
Daniel Molnar b5ebed1f7d
Docstring infrastructure. (#880)
<!-- .github/pull_request_template.md -->

## Description
<!-- Provide a clear description of the changes in this PR -->

## DCO Affirmation
I affirm that all code in every commit of this pull request conforms to
the terms of the Topoteretes Developer Certificate of Origin.
2025-05-28 17:47:31 +02:00

29 lines
909 B
Python

from abc import ABC, abstractmethod
from typing import List
from cognee.modules.engine.models import Entity
class BaseEntityExtractor(ABC):
"""
Base class for entity extraction strategies.
This class defines the interface for entity extraction methods that derived classes must
implement. It serves as a blueprint for entity extraction strategies.
"""
@abstractmethod
async def extract_entities(self, text: str) -> List[Entity]:
"""
Extract entities from the given text.
This is an abstract method that must be implemented by any subclass of
BaseEntityExtractor. The implementation should take a string as input and return a list
of extracted entities, defined by the Entity type.
Parameters:
-----------
- text (str): A string containing the text from which to extract entities.
"""
pass