Camel.toolkits.openai agent toolkit

​

OpenAIAgentToolkit

class OpenAIAgentToolkit(BaseToolkit):

Toolkit for accessing OpenAI’s agent tools including web search and file search.

Provides access to OpenAI’s web search and file search capabilities through the Responses API, allowing agents to retrieve information from the web and search through uploaded files.

​

init

def __init__(
    self,
    model: Optional[BaseModelBackend] = None,
    api_key: Optional[str] = None,
    timeout: Optional[float] = None
):

Initialize the OpenAI agent toolkit.

Parameters:

• model (BaseModelBackend): The OpenAI model to use for responses. If None, defaults to gpt-4o-mini. (default: :obj:None)
• api_key (str): OpenAI API key. If not provided, will attempt to use OPENAI_API_KEY environment variable. (default: :obj:None)
• timeout (Optional[float]): The timeout value for API requests in seconds. If None, no timeout is applied. (default: :obj:None)

​

web_search

def web_search(self, query: str):

Perform a web search using OpenAI’s web search tool.

Parameters:

• query (str): The search query.

Returns:

str: The search result or error message.

​

file_search

def file_search(self, query: str, vector_store_id: str):

Search through files using OpenAI’s file search tool.

Parameters:

• query (str): The search query.
• vector_store_id (str): The vector store ID to search in.

Returns:

str: The search result or error message.

​

get_tools

def get_tools(self):

Returns:

List[FunctionTool]: Collection of FunctionTool objects representing the available search functions in this toolkit.