mirror of
https://github.com/onyx-dot-app/onyx.git
synced 2026-10-22 19:32:55 -05:00
64 lines
1.6 KiB
Python
64 lines
1.6 KiB
Python
import abc
|
|
from collections.abc import Generator
|
|
from typing import Any
|
|
|
|
from danswer.dynamic_configs.interface import JSON_ro
|
|
from danswer.llm.answering.models import PreviousMessage
|
|
from danswer.llm.interfaces import LLM
|
|
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
|