openai-sdk-helpers 0.4.2__py3-none-any.whl → 0.5.0__py3-none-any.whl

openai_sdk_helpers/structure/plan/plan.py

@@ -57,26 +57,6 @@ class PlanStructure(StructureBase):
         description="Ordered list of agent tasks to execute.",
     )
 
-    def print(self) -> str:
-        """Return a human-readable representation of the plan.
-
-        Returns
-        -------
-        str
-            Concatenated description of each task with task numbers.
-
-        Examples
-        --------
-        >>> plan = PlanStructure()
-        >>> plan.print()
-        'No tasks defined.'
-        """
-        if not self.tasks:
-            return "No tasks defined."
-        return "\n\n".join(
-            [f"Task {idx + 1}:\n{task.print()}" for idx, task in enumerate(self.tasks)]
-        )
-
     def __len__(self) -> int:
         """Return the number of tasks in the plan.
 

openai_sdk_helpers/structure/plan/task.py

@@ -117,38 +117,5 @@ class TaskStructure(StructureBase):
             return value
         return AgentEnum(value)
 
-    def print(self) -> str:
-        """Return a human-readable representation of the task.
-
-        Parameters
-        ----------
-        None
-
-        Returns
-        -------
-        str
-            Multi-line description of the task metadata.
-
-        Raises
-        ------
-        None
-
-        Examples
-        --------
-        >>> TaskStructure(prompt="Test").print()
-        'Task type: ...'  # doctest: +SKIP
-        """
-        return "\n".join(
-            [
-                StructureBase.format_output("Task type", value=self.task_type),
-                StructureBase.format_output("Prompt", value=self.prompt),
-                StructureBase.format_output("Context", value=self.context),
-                StructureBase.format_output("Status", value=self.status),
-                StructureBase.format_output("Start date", value=self.start_date),
-                StructureBase.format_output("End date", value=self.end_date),
-                StructureBase.format_output("Results", value=self.results),
-            ]
-        )
-
 
 __all__ = ["TaskStructure"]

openai_sdk_helpers/structure/prompt.py

@@ -41,3 +41,19 @@ class PromptStructure(StructureBase):
             "Generate a summary of the latest news in AI.",
         ],
     )
+
+    @staticmethod
+    def from_str(prompt_str: str) -> PromptStructure:
+        """Create a PromptStructure instance from a simple string.
+
+        Parameters
+        ----------
+        prompt_str : str
+            The prompt text to use for the OpenAI API request.
+
+        Returns
+        -------
+        PromptStructure
+            An instance of PromptStructure with the provided prompt text.
+        """
+        return PromptStructure(prompt=prompt_str)

openai_sdk_helpers/structure/responses.py

@@ -92,7 +92,7 @@ def assistant_format(structure: type[StructureBase]) -> dict:
 def response_tool_definition(
     structure: type[StructureBase],
     tool_name: str,
-    tool_description: str,
+    tool_description: str | None,
 ) -> dict:
     """Build a tool definition for OpenAI chat completions.
 
@@ -105,7 +105,7 @@ def response_tool_definition(
         Structure class that defines the tool schema.
     tool_name : str
         Name of the function tool.
-    tool_description : str
+    tool_description : str | None
         Description of what the function tool does.
 
     Returns

openai_sdk_helpers/structure/web_search.py

@@ -150,13 +150,3 @@ class WebSearchStructure(StructureBase):
         "web_search_results"
     )
     web_search_report: WebSearchReportStructure = spec_field("web_search_report")
-
-    def print(self) -> str:
-        """Return the markdown report.
-
-        Returns
-        -------
-        str
-            Markdown-formatted report from web search results.
-        """
-        return self.web_search_report.markdown_report