hamtaa-texttools 1.1.0__tar.gz → 1.1.1__tar.gz

{hamtaa_texttools-1.1.0/hamtaa_texttools.egg-info → hamtaa_texttools-1.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hamtaa-texttools
-Version: 1.1.0
+Version: 1.1.1
 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
@@ -29,7 +29,7 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: openai==1.97.1
-Requires-Dist: PyYAML>=6.0
+Requires-Dist: pyyaml>=6.0
 Dynamic: license-file
 
 # TextTools

{hamtaa_texttools-1.1.0 → hamtaa_texttools-1.1.1/hamtaa_texttools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hamtaa-texttools
-Version: 1.1.0
+Version: 1.1.1
 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
@@ -29,7 +29,7 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: openai==1.97.1
-Requires-Dist: PyYAML>=6.0
+Requires-Dist: pyyaml>=6.0
 Dynamic: license-file
 
 # TextTools

{hamtaa_texttools-1.1.0 → hamtaa_texttools-1.1.1}/hamtaa_texttools.egg-info/requires.txt

@@ -1,2 +1,2 @@
 openai==1.97.1
-PyYAML>=6.0
+pyyaml>=6.0

{hamtaa_texttools-1.1.0 → hamtaa_texttools-1.1.1}/pyproject.toml

@@ -1,32 +1,32 @@
-[build-system]
-requires = ["setuptools>=61.0", "wheel"]
-build-backend = "setuptools.build_meta"
-
-[project]
-name = "hamtaa-texttools"
-version = "1.1.0"
-authors = [
-  { name = "Tohidi", email = "the.mohammad.tohidi@gmail.com" },
-  { name = "Montazer", email = "montazerh82@gmail.com" },
-  { name = "Givechi", email = "mohamad.m.givechi@gmail.com" },
-  { name = "MoosaviNejad", email = "erfanmoosavi84@gmail.com" },
-]
-description = "A high-level NLP toolkit built on top of modern LLMs."
-readme = "README.md"
-license = {file = "LICENSE"}
-requires-python = ">=3.8"
-dependencies = [
-  "openai==1.97.1",
-  "PyYAML>=6.0",
-]
-keywords = ["nlp", "llm", "text-processing", "openai"]
-
-[tool.setuptools.packages.find]
-where = ["."]
-include = ["texttools*"]
-
-[tool.setuptools]
-include-package-data = true
-
-[tool.setuptools.package-data]
-"texttools" = ["prompts/*.yaml", "prompts/*.yml"]
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "hamtaa-texttools"
+version = "1.1.1"
+authors = [
+  { name = "Tohidi", email = "the.mohammad.tohidi@gmail.com" },
+  { name = "Montazer", email = "montazerh82@gmail.com" },
+  { name = "Givechi", email = "mohamad.m.givechi@gmail.com" },
+  { name = "MoosaviNejad", email = "erfanmoosavi84@gmail.com" },
+]
+description = "A high-level NLP toolkit built on top of modern LLMs."
+readme = "README.md"
+license = {file = "LICENSE"}
+requires-python = ">=3.8"
+dependencies = [
+  "openai==1.97.1",
+  "pyyaml>=6.0",
+]
+keywords = ["nlp", "llm", "text-processing", "openai"]
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["texttools*"]
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.package-data]
+"texttools" = ["prompts/*.yaml", "prompts/*.yml"]

{hamtaa_texttools-1.1.0 → hamtaa_texttools-1.1.1}/texttools/tools/async_the_tool.py

@@ -39,7 +39,10 @@ class AsyncTheTool:
         Categorize a text into a single Islamic studies domain category.
 
         Returns:
-            {"result": <category string>} + ("logprobs" and "analysis" if enabled)
+            ToolOutput: Object containing:
+                - result (str): The assigned Islamic studies category
+                - logprobs (list | None): Probability data if logprobs enabled
+                - analysis (str | None): Detailed reasoning if with_analysis enabled
         """
         return await self.operator.run(
             # User parameters
@@ -71,7 +74,10 @@ class AsyncTheTool:
         Extract salient keywords from text.
 
         Returns:
-            {"result": [<keyword1>, <keyword2>, ...]} + ("logprobs" and "analysis" if enabled)
+            ToolOutput: Object containing:
+                - result (list[str]): List of extracted keywords
+                - logprobs (list | None): Probability data if logprobs enabled
+                - analysis (str | None): Detailed reasoning if with_analysis enabled
         """
         return await self.operator.run(
             # User parameters
@@ -103,7 +109,10 @@ class AsyncTheTool:
         Perform Named Entity Recognition (NER) over the input text.
 
         Returns:
-            {"result": [{"text": <entity>, "type": <entity_type>}, ...]} + ("logprobs" and "analysis" if enabled)
+            ToolOutput: Object containing:
+                - result (list[dict]): List of entities with 'text' and 'type' keys
+                - logprobs (list | None): Probability data if logprobs enabled
+                - analysis (str | None): Detailed reasoning if with_analysis enabled
         """
         return await self.operator.run(
             # User parameters
@@ -134,7 +143,10 @@ class AsyncTheTool:
         Detect if the input is phrased as a question.
 
         Returns:
-            {"result": True} or {"result": False} + ("logprobs" and "analysis" if enabled)
+            ToolOutput: Object containing:
+                - result (bool): True if text is a question, False otherwise
+                - logprobs (list | None): Probability data if logprobs enabled
+                - analysis (str | None): Detailed reasoning if with_analysis enabled
         """
         return await self.operator.run(
             # User parameters
@@ -166,7 +178,10 @@ class AsyncTheTool:
         Generate a single question from the given text.
 
         Returns:
-            {"result": <generated_question>} + ("logprobs" and "analysis" if enabled)
+            ToolOutput: Object containing:
+                - result (str): The generated question
+                - logprobs (list | None): Probability data if logprobs enabled
+                - analysis (str | None): Detailed reasoning if with_analysis enabled
         """
         return await self.operator.run(
             # User parameters
@@ -199,7 +214,10 @@ class AsyncTheTool:
         Merge multiple questions into a single unified question.
 
         Returns:
-            {"result": <merged_question>} + ("logprobs" and "analysis" if enabled)
+            ToolOutput: Object containing:
+                - result (str): The merged question
+                - logprobs (list | None): Probability data if logprobs enabled
+                - analysis (str | None): Detailed reasoning if with_analysis enabled
         """
         text = ", ".join(text)
         return await self.operator.run(
@@ -233,7 +251,10 @@ class AsyncTheTool:
         Rewrite a text with different modes.
 
         Returns:
-            {"result": <rewritten_text>} + ("logprobs" and "analysis" if enabled)
+            ToolOutput: Object containing:
+                - result (str): The rewritten text
+                - logprobs (list | None): Probability data if logprobs enabled
+                - analysis (str | None): Detailed reasoning if with_analysis enabled
         """
         return await self.operator.run(
             # User parameters
@@ -266,7 +287,10 @@ class AsyncTheTool:
         Generate a list of questions about a subject.
 
         Returns:
-            {"result": [<question1>, <question2>, ...]} + ("logprobs" and "analysis" if enabled)
+            ToolOutput: Object containing:
+                - result (list[str]): List of generated questions
+                - logprobs (list | None): Probability data if logprobs enabled
+                - analysis (str | None): Detailed reasoning if with_analysis enabled
         """
         return await self.operator.run(
             # User parameters
@@ -299,7 +323,10 @@ class AsyncTheTool:
         Summarize the given subject text.
 
         Returns:
-            {"result": <summary>} + ("logprobs" and "analysis" if enabled)
+            ToolOutput: Object containing:
+                - result (str): The summary text
+                - logprobs (list | None): Probability data if logprobs enabled
+                - analysis (str | None): Detailed reasoning if with_analysis enabled
         """
         return await self.operator.run(
             # User parameters
@@ -331,7 +358,10 @@ class AsyncTheTool:
         Translate text between languages.
 
         Returns:
-            {"result": <translated_text>} + ("logprobs" and "analysis" if enabled)
+            ToolOutput: Object containing:
+                - result (str): The translated text
+                - logprobs (list | None): Probability data if logprobs enabled
+                - analysis (str | None): Detailed reasoning if with_analysis enabled
         """
         return await self.operator.run(
             # User parameters
@@ -363,7 +393,8 @@ class AsyncTheTool:
         Custom tool that can do almost anything!
 
         Returns:
-            {"result": <Any>}
+            ToolOutput: Object with fields:
+                - result (str): The output result
         """
         return await self.operator.run(
             # User paramaeters

{hamtaa_texttools-1.1.0 → hamtaa_texttools-1.1.1}/texttools/tools/the_tool.py

@@ -37,7 +37,10 @@ class TheTool:
         Categorize a text into a single Islamic studies domain category.
 
         Returns:
-            {"result": <category string>} + ("logprobs" and "analysis" if enabled)
+            ToolOutput: Object containing:
+                - result (str): The assigned Islamic studies category
+                - logprobs (list | None): Probability data if logprobs enabled
+                - analysis (str | None): Detailed reasoning if with_analysis enabled
         """
         return self.operator.run(
             # User parameters
@@ -69,7 +72,10 @@ class TheTool:
         Extract salient keywords from text.
 
         Returns:
-            {"result": [<keyword1>, <keyword2>, ...]} + ("logprobs" and "analysis" if enabled)
+            ToolOutput: Object containing:
+                - result (list[str]): List of extracted keywords
+                - logprobs (list | None): Probability data if logprobs enabled
+                - analysis (str | None): Detailed reasoning if with_analysis enabled
         """
         return self.operator.run(
             # User parameters
@@ -101,7 +107,10 @@ class TheTool:
         Perform Named Entity Recognition (NER) over the input text.
 
         Returns:
-            {"result": [{"text": <entity>, "type": <entity_type>}, ...]} + ("logprobs" and "analysis" if enabled)
+            ToolOutput: Object containing:
+                - result (list[dict]): List of entities with 'text' and 'type' keys
+                - logprobs (list | None): Probability data if logprobs enabled
+                - analysis (str | None): Detailed reasoning if with_analysis enabled
         """
         return self.operator.run(
             # User parameters
@@ -132,7 +141,10 @@ class TheTool:
         Detect if the input is phrased as a question.
 
         Returns:
-            {"result": True} or {"result": False} + ("logprobs" and "analysis" if enabled)
+            ToolOutput: Object containing:
+                - result (bool): True if text is a question, False otherwise
+                - logprobs (list | None): Probability data if logprobs enabled
+                - analysis (str | None): Detailed reasoning if with_analysis enabled
         """
         return self.operator.run(
             # User parameters
@@ -164,7 +176,10 @@ class TheTool:
         Generate a single question from the given text.
 
         Returns:
-            {"result": <generated_question>} + ("logprobs" and "analysis" if enabled)
+            ToolOutput: Object containing:
+                - result (str): The generated question
+                - logprobs (list | None): Probability data if logprobs enabled
+                - analysis (str | None): Detailed reasoning if with_analysis enabled
         """
         return self.operator.run(
             # User parameters
@@ -197,7 +212,10 @@ class TheTool:
         Merge multiple questions into a single unified question.
 
         Returns:
-            {"result": <merged_question>} + ("logprobs" and "analysis" if enabled)
+            ToolOutput: Object containing:
+                - result (str): The merged question
+                - logprobs (list | None): Probability data if logprobs enabled
+                - analysis (str | None): Detailed reasoning if with_analysis enabled
         """
         text = ", ".join(text)
         return self.operator.run(
@@ -231,7 +249,10 @@ class TheTool:
         Rewrite a text with different modes.
 
         Returns:
-            {"result": <rewritten_text>} + ("logprobs" and "analysis" if enabled)
+            ToolOutput: Object containing:
+                - result (str): The rewritten text
+                - logprobs (list | None): Probability data if logprobs enabled
+                - analysis (str | None): Detailed reasoning if with_analysis enabled
         """
         return self.operator.run(
             # User parameters
@@ -264,7 +285,10 @@ class TheTool:
         Generate a list of questions about a subject.
 
         Returns:
-            {"result": [<question1>, <question2>, ...]} + ("logprobs" and "analysis" if enabled)
+            ToolOutput: Object containing:
+                - result (list[str]): List of generated questions
+                - logprobs (list | None): Probability data if logprobs enabled
+                - analysis (str | None): Detailed reasoning if with_analysis enabled
         """
         return self.operator.run(
             # User parameters
@@ -297,7 +321,10 @@ class TheTool:
         Summarize the given subject text.
 
         Returns:
-            {"result": <summary>} + ("logprobs" and "analysis" if enabled)
+            ToolOutput: Object containing:
+                - result (str): The summary text
+                - logprobs (list | None): Probability data if logprobs enabled
+                - analysis (str | None): Detailed reasoning if with_analysis enabled
         """
         return self.operator.run(
             # User parameters
@@ -329,7 +356,10 @@ class TheTool:
         Translate text between languages.
 
         Returns:
-            {"result": <translated_text>} + ("logprobs" and "analysis" if enabled)
+            ToolOutput: Object containing:
+                - result (str): The translated text
+                - logprobs (list | None): Probability data if logprobs enabled
+                - analysis (str | None): Detailed reasoning if with_analysis enabled
         """
         return self.operator.run(
             # User parameters
@@ -361,7 +391,8 @@ class TheTool:
         Custom tool that can do almost anything!
 
         Returns:
-            {"result": <Any>}
+            ToolOutput: Object with fields:
+                - result (str): The output result
         """
         return self.operator.run(
             # User paramaeters