extractor-api-lib 3.3.0__tar.gz

extractor_api_lib-3.3.0/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.3
+Name: extractor-api-lib
+Version: 3.3.0
+Summary: Extracts the content of documents, websites, etc and maps it to a common format.
+License: Apache-2.0
+Author: STACKIT GmbH & Co. KG
+Author-email: data-ai@stackit.cloud
+Maintainer: Andreas Klos
+Maintainer-email: andreas.klos@stackit.cloud
+Requires-Python: >=3.13,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: atlassian-python-api (>=4.0.3,<5.0.0)
+Requires-Dist: boto3 (>=1.38.10,<2.0.0)
+Requires-Dist: botocore (>=1.38.10,<2.0.0)
+Requires-Dist: camelot-py[cv] (>=1.0.0,<2.0.0)
+Requires-Dist: datasets (>=3.5.1,<4.0.0)
+Requires-Dist: debugpy (>=1.8.14,<2.0.0)
+Requires-Dist: dependency-injector (>=4.46.0,<5.0.0)
+Requires-Dist: docx2txt (>=0.9,<0.10)
+Requires-Dist: fake-useragent (>=2.2.0,<3.0.0)
+Requires-Dist: fastapi (>=0.118.0,<0.119.0)
+Requires-Dist: fasttext (>=0.9.3,<0.10.0)
+Requires-Dist: html5lib (>=1.1,<2.0)
+Requires-Dist: langchain-community (>=0.3.23,<0.4.0)
+Requires-Dist: langchain-core (==0.3.77)
+Requires-Dist: lxml (>=5.4.0,<6.0.0)
+Requires-Dist: markdownify (>=1.1.0,<2.0.0)
+Requires-Dist: numpy (>=2.2.5,<3.0.0)
+Requires-Dist: oauthlib (>=3.2.2,<4.0.0)
+Requires-Dist: opencv-python (==4.12.0.88)
+Requires-Dist: pandas (>=2.2.2,<3.0.0)
+Requires-Dist: partial (>=1.0,<2.0)
+Requires-Dist: pdf2image (==1.17.0)
+Requires-Dist: pdfplumber (==0.11.7)
+Requires-Dist: pydantic-settings (>=2.9.1,<3.0.0)
+Requires-Dist: pypandoc-binary (>=1.15,<2.0)
+Requires-Dist: pypdfium2 (==4.30.0)
+Requires-Dist: pytesseract (>=0.3.10,<0.4.0)
+Requires-Dist: python-multipart (>=0.0.20,<0.0.21)
+Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
+Requires-Dist: requests-oauthlib (>=2.0.0,<3.0.0)
+Requires-Dist: starlette (>=0.47.2,<0.49.0)
+Requires-Dist: tabulate (>=0.9.0,<0.10.0)
+Requires-Dist: unstructured[docx,pptx] (==0.18.15)
+Requires-Dist: uvicorn (>=0.37.0,<0.38.0)
+Requires-Dist: wheel (>=0.45.1,<0.46.0)
+Project-URL: Homepage, https://pypi.org/project/extractor-api-lib
+Project-URL: Repository, https://github.com/stackitcloud/rag-template
+Description-Content-Type: text/markdown
+
+# extractor-api-lib
+
+Content ingestion layer for the STACKIT RAG template. This library exposes a FastAPI extraction service that ingests raw documents (files or remote sources), extracts and converts (to internal representations) the information, and hands output to [`admin-api-lib`](../admin-api-lib/).
+
+## Responsibilities
+
+- Receive binary uploads and remote source descriptors from the admin backend.
+- Route each request through the appropriate extractor (file, sitemap, Confluence, etc.).
+- Convert extracted fragments into the shared `InformationPiece` schema expected by downstream services.
+
+## Feature highlights
+
+- **Broad format coverage** – PDFs, DOCX, PPTX, XML/EPUB, Confluence spaces, and sitemap-driven websites.
+- **Consistent output schema** – Information pieces are returned in a unified structure with content type (`TEXT`, `TABLE`, `IMAGE`) and metadata.
+- **Swappable extractors** – Dependency-injector container makes it easy to add or replace file/source extractors, table converters, etc.
+- **Production-grade plumbing** – Built-in S3-compatible file service, LangChain loaders with retry/backoff, optional PDF OCR, and throttling controls for web crawls.
+
+## Installation
+
+```bash
+pip install extractor-api-lib
+```
+
+Python 3.13 is required. OCR and computer-vision features expect system packages such as `ffmpeg`, `poppler-utils`, and `tesseract` (see `services/document-extractor/README.md` for the full list).
+
+## Module tour
+
+- `dependency_container.py` – Central dependency-injector wiring. Override providers here to plug in custom extractors, endpoints etc.
+- `api_endpoints/` & `impl/api_endpoints/` – Thin FastAPI endpoint abstractions and implementations for file and source (like confluence & sitemaps) extractors.
+- `apis/` – Extractor API abstractions and implementations.
+- `extractors/` & `impl/extractors/` – Format-specific logic (PDF, DOCX, PPTX, XML, EPUB, Confluence, sitemap) packaged behind the `InformationExtractor`/`InformationFileExtractor` interfaces.
+- `mapper/` & `impl/mapper/` – Abstractions and implementations to map langchain documents, internal and external information piece representations to each other.
+- `file_services/` – Default S3-compatible storage adapter; replace it if you store files elsewhere.
+- `impl/settings/` – Configuration settings for dependency injection container components.
+- `table_converter/` & `impl/table_converter/` – Abstractions and implementations to convert `pandas.DataFrame` to markdown and vice versa.
+- `impl/types/` - Enums for content-, extractor- and file types.
+- `impl/utils/` – Helper functions for hashed datetime and sitemap crawling, header injection, and custom metadata parsing.
+
+## Endpoints provided
+
+- `POST /extract_from_file` – Downloads the file from S3, extracts its contents, and returns normalized `InformationPiece` records.
+- `POST /extract_from_source` – Pulls from remote sources (Confluence, sitemap) using credentials and further optional kwargs.
+
+Both endpoints stream their results back to `admin-api-lib`, which takes care of enrichment and persistence.
+
+## How the file extraction endpoint works
+
+1. Download the file from S3
+2. Chose suitable file extractor based on the filename ending
+3. Extract the content from the file
+4. Map the internal representation to the external schema
+5. Return the final output
+
+## How the source extraction endpoint works
+
+1. Chose suitable source extractor based on the source type
+2. Pull the source content using the provided credentials and parameters
+3. Extract the content from the source
+4. Map the internal representation to the external schema
+5. Return the final output
+
+## Configuration overview
+
+Two `pydantic-settings` models ship with this package:
+
+- **S3 storage** (`S3Settings`) – configure the built-in file service with `S3_ACCESS_KEY_ID`, `S3_SECRET_ACCESS_KEY`, `S3_ENDPOINT`, and `S3_BUCKET`.
+- **PDF extraction** (`PDFExtractorSettings`) – adjust footer trimming or diagram export via `PDF_EXTRACTOR_FOOTER_HEIGHT` and `PDF_EXTRACTOR_DIAGRAMS_FOLDER_NAME`.
+
+Other extractors accept their parameters at runtime through the request payload (`ExtractionParameters`). For example, the admin backend forwards Confluence credentials, sitemap URLs, or custom headers when it calls `/extract_from_source`. This keeps the library stateless and makes it easy to plug in additional sources without redeploying.
+
+The Helm chart exposes the environment variables mentioned above under `documentExtractor.envs.*` so production deployments remain declarative.
+
+## Typical usage
+
+```python
+from extractor_api_lib.main import app as perfect_extractor_app
+```
+
+`admin-api-lib` calls `/extract_from_file` and `/extract_from_source` to populate the ingestion pipeline.
+
+## Extending the library
+
+1. Implement `InformationFileExtractor` or `InformationExtractor` for your new format/source.
+2. Register it in `dependency_container.py` (append to `file_extractors` list or `source_extractors` dict).
+3. Update mapper or metadata handling if additional fields are required.
+4. Add unit tests under `libs/extractor-api-lib/tests` using fixtures and fake storage providers.
+
+## Contributing
+
+Ensure new endpoints or adapters remain thin and defer to [`rag-core-lib`](../rag-core-lib/) for shared logic. Run `poetry run pytest` and the configured linters before opening a PR. For further instructions see the [Contributing Guide](https://github.com/stackitcloud/rag-template/blob/main/CONTRIBUTING.md).
+
+## License
+
+Licensed under the project license. See the root [`LICENSE`](https://github.com/stackitcloud/rag-template/blob/main/LICENSE) file.
+

extractor_api_lib-3.3.0/README.md

@@ -0,0 +1,94 @@
+# extractor-api-lib
+
+Content ingestion layer for the STACKIT RAG template. This library exposes a FastAPI extraction service that ingests raw documents (files or remote sources), extracts and converts (to internal representations) the information, and hands output to [`admin-api-lib`](../admin-api-lib/).
+
+## Responsibilities
+
+- Receive binary uploads and remote source descriptors from the admin backend.
+- Route each request through the appropriate extractor (file, sitemap, Confluence, etc.).
+- Convert extracted fragments into the shared `InformationPiece` schema expected by downstream services.
+
+## Feature highlights
+
+- **Broad format coverage** – PDFs, DOCX, PPTX, XML/EPUB, Confluence spaces, and sitemap-driven websites.
+- **Consistent output schema** – Information pieces are returned in a unified structure with content type (`TEXT`, `TABLE`, `IMAGE`) and metadata.
+- **Swappable extractors** – Dependency-injector container makes it easy to add or replace file/source extractors, table converters, etc.
+- **Production-grade plumbing** – Built-in S3-compatible file service, LangChain loaders with retry/backoff, optional PDF OCR, and throttling controls for web crawls.
+
+## Installation
+
+```bash
+pip install extractor-api-lib
+```
+
+Python 3.13 is required. OCR and computer-vision features expect system packages such as `ffmpeg`, `poppler-utils`, and `tesseract` (see `services/document-extractor/README.md` for the full list).
+
+## Module tour
+
+- `dependency_container.py` – Central dependency-injector wiring. Override providers here to plug in custom extractors, endpoints etc.
+- `api_endpoints/` & `impl/api_endpoints/` – Thin FastAPI endpoint abstractions and implementations for file and source (like confluence & sitemaps) extractors.
+- `apis/` – Extractor API abstractions and implementations.
+- `extractors/` & `impl/extractors/` – Format-specific logic (PDF, DOCX, PPTX, XML, EPUB, Confluence, sitemap) packaged behind the `InformationExtractor`/`InformationFileExtractor` interfaces.
+- `mapper/` & `impl/mapper/` – Abstractions and implementations to map langchain documents, internal and external information piece representations to each other.
+- `file_services/` – Default S3-compatible storage adapter; replace it if you store files elsewhere.
+- `impl/settings/` – Configuration settings for dependency injection container components.
+- `table_converter/` & `impl/table_converter/` – Abstractions and implementations to convert `pandas.DataFrame` to markdown and vice versa.
+- `impl/types/` - Enums for content-, extractor- and file types.
+- `impl/utils/` – Helper functions for hashed datetime and sitemap crawling, header injection, and custom metadata parsing.
+
+## Endpoints provided
+
+- `POST /extract_from_file` – Downloads the file from S3, extracts its contents, and returns normalized `InformationPiece` records.
+- `POST /extract_from_source` – Pulls from remote sources (Confluence, sitemap) using credentials and further optional kwargs.
+
+Both endpoints stream their results back to `admin-api-lib`, which takes care of enrichment and persistence.
+
+## How the file extraction endpoint works
+
+1. Download the file from S3
+2. Chose suitable file extractor based on the filename ending
+3. Extract the content from the file
+4. Map the internal representation to the external schema
+5. Return the final output
+
+## How the source extraction endpoint works
+
+1. Chose suitable source extractor based on the source type
+2. Pull the source content using the provided credentials and parameters
+3. Extract the content from the source
+4. Map the internal representation to the external schema
+5. Return the final output
+
+## Configuration overview
+
+Two `pydantic-settings` models ship with this package:
+
+- **S3 storage** (`S3Settings`) – configure the built-in file service with `S3_ACCESS_KEY_ID`, `S3_SECRET_ACCESS_KEY`, `S3_ENDPOINT`, and `S3_BUCKET`.
+- **PDF extraction** (`PDFExtractorSettings`) – adjust footer trimming or diagram export via `PDF_EXTRACTOR_FOOTER_HEIGHT` and `PDF_EXTRACTOR_DIAGRAMS_FOLDER_NAME`.
+
+Other extractors accept their parameters at runtime through the request payload (`ExtractionParameters`). For example, the admin backend forwards Confluence credentials, sitemap URLs, or custom headers when it calls `/extract_from_source`. This keeps the library stateless and makes it easy to plug in additional sources without redeploying.
+
+The Helm chart exposes the environment variables mentioned above under `documentExtractor.envs.*` so production deployments remain declarative.
+
+## Typical usage
+
+```python
+from extractor_api_lib.main import app as perfect_extractor_app
+```
+
+`admin-api-lib` calls `/extract_from_file` and `/extract_from_source` to populate the ingestion pipeline.
+
+## Extending the library
+
+1. Implement `InformationFileExtractor` or `InformationExtractor` for your new format/source.
+2. Register it in `dependency_container.py` (append to `file_extractors` list or `source_extractors` dict).
+3. Update mapper or metadata handling if additional fields are required.
+4. Add unit tests under `libs/extractor-api-lib/tests` using fixtures and fake storage providers.
+
+## Contributing
+
+Ensure new endpoints or adapters remain thin and defer to [`rag-core-lib`](../rag-core-lib/) for shared logic. Run `poetry run pytest` and the configured linters before opening a PR. For further instructions see the [Contributing Guide](https://github.com/stackitcloud/rag-template/blob/main/CONTRIBUTING.md).
+
+## License
+
+Licensed under the project license. See the root [`LICENSE`](https://github.com/stackitcloud/rag-template/blob/main/LICENSE) file.

extractor_api_lib-3.3.0/pyproject.toml

@@ -0,0 +1,152 @@
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name = "extractor-api-lib"
+version = "v3.3.0"
+description = "Extracts the content of documents, websites, etc and maps it to a common format."
+authors = [
+    "STACKIT GmbH & Co. KG <data-ai@stackit.cloud>",
+]
+maintainers = [
+    "Andreas Klos <andreas.klos@stackit.cloud>",
+]
+packages = [{ include = "extractor_api_lib", from = "src" }]
+readme = "README.md"
+license = "Apache-2.0"
+repository = "https://github.com/stackitcloud/rag-template"
+homepage = "https://pypi.org/project/extractor-api-lib"
+
+[[tool.poetry.source]]
+name = "pytorch_cpu"
+url = "https://download.pytorch.org/whl/cpu"
+priority = "explicit"
+
+[tool.flake8]
+exclude = [".eggs", "./src/extractor_api_lib/models/*", ".git", ".hg", ".mypy_cache", ".tox", ".venv", ".devcontainer", "venv", "_build", "buck-out", "build", "dist", "**/__init__.py", "tests/test_data/generate_test_pdfs.py"]
+statistics = true
+show-source = false
+max-complexity = 10
+max-annotations-complexity = 3
+docstring-convent = 'numpy'
+max-line-length = 120
+ignore = ["E203", "W503", "E704"]
+inline-quotes = '"'
+docstring-quotes = '"""'
+multiline-quotes = '"""'
+dictionaries = ["en_US", "python", "technical", "pandas"]
+ban-relative-imports = true
+per-file-ignores = """
+  ./src/extractor_api_lib/apis/extractor_api.py: B008,WOT001,
+  ./src/extractor_api_lib/impl/extractor_api_impl.py: B008,
+  ./src/extractor_api_lib/container.py: CCE002,CCE001,
+  ./src/extractor_api_lib/apis/extractor_api_base.py: WOT001,
+  ./tests/*: S101,E501,
+"""
+
+[tool.black]
+line-length = 120
+exclude = """
+/(
+  |  .eggs
+  |  .git
+  |  .hg
+  |  .mypy_cache
+  |  .nox
+  |  .pants.d
+  |  .tox
+  |  .venv
+  |  _build
+  |  buck-out
+  |  build
+  |  dist
+  |  node_modules
+  |  venv
+)/
+"""
+
+[tool.isort]
+profile = "black"
+skip = ['.eggs', '.git', '.hg', '.mypy_cache', '.nox', '.pants.d', '.tox', '.venv', '_build', 'buck-out', 'build', 'dist', 'node_modules', 'venv']
+skip_gitignore = true
+known_local_folder = ["extractor_api_lib", "rag_core_lib"]
+
+[tool.pylint]
+max-line-length = 120
+
+[tool.poetry.dependencies]
+python = "^3.13"
+wheel = "^0.45.1"
+botocore = "^1.38.10"
+fasttext = "^0.9.3"
+pytesseract = "^0.3.10"
+fastapi = "^0.118.0"
+uvicorn = "^0.37.0"
+dependency-injector = "^4.46.0"
+pydantic-settings = "^2.9.1"
+boto3 = "^1.38.10"
+debugpy = "^1.8.14"
+python-multipart = "^0.0.20"
+oauthlib = "^3.2.2"
+requests-oauthlib = "^2.0.0"
+pdfplumber = "0.11.7"
+opencv-python = "4.12.0.88"
+pdf2image = "1.17.0"
+datasets = "^3.5.1"
+pandas = "^2.2.2"
+tabulate = "^0.9.0"
+lxml = "^5.4.0"
+partial = "^1.0"
+pyyaml = "^6.0.2"
+numpy = "^2.2.5"
+docx2txt = "^0.9"
+unstructured = {extras = ["docx", "pptx"], version = "0.18.15"}
+html5lib = "^1.1"
+langchain-community = "^0.3.23"
+atlassian-python-api = "^4.0.3"
+markdownify = "^1.1.0"
+langchain-core = "0.3.77"
+camelot-py = {extras = ["cv"], version = "^1.0.0"}
+fake-useragent = "^2.2.0"
+pypdfium2 = "4.30.0"
+pypandoc-binary = "^1.15"
+starlette = ">=0.47.2,<0.49.0"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.3.5"
+pytest-asyncio = "^0.26.0"
+coverage = "^7.8.0"
+flake8 = "^7.2.0"
+flake8-black = "^0.4.0"
+flake8-pyproject = "^1.2.3"
+flake8-quotes = "^3.4.0"
+flake8-return = "^1.2.0"
+flake8-annotations-complexity = "^0.1.0"
+flake8-bandit = "^4.1.1"
+flake8-bugbear = "^24.12.12"
+flake8-builtins = "^2.5.0"
+flake8-comprehensions = "^3.15.0"
+flake8-eradicate = "^1.5.0"
+flake8-expression-complexity = "^0.0.11"
+flake8-pytest-style = "^2.1.0"
+pep8-naming = "^0.15.1"
+flake8-eol = "^0.0.8"
+flake8-exceptions = "^0.0.1a0"
+flake8-simplify = "^0.22.0"
+flake8-wot = "^0.2.0"
+flake8-function-order = "^0.0.5"
+flake8-tidy-imports = "^4.10.0"
+black = "^25.1.0"
+# flake8-logging-format = "^2024.24.12"
+# flake8-docstrings = "^1.7.0"
+
+[tool.poetry.group.tests.dependencies]
+httpx = "^0.28.1"
+
+[tool.pytest.ini_options]
+log_cli = true
+log_cli_level = "DEBUG"
+pythonpath = "src"
+testpaths = "src/tests"
+

extractor_api_lib-3.3.0/src/extractor_api_lib/api_endpoints/file_extractor.py

@@ -0,0 +1,23 @@
+from abc import ABC, abstractmethod
+from extractor_api_lib.models.extraction_request import ExtractionRequest
+from extractor_api_lib.models.information_piece import InformationPiece
+
+
+class FileExtractor(ABC):
+    """Abstract base class for extract__from_file endpoint."""
+
+    @abstractmethod
+    async def aextract_information(self, extraction_request: ExtractionRequest) -> list[InformationPiece]:
+        """
+        Extract information of a document, given by the extraction_request.
+
+        Parameters
+        ----------
+        extraction_request : ExtractionRequest
+            The request containing the details of the document to be processed for information extraction.
+
+        Returns
+        -------
+        list[InformationPiece]
+            A list of extracted information pieces from the document.
+        """

extractor_api_lib-3.3.0/src/extractor_api_lib/api_endpoints/source_extractor.py

@@ -0,0 +1,27 @@
+from abc import ABC, abstractmethod
+
+from extractor_api_lib.models.extraction_parameters import ExtractionParameters
+from extractor_api_lib.models.information_piece import InformationPiece
+
+
+class SourceExtractor(ABC):
+    """Abstract base class for extract_from_source endpoint."""
+
+    @abstractmethod
+    async def aextract_information(
+        self,
+        extraction_parameters: ExtractionParameters,
+    ) -> list[InformationPiece]:
+        """
+        Extract information from source, using the given parameters.
+
+        Parameters
+        ----------
+        extraction_parameters : ExtractionParameters
+            The parameters used to extract information from the source.
+
+        Returns
+        -------
+        list[InformationPiece]
+            A list of extracted information pieces.
+        """

extractor_api_lib-3.3.0/src/extractor_api_lib/apis/extractor_api.py

@@ -0,0 +1,105 @@
+"""Module for the Extractor API."""
+
+# coding: utf-8
+
+from typing import Dict, List  # noqa: F401
+import importlib
+import pkgutil
+
+from extractor_api_lib.apis.extractor_api_base import BaseExtractorApi
+import extractor_api_lib.impl
+
+from fastapi import (  # noqa: F401
+    APIRouter,
+    Body,
+    Cookie,
+    Depends,
+    Form,
+    Header,
+    HTTPException,
+    Path,
+    Query,
+    Response,
+    Security,
+    status,
+)
+
+from extractor_api_lib.models.extra_models import TokenModel  # noqa: F401
+from extractor_api_lib.models.extraction_parameters import ExtractionParameters
+from extractor_api_lib.models.extraction_request import ExtractionRequest
+from extractor_api_lib.models.information_piece import InformationPiece
+
+
+router = APIRouter()
+
+ns_pkg = extractor_api_lib.impl
+for _, name, _ in pkgutil.iter_modules(ns_pkg.__path__, ns_pkg.__name__ + "."):
+    importlib.import_module(name)
+
+
+@router.post(
+    "/extract_from_file",
+    responses={
+        200: {"model": List[InformationPiece], "description": "List of extracted information."},
+        422: {"description": "Body is not a valid PDF."},
+        500: {"description": "Something somewhere went terribly wrong."},
+    },
+    tags=["extractor"],
+    response_model_by_alias=True,
+)
+async def extract_from_file_post(
+    extraction_request: ExtractionRequest = Body(None, description=""),
+) -> List[InformationPiece]:
+    """
+    Extract information from a file based on the provided extraction request.
+
+    Parameters
+    ----------
+    extraction_request : ExtractionRequest
+        The request object containing details about the extraction process.
+
+    Returns
+    -------
+    List[InformationPiece]
+        A list of extracted information pieces.
+    """
+    if not BaseExtractorApi.subclasses:
+        raise HTTPException(status_code=500, detail="Not implemented")
+    return await BaseExtractorApi.subclasses[0]().extract_from_file_post(extraction_request)
+
+
+@router.post(
+    "/extract_from_source",
+    responses={
+        200: {"model": List[InformationPiece], "description": "ok"},
+        404: {"description": "not found"},
+        422: {"description": "unprocessable entity"},
+        500: {"description": "internal server error"},
+    },
+    tags=["extractor"],
+    response_model_by_alias=True,
+)
+async def extract_from_source(
+    extraction_parameters: ExtractionParameters = Body(None, description=""),
+) -> List[InformationPiece]:
+    """
+    Extract information from a source based on the provided extraction parameters.
+
+    Parameters
+    ----------
+    extraction_parameters : ExtractionParameters, optional
+        The request object containing details about the extraction process.
+
+    Returns
+    -------
+    List[InformationPiece]
+        A list of extracted information pieces.
+
+    Raises
+    ------
+    HTTPException
+        If the extraction process fails or encounters an error.
+    """
+    if not BaseExtractorApi.subclasses:
+        raise HTTPException(status_code=500, detail="Not implemented")
+    return await BaseExtractorApi.subclasses[0]().extract_from_source(extraction_parameters)

extractor_api_lib-3.3.0/src/extractor_api_lib/apis/extractor_api_base.py

@@ -0,0 +1,62 @@
+"""Module for the base ExtractorApi interface."""
+
+# coding: utf-8
+
+from typing import ClassVar, Dict, List, Tuple  # noqa: F401
+
+from extractor_api_lib.models.extraction_parameters import ExtractionParameters
+from extractor_api_lib.models.extraction_request import ExtractionRequest
+from extractor_api_lib.models.information_piece import InformationPiece
+
+
+class BaseExtractorApi:
+    """
+    The base ExtractorApi interface.
+
+    Attributes
+    ----------
+    subclasses : ClassVar[Tuple]
+        A tuple containing all subclasses of BaseExtractorApi.
+    """
+
+    subclasses: ClassVar[Tuple] = ()
+
+    def __init_subclass__(cls, **kwargs):
+        super().__init_subclass__(**kwargs)
+        BaseExtractorApi.subclasses = BaseExtractorApi.subclasses + (cls,)
+
+    async def extract_from_file_post(
+        self,
+        extraction_request: ExtractionRequest,
+    ) -> List[InformationPiece]:
+        """
+        Extract information from a file based on the provided extraction request.
+
+        Parameters
+        ----------
+        extraction_request : ExtractionRequest
+            The request object containing details about the extraction process.
+
+        Returns
+        -------
+        List[InformationPiece]
+            A list of extracted information pieces.
+        """
+
+    async def extract_from_source(
+        self,
+        extraction_parameters: ExtractionParameters,
+    ) -> List[InformationPiece]:
+        """
+        Extract information from a source based on the provided extraction request.
+
+        Parameters
+        ----------
+        extraction_parameters : ExtractionParameters
+           The parameters required to access and extract information from the source.
+
+        Returns
+        -------
+        List[InformationPiece]
+            A list of extracted information pieces.
+        """