glchat-plugin 0.2.12__py3-none-any.whl → 0.3.1__py3-none-any.whl

glchat_plugin/config/constant.py

@@ -62,3 +62,48 @@ class SearchType(StrEnum):
             stacklevel=2,
         )
         return cls._DEEP_RESEARCH
+
+
+class ReferenceFormatterType(StrEnum):
+    """The type of reference formatter to use.
+
+    Attributes:
+        SIMILARITY: Use similarity based reference formatter.
+        LM: Use LM based reference formatter.
+        NONE: No reference formatter is used.
+    """
+
+    SIMILARITY = "similarity"
+    LM = "lm"
+    NONE = "none"
+
+
+class TopicSafetyMode(StrEnum):
+    """Topic safety mode enumeration for guardrail configuration."""
+
+    ALLOWLIST = "allowlist"
+    DENYLIST = "denylist"
+    HYBRID = "hybrid"
+    DISABLED = "disabled"
+
+
+class GuardrailMode(StrEnum):
+    """Guardrail mode enumeration for guardrail configuration."""
+
+    DISABLED = "disabled"
+    INPUT_ONLY = "input_only"
+    OUTPUT_ONLY = "output_only"
+    BOTH = "both"
+
+
+WEB_SEARCH_BLACKLIST_DEFAULT = "[]"
+WEB_SEARCH_WHITELIST_DEFAULT = "[]"
+
+GUARDRAIL_ERR_MSG = (
+    "I apologize, but I cannot process your request as it appears to violate our content guidelines. "
+    "This could be due to:\n"
+    "- Inappropriate or harmful content\n"
+    "- Requests that go against our safety policies\n"
+    "- Content that may violate legal or ethical standards\n\n"
+    "Please rephrase your question or ask about a different topic that complies with our guidelines."
+)

glchat_plugin/pipeline/base_pipeline_preset_config.py

@@ -9,9 +9,17 @@ References:
 
 from typing import Any
 
-from pydantic import BaseModel
+from pydantic import BaseModel, Field
 
-from glchat_plugin.config.constant import SearchType
+from glchat_plugin.config.constant import (
+    GUARDRAIL_ERR_MSG,
+    WEB_SEARCH_BLACKLIST_DEFAULT,
+    WEB_SEARCH_WHITELIST_DEFAULT,
+    GuardrailMode,
+    ReferenceFormatterType,
+    SearchType,
+    TopicSafetyMode,
+)
 
 
 class BasePipelinePresetConfig(BaseModel):
@@ -25,6 +33,35 @@ class BasePipelinePresetConfig(BaseModel):
         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.
+        allowed_topics (str): The allowed topics.
+        anonymize_em (bool): Whether to anonymize before using the embedding model.
+        anonymize_lm (bool): Whether to anonymize before using the language model.
+        augment_context (bool): Whether context augmentation from the knowledge base is allowed.
+        banned_phrases (str): The banned phrases.
+        chat_history_limit (int): The chat history limit. If the value is negative, no limit will be applied.
+        enable_guardrails (bool): Whether to enable guardrails.
+        enable_memory (bool): Whether to enable memory.
+        enable_smart_search_integration (bool): Whether to enable smart search integration.
+        guardrail_fallback_message (str): The guardrail fallback message.
+        guardrail_mode (GuardrailMode): The guardrail mode.
+        normal_search_top_k (int): The top k for normal search. Must be greater than or equal to 1.
+        prompt_context_char_threshold (int): The character limit above which the prompt is assumed
+            to have contained the context.
+        reference_formatter_batch_size (int): The reference formatter batch size.
+        reference_formatter_threshold (float): The reference formatter threshold.
+        reference_formatter_type (ReferenceFormatterType): The reference formatter type.
+        rerank_kwargs (str): The rerank kwargs.
+        rerank_type (str): The rerank type.
+        retrieve_memory_threshold (float): The retrieve memory threshold.
+        retrieve_memory_top_k (int): The retrieve memory top k.
+        smart_search_top_k (int): The top k for smart search. Must be greater than or equal to 1.
+        topic_safety_mode (TopicSafetyMode): The topic safety mode.
+        use_cache (bool): Whether to use cache.
+        use_model_knowledge (bool): Whether to use model knowledge.
+        vector_weight (float): The vector weight. Must be between 0 and 1 (inclusive).
+        web_search_blacklist (str): The web search blacklist.
+        web_search_top_k (int): The top k for web search. Must be greater than or equal to 1.
+        web_search_whitelist (str): The web search whitelist.
     """
 
     pipeline_preset_id: str
@@ -34,3 +71,31 @@ class BasePipelinePresetConfig(BaseModel):
     support_multimodal: bool
     use_docproc: bool
     search_types: list[SearchType]
+    allowed_topics: str = "[]"
+    anonymize_em: bool
+    anonymize_lm: bool
+    augment_context: bool
+    banned_phrases: str = "[]"
+    chat_history_limit: int
+    enable_guardrails: bool = False
+    enable_memory: bool = False
+    enable_smart_search_integration: bool = False
+    guardrail_fallback_message: str = Field(default=GUARDRAIL_ERR_MSG)
+    guardrail_mode: GuardrailMode = Field(default=GuardrailMode.INPUT_ONLY)
+    normal_search_top_k: int = Field(ge=1)
+    prompt_context_char_threshold: int = 32000
+    reference_formatter_batch_size: int = Field(ge=1)
+    reference_formatter_threshold: float = Field(ge=0, le=1)
+    reference_formatter_type: ReferenceFormatterType
+    rerank_kwargs: str = "{}"
+    rerank_type: str = ""
+    retrieve_memory_threshold: float = Field(default=0.3, ge=0, le=1)
+    retrieve_memory_top_k: int = Field(default=10, ge=1)
+    smart_search_top_k: int = Field(ge=1)
+    topic_safety_mode: TopicSafetyMode = Field(default=TopicSafetyMode.HYBRID)
+    use_cache: bool
+    use_model_knowledge: bool
+    vector_weight: float = Field(ge=0, le=1)
+    web_search_blacklist: str = Field(default=WEB_SEARCH_BLACKLIST_DEFAULT)
+    web_search_top_k: int = Field(ge=1)
+    web_search_whitelist: str = Field(default=WEB_SEARCH_WHITELIST_DEFAULT)

{glchat_plugin-0.2.12.dist-info → glchat_plugin-0.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: glchat-plugin
-Version: 0.2.12
+Version: 0.3.1
 Author-email: GenAI SDK Team <gat-sdk@gdplabs.id>
 Requires-Python: <3.13,>=3.11
 Description-Content-Type: text/markdown

{glchat_plugin-0.2.12.dist-info → glchat_plugin-0.3.1.dist-info}/RECORD

@@ -1,13 +1,13 @@
 glchat_plugin/__init__.py,sha256=SHSBMz7JDU6MecyIrhHu5-3NVs89JkXhyvD3ZGOkWOE,37
 glchat_plugin/config/__init__.py,sha256=DNnX8B_TvAN89oyMgq32zG1DeaezODrihiAXTwOPT5o,39
 glchat_plugin/config/app_config.py,sha256=9_ShYtaQ7Rp14sSkrIFLoOAMlbwVlm13EuCxzOn4NCI,426
-glchat_plugin/config/constant.py,sha256=D8BCSkwL7AbXUT_zdsXEdLmmuSlLThSJn7-02niZeXI,2340
+glchat_plugin/config/constant.py,sha256=Hsex2hjz4yV9lSFeLWMp5i9lRTUOiwBXYx5FZu584Nk,3577
 glchat_plugin/context/__init__.py,sha256=3Wx_apMIS6z-m6eRs6hoyOsJFLJfKmMFOkrPDkPQfJI,40
 glchat_plugin/context/context_manager.py,sha256=0lhO0w_hd5dUdIEJQ2LOJFZsgpzitQU_aPZfTfQK3vw,1302
 glchat_plugin/handler/__init__.py,sha256=H5DJaAfwwtRsvMcOaEzHfGMQk25H7la0E7uPfksWtoQ,40
 glchat_plugin/handler/base_post_login_handler.py,sha256=48xSbe_LwTCjRY-lCuzWXqbnEr1ql8bAhQih1Xeh8f8,2835
 glchat_plugin/pipeline/__init__.py,sha256=Sk-NfIGyA9VKIg0Bt5OHatNUYyWVPh9i5xhE5DFAfbo,41
-glchat_plugin/pipeline/base_pipeline_preset_config.py,sha256=2DxJlroZ_tvVO6DYo1R07cjhWgKQJpysw1GsJ3BNRnw,1100
+glchat_plugin/pipeline/base_pipeline_preset_config.py,sha256=QkFDllWXwj4bKyH4sF9yjknhVNrSR9ZPiXHIS_hANSc,4683
 glchat_plugin/pipeline/pipeline_handler.py,sha256=aCRvhS6Dkhmqsx_Ya-2t2PbMseacw1VI6PUEOQq0RsM,25620
 glchat_plugin/pipeline/pipeline_plugin.py,sha256=fozvxVrOphgwLIF7uPrEkF8ZQcu8xgifYAQyuxj9628,4393
 glchat_plugin/service/__init__.py,sha256=9T4qzyYL052qLqva5el1F575OTRNaaf9tb9UvW-leTc,47
@@ -19,7 +19,7 @@ glchat_plugin/storage/base_anonymizer_storage.py,sha256=oFwovWrsjM7v1YjeN-4p-M3O
 glchat_plugin/storage/base_chat_history_storage.py,sha256=JvUUFMu_9jRBQ9yug_x7S4rQjZEA1vM5ombDvz-7zCE,11095
 glchat_plugin/tools/__init__.py,sha256=OFotHbgQ8mZEbdlvlv5aVMdxfubPvkVWAcTwhIPdIqQ,542
 glchat_plugin/tools/decorators.py,sha256=AvQBV18wzXWdC483RSSmpfh92zsqTyp8SzDLIkreIGU,3925
-glchat_plugin-0.2.12.dist-info/METADATA,sha256=h6yydWtgi_jo81TY5ghsCrT0GgNdjrOD_4dimxcZi7Q,2064
-glchat_plugin-0.2.12.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-glchat_plugin-0.2.12.dist-info/top_level.txt,sha256=fzKSXmct5dY4CAKku4-mkdHX-QPAyQVvo8vpQj8qizY,14
-glchat_plugin-0.2.12.dist-info/RECORD,,
+glchat_plugin-0.3.1.dist-info/METADATA,sha256=lUYcNuRxb6cJitJlkaLH5dMuO9F1vWyczplOYi7LsFM,2063
+glchat_plugin-0.3.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+glchat_plugin-0.3.1.dist-info/top_level.txt,sha256=fzKSXmct5dY4CAKku4-mkdHX-QPAyQVvo8vpQj8qizY,14
+glchat_plugin-0.3.1.dist-info/RECORD,,