gllm-plugin 0.0.5.dev1__cp311-cp311-macosx_14_0_arm64.whl

gllm_plugin/config/app_config.pyi

@@ -0,0 +1,9 @@
+from pydantic import BaseModel
+from typing import TypeVar
+
+Chatbot = TypeVar('Chatbot')
+
+class AppConfig(BaseModel):
+    """Application configuration model."""
+    chatbots: dict[str, Chatbot]
+    user_chatbots: dict[str, list[str]]

gllm_plugin/config/constant.pyi

@@ -0,0 +1,15 @@
+from enum import StrEnum
+
+class SearchType(StrEnum):
+    """The type of search to perform.
+
+    Values:
+        NORMAL: Get answer from chatbot knowledge.
+        SMART: Get more relevant information from your stored documents and knowledge base.
+            Knowledge Search is an AI with specialized knowledge. No agents are available in this mode.
+        WEB: Get more relevant information from the web.
+            Web Search uses real-time data. Agent selection isn't available in this mode.
+    """
+    NORMAL = 'normal'
+    SMART = 'smart'
+    WEB = 'web'

gllm_plugin/pipeline/base_pipeline_preset_config.pyi

@@ -0,0 +1,23 @@
+from gllm_plugin.config.constant import SearchType as SearchType
+from pydantic import BaseModel
+from typing import Any
+
+class BasePipelinePresetConfig(BaseModel):
+    """A Pydantic model representing the base preset configuration of all pipelines.
+
+    Attributes:
+        pipeline_preset_id (str): The pipeline preset id.
+        supported_models (dict[str, Any]): The supported models.
+        supported_agents (list[str]): The supported agents.
+        support_pii_anonymization (bool): Whether the pipeline supports pii anonymization.
+        support_multimodal (bool): Whether the pipeline supports multimodal.
+        use_docproc (bool): Whether to use the document processor.
+        search_types (list[SearchType]): The supported search types.
+    """
+    pipeline_preset_id: str
+    supported_models: dict[str, Any]
+    supported_agents: list[str]
+    support_pii_anonymization: bool
+    support_multimodal: bool
+    use_docproc: bool
+    search_types: list[SearchType]

gllm_plugin/pipeline/pipeline_handler.pyi

@@ -0,0 +1,157 @@
+from _typeshed import Incomplete
+from bosa_core import Plugin as Plugin
+from bosa_core.plugin.handler import PluginHandler
+from gllm_inference.catalog import LMRequestProcessorCatalog as LMRequestProcessorCatalog, PromptBuilderCatalog as PromptBuilderCatalog
+from gllm_pipeline.pipeline.pipeline import Pipeline as Pipeline
+from gllm_plugin.config.app_config import AppConfig as AppConfig
+from gllm_plugin.storage.base_chat_history_storage import BaseChatHistoryStorage as BaseChatHistoryStorage
+from gllm_plugin.supported_models import ModelName as ModelName
+from pydantic import BaseModel
+from typing import Any
+
+class ChatbotConfig(BaseModel):
+    """Chatbot configuration class containing pipeline configs and metadata.
+    
+    Attributes:
+        pipeline_type (str): Type of pipeline to use.
+        pipeline_config (dict[str, Any]): Pipeline configuration dictionary.
+        prompt_builder_catalogs (dict[str, PromptBuilderCatalog] | None): Mapping of prompt builder catalogs.
+        lmrp_catalogs (dict[str, LMRequestProcessorCatalog] | None): Mapping of LM request processor catalogs.
+    """
+    pipeline_type: str
+    pipeline_config: dict[str, Any]
+    prompt_builder_catalogs: dict[str, PromptBuilderCatalog] | None
+    lmrp_catalogs: dict[str, LMRequestProcessorCatalog] | None
+    model_config: Incomplete
+
+class PipelinePresetConfig(BaseModel):
+    """Pipeline preset configuration class.
+    
+    Attributes:
+        preset_id (str): Unique identifier for the pipeline preset.
+        supported_models (list[str]): List of model names supported by this preset.
+    """
+    preset_id: str
+    supported_models: list[str]
+
+class ChatbotPresetMapping(BaseModel):
+    """Chatbot preset mapping.
+    
+    Attributes:
+        pipeline_type (str): Type of pipeline.
+        chatbot_preset_map (dict[str, PipelinePresetConfig]): Mapping of chatbot IDs to their pipeline preset configurations.
+    """
+    pipeline_type: str
+    chatbot_preset_map: dict[str, PipelinePresetConfig]
+
+logger: Incomplete
+
+class PipelineHandler(PluginHandler):
+    """Handler for pipeline builder plugins.
+
+    This handler manages pipeline builder plugins and provides caching for built pipelines.
+
+    Attributes:
+        app_config (AppConfig): Application configuration.
+        _activated_configs (dict[str, ChatbotPresetMapping]): Collection of chatbot preset mapping by pipeline types.
+        _chatbot_configs (dict[str, ChatbotConfig]): Mapping of chatbot IDs to their configurations.
+        _builders (dict[str, Plugin]): Mapping of chatbot IDs to their pipeline builder plugins.
+        _pipeline_cache (dict[tuple[str, str], Pipeline]): Cache mapping (chatbot_id, model_name) to Pipeline instances.
+    """
+    app_config: AppConfig
+    chat_history_storage: Incomplete
+    def __init__(self, app_config: AppConfig, chat_history_storage: BaseChatHistoryStorage) -> None:
+        """Initialize the pipeline handler.
+
+        Args:
+            app_config (AppConfig): Application configuration.
+            chat_history_storage (BaseChatHistoryStorage): Chat history storage.
+        """
+    @classmethod
+    def create_injections(cls, instance: PipelineHandler) -> dict[type[Any], Any]:
+        """Create injection mappings for pipeline builder plugins.
+
+        Args:
+            instance (PipelineHandler): The handler instance providing injections.
+
+        Returns:
+            dict[Type[Any], Any]: Dictionary mapping service types to their instances.
+        """
+    @classmethod
+    def initialize_plugin(cls, instance: PipelineHandler, plugin: Plugin) -> None:
+        """Initialize plugin-specific resources.
+
+        This method is called after plugin creation and service injection.
+        For each pipeline builder plugin, we build pipelines for all supported models and cache them.
+
+        Args:
+            instance (PipelineHandler): The handler instance.
+            plugin (Plugin): The pipeline builder plugin instance.
+        """
+    def get_pipeline_builder(self, chatbot_id: str) -> Plugin:
+        """Get a pipeline builder instance for the given chatbot.
+
+        Args:
+            chatbot_id (str): The chatbot ID.
+
+        Returns:
+            Plugin: The pipeline builder instance.
+
+        Raises:
+            ValueError: If the chatbot ID is invalid or the model name is not supported.
+        """
+    def get_pipeline(self, chatbot_id: str, model_name: ModelName) -> Pipeline:
+        """Get a pipeline instance for the given chatbot and model name.
+
+        Args:
+            chatbot_id (str): The chatbot ID.
+            model_name (ModelName): The model to use for inference.
+
+        Returns:
+            Pipeline: The pipeline instance.
+
+        Raises:
+            ValueError: If the chatbot ID is invalid.
+        """
+    def get_pipeline_config(self, chatbot_id: str) -> dict[str, Any]:
+        """Get the pipeline configuration by chatbot ID.
+
+        Args:
+            chatbot_id (str): The chatbot ID.
+
+        Returns:
+            dict[str, Any]: The pipeline configuration.
+
+        Raises:
+            ValueError: If the chatbot or pipeline is not found.
+        """
+    def get_pipeline_type(self, chatbot_id: str) -> str:
+        """Get the pipeline type for the given chatbot.
+
+        Args:
+            chatbot_id (str): The chatbot ID.
+        """
+    def get_use_docproc(self, chatbot_id: str) -> bool:
+        """Get whether DocProc should be used for this chatbot.
+
+        Args:
+            chatbot_id (str): The chatbot ID.
+
+        Returns:
+            bool: Whether DocProc should be used.
+
+        Raises:
+            ValueError: If the chatbot or pipeline is not found.
+        """
+    def get_max_file_size(self, chatbot_id: str) -> int | None:
+        """Get maximum file size for the given chatbot.
+
+        Args:
+            chatbot_id (str): The chatbot ID.
+
+        Returns:
+            int | None: The maximum file size if provided.
+
+        Raises:
+            ValueError: If the chatbot or pipeline is not found.
+        """

gllm_plugin/pipeline/pipeline_plugin.pyi

@@ -0,0 +1,78 @@
+import abc
+from abc import ABC, abstractmethod
+from bosa_core.plugin.plugin import Plugin
+from gllm_inference.catalog.catalog import BaseCatalog as BaseCatalog
+from gllm_pipeline.pipeline.pipeline import Pipeline as Pipeline
+from gllm_plugin.pipeline.pipeline_handler import PipelineHandler as PipelineHandler
+from typing import Any, Generic, TypeVar
+
+PipelineState = TypeVar('PipelineState')
+PipelinePresetConfig = TypeVar('PipelinePresetConfig', bound='BasePipelinePresetConfig')
+PipelineRuntimeConfig = TypeVar('PipelineRuntimeConfig', bound='BaseModel')
+
+class PipelineBuilderPlugin(Plugin, ABC, Generic[PipelineState, PipelinePresetConfig], metaclass=abc.ABCMeta):
+    """Base class for pipeline builder plugins.
+
+    This class combines the Plugin architecture with the Pipeline Builder functionality.
+
+    Attributes:
+        name (str): The name of the plugin.
+        description (str): The description of the plugin.
+        version (str): The version of the plugin.
+        catalog (BaseCatalog): The catalog instance.
+        additional_config_class (Type[PipelineRuntimeConfig] | None): The additional runtime configuration class.
+        preset_config_class (Type[PipelinePresetConfig] | None): The preset configuration class.
+    """
+    name: str
+    description: str
+    version: str
+    catalog: BaseCatalog[Any]
+    additional_config_class: type[PipelineRuntimeConfig] | None
+    preset_config_class: type[PipelinePresetConfig] | None
+    @classmethod
+    def get_preset_config_class(cls) -> type[PipelinePresetConfig]:
+        """Get the preset_config_class.
+
+        Returns:
+            Type[PipelinePresetConfig]: The pipeline preset config class.
+
+        Raises:
+            NotImplementedError: If the preset_config_class is not defined.
+        """
+    @abstractmethod
+    def build_initial_state(self, request_config: dict[str, Any], pipeline_config: dict[str, Any], **kwargs: Any) -> PipelineState:
+        """Build the initial pipeline state.
+
+        Args:
+            request_config (dict[str, Any]): Request configuration.
+            pipeline_config (dict[str, Any]): Pipeline configuration.
+            kwargs (Any): Additional state arguments.
+
+        Returns:
+            PipelineState: Initial pipeline state.
+        """
+    @abstractmethod
+    def build(self, pipeline_config: dict[str, Any]) -> Pipeline:
+        """Build a pipeline instance.
+
+        Args:
+            pipeline_config (dict[str, Any]): Pipeline configuration including model name and other settings.
+
+        Returns:
+            Pipeline: Built pipeline instance.
+        """
+    def build_additional_runtime_config(self, pipeline_config: dict[str, Any]) -> dict[str, Any]:
+        """Build additional runtime configuration.
+
+        Args:
+            pipeline_config (dict[str, Any]): Pipeline configuration.
+
+        Returns:
+            dict[str, Any]: Additional runtime configuration.
+        """
+    def get_config(self) -> dict[str, Any]:
+        """Get the pipeline configuration.
+
+        Returns:
+            dict[str, Any]: Pipeline configuration.
+        """

gllm_plugin/storage/base_anonymizer_storage.pyi

@@ -0,0 +1,41 @@
+import abc
+from abc import ABC, abstractmethod
+from typing import TypeVar
+
+AnonymizerMapping = TypeVar('AnonymizerMapping')
+MappingDataType = TypeVar('MappingDataType')
+
+class BaseAnonymizerStorage(ABC, metaclass=abc.ABCMeta):
+    """Interface for anonymizer storage that defines methods for managing anonymizer mappings."""
+    @abstractmethod
+    def get_mappings_by_conversation_id(self, conversation_id: str) -> list[AnonymizerMapping]:
+        """Retrieve anonymizer mappings by conversation ID.
+
+        Args:
+            conversation_id (str): The ID of the conversation.
+
+        Returns:
+            list[AnonymizerMapping]: A list of anonymizer mappings associated with the conversation ID.
+        """
+    @abstractmethod
+    def create_mapping(self, conversation_id: str, pii_type: str, anonymized_value: str, pii_value: str) -> AnonymizerMapping:
+        """Create a new anonymizer mapping.
+
+        Args:
+            conversation_id (str): The ID of the conversation.
+            pii_type (str): The type of personally identifiable information (PII).
+            anonymized_value (str): The anonymized value of the PII.
+            pii_value (str): The original PII value.
+
+        Returns:
+            AnonymizerMapping: The created anonymizer mapping.
+        """
+    @abstractmethod
+    def update_mapping(self, conversation_id: str, is_anonymized: bool, mapping_data_type: MappingDataType) -> None:
+        """Update the mappings for a specific conversation with new anonymizer mappings.
+
+        Args:
+            conversation_id (str): The unique identifier for the conversation.
+            is_anonymized (bool): The flag to determine if the message is anonymized.
+            mapping_data_type (MappingDataType): A dictionary of new anonymizer mappings to update for deanonymization.
+        """

gllm_plugin/storage/base_chat_history_storage.pyi

@@ -0,0 +1,287 @@
+import abc
+from abc import ABC, abstractmethod
+from datetime import datetime
+from enum import StrEnum
+from gllm_plugin.storage.base_anonymizer_storage import AnonymizerMapping as AnonymizerMapping
+from typing import Any
+from typing_extensions import TypeVar
+
+Conversation = TypeVar('Conversation')
+Message = TypeVar('Message')
+ConversationDocument = TypeVar('ConversationDocument')
+
+class MessageRole(StrEnum):
+    """Enum for Message Type."""
+    USER = 'USER'
+    AI = 'AI'
+
+class DocumentStatus(StrEnum):
+    """Enum for ConversationDocument Status."""
+    PROCESSING = 'processing'
+    DONE = 'done'
+    FAILED = 'failed'
+
+class BaseChatHistoryStorage(ABC, metaclass=abc.ABCMeta):
+    """Interface for chat history storage that defines methods for managing chat conversations and messages."""
+    @abstractmethod
+    def create_conversation(self, user_id: str, conversation_title: str, chatbot_id: str, **kwargs: Any) -> Conversation:
+        """Create a new conversation.
+
+        Args:
+            user_id (str): The ID of the user.
+            conversation_title (str): The title of the conversation.
+            chatbot_id (str): The ID of the chatbot.
+            kwargs (Any): Additional arguments.
+
+        Returns:
+            Conversation: The created conversation.
+        """
+    @abstractmethod
+    def get_conversation(self, user_id: str, conversation_id: str, **kwargs: Any) -> Conversation | None:
+        """Retrieve a specific conversation by its ID.
+
+        Args:
+            user_id (str): The ID of the user.
+            conversation_id (str): The ID of the conversation.
+            kwargs (Any): Additional arguments.
+
+        Returns:
+            Conversation | None: The conversation if found, otherwise None.
+        """
+    @abstractmethod
+    def get_conversations(self, user_id: str, query: str = '', chatbot_ids: list[str] | None = None, cursor: str | None = None, limit: int | None = None, **kwargs: Any) -> list[Conversation]:
+        '''Retrieve a list of conversations for a user.
+
+        Args:
+            user_id (str): The ID of the user.
+            query (str, optional): A search query to filter conversations. Defaults to "".
+            chatbot_ids (list[str] | None, optional): A list of chatbot IDs to filter conversations. Defaults to None.
+            cursor (str | None, optional): A cursor for pagination. Defaults to None.
+            limit (int | None, optional): The maximum number of conversations to retrieve. Defaults to None.
+            kwargs (Any): Additional arguments.
+
+        Returns:
+            list[Conversation]: A list of conversations.
+        '''
+    @abstractmethod
+    def rename_conversation(self, user_id: str, conversation_id: str, new_title: str, **kwargs: Any) -> Conversation:
+        """Rename an existing conversation.
+
+        Args:
+            user_id (str): The ID of the user.
+            conversation_id (str): The ID of the conversation.
+            new_title (str): The new title of the conversation.
+            kwargs (Any): Additional arguments.
+
+        Returns:
+            Conversation: The updated conversation.
+        """
+    @abstractmethod
+    def delete_conversation(self, user_id: str, conversation_id: str, **kwargs: Any) -> None:
+        """Delete a conversation by its ID.
+
+        Args:
+            user_id (str): The ID of the user.
+            conversation_id (str): The ID of the conversation.
+            kwargs (Any): Additional arguments.
+
+        Returns:
+            None
+        """
+    @abstractmethod
+    def delete_conversations(self, user_id: str, chatbot_id: str, **kwargs: Any) -> None:
+        """Delete all conversations associated with a chatbot.
+
+        Args:
+            user_id (str): The ID of the user.
+            chatbot_id (str): The ID of the chatbot.
+            kwargs (Any): Additional arguments.
+
+        Returns:
+            None
+        """
+    @abstractmethod
+    def add_user_message(self, message: str, user_id: str, conversation_id: str, parent_id: str | None = None, source: str | None = None, **kwargs: Any) -> Message:
+        """Add a user message to a conversation.
+
+        Args:
+            message (str): The message content.
+            user_id (str): The ID of the user.
+            conversation_id (str): The ID of the conversation.
+            parent_id (str | None, optional): The ID of the parent message. Defaults to None.
+            source (str | None, optional): The source of the message. Defaults to None.
+            kwargs (Any): Additional arguments.
+
+        Returns:
+            Message: The added message.
+        """
+    @abstractmethod
+    def add_ai_message(self, message: str, user_id: str, conversation_id: str, parent_id: str | None = None, source: str | None = None, **kwargs: Any) -> Message:
+        """Add an AI message to a conversation.
+
+        Args:
+            message (str): The message content.
+            user_id (str): The ID of the user.
+            conversation_id (str): The ID of the conversation.
+            parent_id (str | None, optional): The ID of the parent message. Defaults to None.
+            source (str | None, optional): The source of the message. Defaults to None.
+            kwargs (Any): Additional arguments.
+
+        Returns:
+            Message: The added message.
+        """
+    @abstractmethod
+    def save_message(self, user_id: str, conversation_id: str, message_list: list[Any], attachments: dict[str, Any] | None, **kwargs: Any) -> list[Message]:
+        """Save a list of messages to a conversation.
+
+        Args:
+            user_id (str): The ID of the user.
+            conversation_id (str): The ID of the conversation.
+            message_list (list[Any]): A list of messages to save.
+            attachments (dict[str, Any] | None): Attachments associated with the messages.
+            kwargs (Any): Additional arguments.
+
+        Returns:
+            list[Message]: The saved messages.
+        """
+    @abstractmethod
+    def get_message_by_id(self, message_id: str, **kwargs: Any) -> Message:
+        """Retrieve a specific message by its ID.
+
+        Args:
+            message_id (str): The ID of the message.
+            kwargs (Any): Additional arguments.
+
+        Returns:
+            Message: The message.
+        """
+    @abstractmethod
+    def get_messages_by_ids(self, message_ids: list[str], **kwargs: Any) -> list[Message]:
+        """Retrieve messages by their IDs.
+
+        Args:
+            message_ids (list[str]): A list of message IDs.
+            kwargs (Any): Additional arguments.
+
+        Returns:
+            list[Message]: A list of messages.
+        """
+    @abstractmethod
+    def get_messages(self, user_id: str, conversation_id: str, limit: int | None = None, max_timestamp: datetime | None = None, **kwargs: Any) -> list[Message]:
+        """Retrieve messages from a conversation.
+
+        Args:
+            user_id (str): The ID of the user.
+            conversation_id (str): The ID of the conversation.
+            limit (int | None, optional): The maximum number of messages to retrieve. Defaults to None.
+            max_timestamp (datetime | None, optional): The maximum timestamp for the messages. Defaults to None.
+            kwargs (Any): Additional arguments.
+
+        Returns:
+            list[Message]: A list of messages.
+        """
+    @abstractmethod
+    def update_message_metadata(self, message_id: str, metadata_: dict[str, Any], **kwargs: Any) -> Message:
+        """Update the metadata of a message.
+
+        Args:
+            message_id (str): The ID of the message.
+            metadata_ (dict[str, Any]): The metadata to update.
+            kwargs (Any): Additional arguments.
+
+        Returns:
+            Message: The updated message.
+        """
+    @abstractmethod
+    def delete_messages(self, user_id: str, message_ids: list[str], chatbot_ids: list[str], **kwargs: Any) -> None:
+        """Delete messages by their IDs.
+
+        Args:
+            user_id (str): The ID of the user.
+            message_ids (list[str]): A list of message IDs to delete.
+            chatbot_ids (list[str]): A list of chatbot IDs associated with the messages.
+            kwargs (Any): Additional arguments.
+
+        Returns:
+            None
+        """
+    @abstractmethod
+    def create_conversation_document(self, conversation_id: str, status: str = ..., file_hash: str = '', **kwargs: Any) -> ConversationDocument:
+        '''Create a new conversation document.
+
+        Args:
+            conversation_id (str): The ID of the conversation.
+            status (str, optional): The status of the document. Defaults to DocumentStatus.PROCESSING.value.
+            file_hash (str, optional): The hash of the file. Defaults to "".
+            kwargs (Any): Additional arguments.
+
+        Returns:
+            ConversationDocument: The created conversation document.
+        '''
+    @abstractmethod
+    def get_conversation_document(self, document_id: str, **kwargs: Any) -> ConversationDocument:
+        """Retrieve a conversation document by its ID.
+
+        Args:
+            document_id (str): The ID of the document.
+            kwargs (Any): Additional arguments.
+
+        Returns:
+            ConversationDocument: The conversation document.
+        """
+    @abstractmethod
+    def update_conversation_document(self, document_id: str, status: str, number_of_chunks: int, message: str | None, object_key: str | None, **kwargs: Any) -> ConversationDocument:
+        """Update a conversation document.
+
+        Args:
+            document_id (str): The ID of the document.
+            status (str): The status of the document.
+            number_of_chunks (int): The number of chunks in the document.
+            message (str | None, optional): A message associated with the document. Defaults to None.
+            object_key (str | None, optional): The object key of the document. Defaults to None.
+            kwargs (Any): Additional arguments.
+
+        Returns:
+            ConversationDocument: The updated conversation document.
+        """
+    @abstractmethod
+    def save_feedback(self, user_id: str, message_id: str, feedback: str, **kwargs: Any) -> None:
+        """Save feedback for a message.
+
+        Args:
+            user_id (str): The ID of the user.
+            message_id (str): The ID of the message.
+            feedback (str): The feedback content.
+            kwargs (Any): Additional arguments.
+
+        Returns:
+            None
+        """
+    @abstractmethod
+    def get_deanonymized_message(self, user_id: str, conversation_id: str, message_id: str, is_anonymized: bool, mappings: list[AnonymizerMapping], **kwargs: Any) -> Message:
+        """Retrieve a deanonymized message.
+
+        Args:
+            user_id (str): The ID of the user.
+            conversation_id (str): The ID of the conversation.
+            message_id (str): The ID of the message.
+            is_anonymized (bool): Whether the message is anonymized.
+            mappings (list[AnonymizerMapping]): A list of anonymizer mappings.
+            kwargs (Any): Additional arguments.
+
+        Returns:
+            Message: The deanonymized message.
+        """
+    @abstractmethod
+    def get_deanonymized_messages(self, messages: list[Message], is_anonymized: bool, mappings: list[AnonymizerMapping] | None = None, **kwargs: Any) -> list[Message]:
+        """Retrieve a list of deanonymized messages.
+
+        Args:
+            messages (list[Message]): A list of messages.
+            is_anonymized (bool): Whether the messages are anonymized.
+            mappings (list[AnonymizerMapping] | None, optional): A list of anonymizer mappings. Defaults to None.
+            kwargs (Any): Additional arguments.
+
+        Returns:
+            list[Message]: A list of deanonymized messages.
+        """

gllm_plugin/supported_models.pyi

@@ -0,0 +1,172 @@
+from _typeshed import Incomplete
+from enum import StrEnum
+from pydantic import BaseModel, BeforeValidator as BeforeValidator, HttpUrl
+from typing import Annotated
+
+class Provider(StrEnum):
+    """Supported model providers."""
+    ANTHROPIC = 'anthropic'
+    DEEPSEEK = 'deepseek'
+    GOOGLE = 'google'
+    OPENAI = 'openai'
+    TGI = 'tgi'
+    TEI = 'tei'
+    VLLM = 'vllm'
+    GROQ = 'groq'
+    TOGETHER_AI = 'together-ai'
+    DEEPINFRA = 'deepinfra'
+    ROUTABLE = 'routable'
+
+class OpenAIModel(StrEnum):
+    """Supported OpenAI models."""
+    GPT_4O = 'gpt-4o'
+    GPT_4O_MINI = 'gpt-4o-mini'
+    GPT_4_5_PREVIEW = 'gpt-4.5-preview'
+    O1 = 'o1'
+    O1_MINI = 'o1-mini'
+    O1_PREVIEW = 'o1-preview'
+    O3 = 'o3'
+    O3_MINI = 'o3-mini'
+    TEXT_EMBEDDING_3_SMALL = 'text-embedding-3-small'
+    TEXT_EMBEDDING_3_LARGE = 'text-embedding-3-large'
+    TEXT_EMBEDDING_ADA_002 = 'text-embedding-ada-002'
+
+class AnthropicModel(StrEnum):
+    """Supported Anthropic models."""
+    CLAUDE_3_7_SONNET = 'claude-3-7-sonnet'
+    CLAUDE_3_5_SONNET = 'claude-3-5-sonnet'
+    CLAUDE_3_5_HAIKU = 'claude-3-5-haiku'
+    CLAUDE_3_OPUS = 'claude-3-opus'
+
+class GoogleModel(StrEnum):
+    """Supported Google models."""
+    GEMINI_1_5_FLASH = 'gemini-1.5-flash'
+    GEMINI_1_5_FLASH_8B = 'gemini-1.5-flash-8b'
+    GEMINI_1_5_PRO = 'gemini-1.5-pro'
+    GEMINI_2_0_FLASH = 'gemini-2.0-flash'
+    TEXT_EMBEDDING_GECKO_001 = 'textembedding-gecko@001'
+    TEXT_EMBEDDING_GECKO_003 = 'textembedding-gecko@003'
+    TEXT_EMBEDDING_004 = 'text-embedding-004'
+    TEXT_EMBEDDING_005 = 'text-embedding-005'
+
+class DeepSeekModel(StrEnum):
+    """Supported DeepSeek models."""
+    DEEPSEEK_CHAT = 'deepseek-chat'
+    DEEPSEEK_REASONER = 'deepseek-reasoner'
+
+class GroqModel(StrEnum):
+    """Supported Groq models."""
+    DEEPSEEK_R1_DISTILL_QWEN_32B = 'deepseek-r1-distill-qwen-32b'
+    DEEPSEEK_R1_DISTILL_LLAMA_70B = 'deepseek-r1-distill-llama-70b'
+    LLAMA_3_2_1B_PREVIEW = 'llama-3.2-1b-preview'
+
+class TogetherAIModel(StrEnum):
+    """Supported Together.AI models."""
+    DEEPSEEK_V3 = 'deepseek-ai/DeepSeek-V3'
+
+class DeepInfraModel(StrEnum):
+    """Supported DeepInfra models."""
+    QWEN_2_5_72B_INSTRUCT = 'Qwen/Qwen2.5-72B-Instruct'
+    DEEPSEEK_R1_DISTILL_QWEN_32B = 'deepseek-ai/DeepSeek-R1-Distill-Qwen-32B'
+    DEEPSEEK_R1 = 'deepseek-ai/DeepSeek-R1'
+    DEEPSEEK_V3 = 'deepseek-ai/DeepSeek-V3'
+
+class RoutableModel(StrEnum):
+    """Supported routable model presets.
+
+    These are presets that map a specific model name to a routable invoker.
+    The actual invoker will be determined by the router.
+
+    Currently supports:
+        - '__default__' - Strong model: gpt-4o. Weak model: gpt-4o-mini.
+        - 'gpt' - Strong model: o3-mini. Weak model: gpt-4o.
+        - 'deepseek' - Strong model: DeepSeek-R1-Distill-Qwen-32B. Weak model: DeepSeek-V3.
+    """
+    DEFAULT = '__default__'
+    GPT = 'gpt'
+    DEEPSEEK = 'deepseek'
+
+MODEL_MAP: Incomplete
+DEFAULT_VERSION_MAP: Incomplete
+UNIMODAL_PROVIDERS: Incomplete
+
+def validate_model_name(model_name: str, provider: Provider) -> str:
+    """A Pydantic validator that validates the model name is valid for the given provider.
+
+    Args:
+        model_name (str): The model name to validate.
+        provider (Provider): The provider to validate the model name against.
+
+    Returns:
+        str: The validated model name.
+
+    Raises:
+        ValueError: If the model name is invalid for the provider.
+    """
+
+class ModelName(BaseModel):
+    """A model name in a standardized format.
+
+    - For cloud providers: 'provider/model-name[-version]'
+    - For TGI: 'tgi/[base64-encoded-url]'
+    - For VLLM: 'vllm/[model-name]@[base64-encoded-url]'
+
+    Args:
+        provider (Provider): The provider of the model.
+        name (str): The name of the model.
+        version (str | None, optional): The version of the model. Defaults to None.
+        url (HttpUrl | None, optional): The URL for self-hosted models (e.g. TGI, VLLM). Defaults to None.
+
+    Attributes:
+        provider (Provider): The provider of the model.
+        name (str): The name of the model.
+        version (str | None): The version of the model.
+        url (HttpUrl | None): The URL for self-hosted models (e.g. TGI, VLLM).
+
+    Raises:
+        ValueError: If the model name is invalid for the provider.
+    """
+    model_config: Incomplete
+    provider: Provider
+    name: Annotated[str, None]
+    version: Annotated[str | None, None]
+    url: HttpUrl | None
+    @classmethod
+    def from_string(cls, provider_model_string: str) -> ModelName:
+        """Parse a provider/model string into a ModelName.
+
+        Format varies by provider:
+        - Cloud providers: 'provider/model-name[-version]'
+        - TGI: 'tgi/[base64-encoded-url]'
+        - TEI: 'tei/[base64-encoded-url]'
+        - VLLM: 'vllm/[model-name]@[base64-encoded-url]'
+
+        Args:
+            provider_model_string (str): The provider/model string.
+
+        Returns:
+            ModelName: The parsed model name.
+
+        Raises:
+            ValueError: If the string format is invalid or the provider is not supported.
+        """
+    def to_string(self) -> str:
+        """Return the standard format as a string.
+
+        Returns:
+            str: The formatted string representation.
+        """
+    def get_full_name(self) -> str:
+        """Return the complete model identifier.
+
+        For cloud providers: name[-version]
+        For TGI: base64-encoded-url
+        For TEI: base64-encoded-url
+        For VLLM: model-name@base64-encoded-url
+
+        Returns:
+            str: The complete model identifier.
+
+        Raises:
+            ValueError: If URL is required but not provided, or if URL is invalid.
+        """

gllm_plugin/tools/__init__.pyi

@@ -0,0 +1,3 @@
+from gllm_plugin.tools.decorators import get_plugin_metadata as get_plugin_metadata, is_tool_plugin as is_tool_plugin, tool_plugin as tool_plugin
+
+__all__ = ['tool_plugin', 'is_tool_plugin', 'get_plugin_metadata']

gllm_plugin/tools/decorators.pyi

@@ -0,0 +1,53 @@
+from _typeshed import Incomplete
+from langchain_core.tools import BaseTool
+from typing import Any, Callable
+
+logger: Incomplete
+
+def tool_plugin(version: str = '1.0.0') -> Callable[[type[BaseTool]], type[BaseTool]]:
+    '''Decorator to mark a BaseTool class as a tool plugin.
+
+    This decorator adds metadata to the tool class that will be used by the
+    plugin system when the tool is loaded. It doesn\'t directly register
+    the tool with any system, allowing for use in external repositories.
+    The actual tool name and description are intended to be retrieved
+    from the tool instance at runtime.
+
+    Args:
+        version (str): Version of the plugin. Defaults to "1.0.0".
+
+    Returns:
+        Callable[[Type[BaseTool]], Type[BaseTool]]: A decorator function that wraps the tool class.
+
+    Example:
+        ```python
+        @tool_plugin(version="1.0.0")
+        class MyAwesomeTool(BaseTool):
+            name = "my_awesome_tool"
+            description = "Does something awesome"
+
+            def _run(self, **kwargs):
+                return "Awesome result!"
+        ```
+    '''
+def is_tool_plugin(obj: Any) -> bool:
+    """Check if an object is a tool plugin.
+
+    Args:
+        obj (Any): The object to check.
+
+    Returns:
+        bool: True if the object is a decorated tool plugin, False otherwise.
+    """
+def get_plugin_metadata(tool_class: type[BaseTool]) -> dict[str, Any]:
+    """Get the plugin metadata from a decorated tool class.
+
+    Args:
+        tool_class (Type[BaseTool]): The tool class to get metadata from.
+
+    Returns:
+        dict[str, Any]: A dictionary of plugin metadata.
+
+    Raises:
+        ValueError: If the tool class is not a decorated tool plugin.
+    """

gllm_plugin-0.0.5.dev1.dist-info/METADATA

@@ -0,0 +1,71 @@
+Metadata-Version: 2.1
+Name: gllm-plugin
+Version: 0.0.5.dev1
+Summary: 
+Author: GenAI SDK Team
+Author-email: gat-sdk@gdplabs.id
+Requires-Python: >=3.11,<3.13
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Provides-Extra: flair
+Requires-Dist: bosa-core
+Requires-Dist: gllm-core
+Requires-Dist: gllm-inference
+Requires-Dist: gllm-pipeline
+Requires-Dist: langchain (>=0.3.0,<0.4.0)
+Requires-Dist: langchain-core (>=0.3.51)
+Requires-Dist: semver (>=3.0.4,<4.0.0)
+Description-Content-Type: text/markdown
+
+# GDP Labs GenAI Plugin
+
+## Description
+
+A library to implement Plugin architecture and integrate with existing pipelines.
+
+## Installation
+
+1. Python v3.11 or above:
+
+    You can install Python using [Miniconda](https://docs.anaconda.com/free/miniconda/index.html).
+
+2. [Poetry](https://python-poetry.org/docs/) v1.8.2:
+
+    You can install Poetry using cURL (you need Python to install Poetry):
+    ```bash
+    curl -sSL https://install.python-poetry.org | python3 -
+    ```
+
+3. Install the library using Poetry:
+
+    ```bash
+    # Add GDP Labs artifact repository as primary source
+    poetry source add gen-ai https://asia-southeast2-python.pkg.dev/gdp-labs/gen-ai/simple/ --priority=primary
+
+    # Add PyPI as supplemental source
+    poetry source add pypi --priority=supplemental
+
+    # Authenticate to GDP Labs SDK libraries (only gat@gdplabs.id group team has access)
+    poetry config http-basic.gen-ai oauth2accesstoken "$(gcloud auth print-access-token)"
+    
+    # Latest version
+    poetry add gllm-plugin --source gen-ai
+
+    # Specific version
+    poetry add gllm-plugin@0.0.1b5 --source gen-ai
+    ```
+
+4. At this step, you can deactivate Miniconda environment as Poetry will create and manage its own virtual environment for you.
+    ```bash
+    conda deactivate
+    ```
+
+5. Try running the unit test to see if it's working:
+    ```bash
+    poetry run pytest
+    ```
+
+## Usage
+For more information, please refer to the [PIPELINE.md](https://github.com/GDP-ADMIN/gen-ai-external/blob/main/libs/gllm-plugin/PIPELINE.md).
+

gllm_plugin-0.0.5.dev1.dist-info/RECORD

@@ -0,0 +1,20 @@
+gllm_plugin/__init__.pyi,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gllm_plugin/config/__init__.pyi,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gllm_plugin/config/app_config.pyi,sha256=u8GKpA2RfbPcc_f-Cs1PSEXxzlMBXh9Lk_FCyNilzYA,233
+gllm_plugin/config/constant.pyi,sha256=0n-BprzqEIepx8DkZHYEKeZat2VuZUweotwXOAG9hdc,564
+gllm_plugin/pipeline/__init__.pyi,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gllm_plugin/pipeline/base_pipeline_preset_config.pyi,sha256=iNzseVfo4UUPNSb1mMIGEjkqzA3Doa1EJHH_mFjqAEw,979
+gllm_plugin/pipeline/pipeline_handler.pyi,sha256=z0i8K-36VoL_JffGPxGpGlacf3QBeb-z59zOcYvptL4,5996
+gllm_plugin/pipeline/pipeline_plugin.pyi,sha256=KwL1DiUuE9TP1n_8hOi5D2qVpklX8m3MgtDkkGQhD8Q,3082
+gllm_plugin/storage/__init__.pyi,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gllm_plugin/storage/base_anonymizer_storage.pyi,sha256=Hv9WMbSakKePD_npOOD4fxXWxJt_qdISgCOkOUf2BqY,1818
+gllm_plugin/storage/base_chat_history_storage.pyi,sha256=qgRC2clzOBs9WZ_ObIeAMQ114T_5CGkZOtfGADaofSs,11768
+gllm_plugin/supported_models.pyi,sha256=4-yZ7F46fCBy6GuvZ6WukyEInUmoM7vwytp_8OCQkGM,5709
+gllm_plugin/tools/__init__.pyi,sha256=7-eCKyzV0E_a17GyxWIhOMTzTgIsJCq-znVsbE35l1o,214
+gllm_plugin/tools/decorators.pyi,sha256=i5DooMyw-7z59Gi9uUSyT4T5eUSne6uih64-CQ3F0aY,1708
+gllm_plugin.build/.gitignore,sha256=aEiIwOuxfzdCmLZe4oB1JsBmCUxwG8x-u-HBCV9JT8E,1
+gllm_plugin.cpython-311-darwin.so,sha256=vyBDpiy08RhjzcBJM83DF62zyg7LXsw8MFf-S-0Zsc8,739152
+gllm_plugin.pyi,sha256=5Gz4wVBrRp8zcmqfPVeeR1sHP_exeLLc9tHsAneMzMM,661
+gllm_plugin-0.0.5.dev1.dist-info/METADATA,sha256=_1HHuZNqEgMlDynXCQHXpVyMj57978uuyaHrks65Z1g,2137
+gllm_plugin-0.0.5.dev1.dist-info/WHEEL,sha256=h9XAMipeFIBqDUT_aBB0JdEY0xFkdkjrW2Vy94TWs4I,106
+gllm_plugin-0.0.5.dev1.dist-info/RECORD,,

gllm_plugin-0.0.5.dev1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.0
+Root-Is-Purelib: false
+Tag: cp311-cp311-macosx_14_0_arm64

gllm_plugin.build/.gitignore

@@ -0,0 +1 @@
+*

gllm_plugin.pyi

@@ -0,0 +1,33 @@
+# This file was generated by Nuitka
+
+# Stubs included by default
+
+
+__name__ = ...
+
+
+
+# Modules used internally, to allow implicit dependencies to be seen:
+import os
+import typing
+import pydantic
+import enum
+import bosa_core
+import bosa_core.plugin
+import bosa_core.plugin.handler
+import gllm_core
+import gllm_core.utils
+import gllm_inference
+import gllm_inference.catalog
+import gllm_pipeline
+import gllm_pipeline.pipeline
+import gllm_pipeline.pipeline.pipeline
+import abc
+import bosa_core.plugin.plugin
+import gllm_inference.catalog.catalog
+import datetime
+import typing_extensions
+import base64
+import inspect
+import langchain_core
+import langchain_core.tools