from abc import abstractmethod from dataclasses import dataclass, field from typing import Any, Literal from livekit.agents import ProviderTool from openai.types import responses class OpenAITool(ProviderTool): """Base class for OpenAI server-side provider tools.""" @abstractmethod def to_dict(self) -> dict[str, Any]: ... @dataclass class WebSearch(OpenAITool): """Enable web search tool to access up-to-date information from the internet""" filters: responses.web_search_tool.Filters | None = None search_context_size: Literal["low", "medium", "high"] | None = "medium" user_location: responses.web_search_tool.UserLocation | None = None def __post_init__(self) -> None: super().__init__(id="openai_web_search") def to_dict(self) -> dict[str, Any]: result: dict[str, Any] = { "type": "web_search", "search_context_size": self.search_context_size, } if self.user_location is not None: result["user_location"] = self.user_location if self.filters is not None: result["filters"] = self.filters return result @dataclass class FileSearch(OpenAITool): """Enable file search tool to search uploaded document collections""" vector_store_ids: list[str] = field(default_factory=list) filters: responses.file_search_tool.Filters | None = None max_num_results: int | None = None ranking_options: responses.file_search_tool.RankingOptions | None = None def __post_init__(self) -> None: super().__init__(id="openai_file_search") def to_dict(self) -> dict[str, Any]: result: dict[str, Any] = { "type": "file_search", "vector_store_ids": self.vector_store_ids, } if self.filters is not None: result["filters"] = self.filters if self.max_num_results is not None: result["max_num_results"] = self.max_num_results if self.ranking_options is not None: result["ranking_options"] = self.ranking_options return result @dataclass class CodeInterpreter(OpenAITool): """Enable the code interpreter tool to write and execute Python code in a sandboxed environment""" container: str | dict[str, Any] | None = None def __post_init__(self) -> None: super().__init__(id="openai_code_interpreter") def to_dict(self) -> dict[str, Any]: result = {"type": "code_interpreter", "container": self.container} return result