Skip to content

LLM-Driven Extraction of Unstructured Data — Built for API Deployments & ETL Pipeline Workflows

13.7 KB
Raw Blame
import json
import logging
from typing import Any

from account_v2.models import User
from cryptography.fernet import Fernet
from django.conf import settings
from django.core.exceptions import ObjectDoesNotExist
from platform_settings_v2.platform_auth_service import PlatformAuthenticationService
from tenant_account_v2.organization_member_service import OrganizationMemberService

from adapter_processor_v2.constants import AdapterKeys, AllowedDomains
from adapter_processor_v2.deprecated_adapters import (
    get_deprecation_message,
    is_adapter_deprecated,
)
from adapter_processor_v2.exceptions import (
    AdapterNotFound,
    DeprecatedAdapter,
    InternalServiceError,
    InValidAdapterId,
    TestAdapterError,
)
from adapter_processor_v2.image_output_gating import (
    filter_image_output_mode,
    validate_image_output_allowed,
)
from unstract.sdk1.adapters.adapterkit import Adapterkit
from unstract.sdk1.adapters.base import Adapter
from unstract.sdk1.adapters.x2text.constants import X2TextConstants
from unstract.sdk1.constants import AdapterTypes
from unstract.sdk1.embedding import EmbeddingCompat
from unstract.sdk1.exceptions import SdkError
from unstract.sdk1.llm import LLM

from .models import AdapterInstance, UserDefaultAdapter

logger = logging.getLogger(__name__)

try:
    from plugins.subscription.time_trials.subscription_adapter import add_unstract_key
except ImportError:
    add_unstract_key = None


class AdapterProcessor:
    @staticmethod
    def get_json_schema(adapter_id: str) -> dict[str, Any]:
        """Function to return JSON Schema for Adapters."""
        schema_details: dict[str, Any] = {}
        if is_adapter_deprecated(adapter_id):
            raise DeprecatedAdapter(get_deprecation_message(adapter_id))
        updated_adapters = AdapterProcessor.__fetch_adapters_by_key_value(
            AdapterKeys.ID, adapter_id
        )
        if len(updated_adapters) != 0:
            schema_details[AdapterKeys.JSON_SCHEMA] = filter_image_output_mode(
                adapter_id,
                json.loads(updated_adapters[0].get(AdapterKeys.JSON_SCHEMA)),
            )
        else:
            logger.error(f"Invalid adapter Id : {adapter_id} while fetching JSON Schema")
            raise InValidAdapterId()
        return schema_details

    @staticmethod
    def get_all_supported_adapters(user_email: str, type: str) -> list[dict[Any, Any]]:
        """Function to return list of all supported adapters."""
        supported_adapters = []
        updated_adapters = []
        updated_adapters = AdapterProcessor.__fetch_adapters_by_key_value(
            AdapterKeys.ADAPTER_TYPE, type
        )
        is_special_user = any(
            identifier in user_email for identifier in AllowedDomains.list()
        )

        for each_adapter in updated_adapters:
            adapter_id = each_adapter.get(AdapterKeys.ID)
            if not is_special_user and adapter_id.startswith("noOp"):
                continue
            if is_adapter_deprecated(adapter_id):
                continue

            supported_adapters.append(
                {
                    AdapterKeys.ID: adapter_id,
                    AdapterKeys.NAME: each_adapter.get(AdapterKeys.NAME),
                    AdapterKeys.DESCRIPTION: each_adapter.get(AdapterKeys.DESCRIPTION),
                    AdapterKeys.ICON: each_adapter.get(AdapterKeys.ICON),
                    AdapterKeys.ADAPTER_TYPE: each_adapter.get(AdapterKeys.ADAPTER_TYPE),
                    AdapterKeys.DOC_URL: each_adapter.get(AdapterKeys.DOC_URL, ""),
                }
            )
        return supported_adapters

    @staticmethod
    def get_adapter_data_with_key(adapter_id: str, key_value: str) -> Any:
        """Generic Function to get adapter data with provided key.

        Args:
            adapter_id: The SDK identifier for the adapter
            key_value: The key to retrieve from adapter data

        Returns:
            The value associated with the key

        Raises:
            InValidAdapterId: If adapter is not found in SDK

        Note:
            For deprecated adapters (not in SDK), this will raise InValidAdapterId.
            Callers should handle this gracefully by checking is_available field first.
        """
        updated_adapters = AdapterProcessor.__fetch_adapters_by_key_value(
            "id", adapter_id
        )
        if len(updated_adapters) == 0:
            logger.warning(
                f"Adapter ID {adapter_id} not found in SDK. "
                "This may be a deprecated adapter that was removed from SDK."
            )
            raise InValidAdapterId()
        return updated_adapters[0].get(key_value)

    @staticmethod
    def get_icon(adapter: AdapterInstance) -> str:
        """Registry icon for an adapter, or the warning icon if unresolvable."""
        if not adapter.is_available or is_adapter_deprecated(adapter.adapter_id):
            return AdapterKeys.UNAVAILABLE_ICON
        try:
            adapter_class = Adapterkit().get_adapter_class_by_adapter_id(
                adapter.adapter_id
            )
        except Exception as e:
            logger.warning(
                "Adapter %s is not in the SDK registry: %s", adapter.adapter_id, e
            )
            return AdapterKeys.UNAVAILABLE_ICON
        return adapter_class.get_icon() or AdapterKeys.UNAVAILABLE_ICON

    @staticmethod
    def get_model_label(adapter: AdapterInstance) -> str:
        """Model name from the adapter metadata.

        Adapters without a model use the adapter id's provider prefix.
        """
        try:
            model = adapter.metadata.get("model")
        except Exception as e:
            logger.error(
                "Could not read metadata for adapter %s: %s", adapter.adapter_id, e
            )
            model = None
        return model or adapter.adapter_id.split("|")[0]

    @staticmethod
    def test_adapter(adapter_id: str, adapter_metadata: dict[str, Any]) -> bool:
        validate_image_output_allowed(adapter_metadata, adapter_id)
        try:
            adapter_type = adapter_metadata.get(AdapterKeys.ADAPTER_TYPE)

            if adapter_type == AdapterKeys.EMBEDDING:
                embedding = EmbeddingCompat(
                    adapter_id=adapter_id, adapter_metadata=adapter_metadata
                )
                return embedding.test_connection()
            elif adapter_type == AdapterKeys.LLM:
                llm = LLM(adapter_id=adapter_id, adapter_metadata=adapter_metadata)
                return llm.test_connection()
            else:
                adapter_class = Adapterkit().get_adapter_class_by_adapter_id(adapter_id)

                if adapter_metadata.pop(AdapterKeys.ADAPTER_TYPE) == AdapterKeys.X2TEXT:
                    if (
                        adapter_metadata.get(AdapterKeys.PLATFORM_PROVIDED_UNSTRACT_KEY)
                        and add_unstract_key
                    ):
                        adapter_metadata = add_unstract_key(adapter_metadata)
                    adapter_metadata[X2TextConstants.X2TEXT_HOST] = settings.X2TEXT_HOST
                    adapter_metadata[X2TextConstants.X2TEXT_PORT] = settings.X2TEXT_PORT
                    platform_key = PlatformAuthenticationService.get_active_platform_key()
                    adapter_metadata[X2TextConstants.PLATFORM_SERVICE_API_KEY] = str(
                        platform_key.key
                    )

                adapter_instance = adapter_class(adapter_metadata)
                return adapter_instance.test_connection()
        except SdkError as e:
            raise TestAdapterError(
                e, adapter_name=adapter_metadata[AdapterKeys.ADAPTER_NAME]
            ) from e

    @staticmethod
    def update_adapter_metadata(adapter_metadata_b: Any, **kwargs) -> Any:
        if add_unstract_key:
            encryption_secret: str = settings.ENCRYPTION_KEY
            f: Fernet = Fernet(encryption_secret.encode("utf-8"))

            adapter_metadata = json.loads(
                f.decrypt(bytes(adapter_metadata_b).decode("utf-8"))
            )
            adapter_metadata = add_unstract_key(adapter_metadata, **kwargs)

            adapter_metadata_b = f.encrypt(json.dumps(adapter_metadata).encode("utf-8"))
            return adapter_metadata_b
        return adapter_metadata_b

    @staticmethod
    def __fetch_adapters_by_key_value(key: str, value: Any) -> Adapter:
        """Fetches a list of adapters that have an attribute matching key and
        value.
        """
        logger.info(f"Fetching adapter list for {key} with {value}")
        adapter_kit = Adapterkit()
        adapters = adapter_kit.get_adapters_list()
        return [iterate for iterate in adapters if iterate[key] == value]

    @staticmethod
    def set_default_triad(default_triad: dict[str, str], user: User) -> None:
        try:
            organization_member = OrganizationMemberService.get_user_by_id(user.id)
            (
                user_default_adapter,
                created,
            ) = UserDefaultAdapter.objects.get_or_create(
                organization_member=organization_member
            )

            if default_triad.get(AdapterKeys.LLM_DEFAULT, None):
                user_default_adapter.default_llm_adapter = AdapterInstance.objects.get(
                    pk=default_triad[AdapterKeys.LLM_DEFAULT]
                )
            if default_triad.get(AdapterKeys.EMBEDDING_DEFAULT, None):
                user_default_adapter.default_embedding_adapter = (
                    AdapterInstance.objects.get(
                        pk=default_triad[AdapterKeys.EMBEDDING_DEFAULT]
                    )
                )

            if default_triad.get(AdapterKeys.VECTOR_DB_DEFAULT, None):
                user_default_adapter.default_vector_db_adapter = (
                    AdapterInstance.objects.get(
                        pk=default_triad[AdapterKeys.VECTOR_DB_DEFAULT]
                    )
                )

            if default_triad.get(AdapterKeys.X2TEXT_DEFAULT, None):
                user_default_adapter.default_x2text_adapter = AdapterInstance.objects.get(
                    pk=default_triad[AdapterKeys.X2TEXT_DEFAULT]
                )

            user_default_adapter.save()

            logger.info("Changed defaults successfully")
        except Exception as e:
            logger.error(f"Unable to save defaults because: {e}")
            if isinstance(e, InValidAdapterId):
                raise e
            else:
                raise InternalServiceError()

    @staticmethod
    def get_adapters_by_type(
        adapter_type: AdapterTypes, user: User
    ) -> list[AdapterInstance]:
        """Get a list of adapters by their type.

        Parameters:
        - adapter_type (AdapterTypes): The type of adapters to retrieve.
        - user: Logged in User

        Returns:
        - list[AdapterInstance]: A list of AdapterInstance objects that match
            the specified adapter type.
        """
        adapters: list[AdapterInstance] = AdapterInstance.objects.for_user(user).filter(
            adapter_type=adapter_type.value,
        )
        return adapters

    @staticmethod
    def get_adapter_by_name_and_type(
        adapter_type: AdapterTypes,
        adapter_name: str,
    ) -> AdapterInstance:
        """Get the adapter instance by its name and type.

        Parameters:
        - adapter_name (str): The name of the adapter instance.
        - adapter_type (AdapterTypes): The type of the adapter instance.

        Returns:
        - AdapterInstance: The adapter with the specified name and type.

        Raises:
        - AdapterNotFound: If the adapter is not found.
        """
        if not adapter_name:
            raise AdapterNotFound(
                f"adapter_name is required to look up an adapter of type "
                f"'{adapter_type.value}'"
            )
        try:
            adapter: AdapterInstance = AdapterInstance.objects.get(
                adapter_name=adapter_name, adapter_type=adapter_type.value
            )
        except AdapterInstance.DoesNotExist:
            error_msg = (
                f"Couldn't find adapter with name '{adapter_name}' "
                f"and type '{adapter_type.value}'"
            )
            logger.error(error_msg)
            raise AdapterNotFound(error_msg)
        return adapter

    @staticmethod
    def get_default_adapters(user: User) -> list[AdapterInstance]:
        """Retrieve a list of default adapter instances. This method queries
        the database to fetch all adapter instances marked as default.

        Raises:
            InternalServiceError: If an unexpected error occurs during
            the database query.

        Returns:
            list[AdapterInstance]: A list of AdapterInstance objects that are
            marked as default.
        """
        try:
            adapters: list[AdapterInstance] = []

            organization_member = OrganizationMemberService.get_user_by_id(id=user.id)
            default_adapter: UserDefaultAdapter = UserDefaultAdapter.objects.get(
                organization_member=organization_member
            )

            if default_adapter.default_embedding_adapter:
                adapters.append(default_adapter.default_embedding_adapter)
            if default_adapter.default_llm_adapter:
                adapters.append(default_adapter.default_llm_adapter)
            if default_adapter.default_vector_db_adapter:
                adapters.append(default_adapter.default_vector_db_adapter)
            if default_adapter.default_x2text_adapter:
                adapters.append(default_adapter.default_x2text_adapter)

            return adapters
        except ObjectDoesNotExist as e:
            logger.error(f"No default adapters found: {e}")
            raise InternalServiceError(
                "No default adapters found, configure them through Platform Settings"
            )