vectara-agentic 0.3.2__py3-none-any.whl → 0.4.0__py3-none-any.whl

vectara_agentic/tool_utils.py

@@ -4,6 +4,7 @@ This module contains the ToolsFactory class for creating agent tools.
 
 import inspect
 import re
+import traceback
 
 from typing import (
     Callable,
@@ -17,7 +18,7 @@ from typing import (
     get_origin,
     get_args,
 )
-from pydantic import BaseModel, create_model
+from pydantic import BaseModel, create_model, Field
 from pydantic_core import PydanticUndefined
 
 from llama_index.core.tools import FunctionTool
@@ -31,21 +32,26 @@ from .utils import is_float
 
 class VectaraToolMetadata(ToolMetadata):
     """
-    A subclass of ToolMetadata adding the tool_type attribute.
+    A subclass of ToolMetadata adding the tool_type and vhc_eligible attributes.
     """
 
     tool_type: ToolType
+    vhc_eligible: bool
 
-    def __init__(self, tool_type: ToolType, **kwargs):
+    def __init__(self, tool_type: ToolType, vhc_eligible: bool = True, **kwargs):
         super().__init__(**kwargs)
         self.tool_type = tool_type
+        self.vhc_eligible = vhc_eligible
 
     def __repr__(self) -> str:
         """
-        Returns a string representation of the VectaraToolMetadata object, including the tool_type attribute.
+        Returns a string representation of the VectaraToolMetadata object,
+        including the tool_type and vhc_eligible attributes.
         """
         base_repr = super().__repr__()
-        return f"{base_repr}, tool_type={self.tool_type}"
+        return (
+            f"{base_repr}, tool_type={self.tool_type}, vhc_eligible={self.vhc_eligible}"
+        )
 
 
 class VectaraTool(FunctionTool):
@@ -59,11 +65,17 @@ class VectaraTool(FunctionTool):
         metadata: ToolMetadata,
         fn: Optional[Callable[..., Any]] = None,
         async_fn: Optional[AsyncCallable] = None,
+        vhc_eligible: bool = True,
     ) -> None:
+        # Use Pydantic v2 compatible method for extracting metadata
         metadata_dict = (
-            metadata.dict() if hasattr(metadata, "dict") else metadata.__dict__
+            metadata.model_dump()
+            if hasattr(metadata, "model_dump")
+            else metadata.dict() if hasattr(metadata, "dict") else metadata.__dict__
+        )
+        vm = VectaraToolMetadata(
+            tool_type=tool_type, vhc_eligible=vhc_eligible, **metadata_dict
         )
-        vm = VectaraToolMetadata(tool_type=tool_type, **metadata_dict)
         super().__init__(fn, vm, async_fn)
 
     @classmethod
@@ -80,6 +92,7 @@ class VectaraTool(FunctionTool):
         async_callback: Optional[AsyncCallable] = None,
         partial_params: Optional[Dict[str, Any]] = None,
         tool_type: ToolType = ToolType.QUERY,
+        vhc_eligible: bool = True,
     ) -> "VectaraTool":
         tool = FunctionTool.from_defaults(
             fn,
@@ -98,6 +111,7 @@ class VectaraTool(FunctionTool):
             fn=tool.fn,
             metadata=tool.metadata,
             async_fn=tool.async_fn,
+            vhc_eligible=vhc_eligible,
         )
         return vectara_tool
 
@@ -123,94 +137,82 @@ class VectaraTool(FunctionTool):
         )
         return is_equal
 
-    def call(
-        self, *args: Any, ctx: Optional[Context] = None, **kwargs: Any
+    def _create_tool_error_output(
+        self, error: Exception, args: Any, kwargs: Any, include_traceback: bool = False
     ) -> ToolOutput:
-        try:
-            result = super().call(*args, ctx=ctx, **kwargs)
-            return self._format_tool_output(result)
-        except TypeError as e:
+        """Create standardized error output for tool execution failures."""
+        if isinstance(error, TypeError):
+            # Parameter validation error handling
             sig = inspect.signature(self.metadata.fn_schema)
             valid_parameters = list(sig.parameters.keys())
             params_str = ", ".join(valid_parameters)
-
-            err_output = ToolOutput(
+            return ToolOutput(
                 tool_name=self.metadata.name,
                 content=(
-                    f"Wrong argument used when calling {self.metadata.name}: {str(e)}."
-                    f"Valid arguments: {params_str}. please call the tool again with the correct arguments."
+                    f"Wrong argument used when calling {self.metadata.name}: {str(error)}. "
+                    f"Valid arguments: {params_str}. Please call the tool again with the correct arguments."
                 ),
                 raw_input={"args": args, "kwargs": kwargs},
-                raw_output={"response": str(e)},
+                raw_output={"response": str(error)},
             )
-            return err_output
-        except Exception as e:
-            err_output = ToolOutput(
+        else:
+            # General execution error handling
+            content = f"Tool {self.metadata.name} Malfunction: {str(error)}"
+            if include_traceback:
+                content += f", traceback: {traceback.format_exc()}"
+
+            return ToolOutput(
                 tool_name=self.metadata.name,
-                content=f"Tool {self.metadata.name} Malfunction: {str(e)}",
+                content=content,
                 raw_input={"args": args, "kwargs": kwargs},
-                raw_output={"response": str(e)},
+                raw_output={"response": str(error)},
             )
-            return err_output
 
-    async def acall(
+    def call(
         self, *args: Any, ctx: Optional[Context] = None, **kwargs: Any
     ) -> ToolOutput:
         try:
-            result = await super().acall(*args, ctx=ctx, **kwargs)
+            # Only pass ctx if it's not None to avoid passing unwanted kwargs to the function
+            if ctx is not None:
+                result = super().call(*args, ctx=ctx, **kwargs)
+            else:
+                result = super().call(*args, **kwargs)
             return self._format_tool_output(result)
-        except TypeError as e:
-            sig = inspect.signature(self.metadata.fn_schema)
-            valid_parameters = list(sig.parameters.keys())
-            params_str = ", ".join(valid_parameters)
-
-            err_output = ToolOutput(
-                tool_name=self.metadata.name,
-                content=(
-                    f"Wrong argument used when calling {self.metadata.name}: {str(e)}. "
-                    f"Valid arguments: {params_str}. please call the tool again with the correct arguments."
-                ),
-                raw_input={"args": args, "kwargs": kwargs},
-                raw_output={"response": str(e)},
-            )
-            return err_output
         except Exception as e:
-            import traceback
+            return self._create_tool_error_output(e, args, kwargs)
 
-            err_output = ToolOutput(
-                tool_name=self.metadata.name,
-                content=f"Tool {self.metadata.name} Malfunction: {str(e)}, traceback: {traceback.format_exc()}",
-                raw_input={"args": args, "kwargs": kwargs},
-                raw_output={"response": str(e)},
+    async def acall(
+        self, *args: Any, ctx: Optional[Context] = None, **kwargs: Any
+    ) -> ToolOutput:
+        try:
+            # Only pass ctx if it's not None to avoid passing unwanted kwargs to the function
+            if ctx is not None:
+                result = await super().acall(*args, ctx=ctx, **kwargs)
+            else:
+                result = await super().acall(*args, **kwargs)
+            return self._format_tool_output(result)
+        except Exception as e:
+            return self._create_tool_error_output(
+                e, args, kwargs, include_traceback=True
             )
-            return err_output
 
     def _format_tool_output(self, result: ToolOutput) -> ToolOutput:
-        """Format tool output to use human-readable representation if available."""
-        if hasattr(result, "content") and _is_human_readable_output(result.content):
+        """Format tool output by converting human-readable wrappers to formatted content immediately."""
+        import logging
+
+        # If the raw_output has human-readable formatting, use it for the content
+        if hasattr(result, "raw_output") and _is_human_readable_output(
+            result.raw_output
+        ):
             try:
-                # Use human-readable format for content, keep raw output
-                human_readable_content = result.content.to_human_readable()
-                raw_output = result.content.get_raw_output()
-                return ToolOutput(
-                    tool_name=result.tool_name,
-                    content=human_readable_content,
-                    raw_input=result.raw_input,
-                    raw_output=raw_output,
-                )
+                formatted_content = result.raw_output.to_human_readable()
+                # Replace the content with the formatted version
+                result.content = formatted_content
             except Exception as e:
-                # If formatting fails, fall back to original content with error info
-                import logging
-
                 logging.warning(
-                    f"Failed to format tool output for {result.tool_name}: {e}"
-                )
-                return ToolOutput(
-                    tool_name=result.tool_name,
-                    content=f"[Formatting Error] {str(result.content)}",
-                    raw_input=result.raw_input,
-                    raw_output={"error": str(e), "original_content": result.content},
+                    f"{self.metadata.name}: Failed to convert to human-readable: {e}"
                 )
+
         return result
 
 
@@ -257,7 +259,6 @@ def _make_docstring(
     tool_description: str,
     fn_schema: Type[BaseModel],
     all_params: List[inspect.Parameter],
-    compact_docstring: bool,
 ) -> str:
     """
     Generates a docstring for a function based on its signature, description,
@@ -269,7 +270,6 @@ def _make_docstring(
         tool_description: The main description of the tool/function.
         fn_schema: The Pydantic model representing the function's arguments schema.
         all_params: A list of inspect.Parameter objects for the function signature.
-        compact_docstring: If True, omits the signature line in the main description.
 
     Returns:
         A formatted docstring string.
@@ -282,10 +282,7 @@ def _make_docstring(
     params_str = ", ".join(params_str_parts)
     signature_line = f"{tool_name}({params_str}) -> dict[str, Any]"
 
-    if compact_docstring:
-        doc_lines = [tool_description.strip()]
-    else:
-        doc_lines = [signature_line, "", tool_description.strip()]
+    doc_lines = [signature_line, "", tool_description.strip()]
 
     full_schema = fn_schema.model_json_schema()
     props = full_schema.get("properties", {})
@@ -339,14 +336,61 @@ def _make_docstring(
     return final_docstring
 
 
+def _auto_fix_field_if_needed(
+    field_name: str, field_info, annotation
+) -> Tuple[Any, Any]:
+    """
+    Auto-fix problematic Field definitions: convert non-Optional types with any default value to Optional.
+
+    Args:
+        field_name: Name of the field
+        field_info: The Pydantic FieldInfo object
+        annotation: The type annotation for the field
+
+    Returns:
+        Tuple of (possibly_modified_annotation, possibly_modified_field_info)
+    """
+    # Check for problematic pattern: non-Optional type with any default value
+    if (
+        field_info.default is not PydanticUndefined
+        and annotation is not None
+        and get_origin(annotation) is not Union
+    ):
+
+        # Convert to Optional[OriginalType] and keep the original default value
+        new_annotation = Union[annotation, type(None)]
+        # Create new field_info preserving the original default value
+        new_field_info = Field(
+            default=field_info.default,
+            description=field_info.description,
+            examples=getattr(field_info, "examples", None),
+            title=getattr(field_info, "title", None),
+            alias=getattr(field_info, "alias", None),
+            json_schema_extra=getattr(field_info, "json_schema_extra", None),
+        )
+
+        # Optional: Log the auto-fix for debugging
+        import logging
+
+        logging.debug(
+            f"Auto-fixed field '{field_name}': "
+            f"converted {annotation} with default={field_info.default} to Optional[{annotation.__name__}]"
+        )
+
+        return new_annotation, new_field_info
+    else:
+        # Keep original field definition
+        return annotation, field_info
+
+
 def create_tool_from_dynamic_function(
     function: Callable[..., ToolOutput],
     tool_name: str,
     tool_description: str,
     base_params_model: Type[BaseModel],
     tool_args_schema: Type[BaseModel],
-    compact_docstring: bool = False,
     return_direct: bool = False,
+    vhc_eligible: bool = True,
 ) -> VectaraTool:
     """
     Create a VectaraTool from a dynamic function.
@@ -356,7 +400,7 @@ def create_tool_from_dynamic_function(
         tool_description (str): The description of the tool.
         base_params_model (Type[BaseModel]): The Pydantic model for the base parameters.
         tool_args_schema (Type[BaseModel]): The Pydantic model for the tool arguments.
-        compact_docstring (bool): Whether to use a compact docstring format.
+        return_direct (bool): Whether to return the tool output directly.
     Returns:
         VectaraTool: The created VectaraTool.
     """
@@ -371,6 +415,11 @@ def create_tool_from_dynamic_function(
     fields: Dict[str, Any] = {}
     base_params = []
     for field_name, field_info in base_params_model.model_fields.items():
+        # Apply auto-conversion if needed
+        annotation, field_info = _auto_fix_field_if_needed(
+            field_name, field_info, field_info.annotation
+        )
+
         default = (
             Ellipsis if field_info.default is PydanticUndefined else field_info.default
         )
@@ -378,16 +427,21 @@ def create_tool_from_dynamic_function(
             field_name,
             inspect.Parameter.POSITIONAL_OR_KEYWORD,
             default=default if default is not Ellipsis else inspect.Parameter.empty,
-            annotation=field_info.annotation,
+            annotation=annotation,
         )
         base_params.append(param)
-        fields[field_name] = (field_info.annotation, field_info)
+        fields[field_name] = (annotation, field_info)
 
     # Add tool_args_schema fields to the fields dict if not already included.
     for field_name, field_info in tool_args_schema.model_fields.items():
         if field_name in fields:
             continue
 
+        # Apply auto-conversion if needed
+        annotation, field_info = _auto_fix_field_if_needed(
+            field_name, field_info, field_info.annotation
+        )
+
         default = (
             Ellipsis if field_info.default is PydanticUndefined else field_info.default
         )
@@ -395,12 +449,12 @@ def create_tool_from_dynamic_function(
             field_name,
             inspect.Parameter.POSITIONAL_OR_KEYWORD,
             default=default if default is not Ellipsis else inspect.Parameter.empty,
-            annotation=field_info.annotation,
+            annotation=annotation,
         )
         base_params.append(param)
-        fields[field_name] = (field_info.annotation, field_info)
+        fields[field_name] = (annotation, field_info)
 
-    # Create the dynamic schema with both base_params_model and tool_args_schema fields.
+    # Create the dynamic schema with both base_params_model and tool_args_schema fields (auto-fixed)
     fn_schema = create_model(f"{tool_name}_schema", **fields)
 
     # Combine parameters into a function signature.
@@ -414,7 +468,7 @@ def create_tool_from_dynamic_function(
     function.__name__ = re.sub(r"[^A-Za-z0-9_]", "_", tool_name)
 
     function.__doc__ = _make_docstring(
-        function, tool_name, tool_description, fn_schema, all_params, compact_docstring
+        function, tool_name, tool_description, fn_schema, all_params
     )
     tool = VectaraTool.from_defaults(
         fn=function,
@@ -423,6 +477,7 @@ def create_tool_from_dynamic_function(
         fn_schema=fn_schema,
         tool_type=ToolType.QUERY,
         return_direct=return_direct,
+        vhc_eligible=vhc_eligible,
     )
     return tool
 

vectara_agentic/tools.py

@@ -74,20 +74,16 @@ class VectaraToolFactory:
         self,
         vectara_corpus_key: str = str(os.environ.get("VECTARA_CORPUS_KEY", "")),
         vectara_api_key: str = str(os.environ.get("VECTARA_API_KEY", "")),
-        compact_docstring: bool = False,
     ) -> None:
         """
         Initialize the VectaraToolFactory
         Args:
             vectara_corpus_key (str): The Vectara corpus key (or comma separated list of keys).
             vectara_api_key (str): The Vectara API key.
-            compact_docstring (bool): Whether to use a compact docstring format for tools
-              This is useful if OpenAI complains on the 1024 token limit.
         """
         self.vectara_corpus_key = vectara_corpus_key
         self.vectara_api_key = vectara_api_key
         self.num_corpora = len(vectara_corpus_key.split(","))
-        self.compact_docstring = compact_docstring
 
     def create_search_tool(
         self,
@@ -116,6 +112,7 @@ class VectaraToolFactory:
         verbose: bool = False,
         vectara_base_url: str = "https://api.vectara.io",
         vectara_verify_ssl: bool = True,
+        vhc_eligible: bool = True,
     ) -> VectaraTool:
         """
         Creates a Vectara search/retrieval tool
@@ -280,7 +277,7 @@ class VectaraToolFactory:
                     # Add all matching text if available
                     matches = result["metadata"]["matching_text"]
                     if matches:
-                        result_str += ''.join(
+                        result_str += "".join(
                             f"Match #{inx} Text: {match}\n"
                             for inx, match in enumerate(matches, 1)
                         )
@@ -312,7 +309,7 @@ class VectaraToolFactory:
                 description="The search query to perform, in the form of a question.",
             )
             top_k: int = Field(
-                10, description="The number of top documents to retrieve."
+                default=10, description="The number of top documents to retrieve."
             )
 
         search_tool_extra_desc = (
@@ -331,8 +328,8 @@ class VectaraToolFactory:
                 else SearchToolBaseParamsWithoutSummarize
             ),
             tool_args_schema,
-            compact_docstring=self.compact_docstring,
             return_direct=return_direct,
+            vhc_eligible=vhc_eligible,
         )
         return tool
 
@@ -367,13 +364,16 @@ class VectaraToolFactory:
         frequency_penalty: Optional[float] = None,
         presence_penalty: Optional[float] = None,
         include_citations: bool = True,
-        citation_pattern: str = "{doc.url}",
+        citation_pattern: str = None,
+        citation_url_pattern: str = "{doc.url}",
+        citation_text_pattern: str = "{doc.title}",
         save_history: bool = False,
         fcs_threshold: float = 0.0,
         return_direct: bool = False,
         verbose: bool = False,
         vectara_base_url: str = "https://api.vectara.io",
         vectara_verify_ssl: bool = True,
+        vhc_eligible: bool = True,
     ) -> VectaraTool:
         """
         Creates a RAG (Retrieve and Generate) tool.
@@ -421,9 +421,13 @@ class VectaraToolFactory:
                 higher values increasing the diversity of topics.
             include_citations (bool, optional): Whether to include citations in the response.
                 If True, uses markdown vectara citations that requires the Vectara scale plan.
-            citation_pattern (str, optional): The pattern for the citations in the response.
+            citation_url_pattern (str, optional): The pattern for the citations in the response.
                 Default is "{doc.url}" which uses the document URL.
                 If include_citations is False, this parameter is ignored.
+                citation_pattern (str, optional): old name for citation_url_pattern. Deprecated.
+            citation_text_pattern (str, optional): The text pattern for citations in the response.
+                Default is "{doc.title}" which uses the title of the document.
+                If include_citations is False, this parameter is ignored.
             save_history (bool, optional): Whether to save the query in history.
             fcs_threshold (float, optional): A threshold for factual consistency.
                 If set above 0, the tool notifies the calling agent that it "cannot respond" if FCS is too low.
@@ -469,6 +473,15 @@ class VectaraToolFactory:
                 )
                 return {"text": msg, "metadata": {"args": args, "kwargs": kwargs}}
 
+            citations_url_pattern = (
+                (
+                    citation_url_pattern
+                    if citation_url_pattern is not None
+                    else citation_pattern
+                )
+                if include_citations
+                else None
+            )
             vectara_query_engine = vectara.as_query_engine(
                 summary_enabled=True,
                 similarity_top_k=summary_num_results,
@@ -501,7 +514,10 @@ class VectaraToolFactory:
                 frequency_penalty=frequency_penalty,
                 presence_penalty=presence_penalty,
                 citations_style="markdown" if include_citations else None,
-                citations_url_pattern=citation_pattern if include_citations else None,
+                citations_url_pattern=citations_url_pattern,
+                citations_text_pattern=(
+                    citation_text_pattern if include_citations else None
+                ),
                 save_history=save_history,
                 x_source_str="vectara-agentic",
                 verbose=verbose,
@@ -513,9 +529,11 @@ class VectaraToolFactory:
                     "Tool failed to generate a response since no matches were found. "
                     "Please check the arguments and try again."
                 )
+                kwargs["query"] = query
                 return {"text": msg, "metadata": {"args": args, "kwargs": kwargs}}
             if str(response) == "None":
                 msg = "Tool failed to generate a response."
+                kwargs["query"] = query
                 return {"text": msg, "metadata": {"args": args, "kwargs": kwargs}}
 
             # Extract citation metadata
@@ -557,11 +575,8 @@ class VectaraToolFactory:
                     if key.isdigit():
                         doc = value.get("document", {})
                         doc_metadata = f"{key}: " + "; ".join(
-                            [
-                                f"{k}='{v}'"
-                                for k, v in doc.items()
-                            ] +
-                            [
+                            [f"{k}='{v}'" for k, v in doc.items()]
+                            + [
                                 f"{k}='{v}'"
                                 for k, v in value.items()
                                 if k not in ["document"] + keys_to_ignore
@@ -589,8 +604,8 @@ class VectaraToolFactory:
             tool_description,
             RagToolBaseParams,
             tool_args_schema,
-            compact_docstring=self.compact_docstring,
             return_direct=return_direct,
+            vhc_eligible=vhc_eligible,
         )
         return tool
 
@@ -604,7 +619,10 @@ class ToolsFactory:
         self.agent_config = agent_config
 
     def create_tool(
-        self, function: Callable, tool_type: ToolType = ToolType.QUERY
+        self,
+        function: Callable,
+        tool_type: ToolType = ToolType.QUERY,
+        vhc_eligible: bool = True,
     ) -> VectaraTool:
         """
         Create a tool from a function.
@@ -616,7 +634,9 @@ class ToolsFactory:
         Returns:
             VectaraTool: A VectaraTool object.
         """
-        return VectaraTool.from_defaults(tool_type=tool_type, fn=function)
+        return VectaraTool.from_defaults(
+            tool_type=tool_type, fn=function, vhc_eligible=vhc_eligible
+        )
 
     def get_llama_index_tools(
         self,
@@ -677,7 +697,7 @@ class ToolsFactory:
         """
         tc = ToolsCatalog(self.agent_config)
         return [
-            self.create_tool(tool)
+            self.create_tool(tool, vhc_eligible=True)
             for tool in [tc.summarize_text, tc.rephrase_text, tc.critique_text]
         ]
 
@@ -685,7 +705,7 @@ class ToolsFactory:
         """
         Create a list of guardrail tools to avoid controversial topics.
         """
-        return [self.create_tool(get_bad_topics)]
+        return [self.create_tool(get_bad_topics, vhc_eligible=False)]
 
     def financial_tools(self):
         """
@@ -726,7 +746,8 @@ class ToolsFactory:
             )
 
         return [
-            self.create_tool(tool) for tool in [summarize_legal_text, critique_as_judge]
+            self.create_tool(tool, vhc_eligible=False)
+            for tool in [summarize_legal_text, critique_as_judge]
         ]
 
     def database_tools(
@@ -801,6 +822,7 @@ class ToolsFactory:
                 fn=tool.fn,
                 async_fn=tool.async_fn,
                 metadata=tool.metadata,
+                vhc_eligible=True,
             )
             vtools.append(vtool)
         return vtools

vectara_agentic/tools_catalog.py

@@ -1,11 +1,10 @@
 """
 This module contains the tools catalog for the Vectara Agentic.
 """
+
 from typing import List
 from datetime import date
 
-import requests
-
 from pydantic import Field
 
 from .types import LLMRole
@@ -13,16 +12,6 @@ from .agent_config import AgentConfig
 from .llm_utils import get_llm
 from .utils import remove_self_from_signature
 
-req_session = requests.Session()
-
-get_headers = {
-    "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:98.0) Gecko/20100101 Firefox/98.0",
-    "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8",
-    "Accept-Language": "en-US,en;q=0.5",
-    "Accept-Encoding": "gzip, deflate",
-    "Connection": "keep-alive",
-}
-
 def get_current_date() -> str:
     """
     Returns the current date as a string.
@@ -35,6 +24,7 @@ class ToolsCatalog:
     """
     A curated set of tools for vectara-agentic
     """
+
     def __init__(self, agent_config: AgentConfig):
         self.agent_config = agent_config
 
@@ -76,7 +66,9 @@ class ToolsCatalog:
     def rephrase_text(
         self,
         text: str = Field(description="the original text."),
-        instructions: str = Field(description="the specific instructions for how to rephrase the text."),
+        instructions: str = Field(
+            description="the specific instructions for how to rephrase the text."
+        ),
     ) -> str:
         """
         This is a helper tool.
@@ -103,8 +95,13 @@ class ToolsCatalog:
     def critique_text(
         self,
         text: str = Field(description="the original text."),
-        role: str = Field(default=None, description="the role of the person providing critique."),
-        point_of_view: str = Field(default=None, description="the point of view with which to provide critique."),
+        role: str = Field(
+            default=None, description="the role of the person providing critique."
+        ),
+        point_of_view: str = Field(
+            default=None,
+            description="the point of view with which to provide critique.",
+        ),
     ) -> str:
         """
         This is a helper tool.
@@ -121,13 +118,16 @@ class ToolsCatalog:
         if role:
             prompt = f"As a {role}, critique the provided text from the point of view of {point_of_view}."
         else:
-            prompt = f"Critique the provided text from the point of view of {point_of_view}."
+            prompt = (
+                f"Critique the provided text from the point of view of {point_of_view}."
+            )
         prompt += "\nStructure the critique as bullet points.\n"
         prompt += f"Original text: {text}\nCritique:"
         llm = get_llm(LLMRole.TOOL, config=self.agent_config)
         response = llm.complete(prompt)
         return response.text
 
+
 #
 # Guardrails tool: returns list of topics to avoid
 #