hamtaa-texttools 1.0.5__py3-none-any.whl → 1.0.7__py3-none-any.whl

texttools/tools/the_tool.py

@@ -8,62 +8,30 @@ import texttools.tools.internals.output_models as OutputModels
 
 class TheTool:
     """
-    High-level interface exposing specialized text tools for.
-
     Each method configures the operator with a specific YAML prompt,
     output schema, and flags, then delegates execution to `operator.run()`.
 
-    Supported capabilities:
-    - categorize: assign a text to one of several Islamic categories.
-    - extract_keywords: produce a keyword list from text.
-    - extract_entities: simple NER (name/type pairs).
-    - detect_question: binary check whether input is a question.
-    - generate_question_from_text: produce a new question from a text.
-    - merge_questions: combine multiple questions (default/reason modes).
-    - rewrite: rephrase questions (same meaning/different wording, or vice versa).
-    - generate_questions_from_subject: generate multiple questions given a subject.
-    - summarize: produce a concise summary of a subject.
-    - translate: translate text between languages.
-
-    Usage pattern:
+    Usage:
         client = OpenAI(...)
-        tool = TheTool(client, model="gemma-3")
-        result = tool.categorize("متن ورودی ...", with_analysis=True)
+        tool = TheTool(client, model="model-name")
+        result = tool.categorize("text ...", with_analysis=True)
     """
 
     def __init__(
         self,
         client: OpenAI,
-        *,
-        model: str = "google/gemma-3n-e4b-it",
-        user_prompt: str | None = None,
-        output_lang: str | None = None,
-        with_analysis: bool = False,
-        temperature: float = 0.0,
-        logprobs: bool = False,
-        top_logprobs: int = 3,
+        model: str,
     ):
-        # Initialize Operator
-        self.operator = Operator(client=client)
-
-        # Initialize default values
-        self.model = model
-        self.user_prompt = user_prompt
-        self.output_lang = output_lang
-        self.with_analysis = with_analysis
-        self.temperature = temperature
-        self.logprobs = logprobs
-        self.top_logprobs = top_logprobs
+        self.operator = Operator(client=client, model=model)
 
     def categorize(
         self,
         text: str,
-        model: str | None = None,
-        user_prompt: str | None = None,
+        with_analysis: bool = False,
         output_lang: str | None = None,
-        with_analysis: bool | None = None,
-        temperature: float | None = None,
-        logprobs: bool | None = None,
+        user_prompt: str | None = None,
+        temperature: float | None = 0.0,
+        logprobs: bool = False,
         top_logprobs: int | None = None,
     ) -> dict[str, str]:
         """
@@ -79,32 +47,29 @@ class TheTool:
             Example: {"result": "باورهای دینی"}
         """
         return self.operator.run(
+            # User parameters
+            text=text,
+            with_analysis=with_analysis,
+            output_lang=output_lang,
+            user_prompt=user_prompt,
+            temperature=temperature,
+            logprobs=logprobs,
+            top_logprobs=top_logprobs,
             # Internal parameters
             prompt_file="categorizer.yaml",
             output_model=OutputModels.CategorizerOutput,
             resp_format="parse",
-            # User parameters
-            text=text,
-            model=self.model if model is None else model,
-            user_prompt=self.user_prompt if user_prompt is None else user_prompt,
-            output_lang=self.output_lang if output_lang is None else output_lang,
-            with_analysis=self.with_analysis
-            if with_analysis is None
-            else with_analysis,
-            temperature=self.temperature if temperature is None else temperature,
-            logprobs=self.logprobs if logprobs is None else logprobs,
-            top_logprobs=self.top_logprobs if top_logprobs is None else top_logprobs,
+            mode=None,
         )
 
     def extract_keywords(
         self,
         text: str,
-        model: str | None = None,
-        user_prompt: str | None = None,
+        with_analysis: bool = False,
         output_lang: str | None = None,
-        with_analysis: bool | None = None,
-        temperature: float | None = None,
-        logprobs: bool | None = None,
+        user_prompt: str | None = None,
+        temperature: float | None = 0.0,
+        logprobs: bool = False,
         top_logprobs: int | None = None,
     ) -> dict[str, list[str]]:
         """
@@ -118,32 +83,29 @@ class TheTool:
             {"result": [<keyword1>, <keyword2>, ...]}
         """
         return self.operator.run(
+            # User parameters
+            text=text,
+            with_analysis=with_analysis,
+            output_lang=output_lang,
+            user_prompt=user_prompt,
+            temperature=temperature,
+            logprobs=logprobs,
+            top_logprobs=top_logprobs,
             # Internal parameters
-            prompt_file="keyword_extractor.yaml",
+            prompt_file="extract_keywords.yaml",
             output_model=OutputModels.ListStrOutput,
             resp_format="parse",
-            # User parameters
-            text=text,
-            model=self.model if model is None else model,
-            user_prompt=self.user_prompt if user_prompt is None else user_prompt,
-            output_lang=self.output_lang if output_lang is None else output_lang,
-            with_analysis=self.with_analysis
-            if with_analysis is None
-            else with_analysis,
-            temperature=self.temperature if temperature is None else temperature,
-            logprobs=self.logprobs if logprobs is None else logprobs,
-            top_logprobs=self.top_logprobs if top_logprobs is None else top_logprobs,
+            mode=None,
         )
 
     def extract_entities(
         self,
         text: str,
-        model: str | None = None,
-        user_prompt: str | None = None,
+        with_analysis: bool = False,
         output_lang: str | None = None,
-        with_analysis: bool | None = None,
-        temperature: float | None = None,
-        logprobs: bool | None = None,
+        user_prompt: str | None = None,
+        temperature: float | None = 0.0,
+        logprobs: bool = False,
         top_logprobs: int | None = None,
     ) -> dict[str, list[dict[str, str]]]:
         """
@@ -157,31 +119,28 @@ class TheTool:
             {"result": [{"text": <entity>, "type": <entity_type>}, ...]}
         """
         return self.operator.run(
+            # User parameters
+            text=text,
+            with_analysis=with_analysis,
+            output_lang=output_lang,
+            user_prompt=user_prompt,
+            temperature=temperature,
+            logprobs=logprobs,
+            top_logprobs=top_logprobs,
             # Internal parameters
-            prompt_file="ner_extractor.yaml",
+            prompt_file="extract_entities.yaml",
             output_model=OutputModels.ListDictStrStrOutput,
             resp_format="parse",
-            # User parameters
-            text=text,
-            model=self.model if model is None else model,
-            user_prompt=self.user_prompt if user_prompt is None else user_prompt,
-            output_lang=self.output_lang if output_lang is None else output_lang,
-            with_analysis=self.with_analysis
-            if with_analysis is None
-            else with_analysis,
-            temperature=self.temperature if temperature is None else temperature,
-            logprobs=self.logprobs if logprobs is None else logprobs,
-            top_logprobs=self.top_logprobs if top_logprobs is None else top_logprobs,
+            mode=None,
         )
 
-    def detect_question(
+    def is_question(
         self,
         text: str,
-        model: str | None = None,
+        with_analysis: bool = False,
         user_prompt: str | None = None,
-        with_analysis: bool | None = None,
-        temperature: float | None = None,
-        logprobs: bool | None = None,
+        temperature: float | None = 0.0,
+        logprobs: bool = False,
         top_logprobs: int | None = None,
     ) -> dict[str, bool]:
         """
@@ -195,32 +154,29 @@ class TheTool:
             {"result": "true"} or {"result": "false"}
         """
         return self.operator.run(
+            # User parameters
+            text=text,
+            with_analysis=with_analysis,
+            user_prompt=user_prompt,
+            temperature=temperature,
+            logprobs=logprobs,
+            top_logprobs=top_logprobs,
             # Internal parameters
-            prompt_file="question_detector.yaml",
+            prompt_file="is_question.yaml",
             output_model=OutputModels.BoolOutput,
             resp_format="parse",
-            output_lang=False,
-            # User parameters
-            text=text,
-            model=self.model if model is None else model,
-            user_prompt=self.user_prompt if user_prompt is None else user_prompt,
-            with_analysis=self.with_analysis
-            if with_analysis is None
-            else with_analysis,
-            temperature=self.temperature if temperature is None else temperature,
-            logprobs=self.logprobs if logprobs is None else logprobs,
-            top_logprobs=self.top_logprobs if top_logprobs is None else top_logprobs,
+            mode=None,
+            output_lang=None,
         )
 
-    def generate_question_from_text(
+    def text_to_question(
         self,
         text: str,
-        model: str | None = None,
-        user_prompt: str | None = None,
+        with_analysis: bool = False,
         output_lang: str | None = None,
-        with_analysis: bool | None = None,
-        temperature: float | None = None,
-        logprobs: bool | None = None,
+        user_prompt: str | None = None,
+        temperature: float | None = 0.0,
+        logprobs: bool = False,
         top_logprobs: int | None = None,
     ) -> dict[str, str]:
         """
@@ -234,34 +190,31 @@ class TheTool:
             {"result": <generated_question>}
         """
         return self.operator.run(
+            # User parameters
+            text=text,
+            with_analysis=with_analysis,
+            output_lang=output_lang,
+            user_prompt=user_prompt,
+            temperature=temperature,
+            logprobs=logprobs,
+            top_logprobs=top_logprobs,
             # Internal parameters
-            prompt_file="question_generator.yaml",
+            prompt_file="text_to_question.yaml",
             output_model=OutputModels.StrOutput,
             resp_format="parse",
-            # User parameters
-            text=text,
-            model=self.model if model is None else model,
-            user_prompt=self.user_prompt if user_prompt is None else user_prompt,
-            output_lang=self.output_lang if output_lang is None else output_lang,
-            with_analysis=self.with_analysis
-            if with_analysis is None
-            else with_analysis,
-            temperature=self.temperature if temperature is None else temperature,
-            logprobs=self.logprobs if logprobs is None else logprobs,
-            top_logprobs=self.top_logprobs if top_logprobs is None else top_logprobs,
+            mode=None,
         )
 
     def merge_questions(
         self,
-        questions: list[str],
-        mode: Literal["default", "reason"] = "default",
-        model: str | None = None,
-        user_prompt: str | None = None,
+        text: list[str],
+        with_analysis: bool = False,
         output_lang: str | None = None,
-        with_analysis: bool | None = None,
-        temperature: float | None = None,
-        logprobs: bool | None = None,
+        user_prompt: str | None = None,
+        temperature: float | None = 0.0,
+        logprobs: bool = False,
         top_logprobs: int | None = None,
+        mode: Literal["default", "reason"] = "default",
     ) -> dict[str, str]:
         """
         Merge multiple questions into a single unified question.
@@ -276,37 +229,33 @@ class TheTool:
         Returns:
             {"result": <merged_question>}
         """
-        text = ", ".join(questions)
+        text = ", ".join(text)
         return self.operator.run(
+            # User parameters
+            text=text,
+            with_analysis=with_analysis,
+            output_lang=output_lang,
+            user_prompt=user_prompt,
+            temperature=temperature,
+            logprobs=logprobs,
+            top_logprobs=top_logprobs,
             # Internal parameters
-            prompt_file="question_merger.yaml",
+            prompt_file="merge_questions.yaml",
             output_model=OutputModels.StrOutput,
             resp_format="parse",
-            # User parameters
-            text=text,
             mode=mode,
-            model=self.model if model is None else model,
-            user_prompt=self.user_prompt if user_prompt is None else user_prompt,
-            output_lang=self.output_lang if output_lang is None else output_lang,
-            with_analysis=self.with_analysis
-            if with_analysis is None
-            else with_analysis,
-            temperature=self.temperature if temperature is None else temperature,
-            logprobs=self.logprobs if logprobs is None else logprobs,
-            top_logprobs=self.top_logprobs if top_logprobs is None else top_logprobs,
         )
 
     def rewrite(
         self,
         text: str,
-        mode: Literal["positive", "negative", "hard_negative"] = "positive",
-        model: str | None = None,
-        user_prompt: str | None = None,
+        with_analysis: bool = False,
         output_lang: str | None = None,
-        with_analysis: bool | None = None,
-        temperature: float | None = None,
-        logprobs: bool | None = None,
+        user_prompt: str | None = None,
+        temperature: float | None = 0.0,
+        logprobs: bool = False,
         top_logprobs: int | None = None,
+        mode: Literal["positive", "negative", "hard_negative"] = "positive",
     ) -> dict[str, str]:
         """
         Rewrite a question with different wording or meaning.
@@ -322,34 +271,30 @@ class TheTool:
             {"result": <rewritten_question>}
         """
         return self.operator.run(
+            # User parameters
+            text=text,
+            with_analysis=with_analysis,
+            output_lang=output_lang,
+            user_prompt=user_prompt,
+            temperature=temperature,
+            logprobs=logprobs,
+            top_logprobs=top_logprobs,
             # Internal parameters
-            prompt_file="rewriter.yaml",
+            prompt_file="rewrite.yaml",
             output_model=OutputModels.StrOutput,
             resp_format="parse",
-            # User parameters
-            text=text,
             mode=mode,
-            model=self.model if model is None else model,
-            user_prompt=self.user_prompt if user_prompt is None else user_prompt,
-            output_lang=self.output_lang if output_lang is None else output_lang,
-            with_analysis=self.with_analysis
-            if with_analysis is None
-            else with_analysis,
-            temperature=self.temperature if temperature is None else temperature,
-            logprobs=self.logprobs if logprobs is None else logprobs,
-            top_logprobs=self.top_logprobs if top_logprobs is None else top_logprobs,
         )
 
-    def generate_questions_from_subject(
+    def subject_to_question(
         self,
         text: str,
         number_of_questions: int,
-        model: str | None = None,
-        user_prompt: str | None = None,
+        with_analysis: bool = False,
         output_lang: str | None = None,
-        with_analysis: bool | None = None,
-        temperature: float | None = None,
-        logprobs: bool | None = None,
+        user_prompt: str | None = None,
+        temperature: float | None = 0.0,
+        logprobs: bool = False,
         top_logprobs: int | None = None,
     ) -> dict[str, list[str]]:
         """
@@ -365,33 +310,30 @@ class TheTool:
             {"result": [<question1>, <question2>, ...]}
         """
         return self.operator.run(
-            # Internal parameters
-            prompt_file="subject_question_generator.yaml",
-            output_model=OutputModels.ReasonListStrOutput,
-            resp_format="parse",
             # User parameters
             text=text,
             number_of_questions=number_of_questions,
-            model=self.model if model is None else model,
-            user_prompt=self.user_prompt if user_prompt is None else user_prompt,
-            output_lang=self.output_lang if output_lang is None else output_lang,
-            with_analysis=self.with_analysis
-            if with_analysis is None
-            else with_analysis,
-            temperature=self.temperature if temperature is None else temperature,
-            logprobs=self.logprobs if logprobs is None else logprobs,
-            top_logprobs=self.top_logprobs if top_logprobs is None else top_logprobs,
+            with_analysis=with_analysis,
+            output_lang=output_lang,
+            user_prompt=user_prompt,
+            temperature=temperature,
+            logprobs=logprobs,
+            top_logprobs=top_logprobs,
+            # Internal parameters
+            prompt_file="subject_to_question.yaml",
+            output_model=OutputModels.ReasonListStrOutput,
+            resp_format="parse",
+            mode=None,
         )
 
     def summarize(
         self,
         text: str,
-        model: str | None = None,
-        user_prompt: str | None = None,
+        with_analysis: bool = False,
         output_lang: str | None = None,
-        with_analysis: bool | None = None,
-        temperature: float | None = None,
-        logprobs: bool | None = None,
+        user_prompt: str | None = None,
+        temperature: float | None = 0.0,
+        logprobs: bool = False,
         top_logprobs: int | None = None,
     ) -> dict[str, str]:
         """
@@ -405,32 +347,30 @@ class TheTool:
             {"result": <summary>}
         """
         return self.operator.run(
+            # User parameters
+            text=text,
+            with_analysis=with_analysis,
+            output_lang=output_lang,
+            user_prompt=user_prompt,
+            temperature=temperature,
+            logprobs=logprobs,
+            top_logprobs=top_logprobs,
             # Internal parameters
-            prompt_file="summarizer.yaml",
+            prompt_file="summarize.yaml",
             output_model=OutputModels.StrOutput,
             resp_format="parse",
-            # User paramaeters
-            text=text,
-            model=self.model if model is None else model,
-            user_prompt=self.user_prompt if user_prompt is None else user_prompt,
-            output_lang=self.output_lang if output_lang is None else output_lang,
-            with_analysis=self.with_analysis
-            if with_analysis is None
-            else with_analysis,
-            temperature=self.temperature if temperature is None else temperature,
-            logprobs=self.logprobs if logprobs is None else logprobs,
-            top_logprobs=self.top_logprobs if top_logprobs is None else top_logprobs,
+            mode=None,
         )
 
     def translate(
         self,
         text: str,
         target_language: str,
-        model: str | None = None,
+        with_analysis: bool = False,
+        output_lang: str | None = None,
         user_prompt: str | None = None,
-        with_analysis: bool | None = None,
-        temperature: float | None = None,
-        logprobs: bool | None = None,
+        temperature: float | None = 0.0,
+        logprobs: bool = False,
         top_logprobs: int | None = None,
     ) -> dict[str, str]:
         """
@@ -445,32 +385,29 @@ class TheTool:
             {"result": <translated_text>}
         """
         return self.operator.run(
-            # Internal parameters
-            prompt_file="translator.yaml",
-            output_model=OutputModels.StrOutput,
-            resp_format="parse",
-            output_lang=False,
             # User parameters
             text=text,
             target_language=target_language,
-            model=self.model if model is None else model,
-            user_prompt=self.user_prompt if user_prompt is None else user_prompt,
-            with_analysis=self.with_analysis
-            if with_analysis is None
-            else with_analysis,
-            temperature=self.temperature if temperature is None else temperature,
-            logprobs=self.logprobs if logprobs is None else logprobs,
-            top_logprobs=self.top_logprobs if top_logprobs is None else top_logprobs,
+            with_analysis=with_analysis,
+            output_lang=output_lang,
+            user_prompt=user_prompt,
+            temperature=temperature,
+            logprobs=logprobs,
+            top_logprobs=top_logprobs,
+            # Internal parameters
+            prompt_file="translate.yaml",
+            output_model=OutputModels.StrOutput,
+            resp_format="parse",
+            mode=None,
         )
 
-    def custom_tool(
+    def run_custom(
         self,
         prompt: str,
         output_model: Any,
-        model: str | None = None,
         output_lang: str | None = None,
         temperature: float | None = None,
-        logprobs: float | None = None,
+        logprobs: bool | None = None,
         top_logprobs: int | None = None,
     ) -> dict[str, Any]:
         """
@@ -484,18 +421,18 @@ class TheTool:
             {"result": <Any>}
         """
         return self.operator.run(
-            # Internal parameters
-            prompt_file="custom_tool.yaml",
-            resp_format="parse",
-            user_prompt=False,
-            with_analysis=False,
             # User paramaeters
             text=prompt,
             output_model=output_model,
             output_model_str=output_model.model_json_schema(),
-            model=self.model if model is None else model,
-            output_lang=self.output_lang if output_lang is None else output_lang,
-            temperature=self.temperature if temperature is None else temperature,
-            logprobs=self.logprobs if logprobs is None else logprobs,
-            top_logprobs=self.top_logprobs if top_logprobs is None else top_logprobs,
+            output_lang=output_lang,
+            temperature=temperature,
+            logprobs=logprobs,
+            top_logprobs=top_logprobs,
+            # Internal parameters
+            prompt_file="run_custom.yaml",
+            resp_format="parse",
+            user_prompt=None,
+            with_analysis=False,
+            mode=None,
         )

hamtaa_texttools-1.0.5.dist-info/RECORD

@@ -1,30 +0,0 @@
-hamtaa_texttools-1.0.5.dist-info/licenses/LICENSE,sha256=Hb2YOBKy2MJQLnyLrX37B4ZVuac8eaIcE71SvVIMOLg,1082
-texttools/__init__.py,sha256=v3tQCH_Cjj47fCpuhK6sKSVAqEjNkc-cZbY4OJa4IZw,202
-texttools/batch/__init__.py,sha256=q50JsQsmQGp_8RW0KNasYeYWVV0R4FUNZ-ujXwEJemY,143
-texttools/batch/batch_manager.py,sha256=aYnHy82b4FJmhi2TWjXtxg67dN6PZOu2gQSusx373vE,9328
-texttools/batch/batch_runner.py,sha256=OHxeFT0YhEuDwZVAE07PUEC_7cuICWnnim3SuyZsx4U,7814
-texttools/formatters/base_formatter.py,sha256=xxnbujAr01NqZ49Y61LVFpIbj6kTEmV6JiUH_qCsIFk,1180
-texttools/formatters/user_merge_formatter.py,sha256=U_d7npTkC9QDgtEFjAjIuDlPfxVj3S1RyziidKqjciw,1086
-texttools/prompts/README.md,sha256=z8XW7ovh0yT1WGhkSPzYKixEtiGuDzeof6MALXaxUUY,1365
-texttools/prompts/categorizer.yaml,sha256=GMqIIzQFhgnlpkgU1qi3FAD3mD4A2jiWD5TilQ2XnnE,1204
-texttools/prompts/custom_tool.yaml,sha256=38OkCoVITbuuS9c08UZSP1jZW4WjSmRIi8fR0RAiPu4,108
-texttools/prompts/keyword_extractor.yaml,sha256=R05Ac_qnP4sUvhOGCW3XpjlJFdz1KgU4CgVCOXflY8M,775
-texttools/prompts/ner_extractor.yaml,sha256=KiKjeDpHaeh3JVtZ6q1pa3k4DYucUIU9WnEcRTCA-SE,651
-texttools/prompts/question_detector.yaml,sha256=d0-vKRbXWkxvO64ikvxRjEmpAXGpCYIPGhgexvPPjws,471
-texttools/prompts/question_generator.yaml,sha256=UheKYpDn6iyKI8NxunHZtFpNyfCLZZe5cvkuXpurUJY,783
-texttools/prompts/question_merger.yaml,sha256=b72QAk9Gs8k1xb2lSDXx44u-3Ku5vIuWL_6han4UaO0,1797
-texttools/prompts/rewriter.yaml,sha256=LO7He_IA3MZKz8a-LxH9DHJpOjpYwaYN1pbjp1Y0tFo,5392
-texttools/prompts/subject_question_generator.yaml,sha256=C7x7rNNm6U_ZG9HOn6zuzYOtvJUZ2skuWbL1-aYdd3E,1147
-texttools/prompts/summarizer.yaml,sha256=o6rxGPfWtZd61Duvm8NVvCJqfq73b-wAuMSKR6UYUqY,459
-texttools/prompts/translator.yaml,sha256=mGT2uBCei6uucWqVbs4silk-UV060v3G0jnt0P6sr50,634
-texttools/tools/__init__.py,sha256=hG1I28Q7BJ1Dbs95x6QMKXdsAlC5Eh_tqC-EbAibwiU,114
-texttools/tools/async_the_tool.py,sha256=m5b8t1eAGDDN44nOf-h9l-8rLxg7a859nZ9QePVlRzI,8827
-texttools/tools/the_tool.py,sha256=oRDsg8ZqMcUiWX6WXdtw9C1XkgWdi93GcBXCqTcUCMo,19406
-texttools/tools/internals/async_operator.py,sha256=jvpeVffRYnm6inUB7jncbmiOAztayMPzsIi7UH1IrHs,9910
-texttools/tools/internals/operator.py,sha256=4lrV8UisJoSUKGI23iL8IjK_MWg-ev43ywAXxCob3nU,10033
-texttools/tools/internals/output_models.py,sha256=Rf2x-UuGlmQHrvYIqnD11YuzMH_mPuir62HoMJQa2uk,1528
-texttools/tools/internals/prompt_loader.py,sha256=8RFhZE3HOcnQdtndSP2qULD6YQbZ34EVsTbXR-Zr-NM,2510
-hamtaa_texttools-1.0.5.dist-info/METADATA,sha256=l2qrSuF_s2JHwcybcGdq4c2hhcE-D6eqNzPvJZPyHaE,7780
-hamtaa_texttools-1.0.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-hamtaa_texttools-1.0.5.dist-info/top_level.txt,sha256=5Mh0jIxxZ5rOXHGJ6Mp-JPKviywwN0MYuH0xk5bEWqE,10
-hamtaa_texttools-1.0.5.dist-info/RECORD,,