gllm-inference-binary 0.5.22__cp312-cp312-win_amd64.whl → 0.5.23__cp312-cp312-win_amd64.whl

gllm_inference/request_processor/uses_lm_mixin.pyi

@@ -1,40 +1,104 @@
+from gllm_inference.builder.build_lm_invoker import build_lm_invoker as build_lm_invoker
 from gllm_inference.lm_invoker.lm_invoker import BaseLMInvoker as BaseLMInvoker
 from gllm_inference.output_parser.output_parser import BaseOutputParser as BaseOutputParser
 from gllm_inference.prompt_builder.prompt_builder import PromptBuilder as PromptBuilder
 from gllm_inference.request_processor.lm_request_processor import LMRequestProcessor as LMRequestProcessor
+from gllm_inference.schema import LMOutput as LMOutput
+from pydantic import BaseModel as BaseModel
 from typing import Any
 
 class UsesLM:
-    '''A mixin to initialize classes that use LMRequestProcessor by providing the components directly.
-
-    This mixin should be extended by classes that use LMRequestProcessor. Extending this mixin allows the class to
-    create an instance of itself by providing the LMRequestProcessor components directly.
-
-    For example:
-    ```python
-    class LMBasedComponent(BaseComponent, UsesLM):
-        def __init__(self, lm_request_processor: LMRequestProcessor, custom_kwarg: str):
-            self.lm_request_processor = lm_request_processor
-            self.custom_kwarg = custom_kwarg
-    ```
-
-    Then, the class can be instantiated with the following:
-    ```python
-    component = LMBasedComponent.from_lm_components(
-        prompt_builder,
-        lm_invoker,
-        output_parser,
-        **{"custom_kwarg": "custom_value"},
-    )
-    ```
-
-    Note:
-        Classes that extend this mixin must have a constructor that accepts the LMRequestProcessor instance as its
-        first argument.
+    '''A mixin to be extended by components that use LMRequestProcessor.
+
+    This mixin should be extended by components that use LMRequestProcessor. Components that extend this mixin
+    must have a constructor that accepts the LMRequestProcessor instance as its first argument.
+
+    LM based components can be categorized into two types:
+    1. Components that do not utilize structured output.
+    2. Components that utilize structured output.
+
+    Building a component without structured output:
+        As defined above, the component must accepts an LMRequestProcessor instance as its first argument, e.g.:
+        ```python
+        class LMBasedComponent(Component, UsesLM):
+            def __init__(self, lm_request_processor: LMRequestProcessor, custom_kwarg: str):
+                self.lm_request_processor = lm_request_processor
+                self.custom_kwarg = custom_kwarg
+        ```
+
+        Using the `from_lm_components` method provided by this mixin, the component can be instantiated as follows:
+        ```python
+        component = LMBasedComponent.from_lm_components(
+            prompt_builder,
+            lm_invoker,
+            output_parser,
+            custom_kwarg="custom_value",
+        )
+        ```
+
+    Building a component with structured output:
+        When the component utilizes structured output, the `_parse_structured_output` method can be used
+        to simplify the process of extracting the structured output in the component\'s runtime methods, e.g.:
+        ```python
+        class LMBasedComponent(Component, UsesLM):
+            def __init__(self, lm_request_processor: LMRequestProcessor, custom_kwarg: str):
+                self.lm_request_processor = lm_request_processor
+                self.custom_kwarg = custom_kwarg
+
+            def runtime_method(self, param1: str, param2: str) -> str:
+                lm_output = self.lm_request_processor.process(param1=param1, param2=param2)
+                return self._parse_structured_output(lm_output, "target_key", "fallback_output")
+        ```
+
+        Notice that in the above example, the LMRequestProcessor is configured to take `param1` and `param2`
+        as keyword arguments and output a structured output that contains the `target_key` key. Hence,
+        these conditions must be fulfilled when instantiating the component.
+
+        This mixin also provides the `with_structured_output` method to simplify the process of instantiating
+        the component with structured output. Let\'s take a look at an example that meets the above conditions:
+        ```python
+        class Schema(BaseModel):
+            target_key: str
+
+        component = LMBasedComponent.with_structured_output(
+            model_id="openai/gpt-4.1-mini",
+            response_schema=Schema,
+            system_template="system_template {param1}",
+            user_template="user_template {param2}",
+            custom_kwarg="custom_value",
+        )
+        ```
+
+    Building a structured output preset:
+        If desired, the component can also define a quick preset. This can be done by providing default prompts
+        as response schema. Here\'s an example:
+        ```python
+        class Schema(BaseModel):
+            target_key: str
+
+        @classmethod
+        def from_preset(cls, model_id: str, custom_kwarg: str) -> "LMBasedComponent":
+            return cls.with_structured_output(
+                model_id=model_id,
+                response_schema=Schema,
+                system_template=PRESET_SYSTEM_TEMPLATE,
+                user_template=PRESET_USER_TEMPLATE,
+                custom_kwarg=custom_kwarg,
+            )
+        )
+        ```
+
+        Then, the preset can be instantiated as follows:
+        ```python
+        component = LMBasedComponent.from_preset(
+            model_id="openai/gpt-4.1-mini",
+            custom_kwarg="custom_value",
+        )
+        ```
     '''
     @classmethod
-    def from_lm_components(cls, prompt_builder: PromptBuilder, lm_invoker: BaseLMInvoker, output_parser: BaseOutputParser | None = None, **kwargs: Any):
-        """Creates an instance by initializing LMRequestProcessor with given components.
+    def from_lm_components(cls, prompt_builder: PromptBuilder, lm_invoker: BaseLMInvoker, output_parser: BaseOutputParser | None = None, **kwargs: Any) -> UsesLM:
+        """Creates an instance from LMRequestProcessor components directly.
 
         This method is a shortcut to initialize the class by providing the LMRequestProcessor components directly.
 
@@ -46,5 +110,21 @@ class UsesLM:
             **kwargs (Any): Additional keyword arguments to be passed to the class constructor.
 
         Returns:
-            An instance of the class that mixes in this mixin.
+            UsesLM: An instance of the class that mixes in this mixin.
+        """
+    @classmethod
+    def with_structured_output(cls, model_id: str, response_schema: type[BaseModel], system_template: str = '', user_template: str = '', **kwargs: Any) -> UsesLM:
+        """Creates an instance with structured output configuration.
+
+        This method is a shortcut to initialize the class with structured output configuration.
+
+        Args:
+            model_id (str): The model ID of the language model.
+            response_schema (type[BaseModel]): The response schema of the language model.
+            system_template (str, optional): The system template of the language model. Defaults to an empty string.
+            user_template (str, optional): The user template of the language model. Defaults to an empty string.
+            **kwargs (Any): Additional keyword arguments to be passed to the class constructor.
+
+        Returns:
+            UsesLM: An instance of the class that mixes in this mixin with structured output configuration.
         """

{gllm_inference_binary-0.5.22.dist-info → gllm_inference_binary-0.5.23.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gllm-inference-binary
-Version: 0.5.22
+Version: 0.5.23
 Summary: A library containing components related to model inferences in Gen AI applications.
 Author: Henry Wicaksono
 Author-email: henry.wicaksono@gdplabs.id

{gllm_inference_binary-0.5.22.dist-info → gllm_inference_binary-0.5.23.dist-info}/RECORD

@@ -77,7 +77,7 @@ gllm_inference/prompt_formatter/openai_prompt_formatter.pyi,sha256=xGpytprs5W1To
 gllm_inference/prompt_formatter/prompt_formatter.pyi,sha256=hAc6rxWc6JSYdD-OypLixGKXlPA8djE7zJqZpVKXcOs,1176
 gllm_inference/request_processor/__init__.pyi,sha256=giEme2WFQhgyKiBZHhSet0_nKSCHwGy-_2p6NRzg0Zc,231
 gllm_inference/request_processor/lm_request_processor.pyi,sha256=0fy1HyILCVDw6y46E-7tLnQTRYx4ppeRMe0QP6t9Jyw,5990
-gllm_inference/request_processor/uses_lm_mixin.pyi,sha256=znBG4AWWm_H70Qqrc1mO4ohmWotX9id81Fqe-x9Qa6Q,2371
+gllm_inference/request_processor/uses_lm_mixin.pyi,sha256=LYHq-zLoXEMel1LfVdYv7W3BZ8WtBLo_WWFjRf10Yto,6512
 gllm_inference/schema/__init__.pyi,sha256=bYdXkfqkNAKEr48xaOKKQTbt2zLcCPiLCdSl2UTEIfE,1521
 gllm_inference/schema/attachment.pyi,sha256=9zgAjGXBjLfzPGaKi68FMW6b5mXdEA352nDe-ynOSvY,3385
 gllm_inference/schema/code_exec_result.pyi,sha256=WQ-ARoGM9r6nyRX-A0Ro1XKiqrc9R3jRYXZpu_xo5S4,573
@@ -96,8 +96,8 @@ gllm_inference/utils/io_utils.pyi,sha256=Eg7dvHWdXslTKdjh1j3dG50i7r35XG2zTmJ9XXv
 gllm_inference/utils/langchain.pyi,sha256=4AwFiVAO0ZpdgmqeC4Pb5NJwBt8vVr0MSUqLeCdTscc,1194
 gllm_inference/utils/validation.pyi,sha256=-RdMmb8afH7F7q4Ao7x6FbwaDfxUHn3hA3WiOgzB-3s,397
 gllm_inference.build/.gitignore,sha256=aEiIwOuxfzdCmLZe4oB1JsBmCUxwG8x-u-HBCV9JT8E,1
-gllm_inference.cp312-win_amd64.pyd,sha256=0xFeQfNixoGL0j_6hvZ9WWKAoWkPgeJ24geXEzcEOp4,2974208
+gllm_inference.cp312-win_amd64.pyd,sha256=pFLMLpBS5yOsZxT3fwEAOSZ-t8kcRnLVByTDXYf-kqM,2994176
 gllm_inference.pyi,sha256=lTVixRzlC12Joi4kW_vxnux0rLHAUB_3j7RMFOwLK-M,3616
-gllm_inference_binary-0.5.22.dist-info/METADATA,sha256=cYrD49wnleGgC4XFM7sECpvEUXxaoewJ9DOBqCCQdwc,4615
-gllm_inference_binary-0.5.22.dist-info/WHEEL,sha256=4N0hGcnWMI_Ty6ATf4qJqqSl-UNI-Ln828iTWGIywmU,98
-gllm_inference_binary-0.5.22.dist-info/RECORD,,
+gllm_inference_binary-0.5.23.dist-info/METADATA,sha256=zuk4QzAoRrrwKmjbfX4jgFotZrE6Olk-behj1vcrRGk,4615
+gllm_inference_binary-0.5.23.dist-info/WHEEL,sha256=4N0hGcnWMI_Ty6ATf4qJqqSl-UNI-Ln828iTWGIywmU,98
+gllm_inference_binary-0.5.23.dist-info/RECORD,,