hamtaa-texttools 1.1.21__py3-none-any.whl → 1.1.23__py3-none-any.whl

texttools/tools/async_tools.py

@@ -1,6 +1,6 @@
 import sys
 from time import perf_counter
-from typing import Literal
+from typing import Literal, Any
 from collections.abc import Callable
 
 from openai import AsyncOpenAI
@@ -38,9 +38,9 @@ class AsyncTheTool:
         temperature: float | None = 0.0,
         logprobs: bool = False,
         top_logprobs: int = 3,
-        validator: Callable[[object], bool] | None = None,
+        validator: Callable[[Any], bool] | None = None,
         max_validation_retries: int | None = None,
-        priority: int = 0,
+        priority: int | None = None,
     ) -> Models.ToolOutput:
         """
         Categorize a text into a category / category tree.
@@ -48,11 +48,11 @@ class AsyncTheTool:
         Important Note: category_tree mode is EXPERIMENTAL, you can use it but it isn't reliable.
 
         Arguments:
-            text: The input text to categorize
+            text: The input text
             categories: The category list / category tree
             with_analysis: Whether to include detailed reasoning analysis
-            user_prompt: Additional instructions for the categorization
-            temperature: Controls randomness
+            user_prompt: Additional instructions
+            temperature: Controls randomness (0.0 - 2.0)
             logprobs: Whether to return token probability information
             top_logprobs: Number of top token alternatives to return if logprobs enabled
             validator: Custom validation function to validate the output
@@ -64,7 +64,6 @@ class AsyncTheTool:
 
         """
         tool_name = sys._getframe().f_code.co_name
-        prompt_file = tool_name + ".yaml"
         start = perf_counter()
 
         try:
@@ -82,7 +81,7 @@ class AsyncTheTool:
                     max_validation_retries=max_validation_retries,
                     priority=priority,
                     # Internal parameters
-                    prompt_file=prompt_file,
+                    tool_name=tool_name,
                     output_model=Models.create_dynamic_model(categories),
                     mode=None,
                     output_lang=None,
@@ -128,7 +127,7 @@ class AsyncTheTool:
                         max_validation_retries=max_validation_retries,
                         priority=priority,
                         # Internal parameters
-                        prompt_file=prompt_file,
+                        tool_name=tool_name,
                         output_model=Models.create_dynamic_model(category_names),
                         mode=None,
                         output_lang=None,
@@ -174,19 +173,19 @@ class AsyncTheTool:
         top_logprobs: int = 3,
         mode: Literal["auto", "threshold", "count"] = "auto",
         number_of_keywords: int | None = None,
-        validator: Callable[[object], bool] | None = None,
+        validator: Callable[[Any], bool] | None = None,
         max_validation_retries: int | None = None,
-        priority: int | None = 0,
+        priority: int | None = None,
     ) -> Models.ToolOutput:
         """
         Extract salient keywords from text.
 
         Arguments:
-            text: The input text to extract keywords from
+            text: The input text
             with_analysis: Whether to include detailed reasoning analysis
-            output_lang: Language for the output response
-            user_prompt: Additional instructions for keyword extraction
-            temperature: Controls randomness
+            output_lang: Language for the output
+            user_prompt: Additional instructions
+            temperature: Controls randomness (0.0 - 2.0)
             logprobs: Whether to return token probability information
             top_logprobs: Number of top token alternatives to return if logprobs enabled
             validator: Custom validation function to validate the output
@@ -197,7 +196,6 @@ class AsyncTheTool:
             ToolOutput
         """
         tool_name = sys._getframe().f_code.co_name
-        prompt_file = tool_name + ".yaml"
         start = perf_counter()
 
         try:
@@ -216,7 +214,7 @@ class AsyncTheTool:
                 max_validation_retries=max_validation_retries,
                 priority=priority,
                 # Internal parameters
-                prompt_file=prompt_file,
+                tool_name=tool_name,
                 output_model=Models.ListStr,
             )
 
@@ -248,20 +246,20 @@ class AsyncTheTool:
         temperature: float | None = 0.0,
         logprobs: bool = False,
         top_logprobs: int = 3,
-        validator: Callable[[object], bool] | None = None,
+        validator: Callable[[Any], bool] | None = None,
         max_validation_retries: int | None = None,
-        priority: int | None = 0,
+        priority: int | None = None,
     ) -> Models.ToolOutput:
         """
         Perform Named Entity Recognition (NER) over the input text.
 
         Arguments:
-            text: The input text to extract entities from
+            text: The input text
             entities: List of entities provided by user (Optional)
             with_analysis: Whether to include detailed reasoning analysis
-            output_lang: Language for the output response
-            user_prompt: Additional instructions for entity extraction
-            temperature: Controls randomness
+            output_lang: Language for the output
+            user_prompt: Additional instructions
+            temperature: Controls randomness (0.0 - 2.0)
             logprobs: Whether to return token probability information
             top_logprobs: Number of top token alternatives to return if logprobs enabled
             validator: Custom validation function to validate the output
@@ -272,7 +270,6 @@ class AsyncTheTool:
             ToolOutput
         """
         tool_name = sys._getframe().f_code.co_name
-        prompt_file = tool_name + ".yaml"
         start = perf_counter()
 
         try:
@@ -291,7 +288,7 @@ class AsyncTheTool:
                 max_validation_retries=max_validation_retries,
                 priority=priority,
                 # Internal parameters
-                prompt_file=prompt_file,
+                tool_name=tool_name,
                 output_model=Models.ListDictStrStr,
                 mode=None,
             )
@@ -322,18 +319,18 @@ class AsyncTheTool:
         temperature: float | None = 0.0,
         logprobs: bool = False,
         top_logprobs: int = 3,
-        validator: Callable[[object], bool] | None = None,
+        validator: Callable[[Any], bool] | None = None,
         max_validation_retries: int | None = None,
-        priority: int | None = 0,
+        priority: int | None = None,
     ) -> Models.ToolOutput:
         """
         Detect if the input is phrased as a question.
 
         Arguments:
-            text: The input text to analyze
+            text: The input text
             with_analysis: Whether to include detailed reasoning analysis
-            user_prompt: Additional instructions for question detection
-            temperature: Controls randomness
+            user_prompt: Additional instructions
+            temperature: Controls randomness (0.0 - 2.0)
             logprobs: Whether to return token probability information
             top_logprobs: Number of top token alternatives to return if logprobs enabled
             validator: Custom validation function to validate the output
@@ -344,7 +341,7 @@ class AsyncTheTool:
             ToolOutput
         """
         tool_name = sys._getframe().f_code.co_name
-        prompt_file = tool_name + ".yaml"
+
         start = perf_counter()
 
         try:
@@ -360,7 +357,7 @@ class AsyncTheTool:
                 max_validation_retries=max_validation_retries,
                 priority=priority,
                 # Internal parameters
-                prompt_file=prompt_file,
+                tool_name=tool_name,
                 output_model=Models.Bool,
                 mode=None,
                 output_lang=None,
@@ -394,20 +391,20 @@ class AsyncTheTool:
         temperature: float | None = 0.0,
         logprobs: bool = False,
         top_logprobs: int = 3,
-        validator: Callable[[object], bool] | None = None,
+        validator: Callable[[Any], bool] | None = None,
         max_validation_retries: int | None = None,
-        priority: int | None = 0,
+        priority: int | None = None,
     ) -> Models.ToolOutput:
         """
         Generate a single question from the given text.
 
         Arguments:
-            text: The input text to generate a question from
+            text: The input text
             number_of_questions: Number of questions to generate
             with_analysis: Whether to include detailed reasoning analysis
-            output_lang: Language for the output question
-            user_prompt: Additional instructions for question generation
-            temperature: Controls randomness
+            output_lang: Language for the output
+            user_prompt: Additional instructions
+            temperature: Controls randomness (0.0 - 2.0)
             logprobs: Whether to return token probability information
             top_logprobs: Number of top token alternatives to return if logprobs enabled
             validator: Custom validation function to validate the output
@@ -418,7 +415,6 @@ class AsyncTheTool:
             ToolOutput
         """
         tool_name = sys._getframe().f_code.co_name
-        prompt_file = tool_name + ".yaml"
         start = perf_counter()
 
         try:
@@ -436,7 +432,7 @@ class AsyncTheTool:
                 max_validation_retries=max_validation_retries,
                 priority=priority,
                 # Internal parameters
-                prompt_file=prompt_file,
+                tool_name=tool_name,
                 output_model=Models.ReasonListStr,
                 mode=None,
             )
@@ -469,9 +465,9 @@ class AsyncTheTool:
         logprobs: bool = False,
         top_logprobs: int = 3,
         mode: Literal["default", "reason"] = "default",
-        validator: Callable[[object], bool] | None = None,
+        validator: Callable[[Any], bool] | None = None,
         max_validation_retries: int | None = None,
-        priority: int | None = 0,
+        priority: int | None = None,
     ) -> Models.ToolOutput:
         """
         Merge multiple questions into a single unified question.
@@ -479,12 +475,11 @@ class AsyncTheTool:
         Arguments:
             text: List of questions to merge
             with_analysis: Whether to include detailed reasoning analysis
-            output_lang: Language for the output merged question
-            user_prompt: Additional instructions for question merging
-            temperature: Controls randomness
+            output_lang: Language for the output
+            user_prompt: Additional instructions
+            temperature: Controls randomness (0.0 - 2.0)
             logprobs: Whether to return token probability information
             top_logprobs: Number of top token alternatives to return if logprobs enabled
-            mode: Merging strategy - 'default' for direct merge, 'reason' for reasoned merge
             validator: Custom validation function to validate the output
             max_validation_retries: Maximum number of retry attempts if validation fails
             priority: Task execution priority (if enabled by vLLM and the model)
@@ -493,7 +488,6 @@ class AsyncTheTool:
             ToolOutput
         """
         tool_name = sys._getframe().f_code.co_name
-        prompt_file = tool_name + ".yaml"
         start = perf_counter()
 
         try:
@@ -511,7 +505,7 @@ class AsyncTheTool:
                 max_validation_retries=max_validation_retries,
                 priority=priority,
                 # Internal parameters
-                prompt_file=prompt_file,
+                tool_name=tool_name,
                 output_model=Models.Str,
                 mode=mode,
             )
@@ -544,22 +538,21 @@ class AsyncTheTool:
         logprobs: bool = False,
         top_logprobs: int = 3,
         mode: Literal["positive", "negative", "hard_negative"] = "positive",
-        validator: Callable[[object], bool] | None = None,
+        validator: Callable[[Any], bool] | None = None,
         max_validation_retries: int | None = None,
-        priority: int | None = 0,
+        priority: int | None = None,
     ) -> Models.ToolOutput:
         """
         Rewrite a text with different modes.
 
         Arguments:
-            text: The input text to rewrite
+            text: The input text
             with_analysis: Whether to include detailed reasoning analysis
-            output_lang: Language for the output rewritten text
-            user_prompt: Additional instructions for rewriting
-            temperature: Controls randomness
+            output_lang: Language for the output
+            user_prompt: Additional instructions
+            temperature: Controls randomness (0.0 - 2.0)
             logprobs: Whether to return token probability information
             top_logprobs: Number of top token alternatives to return if logprobs enabled
-            mode: Rewriting mode - 'positive', 'negative', or 'hard_negative'
             validator: Custom validation function to validate the output
             max_validation_retries: Maximum number of retry attempts if validation fails
             priority: Task execution priority (if enabled by vLLM and the model)
@@ -568,7 +561,6 @@ class AsyncTheTool:
             ToolOutput
         """
         tool_name = sys._getframe().f_code.co_name
-        prompt_file = tool_name + ".yaml"
         start = perf_counter()
 
         try:
@@ -585,7 +577,7 @@ class AsyncTheTool:
                 max_validation_retries=max_validation_retries,
                 priority=priority,
                 # Internal parameters
-                prompt_file=prompt_file,
+                tool_name=tool_name,
                 output_model=Models.Str,
                 mode=mode,
             )
@@ -618,9 +610,9 @@ class AsyncTheTool:
         temperature: float | None = 0.0,
         logprobs: bool = False,
         top_logprobs: int = 3,
-        validator: Callable[[object], bool] | None = None,
+        validator: Callable[[Any], bool] | None = None,
         max_validation_retries: int | None = None,
-        priority: int | None = 0,
+        priority: int | None = None,
     ) -> Models.ToolOutput:
         """
         Generate a list of questions about a subject.
@@ -629,9 +621,9 @@ class AsyncTheTool:
             text: The subject text to generate questions about
             number_of_questions: Number of questions to generate
             with_analysis: Whether to include detailed reasoning analysis
-            output_lang: Language for the output questions
-            user_prompt: Additional instructions for question generation
-            temperature: Controls randomness
+            output_lang: Language for the output
+            user_prompt: Additional instructions
+            temperature: Controls randomness (0.0 - 2.0)
             logprobs: Whether to return token probability information
             top_logprobs: Number of top token alternatives to return if logprobs enabled
             validator: Custom validation function to validate the output
@@ -642,7 +634,6 @@ class AsyncTheTool:
             ToolOutput
         """
         tool_name = sys._getframe().f_code.co_name
-        prompt_file = tool_name + ".yaml"
         start = perf_counter()
 
         try:
@@ -660,7 +651,7 @@ class AsyncTheTool:
                 max_validation_retries=max_validation_retries,
                 priority=priority,
                 # Internal parameters
-                prompt_file=prompt_file,
+                tool_name=tool_name,
                 output_model=Models.ReasonListStr,
                 mode=None,
             )
@@ -692,19 +683,19 @@ class AsyncTheTool:
         temperature: float | None = 0.0,
         logprobs: bool = False,
         top_logprobs: int = 3,
-        validator: Callable[[object], bool] | None = None,
+        validator: Callable[[Any], bool] | None = None,
         max_validation_retries: int | None = None,
-        priority: int | None = 0,
+        priority: int | None = None,
     ) -> Models.ToolOutput:
         """
         Summarize the given subject text.
 
         Arguments:
-            text: The input text to summarize
+            text: The input text
             with_analysis: Whether to include detailed reasoning analysis
-            output_lang: Language for the output summary
-            user_prompt: Additional instructions for summarization
-            temperature: Controls randomness
+            output_lang: Language for the output
+            user_prompt: Additional instructions
+            temperature: Controls randomness (0.0 - 2.0)
             logprobs: Whether to return token probability information
             top_logprobs: Number of top token alternatives to return if logprobs enabled
             validator: Custom validation function to validate the output
@@ -715,7 +706,6 @@ class AsyncTheTool:
             ToolOutput
         """
         tool_name = sys._getframe().f_code.co_name
-        prompt_file = tool_name + ".yaml"
         start = perf_counter()
 
         try:
@@ -732,7 +722,7 @@ class AsyncTheTool:
                 max_validation_retries=max_validation_retries,
                 priority=priority,
                 # Internal parameters
-                prompt_file=prompt_file,
+                tool_name=tool_name,
                 output_model=Models.Str,
                 mode=None,
             )
@@ -765,9 +755,9 @@ class AsyncTheTool:
         temperature: float | None = 0.0,
         logprobs: bool = False,
         top_logprobs: int = 3,
-        validator: Callable[[object], bool] | None = None,
+        validator: Callable[[Any], bool] | None = None,
         max_validation_retries: int | None = None,
-        priority: int | None = 0,
+        priority: int | None = None,
     ) -> Models.ToolOutput:
         """
         Translate text between languages.
@@ -775,12 +765,12 @@ class AsyncTheTool:
         Important Note: This tool is EXPERIMENTAL, you can use it but it isn't reliable.
 
         Arguments:
-            text: The input text to translate
+            text: The input text
             target_language: The target language for translation
             use_chunker: Whether to use text chunker for text length bigger than 1500
             with_analysis: Whether to include detailed reasoning analysis
-            user_prompt: Additional instructions for translation
-            temperature: Controls randomness
+            user_prompt: Additional instructions
+            temperature: Controls randomness (0.0 - 2.0)
             logprobs: Whether to return token probability information
             top_logprobs: Number of top token alternatives to return if logprobs enabled
             validator: Custom validation function to validate the output
@@ -791,7 +781,6 @@ class AsyncTheTool:
             ToolOutput
         """
         tool_name = sys._getframe().f_code.co_name
-        prompt_file = tool_name + ".yaml"
         start = perf_counter()
 
         try:
@@ -815,7 +804,7 @@ class AsyncTheTool:
                         max_validation_retries=max_validation_retries,
                         priority=priority,
                         # Internal parameters
-                        prompt_file=prompt_file,
+                        tool_name=tool_name,
                         output_model=Models.Str,
                         mode=None,
                         output_lang=None,
@@ -852,7 +841,7 @@ class AsyncTheTool:
                     max_validation_retries=max_validation_retries,
                     priority=priority,
                     # Internal parameters
-                    prompt_file=prompt_file,
+                    tool_name=tool_name,
                     output_model=Models.Str,
                     mode=None,
                     output_lang=None,
@@ -885,9 +874,9 @@ class AsyncTheTool:
         temperature: float | None = 0.0,
         logprobs: bool = False,
         top_logprobs: int = 3,
-        validator: Callable[[object], bool] | None = None,
+        validator: Callable[[Any], bool] | None = None,
         max_validation_retries: int | None = None,
-        priority: int | None = 0,
+        priority: int | None = None,
     ) -> Models.ToolOutput:
         """
         Proposition input text to meaningful sentences.
@@ -897,9 +886,9 @@ class AsyncTheTool:
         Arguments:
             text: The input text
             with_analysis: Whether to include detailed reasoning analysis
-            output_lang: Language for the output summary
-            user_prompt: Additional instructions for summarization
-            temperature: Controls randomness
+            output_lang: Language for the output
+            user_prompt: Additional instructions
+            temperature: Controls randomness (0.0 - 2.0)
             logprobs: Whether to return token probability information
             top_logprobs: Number of top token alternatives to return if logprobs enabled
             validator: Custom validation function to validate the output
@@ -910,7 +899,6 @@ class AsyncTheTool:
             ToolOutput
         """
         tool_name = sys._getframe().f_code.co_name
-        prompt_file = tool_name + ".yaml"
         start = perf_counter()
 
         try:
@@ -927,7 +915,7 @@ class AsyncTheTool:
                 max_validation_retries=max_validation_retries,
                 priority=priority,
                 # Internal parameters
-                prompt_file=prompt_file,
+                tool_name=tool_name,
                 output_model=Models.ListStr,
                 mode=None,
             )
@@ -960,9 +948,9 @@ class AsyncTheTool:
         temperature: float | None = 0.0,
         logprobs: bool = False,
         top_logprobs: int = 3,
-        validator: Callable[[object], bool] | None = None,
+        validator: Callable[[Any], bool] | None = None,
         max_validation_retries: int | None = None,
-        priority: int | None = 0,
+        priority: int | None = None,
     ) -> Models.ToolOutput:
         """
         Checks wheather a statement is relevant to the source text or not.
@@ -973,9 +961,9 @@ class AsyncTheTool:
             text: The input text
             source_text: the source text that we want to check relation of text to it
             with_analysis: Whether to include detailed reasoning analysis
-            output_lang: Language for the output summary
-            user_prompt: Additional instructions for summarization
-            temperature: Controls randomness
+            output_lang: Language for the output
+            user_prompt: Additional instructions
+            temperature: Controls randomness (0.0 - 2.0)
             logprobs: Whether to return token probability information
             top_logprobs: Number of top token alternatives to return if logprobs enabled
             validator: Custom validation function to validate the output
@@ -986,7 +974,6 @@ class AsyncTheTool:
             ToolOutput
         """
         tool_name = sys._getframe().f_code.co_name
-        prompt_file = tool_name + ".yaml"
         start = perf_counter()
 
         try:
@@ -1003,7 +990,7 @@ class AsyncTheTool:
                 max_validation_retries=max_validation_retries,
                 priority=priority,
                 # Internal parameters
-                prompt_file=prompt_file,
+                tool_name=tool_name,
                 output_model=Models.Bool,
                 mode=None,
                 source_text=source_text,
@@ -1030,29 +1017,27 @@ class AsyncTheTool:
     async def run_custom(
         self,
         prompt: str,
-        output_model: object,
+        output_model: Any,
         with_analysis: bool = False,
         analyze_template: str | None = None,
         output_lang: str | None = None,
         temperature: float | None = None,
         logprobs: bool | None = None,
         top_logprobs: int = 3,
-        validator: Callable[[object], bool] | None = None,
+        validator: Callable[[Any], bool] | None = None,
         max_validation_retries: int | None = None,
-        priority: int | None = 0,
+        priority: int | None = None,
     ) -> Models.ToolOutput:
         """
         Custom tool that can do almost anything!
 
-        Important Note: This tool is EXPERIMENTAL, you can use it but it isn't reliable.
-
         Arguments:
             prompt: The user prompt
             output_model: Pydantic BaseModel used for structured output
             with_analysis: Whether to include detailed reasoning analysis
             analyze_template: The analyze template used for reasoning analysis
-            output_lang: Language for the output summary
-            temperature: Controls randomness
+            output_lang: Language for the output
+            temperature: Controls randomness (0.0 - 2.0)
             logprobs: Whether to return token probability information
             top_logprobs: Number of top token alternatives to return if logprobs enabled
             validator: Custom validation function to validate the output
@@ -1063,7 +1048,6 @@ class AsyncTheTool:
             ToolOutput
         """
         tool_name = sys._getframe().f_code.co_name
-        prompt_file = tool_name + ".yaml"
         start = perf_counter()
 
         try:
@@ -1082,7 +1066,7 @@ class AsyncTheTool:
                 max_validation_retries=max_validation_retries,
                 priority=priority,
                 # Internal parameters
-                prompt_file=prompt_file,
+                tool_name=tool_name,
                 user_prompt=None,
                 mode=None,
             )