hamtaa-texttools 2.3.0__tar.gz → 2.3.1__tar.gz

{hamtaa_texttools-2.3.0 → hamtaa_texttools-2.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hamtaa-texttools
-Version: 2.3.0
+Version: 2.3.1
 Summary: A high-level NLP toolkit built on top of modern LLMs.
 Author-email: Tohidi <the.mohammad.tohidi@gmail.com>, Erfan Moosavi <erfanmoosavi84@gmail.com>, Montazer <montazerh82@gmail.com>, Givechi <mohamad.m.givechi@gmail.com>, Zareshahi <a.zareshahi1377@gmail.com>
 Maintainer-email: Erfan Moosavi <erfanmoosavi84@gmail.com>, Tohidi <the.mohammad.tohidi@gmail.com>
@@ -128,6 +128,7 @@ Every tool of `TextTools` returns a `ToolOutput` object which is a BaseModel wit
             - **`prompt_tokens: int`**
             - **`completion_tokens: int`**
             - **`total_tokens: int`**
+        - **`total_tokens: int`**
 
 - Serialize output to JSON using the `to_json()` method.
 - Verify operation success with the `is_successful()` method.

{hamtaa_texttools-2.3.0 → hamtaa_texttools-2.3.1}/README.md

@@ -105,6 +105,7 @@ Every tool of `TextTools` returns a `ToolOutput` object which is a BaseModel wit
             - **`prompt_tokens: int`**
             - **`completion_tokens: int`**
             - **`total_tokens: int`**
+        - **`total_tokens: int`**
 
 - Serialize output to JSON using the `to_json()` method.
 - Verify operation success with the `is_successful()` method.

{hamtaa_texttools-2.3.0 → hamtaa_texttools-2.3.1}/hamtaa_texttools.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hamtaa-texttools
-Version: 2.3.0
+Version: 2.3.1
 Summary: A high-level NLP toolkit built on top of modern LLMs.
 Author-email: Tohidi <the.mohammad.tohidi@gmail.com>, Erfan Moosavi <erfanmoosavi84@gmail.com>, Montazer <montazerh82@gmail.com>, Givechi <mohamad.m.givechi@gmail.com>, Zareshahi <a.zareshahi1377@gmail.com>
 Maintainer-email: Erfan Moosavi <erfanmoosavi84@gmail.com>, Tohidi <the.mohammad.tohidi@gmail.com>
@@ -128,6 +128,7 @@ Every tool of `TextTools` returns a `ToolOutput` object which is a BaseModel wit
             - **`prompt_tokens: int`**
             - **`completion_tokens: int`**
             - **`total_tokens: int`**
+        - **`total_tokens: int`**
 
 - Serialize output to JSON using the `to_json()` method.
 - Verify operation success with the `is_successful()` method.

{hamtaa_texttools-2.3.0 → hamtaa_texttools-2.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "hamtaa-texttools"
-version = "2.3.0"
+version = "2.3.1"
 authors = [
   {name = "Tohidi", email = "the.mohammad.tohidi@gmail.com"},
   {name = "Erfan Moosavi", email = "erfanmoosavi84@gmail.com"},

{hamtaa_texttools-2.3.0 → hamtaa_texttools-2.3.1}/texttools/core/internal_models.py

@@ -54,11 +54,8 @@ class OperatorOutput(BaseModel):
     result: Any
     analysis: str | None
     logprobs: list[dict[str, Any]] | None
+    processed_by: str
     token_usage: TokenUsage | None = None
-    prompt_tokens: int | None = None
-    completion_tokens: int | None = None
-    analysis_tokens: int | None = None
-    total_tokens: int | None = None
 
 
 class Str(BaseModel):

{hamtaa_texttools-2.3.0 → hamtaa_texttools-2.3.1}/texttools/core/operators/async_operator.py

@@ -181,6 +181,7 @@ class AsyncOperator:
                 logprobs=OperatorUtils.extract_logprobs(completion)
                 if logprobs
                 else None,
+                processed_by=self._model,
                 token_usage=OperatorUtils.extract_token_usage(
                     completion, analyze_completion
                 ),

{hamtaa_texttools-2.3.0 → hamtaa_texttools-2.3.1}/texttools/core/operators/sync_operator.py

@@ -177,6 +177,7 @@ class Operator:
                 logprobs=OperatorUtils.extract_logprobs(completion)
                 if logprobs
                 else None,
+                processed_by=self._model,
                 token_usage=OperatorUtils.extract_token_usage(
                     completion, analyze_completion
                 ),

{hamtaa_texttools-2.3.0 → hamtaa_texttools-2.3.1}/texttools/core/utils.py

@@ -110,13 +110,12 @@ class OperatorUtils:
         return [{"role": "user", "content": prompt}]
 
     @staticmethod
-    def extract_logprobs(completion: Any) -> list[dict]:
+    def extract_logprobs(completion: Any) -> list[dict[str, Any]]:
         """
         Extracts and filters logprobs from completion.
         Skips punctuation and structural tokens.
         """
         logprobs_data = []
-
         ignore_pattern = re.compile(r'^(result|[\s\[\]\{\}",:]+)$')
 
         for choice in completion.choices:

{hamtaa_texttools-2.3.0 → hamtaa_texttools-2.3.1}/texttools/tools/async_tools.py

@@ -30,10 +30,17 @@ class AsyncTheTool:
         model: str,
         raise_on_error: bool = True,
     ):
+        """
+        Initialize the AsyncTheTool instance.
+
+        Args:
+            client: An AsyncOpenAI client instance for making asynchronous API calls
+            model: The name of the model
+            raise_on_error: If True, raises exceptions on errors; if False, logs errors and continues
+        """
         self._operator = AsyncOperator(client=client, model=model)
         self.logger = logging.getLogger(self.__class__.__name__)
         self.raise_on_error = raise_on_error
-        self.model = model
 
     async def categorize(
         self,
@@ -98,7 +105,7 @@ class AsyncTheTool:
                 metadata = ToolOutputMetadata(
                     tool_name=tool_name,
                     execution_time=perf_counter() - start,
-                    processed_by=self.model,
+                    processed_by=operator_output.processed_by,
                     token_usage=operator_output.token_usage,
                 )
                 tool_output = ToolOutput(
@@ -163,7 +170,7 @@ class AsyncTheTool:
                 metadata = ToolOutputMetadata(
                     tool_name=tool_name,
                     execution_time=perf_counter() - start,
-                    processed_by=self.model,
+                    processed_by=level_operator_output.processed_by,
                     token_usage=token_usage,
                 )
                 tool_output = ToolOutput(
@@ -252,7 +259,7 @@ class AsyncTheTool:
             metadata = ToolOutputMetadata(
                 tool_name=tool_name,
                 execution_time=perf_counter() - start,
-                processed_by=self.model,
+                processed_by=operator_output.processed_by,
                 token_usage=operator_output.token_usage,
             )
             tool_output = ToolOutput(
@@ -339,7 +346,7 @@ class AsyncTheTool:
             metadata = ToolOutputMetadata(
                 tool_name=tool_name,
                 execution_time=perf_counter() - start,
-                processed_by=self.model,
+                processed_by=operator_output.processed_by,
                 token_usage=operator_output.token_usage,
             )
             tool_output = ToolOutput(
@@ -421,7 +428,7 @@ class AsyncTheTool:
             metadata = ToolOutputMetadata(
                 tool_name=tool_name,
                 execution_time=perf_counter() - start,
-                processed_by=self.model,
+                processed_by=operator_output.processed_by,
                 token_usage=operator_output.token_usage,
             )
             tool_output = ToolOutput(
@@ -510,7 +517,7 @@ class AsyncTheTool:
             metadata = ToolOutputMetadata(
                 tool_name=tool_name,
                 execution_time=perf_counter() - start,
-                processed_by=self.model,
+                processed_by=operator_output.processed_by,
                 token_usage=operator_output.token_usage,
             )
             tool_output = ToolOutput(
@@ -597,7 +604,7 @@ class AsyncTheTool:
             metadata = ToolOutputMetadata(
                 tool_name=tool_name,
                 execution_time=perf_counter() - start,
-                processed_by=self.model,
+                processed_by=operator_output.processed_by,
                 token_usage=operator_output.token_usage,
             )
             tool_output = ToolOutput(
@@ -683,7 +690,7 @@ class AsyncTheTool:
             metadata = ToolOutputMetadata(
                 tool_name=tool_name,
                 execution_time=perf_counter() - start,
-                processed_by=self.model,
+                processed_by=operator_output.processed_by,
                 token_usage=operator_output.token_usage,
             )
             tool_output = ToolOutput(
@@ -767,7 +774,7 @@ class AsyncTheTool:
             metadata = ToolOutputMetadata(
                 tool_name=tool_name,
                 execution_time=perf_counter() - start,
-                processed_by=self.model,
+                processed_by=operator_output.processed_by,
                 token_usage=operator_output.token_usage,
             )
             tool_output = ToolOutput(
@@ -872,7 +879,7 @@ class AsyncTheTool:
                 metadata = ToolOutputMetadata(
                     tool_name=tool_name,
                     execution_time=perf_counter() - start,
-                    processed_by=self.model,
+                    processed_by=chunk_operator_output.processed_by,
                     token_usage=token_usage,
                 )
                 tool_output = ToolOutput(
@@ -908,7 +915,7 @@ class AsyncTheTool:
                 metadata = ToolOutputMetadata(
                     tool_name=tool_name,
                     execution_time=perf_counter() - start,
-                    processed_by=self.model,
+                    processed_by=operator_output.processed_by,
                     token_usage=operator_output.token_usage,
                 )
                 tool_output = ToolOutput(
@@ -994,7 +1001,7 @@ class AsyncTheTool:
             metadata = ToolOutputMetadata(
                 tool_name=tool_name,
                 execution_time=perf_counter() - start,
-                processed_by=self.model,
+                processed_by=operator_output.processed_by,
                 token_usage=operator_output.token_usage,
             )
             tool_output = ToolOutput(
@@ -1083,7 +1090,7 @@ class AsyncTheTool:
             metadata = ToolOutputMetadata(
                 tool_name=tool_name,
                 execution_time=perf_counter() - start,
-                processed_by=self.model,
+                processed_by=operator_output.processed_by,
                 token_usage=operator_output.token_usage,
             )
             tool_output = ToolOutput(
@@ -1171,7 +1178,7 @@ class AsyncTheTool:
             metadata = ToolOutputMetadata(
                 tool_name=tool_name,
                 execution_time=perf_counter() - start,
-                processed_by=self.model,
+                processed_by=operator_output.processed_by,
                 token_usage=operator_output.token_usage,
             )
             tool_output = ToolOutput(

{hamtaa_texttools-2.3.0 → hamtaa_texttools-2.3.1}/texttools/tools/batch_tools.py

@@ -15,6 +15,15 @@ class BatchTheTool:
         raise_on_error: bool = True,
         max_concurrency: int = 5,
     ):
+        """
+        Initialize the BatchTheTool instance.
+
+        Arguments:
+            client: An AsyncOpenAI client instance for making asynchronous API calls
+            model: The name of the model
+            raise_on_error: If True, raises exceptions on errors; if False, logs errors and continues
+            max_concurrency: Maximum number of concurrent API requests allowed
+        """
         self.tool = AsyncTheTool(client, model, raise_on_error)
         self.semaphore = asyncio.Semaphore(max_concurrency)
 

{hamtaa_texttools-2.3.0 → hamtaa_texttools-2.3.1}/texttools/tools/sync_tools.py

@@ -30,10 +30,17 @@ class TheTool:
         model: str,
         raise_on_error: bool = True,
     ):
+        """
+        Initialize the TheTool instance.
+
+        Args:
+            client: An OpenAI client instance for making API calls
+            model: The name of the model
+            raise_on_error: If True, raises exceptions on errors; if False, logs errors and continues
+        """
         self._operator = Operator(client=client, model=model)
         self.logger = logging.getLogger(self.__class__.__name__)
         self.raise_on_error = raise_on_error
-        self.model = model
 
     def categorize(
         self,
@@ -93,7 +100,7 @@ class TheTool:
                 metadata = ToolOutputMetadata(
                     tool_name=tool_name,
                     execution_time=perf_counter() - start,
-                    processed_by=self.model,
+                    processed_by=operator_output.processed_by,
                     token_usage=operator_output.token_usage,
                 )
                 tool_output = ToolOutput(
@@ -155,7 +162,7 @@ class TheTool:
                 metadata = ToolOutputMetadata(
                     tool_name=tool_name,
                     execution_time=perf_counter() - start,
-                    processed_by=self.model,
+                    processed_by=level_operator_output.processed_by,
                     token_usage=token_usage,
                 )
                 tool_output = ToolOutput(
@@ -239,7 +246,7 @@ class TheTool:
             metadata = ToolOutputMetadata(
                 tool_name=tool_name,
                 execution_time=perf_counter() - start,
-                processed_by=self.model,
+                processed_by=operator_output.processed_by,
                 token_usage=operator_output.token_usage,
             )
             tool_output = ToolOutput(
@@ -321,7 +328,7 @@ class TheTool:
             metadata = ToolOutputMetadata(
                 tool_name=tool_name,
                 execution_time=perf_counter() - start,
-                processed_by=self.model,
+                processed_by=operator_output.processed_by,
                 token_usage=operator_output.token_usage,
             )
             tool_output = ToolOutput(
@@ -398,7 +405,7 @@ class TheTool:
             metadata = ToolOutputMetadata(
                 tool_name=tool_name,
                 execution_time=perf_counter() - start,
-                processed_by=self.model,
+                processed_by=operator_output.processed_by,
                 token_usage=operator_output.token_usage,
             )
             tool_output = ToolOutput(
@@ -482,7 +489,7 @@ class TheTool:
             metadata = ToolOutputMetadata(
                 tool_name=tool_name,
                 execution_time=perf_counter() - start,
-                processed_by=self.model,
+                processed_by=operator_output.processed_by,
                 token_usage=operator_output.token_usage,
             )
             tool_output = ToolOutput(
@@ -564,7 +571,7 @@ class TheTool:
             metadata = ToolOutputMetadata(
                 tool_name=tool_name,
                 execution_time=perf_counter() - start,
-                processed_by=self.model,
+                processed_by=operator_output.processed_by,
                 token_usage=operator_output.token_usage,
             )
             tool_output = ToolOutput(
@@ -645,7 +652,7 @@ class TheTool:
             metadata = ToolOutputMetadata(
                 tool_name=tool_name,
                 execution_time=perf_counter() - start,
-                processed_by=self.model,
+                processed_by=operator_output.processed_by,
                 token_usage=operator_output.token_usage,
             )
             tool_output = ToolOutput(
@@ -724,7 +731,7 @@ class TheTool:
             metadata = ToolOutputMetadata(
                 tool_name=tool_name,
                 execution_time=perf_counter() - start,
-                processed_by=self.model,
+                processed_by=operator_output.processed_by,
                 token_usage=operator_output.token_usage,
             )
             tool_output = ToolOutput(
@@ -824,7 +831,7 @@ class TheTool:
                 metadata = ToolOutputMetadata(
                     tool_name=tool_name,
                     execution_time=perf_counter() - start,
-                    processed_by=self.model,
+                    processed_by=chunk_operator_output.processed_by,
                     token_usage=token_usage,
                 )
                 tool_output = ToolOutput(
@@ -857,7 +864,7 @@ class TheTool:
                 metadata = ToolOutputMetadata(
                     tool_name=tool_name,
                     execution_time=perf_counter() - start,
-                    processed_by=self.model,
+                    processed_by=operator_output.processed_by,
                     token_usage=operator_output.token_usage,
                 )
                 tool_output = ToolOutput(
@@ -938,7 +945,7 @@ class TheTool:
             metadata = ToolOutputMetadata(
                 tool_name=tool_name,
                 execution_time=perf_counter() - start,
-                processed_by=self.model,
+                processed_by=operator_output.processed_by,
                 token_usage=operator_output.token_usage,
             )
             tool_output = ToolOutput(
@@ -1022,7 +1029,7 @@ class TheTool:
             metadata = ToolOutputMetadata(
                 tool_name=tool_name,
                 execution_time=perf_counter() - start,
-                processed_by=self.model,
+                processed_by=operator_output.processed_by,
                 token_usage=operator_output.token_usage,
             )
             tool_output = ToolOutput(
@@ -1105,7 +1112,7 @@ class TheTool:
             metadata = ToolOutputMetadata(
                 tool_name=tool_name,
                 execution_time=perf_counter() - start,
-                processed_by=self.model,
+                processed_by=operator_output.processed_by,
                 token_usage=operator_output.token_usage,
             )
             tool_output = ToolOutput(