hamtaa-texttools 1.1.10__py3-none-any.whl → 1.1.11__py3-none-any.whl

{hamtaa_texttools-1.1.10.dist-info → hamtaa_texttools-1.1.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hamtaa-texttools
-Version: 1.1.10
+Version: 1.1.11
 Summary: A high-level NLP toolkit built on top of modern LLMs.
 Author-email: Tohidi <the.mohammad.tohidi@gmail.com>, Montazer <montazerh82@gmail.com>, Givechi <mohamad.m.givechi@gmail.com>, MoosaviNejad <erfanmoosavi84@gmail.com>
 License: MIT License
@@ -79,7 +79,7 @@ TextTools provides several optional flags to customize LLM behavior:
 
 - **`temperature (float)`** → Determines how creative the model should respond. Takes a float number from `0.0` to `2.0`.
 
-- **`validator (Callable)`** → Forces TheTool to validate the output result based on your custom validator. Validator should return bool (True if there were no problem, False if the validation failed.) If validator failed, TheTool will retry to get another output by modifying `temperature`.
+- **`validator (Callable)`** → Forces TheTool to validate the output result based on your custom validator. Validator should return bool (True if there were no problem, False if the validation failed.) If validator failed, TheTool will retry to get another output by modifying `temperature`. You can specify `max_validation_retries=<N>` to change the number of retries.
 
 All these parameters can be used individually or together to tailor the behavior of any tool in **TextTools**.
 

{hamtaa_texttools-1.1.10.dist-info → hamtaa_texttools-1.1.11.dist-info}/RECORD

@@ -1,4 +1,4 @@
-hamtaa_texttools-1.1.10.dist-info/licenses/LICENSE,sha256=Hb2YOBKy2MJQLnyLrX37B4ZVuac8eaIcE71SvVIMOLg,1082
+hamtaa_texttools-1.1.11.dist-info/licenses/LICENSE,sha256=Hb2YOBKy2MJQLnyLrX37B4ZVuac8eaIcE71SvVIMOLg,1082
 texttools/__init__.py,sha256=EZPPNPafVGvBaxjG9anP0piqH3gAC0DdjdAckQeAgNU,251
 texttools/batch/batch_config.py,sha256=FCDXy9TfH7xjd1PHvn_CtdwEQSq-YO5sktiaMZEId58,740
 texttools/batch/batch_runner.py,sha256=zzzVIXedmaq-8fqsFtGRR64F7CtYRLlhQeBu8uMwJQg,9385
@@ -16,15 +16,15 @@ texttools/prompts/subject_to_question.yaml,sha256=C7x7rNNm6U_ZG9HOn6zuzYOtvJUZ2s
 texttools/prompts/summarize.yaml,sha256=o6rxGPfWtZd61Duvm8NVvCJqfq73b-wAuMSKR6UYUqY,459
 texttools/prompts/text_to_question.yaml,sha256=UheKYpDn6iyKI8NxunHZtFpNyfCLZZe5cvkuXpurUJY,783
 texttools/prompts/translate.yaml,sha256=mGT2uBCei6uucWqVbs4silk-UV060v3G0jnt0P6sr50,634
-texttools/tools/async_tools.py,sha256=yEj4dM2bdW_12hxvimhxPOGfGhl1PqFsHM3Z4toCTaM,14813
-texttools/tools/sync_tools.py,sha256=wHY0O8R9HipUz0P268zk1w3SlFxEIffm5EjX4tcWxNM,14579
-texttools/tools/internals/async_operator.py,sha256=5sVc5K5-Vuulsxly0IfrLmzd8W7ySI4cY09myyOGL0I,7022
-texttools/tools/internals/base_operator.py,sha256=l2Mg59MGIf396yPx1CAgcplKclOptQWeTR0UIz9VTdk,2255
+texttools/tools/async_tools.py,sha256=rLg2oU9isa_3UF9sKNzwIFjYK8pZNXcHR6P8QSKexYA,15933
+texttools/tools/sync_tools.py,sha256=eSNxPNmU1FY5u5LDJGshXSXpHb-CMrSL3Q-acacpuXU,15704
+texttools/tools/internals/async_operator.py,sha256=XawSPIylrOIN8EGXQn-X6jRXHSX-B6k-Af1lAnT2F4Y,7073
+texttools/tools/internals/base_operator.py,sha256=VgZISYaPwPaoTyoWLT_7wU17Oq4KGQ6XWDZpLwOyOm8,2179
 texttools/tools/internals/formatters.py,sha256=tACNLP6PeoqaRpNudVxBaHA25zyWqWYPZQuYysIu88g,941
-texttools/tools/internals/operator.py,sha256=W0DxTGB3cbtDfzLqwMCM8x5xiVWgN0vZWX8PzJwAQKE,6795
 texttools/tools/internals/output_models.py,sha256=ekpbyocmXj_dee7ieOT1zOkMo9cPHT7xcUFCZoUaXA0,1886
 texttools/tools/internals/prompt_loader.py,sha256=4g6-U8kqrGN7VpNaRcrBcnF-h03PXjUDBP0lL0_4EZY,1953
-hamtaa_texttools-1.1.10.dist-info/METADATA,sha256=6X7Qd8nOAIn7reZ5l-66CyK5fczMADtlIfdIbypJIUE,9101
-hamtaa_texttools-1.1.10.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-hamtaa_texttools-1.1.10.dist-info/top_level.txt,sha256=5Mh0jIxxZ5rOXHGJ6Mp-JPKviywwN0MYuH0xk5bEWqE,10
-hamtaa_texttools-1.1.10.dist-info/RECORD,,
+texttools/tools/internals/sync_operator.py,sha256=UCzQatIeZ_o6sQr3lna1elYpUphHcO6EeJwMK8PymAk,6846
+hamtaa_texttools-1.1.11.dist-info/METADATA,sha256=nSiDrQTIQRX957pwvXAHsppGuwI5eU8HdAmgqyrTgew,9179
+hamtaa_texttools-1.1.11.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+hamtaa_texttools-1.1.11.dist-info/top_level.txt,sha256=5Mh0jIxxZ5rOXHGJ6Mp-JPKviywwN0MYuH0xk5bEWqE,10
+hamtaa_texttools-1.1.11.dist-info/RECORD,,

texttools/tools/async_tools.py

@@ -35,6 +35,7 @@ class AsyncTheTool:
         logprobs: bool = False,
         top_logprobs: int | None = None,
         validator: Callable[[Any], bool] | None = None,
+        max_validation_retries: int | None = None,
     ) -> OM.ToolOutput:
         """
         Categorize a text into a single Islamic studies domain category.
@@ -54,6 +55,7 @@ class AsyncTheTool:
             logprobs=logprobs,
             top_logprobs=top_logprobs,
             validator=validator,
+            max_validation_retries=max_validation_retries,
             # Internal parameters
             prompt_file="categorizer.yaml",
             output_model=OM.CategorizerOutput,
@@ -71,6 +73,7 @@ class AsyncTheTool:
         logprobs: bool = False,
         top_logprobs: int | None = None,
         validator: Callable[[Any], bool] | None = None,
+        max_validation_retries: int | None = None,
     ) -> OM.ToolOutput:
         """
         Extract salient keywords from text.
@@ -91,6 +94,7 @@ class AsyncTheTool:
             logprobs=logprobs,
             top_logprobs=top_logprobs,
             validator=validator,
+            max_validation_retries=max_validation_retries,
             # Internal parameters
             prompt_file="extract_keywords.yaml",
             output_model=OM.ListStrOutput,
@@ -107,6 +111,7 @@ class AsyncTheTool:
         logprobs: bool = False,
         top_logprobs: int | None = None,
         validator: Callable[[Any], bool] | None = None,
+        max_validation_retries: int | None = None,
     ) -> OM.ToolOutput:
         """
         Perform Named Entity Recognition (NER) over the input text.
@@ -127,6 +132,7 @@ class AsyncTheTool:
             logprobs=logprobs,
             top_logprobs=top_logprobs,
             validator=validator,
+            max_validation_retries=max_validation_retries,
             # Internal parameters
             prompt_file="extract_entities.yaml",
             output_model=OM.ListDictStrStrOutput,
@@ -142,6 +148,7 @@ class AsyncTheTool:
         logprobs: bool = False,
         top_logprobs: int | None = None,
         validator: Callable[[Any], bool] | None = None,
+        max_validation_retries: int | None = None,
     ) -> OM.ToolOutput:
         """
         Detect if the input is phrased as a question.
@@ -161,6 +168,7 @@ class AsyncTheTool:
             logprobs=logprobs,
             top_logprobs=top_logprobs,
             validator=validator,
+            max_validation_retries=max_validation_retries,
             # Internal parameters
             prompt_file="is_question.yaml",
             output_model=OM.BoolOutput,
@@ -178,6 +186,7 @@ class AsyncTheTool:
         logprobs: bool = False,
         top_logprobs: int | None = None,
         validator: Callable[[Any], bool] | None = None,
+        max_validation_retries: int | None = None,
     ) -> OM.ToolOutput:
         """
         Generate a single question from the given text.
@@ -198,6 +207,7 @@ class AsyncTheTool:
             logprobs=logprobs,
             top_logprobs=top_logprobs,
             validator=validator,
+            max_validation_retries=max_validation_retries,
             # Internal parameters
             prompt_file="text_to_question.yaml",
             output_model=OM.StrOutput,
@@ -215,6 +225,7 @@ class AsyncTheTool:
         top_logprobs: int | None = None,
         mode: Literal["default", "reason"] = "default",
         validator: Callable[[Any], bool] | None = None,
+        max_validation_retries: int | None = None,
     ) -> OM.ToolOutput:
         """
         Merge multiple questions into a single unified question.
@@ -236,6 +247,7 @@ class AsyncTheTool:
             logprobs=logprobs,
             top_logprobs=top_logprobs,
             validator=validator,
+            max_validation_retries=max_validation_retries,
             # Internal parameters
             prompt_file="merge_questions.yaml",
             output_model=OM.StrOutput,
@@ -253,6 +265,7 @@ class AsyncTheTool:
         top_logprobs: int | None = None,
         mode: Literal["positive", "negative", "hard_negative"] = "positive",
         validator: Callable[[Any], bool] | None = None,
+        max_validation_retries: int | None = None,
     ) -> OM.ToolOutput:
         """
         Rewrite a text with different modes.
@@ -273,6 +286,7 @@ class AsyncTheTool:
             logprobs=logprobs,
             top_logprobs=top_logprobs,
             validator=validator,
+            max_validation_retries=max_validation_retries,
             # Internal parameters
             prompt_file="rewrite.yaml",
             output_model=OM.StrOutput,
@@ -290,6 +304,7 @@ class AsyncTheTool:
         logprobs: bool = False,
         top_logprobs: int | None = None,
         validator: Callable[[Any], bool] | None = None,
+        max_validation_retries: int | None = None,
     ) -> OM.ToolOutput:
         """
         Generate a list of questions about a subject.
@@ -311,6 +326,7 @@ class AsyncTheTool:
             logprobs=logprobs,
             top_logprobs=top_logprobs,
             validator=validator,
+            max_validation_retries=max_validation_retries,
             # Internal parameters
             prompt_file="subject_to_question.yaml",
             output_model=OM.ReasonListStrOutput,
@@ -327,6 +343,7 @@ class AsyncTheTool:
         logprobs: bool = False,
         top_logprobs: int | None = None,
         validator: Callable[[Any], bool] | None = None,
+        max_validation_retries: int | None = None,
     ) -> OM.ToolOutput:
         """
         Summarize the given subject text.
@@ -347,6 +364,7 @@ class AsyncTheTool:
             logprobs=logprobs,
             top_logprobs=top_logprobs,
             validator=validator,
+            max_validation_retries=max_validation_retries,
             # Internal parameters
             prompt_file="summarize.yaml",
             output_model=OM.StrOutput,
@@ -363,6 +381,7 @@ class AsyncTheTool:
         logprobs: bool = False,
         top_logprobs: int | None = None,
         validator: Callable[[Any], bool] | None = None,
+        max_validation_retries: int | None = None,
     ) -> OM.ToolOutput:
         """
         Translate text between languages.
@@ -383,6 +402,7 @@ class AsyncTheTool:
             logprobs=logprobs,
             top_logprobs=top_logprobs,
             validator=validator,
+            max_validation_retries=max_validation_retries,
             # Internal parameters
             prompt_file="translate.yaml",
             output_model=OM.StrOutput,

texttools/tools/internals/async_operator.py

@@ -81,6 +81,7 @@ class AsyncOperator(BaseOperator):
         logprobs: bool,
         top_logprobs: int | None,
         validator: Callable[[Any], bool] | None,
+        max_validation_retries: int | None,
         # Internal parameters
         prompt_file: str,
         output_model: Type[T],
@@ -141,7 +142,7 @@ class AsyncOperator(BaseOperator):
 
             # Retry logic if validation fails
             if validator and not validator(output.result):
-                for attempt in range(self.MAX_RETRIES):
+                for attempt in range(max_validation_retries):
                     logger.warning(
                         f"Validation failed, retrying for the {attempt + 1} time."
                     )

texttools/tools/internals/base_operator.py

@@ -13,9 +13,6 @@ ClientType = Union[OpenAI, AsyncOpenAI]
 
 
 class BaseOperator:
-    # Max retry in case of failed output validation
-    MAX_RETRIES = 3
-
     def __init__(self, client: ClientType, model: str):
         self._client = client
         self._model = model

texttools/tools/internals/{operator.py → sync_operator.py}

@@ -80,6 +80,7 @@ class Operator(BaseOperator):
         logprobs: bool,
         top_logprobs: int | None,
         validator: Callable[[Any], bool] | None,
+        max_validation_retries: int | None,
         # Internal parameters
         prompt_file: str,
         output_model: Type[T],
@@ -139,7 +140,7 @@ class Operator(BaseOperator):
 
             # Retry logic if validation fails
             if validator and not validator(output.result):
-                for attempt in range(self.MAX_RETRIES):
+                for attempt in range(max_validation_retries):
                     logger.warning(
                         f"Validation failed, retrying for the {attempt + 1} time."
                     )

texttools/tools/sync_tools.py

@@ -2,7 +2,7 @@ from typing import Literal, Any, Callable
 
 from openai import OpenAI
 
-from texttools.tools.internals.operator import Operator
+from texttools.tools.internals.sync_operator import Operator
 import texttools.tools.internals.output_models as OM
 
 
@@ -33,6 +33,7 @@ class TheTool:
         logprobs: bool = False,
         top_logprobs: int | None = None,
         validator: Callable[[Any], bool] | None = None,
+        max_validation_retries: int | None = None,
     ) -> OM.ToolOutput:
         """
         Categorize a text into a single Islamic studies domain category.
@@ -52,6 +53,7 @@ class TheTool:
             logprobs=logprobs,
             top_logprobs=top_logprobs,
             validator=validator,
+            max_validation_retries=max_validation_retries,
             # Internal parameters
             prompt_file="categorizer.yaml",
             output_model=OM.CategorizerOutput,
@@ -69,6 +71,7 @@ class TheTool:
         logprobs: bool = False,
         top_logprobs: int | None = None,
         validator: Callable[[Any], bool] | None = None,
+        max_validation_retries: int | None = None,
     ) -> OM.ToolOutput:
         """
         Extract salient keywords from text.
@@ -89,6 +92,7 @@ class TheTool:
             logprobs=logprobs,
             top_logprobs=top_logprobs,
             validator=validator,
+            max_validation_retries=max_validation_retries,
             # Internal parameters
             prompt_file="extract_keywords.yaml",
             output_model=OM.ListStrOutput,
@@ -105,6 +109,7 @@ class TheTool:
         logprobs: bool = False,
         top_logprobs: int | None = None,
         validator: Callable[[Any], bool] | None = None,
+        max_validation_retries: int | None = None,
     ) -> OM.ToolOutput:
         """
         Perform Named Entity Recognition (NER) over the input text.
@@ -125,6 +130,7 @@ class TheTool:
             logprobs=logprobs,
             top_logprobs=top_logprobs,
             validator=validator,
+            max_validation_retries=max_validation_retries,
             # Internal parameters
             prompt_file="extract_entities.yaml",
             output_model=OM.ListDictStrStrOutput,
@@ -140,6 +146,7 @@ class TheTool:
         logprobs: bool = False,
         top_logprobs: int | None = None,
         validator: Callable[[Any], bool] | None = None,
+        max_validation_retries: int | None = None,
     ) -> OM.ToolOutput:
         """
         Detect if the input is phrased as a question.
@@ -159,6 +166,7 @@ class TheTool:
             logprobs=logprobs,
             top_logprobs=top_logprobs,
             validator=validator,
+            max_validation_retries=max_validation_retries,
             # Internal parameters
             prompt_file="is_question.yaml",
             output_model=OM.BoolOutput,
@@ -176,6 +184,7 @@ class TheTool:
         logprobs: bool = False,
         top_logprobs: int | None = None,
         validator: Callable[[Any], bool] | None = None,
+        max_validation_retries: int | None = None,
     ) -> OM.ToolOutput:
         """
         Generate a single question from the given text.
@@ -196,6 +205,7 @@ class TheTool:
             logprobs=logprobs,
             top_logprobs=top_logprobs,
             validator=validator,
+            max_validation_retries=max_validation_retries,
             # Internal parameters
             prompt_file="text_to_question.yaml",
             output_model=OM.StrOutput,
@@ -213,6 +223,7 @@ class TheTool:
         top_logprobs: int | None = None,
         mode: Literal["default", "reason"] = "default",
         validator: Callable[[Any], bool] | None = None,
+        max_validation_retries: int | None = None,
     ) -> OM.ToolOutput:
         """
         Merge multiple questions into a single unified question.
@@ -234,6 +245,7 @@ class TheTool:
             logprobs=logprobs,
             top_logprobs=top_logprobs,
             validator=validator,
+            max_validation_retries=max_validation_retries,
             # Internal parameters
             prompt_file="merge_questions.yaml",
             output_model=OM.StrOutput,
@@ -251,6 +263,7 @@ class TheTool:
         top_logprobs: int | None = None,
         mode: Literal["positive", "negative", "hard_negative"] = "positive",
         validator: Callable[[Any], bool] | None = None,
+        max_validation_retries: int | None = None,
     ) -> OM.ToolOutput:
         """
         Rewrite a text with different modes.
@@ -271,6 +284,7 @@ class TheTool:
             logprobs=logprobs,
             top_logprobs=top_logprobs,
             validator=validator,
+            max_validation_retries=max_validation_retries,
             # Internal parameters
             prompt_file="rewrite.yaml",
             output_model=OM.StrOutput,
@@ -288,6 +302,7 @@ class TheTool:
         logprobs: bool = False,
         top_logprobs: int | None = None,
         validator: Callable[[Any], bool] | None = None,
+        max_validation_retries: int | None = None,
     ) -> OM.ToolOutput:
         """
         Generate a list of questions about a subject.
@@ -309,6 +324,7 @@ class TheTool:
             logprobs=logprobs,
             top_logprobs=top_logprobs,
             validator=validator,
+            max_validation_retries=max_validation_retries,
             # Internal parameters
             prompt_file="subject_to_question.yaml",
             output_model=OM.ReasonListStrOutput,
@@ -325,6 +341,7 @@ class TheTool:
         logprobs: bool = False,
         top_logprobs: int | None = None,
         validator: Callable[[Any], bool] | None = None,
+        max_validation_retries: int | None = None,
     ) -> OM.ToolOutput:
         """
         Summarize the given subject text.
@@ -345,6 +362,7 @@ class TheTool:
             logprobs=logprobs,
             top_logprobs=top_logprobs,
             validator=validator,
+            max_validation_retries=max_validation_retries,
             # Internal parameters
             prompt_file="summarize.yaml",
             output_model=OM.StrOutput,
@@ -361,6 +379,7 @@ class TheTool:
         logprobs: bool = False,
         top_logprobs: int | None = None,
         validator: Callable[[Any], bool] | None = None,
+        max_validation_retries: int | None = None,
     ) -> OM.ToolOutput:
         """
         Translate text between languages.
@@ -381,6 +400,7 @@ class TheTool:
             logprobs=logprobs,
             top_logprobs=top_logprobs,
             validator=validator,
+            max_validation_retries=max_validation_retries,
             # Internal parameters
             prompt_file="translate.yaml",
             output_model=OM.StrOutput,