unique_deep_research 3.2.1__py3-none-any.whl → 3.2.3__py3-none-any.whl

unique_deep_research/service.py

@@ -1,4 +1,5 @@
 import logging
+import traceback
 from typing import Any, Optional
 
 from httpx import AsyncClient
@@ -110,7 +111,14 @@ class DeepResearchTool(Tool[DeepResearchToolConfig]):
         self.company_id = event.company_id
         self.user_id = event.user_id
 
-        self.client = get_async_openai_client()
+        self.client = get_async_openai_client(
+            additional_headers={
+                "x-company-id": self.company_id,
+                "x-user-id": self.user_id,
+                "x-assistant-id": self.event.payload.assistant_id,
+                "x-chat-id": self.chat_id,
+            }
+        )
 
         _LOGGER.info(f"Using async OpenAI client pointed to {self.client.base_url}")
 
@@ -208,13 +216,25 @@ class DeepResearchTool(Tool[DeepResearchToolConfig]):
         try:
             return await self._run(tool_call)
         except Exception as e:
+            self.write_message_log_text_message(
+                "**Research failed for an unknown reason**"
+            )
             if self.is_message_execution():
                 await self._update_execution_status(MessageExecutionUpdateStatus.FAILED)
+
             _LOGGER.exception(f"Deep Research tool run failed: {e}")
+
+            debug_info = {
+                **self._get_tool_debug_info(),
+                "error": str(e),
+                "traceback": traceback.format_exc(),
+            }
             await self.chat_service.modify_assistant_message_async(
                 content="Deep Research failed to complete for an unknown reason",
                 set_completed_at=True,
+                debug_info=debug_info,
             )
+
         return ToolCallResponse(
             id=tool_call.id or "",
             name=self.name,
@@ -251,22 +271,8 @@ class DeepResearchTool(Tool[DeepResearchToolConfig]):
             )
             processed_result, content_chunks = await self.run_research(research_brief)
 
-            # Handle success/failure status updates centrally
-            if not processed_result:
-                await self._update_execution_status(MessageExecutionUpdateStatus.FAILED)
-                self.write_message_log_text_message(
-                    "**Research failed for an unknown reason**"
-                )
-                await self.chat_service.modify_assistant_message_async(
-                    content="Deep Research failed to complete for an unknown reason",
-                    set_completed_at=True,
-                )
-                return ToolCallResponse(
-                    id=tool_call.id or "",
-                    name=self.name,
-                    content=processed_result or "Failed to complete research",
-                    error_message="Research process failed or returned empty results",
-                )
+            if processed_result == "":
+                raise ValueError("Research returned empty result")
 
             await self.chat_service.modify_assistant_message_async(
                 set_completed_at=True,
@@ -287,7 +293,10 @@ class DeepResearchTool(Tool[DeepResearchToolConfig]):
         await self.chat_service.modify_assistant_message_async(
             set_completed_at=True,
         )
-        await self._update_tool_debug_info()
+        await self.chat_service.update_debug_info_async(
+            debug_info=self._get_tool_debug_info()
+        )
+
         # put message in short term memory to remember that we asked the followup questions
         await self.memory_service.save_async(
             MemorySchema(message_id=self.event.payload.assistant_message.id),
@@ -317,7 +326,7 @@ class DeepResearchTool(Tool[DeepResearchToolConfig]):
             percentage_completed=percentage,
         )
 
-    async def _update_tool_debug_info(self) -> None:
+    def _get_tool_debug_info(self) -> dict[str, Any]:
         """
         Update debug info for the tool execution.
         Note: Tool call logging should be handled by the orchestrator.
@@ -343,7 +352,7 @@ class DeepResearchTool(Tool[DeepResearchToolConfig]):
             "userMetadata": self.event.payload.user_metadata,
             "toolParameters": self.event.payload.tool_parameters,
         }
-        await self.chat_service.update_debug_info_async(debug_info=debug_info_event)
+        return debug_info_event
 
     def write_message_log_text_message(self, text: str):
         create_message_log_entry(
@@ -385,97 +394,87 @@ class DeepResearchTool(Tool[DeepResearchToolConfig]):
         Run the research using the configured strategy.
         Returns a tuple of (processed_result, content_chunks)
         """
-        try:
-            result = "", []
-            match self.config.engine.get_type():
-                case DeepResearchEngine.OPENAI:
-                    _LOGGER.info("Running OpenAI research")
-                    result = await self.openai_research(research_brief)
-                case DeepResearchEngine.UNIQUE:
-                    _LOGGER.info("Running Custom research")
-                    result = await self.custom_research(research_brief)
-            self.write_message_log_text_message("**Research done**")
-            return result
-        except Exception as e:
-            _LOGGER.exception(f"Research failed: {e}")
-            return "", []
+        result = "", []
+        match self.config.engine.get_type():
+            case DeepResearchEngine.OPENAI:
+                _LOGGER.info("Running OpenAI research")
+                result = await self.openai_research(research_brief)
+            case DeepResearchEngine.UNIQUE:
+                _LOGGER.info("Running Custom research")
+                result = await self.custom_research(research_brief)
+        self.write_message_log_text_message("**Research done**")
+        return result
 
     async def custom_research(self, research_brief: str) -> tuple[str, list[Any]]:
         """
         Run Custom research using LangGraph multi-agent orchestration.
         Returns a tuple of (processed_result, content_chunks)
         """
-        try:
-            # Create citation manager for this research session
-            citation_manager = GlobalCitationManager()
-
-            # Initialize LangGraph state with required services
-            initial_state = {
-                "messages": [HumanMessage(content=research_brief)],
-                "research_brief": research_brief,
-                "notes": [],
-                "final_report": "",
+        # Create citation manager for this research session
+        citation_manager = GlobalCitationManager()
+
+        # Initialize LangGraph state with required services
+        initial_state = {
+            "messages": [HumanMessage(content=research_brief)],
+            "research_brief": research_brief,
+            "notes": [],
+            "final_report": "",
+            "chat_service": self.chat_service,
+            "message_id": self.event.payload.assistant_message.id,
+        }
+
+        # Prepare configuration for LangGraph
+        additional_openai_proxy_headers = {
+            "x-company-id": self.company_id,
+            "x-user-id": self.user_id,
+            "x-assistant-id": self.event.payload.assistant_id,
+            "x-chat-id": self.chat_id,
+        }
+        # Extract tool enablement settings from engine config if it's a UniqueEngine
+        enable_web_tools = True
+        enable_internal_tools = True
+        if isinstance(self.config.engine, UniqueEngine):
+            enable_web_tools = self.config.engine.tools.web_tools
+            enable_internal_tools = self.config.engine.tools.internal_tools
+
+        config = {
+            "configurable": {
+                "engine_config": self.config.engine,
+                "language_model_service": self.language_model_service,
+                "openai_client": self.client,
                 "chat_service": self.chat_service,
+                "content_service": self.content_service,
                 "message_id": self.event.payload.assistant_message.id,
-            }
-
-            # Prepare configuration for LangGraph
-            additional_openai_proxy_headers = {
-                "x-company-id": self.company_id,
-                "x-user-id": self.user_id,
-                "x-assistant-id": self.event.payload.assistant_id,
-                "x-chat-id": self.chat_id,
-            }
-            # Extract tool enablement settings from engine config if it's a UniqueEngine
-            enable_web_tools = True
-            enable_internal_tools = True
-            if isinstance(self.config.engine, UniqueEngine):
-                enable_web_tools = self.config.engine.tools.web_tools
-                enable_internal_tools = self.config.engine.tools.internal_tools
-
-            config = {
-                "configurable": {
-                    "engine_config": self.config.engine,
-                    "language_model_service": self.language_model_service,
-                    "openai_client": self.client,
-                    "chat_service": self.chat_service,
-                    "content_service": self.content_service,
-                    "message_id": self.event.payload.assistant_message.id,
-                    "citation_manager": citation_manager,
-                    "additional_openai_proxy_headers": additional_openai_proxy_headers,
-                    "enable_web_tools": enable_web_tools,
-                    "enable_internal_tools": enable_internal_tools,
-                },
-            }
-
-            result = await custom_agent.ainvoke(initial_state, config=config)  # type: ignore[arg-type]
+                "citation_manager": citation_manager,
+                "additional_openai_proxy_headers": additional_openai_proxy_headers,
+                "enable_web_tools": enable_web_tools,
+                "enable_internal_tools": enable_internal_tools,
+            },
+        }
 
-            # Extract final report (citations already refined by agents.py)
-            research_result = result.get("final_report", "")
+        result = await custom_agent.ainvoke(initial_state, config=config)  # type: ignore[arg-type]
 
-            if not research_result:
-                return "", []
+        # Extract final report (citations already refined by agents.py)
+        research_result = result.get("final_report", "")
 
-            # Validate and map citations using the citation registry
-            citation_registry = citation_manager.get_all_citations()
-            processed_result, references = validate_and_map_citations(
-                research_result, citation_registry
-            )
+        if not research_result:
+            return "", []
 
-            # Update the assistant message with the results
-            await self.chat_service.modify_assistant_message_async(
-                content=processed_result,
-                references=references,
-            )
-            _LOGGER.info(
-                f"Custom research completed with {len(references)} validated citations"
-            )
-            return processed_result, []
+        # Validate and map citations using the citation registry
+        citation_registry = citation_manager.get_all_citations()
+        processed_result, references = validate_and_map_citations(
+            research_result, citation_registry
+        )
 
-        except Exception as e:
-            error_msg = f"Custom research failed: {str(e)}"
-            _LOGGER.exception(error_msg)
-            return error_msg, []
+        # Update the assistant message with the results
+        await self.chat_service.modify_assistant_message_async(
+            content=processed_result,
+            references=references,
+        )
+        _LOGGER.info(
+            f"Custom research completed with {len(references)} validated citations"
+        )
+        return processed_result, []
 
     async def openai_research(self, research_brief: str) -> tuple[str, list[Any]]:
         """

unique_deep_research/unique_custom/utils.py

@@ -570,6 +570,7 @@ async def ainvoke_with_token_handling(
         try:
             return await model.ainvoke(prepared_messages)
         except Exception as e:
+            _LOGGER.exception(f"Error invoking model: {e}")
             # Handle token errors by truncating history and retrying
             if is_token_error(e):
                 # Filtering is not perfect, so in unlikely case we need to truncate the message history to the last AI message

{unique_deep_research-3.2.1.dist-info → unique_deep_research-3.2.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_deep_research
-Version: 3.2.1
+Version: 3.2.3
 Summary: Deep Research Tool for complex research tasks
 License: Proprietary
 Author: Martin Fadler
@@ -36,6 +36,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.2.3] - 2026-02-05
+- Improve error handling and logging
+
+## [3.2.2] - 2026-02-05
+- Fix bug where deep research tool was not using the correct headers causing an authentication error
+
 ## [3.2.1] - 2026-02-05
 - Use deep research logger instead of tool logger
 

{unique_deep_research-3.2.1.dist-info → unique_deep_research-3.2.3.dist-info}/RECORD

@@ -1,7 +1,7 @@
 unique_deep_research/__init__.py,sha256=HMksc03A7au88XB0jjeIR3zGt3YGYTA7ZIAkR8hmQZs,396
 unique_deep_research/config.py,sha256=1DV3CBxNTDTDoxsxeMLI8ARDR3-iRlhL4yhXAKmxeI4,4137
 unique_deep_research/markdown_utils.py,sha256=zyKO4c9T_KnZzOYlYZEDEvC1NHRR9koCzcWmOJbrcok,11024
-unique_deep_research/service.py,sha256=Vim3t3TOag27FgNl5gmkKn5ahZhUzf7hIBr8QjRjW_4,36281
+unique_deep_research/service.py,sha256=yLQ6lyg27fjN04z4H--g_rdetaeq_lnofAypvfNSrxk,35605
 unique_deep_research/templates/clarifying_agent.j2,sha256=TOgD5ezrlRyurpquBGT902oa7PpkdHxsvrkIFWBFa2A,3938
 unique_deep_research/templates/openai/oai_research_system_message.j2,sha256=2YipVh0V4eEikg9iXqIaBVtYwS8ycHMDu3xiFDoJ0vI,1362
 unique_deep_research/templates/report_cleanup_prompt.j2,sha256=9mjj3GX1HEQ0kkxzqvB3D_2wFgAJ-drMbTYDiSc2riI,2049
@@ -15,8 +15,8 @@ unique_deep_research/unique_custom/agents.py,sha256=zMJ8zCz-0714bMPZTzIlMqG79AdZ
 unique_deep_research/unique_custom/citation.py,sha256=dfElOqBTvbXlHXxshT6heNzeHVVKTlgSlIEFTuoNv20,4315
 unique_deep_research/unique_custom/state.py,sha256=tn4pIKN-ZCH6Tqu9XL31lziyrwFkhTVf_lBiUpETVyo,3515
 unique_deep_research/unique_custom/tools.py,sha256=vlR0cooDrXzKUNofPxXX1dcfnhoYoSBcFUylsiGyPqo,25431
-unique_deep_research/unique_custom/utils.py,sha256=ZOKABCVKODawfsig-72CcpXCMveg7K_y_rzwlkaJVz8,20069
-unique_deep_research-3.2.1.dist-info/LICENSE,sha256=GlN8wHNdh53xwOPg44URnwag6TEolCjoq3YD_KrWgss,193
-unique_deep_research-3.2.1.dist-info/METADATA,sha256=CvPq7OXNGaxCOcMJZLIKOwvYkZvn6cZlNuzjYdWyqlA,7308
-unique_deep_research-3.2.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-unique_deep_research-3.2.1.dist-info/RECORD,,
+unique_deep_research/unique_custom/utils.py,sha256=NvPCxDNH8P7y9s5fqgxpt-xPksU1s4Nkeukq3GDNjb8,20129
+unique_deep_research-3.2.3.dist-info/LICENSE,sha256=GlN8wHNdh53xwOPg44URnwag6TEolCjoq3YD_KrWgss,193
+unique_deep_research-3.2.3.dist-info/METADATA,sha256=ZvQRb_zf9bmwdTCRAPc_t8xEG8K017OJKE2xTiuFCf8,7496
+unique_deep_research-3.2.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+unique_deep_research-3.2.3.dist-info/RECORD,,