mirror of
https://github.com/onyx-dot-app/onyx.git
synced 2026-10-23 03:42:59 -05:00
Chris Weaverandpablodanswer
ecf4923a3a
* Fix Fix Refactor more more fix refactor Fix circular imports Refactor Move tests around * Add quote support * Testing * More testing * Fix image generation slowness * Remove unused exception * Fix UT * fix stop generating * minor typo * minor logging updates for clarity --------- Co-authored-by: pablodanswer <pablo@danswer.ai>
83 lines
2.3 KiB
Python
83 lines
2.3 KiB
Python
import abc
|
|
from collections.abc import Generator
|
|
from typing import Any
|
|
from typing import TYPE_CHECKING
|
|
|
|
from danswer.key_value_store.interface import JSON_ro
|
|
from danswer.llm.answering.models import PreviousMessage
|
|
from danswer.llm.interfaces import LLM
|
|
|
|
|
|
if TYPE_CHECKING:
|
|
from danswer.llm.answering.prompts.build import AnswerPromptBuilder
|
|
from danswer.tools.message import ToolCallSummary
|
|
from danswer.tools.models import ToolResponse
|
|
|
|
|
|
class Tool(abc.ABC):
|
|
@property
|
|
@abc.abstractmethod
|
|
def name(self) -> str:
|
|
raise NotImplementedError
|
|
|
|
@property
|
|
@abc.abstractmethod
|
|
def description(self) -> str:
|
|
raise NotImplementedError
|
|
|
|
@property
|
|
@abc.abstractmethod
|
|
def display_name(self) -> str:
|
|
raise NotImplementedError
|
|
|
|
"""For LLMs which support explicit tool calling"""
|
|
|
|
@abc.abstractmethod
|
|
def tool_definition(self) -> dict:
|
|
raise NotImplementedError
|
|
|
|
@abc.abstractmethod
|
|
def build_tool_message_content(
|
|
self, *args: "ToolResponse"
|
|
) -> str | list[str | dict[str, Any]]:
|
|
raise NotImplementedError
|
|
|
|
"""For LLMs which do NOT support explicit tool calling"""
|
|
|
|
@abc.abstractmethod
|
|
def get_args_for_non_tool_calling_llm(
|
|
self,
|
|
query: str,
|
|
history: list[PreviousMessage],
|
|
llm: LLM,
|
|
force_run: bool = False,
|
|
) -> dict[str, Any] | None:
|
|
raise NotImplementedError
|
|
|
|
"""Actual execution of the tool"""
|
|
|
|
@abc.abstractmethod
|
|
def run(self, **kwargs: Any) -> Generator["ToolResponse", None, None]:
|
|
raise NotImplementedError
|
|
|
|
@abc.abstractmethod
|
|
def final_result(self, *args: "ToolResponse") -> JSON_ro:
|
|
"""
|
|
This is the "final summary" result of the tool.
|
|
It is the result that will be stored in the database.
|
|
"""
|
|
raise NotImplementedError
|
|
|
|
"""Some tools may want to modify the prompt based on the tool call summary and tool responses.
|
|
Default behavior is to continue with just the raw tool call request/result passed to the LLM."""
|
|
|
|
@abc.abstractmethod
|
|
def build_next_prompt(
|
|
self,
|
|
prompt_builder: "AnswerPromptBuilder",
|
|
tool_call_summary: "ToolCallSummary",
|
|
tool_responses: list["ToolResponse"],
|
|
using_tool_calling_llm: bool,
|
|
) -> "AnswerPromptBuilder":
|
|
raise NotImplementedError
|