OpenAITools

Namespace: Vercel.AI.OpenAI

public static class OpenAITools

Factories for the OpenAI provider-defined tools, the port of upstream openaiTools. Each builds the LanguageModelTool that OpenAI Responses maps to a hosted tool.

Inheritance: object

View source

Methods

ApplyPatch()

public static LanguageModelTool ApplyPatch()

The apply patch tool (openai.apply_patch).

Returns: LanguageModelTool

View source

CodeInterpreter(OpenAICodeInterpreterToolOptions?)

public static LanguageModelTool CodeInterpreter(OpenAICodeInterpreterToolOptions? options = null)

The code interpreter tool (openai.code_interpreter).

Parameters

Name	Type	Description
options	OpenAICodeInterpreterToolOptions

Returns: LanguageModelTool

View source

Computer()

public static LanguageModelTool Computer()

The computer tool (openai.computer).

Returns: LanguageModelTool

View source

CustomTool(OpenAICustomToolOptions)

public static LanguageModelTool CustomTool(OpenAICustomToolOptions options)

A custom tool (openai.custom) with the name given in <code class=“paramref”>options</code>.

Parameters

Name	Type	Description
options	OpenAICustomToolOptions

Returns: LanguageModelTool

View source

FileSearch(OpenAIFileSearchToolOptions)

public static LanguageModelTool FileSearch(OpenAIFileSearchToolOptions options)

The file search tool (openai.file_search).

Parameters

Name	Type	Description
options	OpenAIFileSearchToolOptions

Returns: LanguageModelTool

View source

ImageGeneration(OpenAIImageGenerationToolOptions?)

public static LanguageModelTool ImageGeneration(OpenAIImageGenerationToolOptions? options = null)

The image generation tool (openai.image_generation).

Parameters

Name	Type	Description
options	OpenAIImageGenerationToolOptions

Returns: LanguageModelTool

View source

LocalShell()

public static LanguageModelTool LocalShell()

The local shell tool (openai.local_shell).

Returns: LanguageModelTool

View source

Mcp(OpenAIMcpToolOptions)

public static LanguageModelTool Mcp(OpenAIMcpToolOptions options)

The MCP tool (openai.mcp).

Parameters

Name	Type	Description
options	OpenAIMcpToolOptions

Returns: LanguageModelTool

View source

ProgrammaticToolCalling()

public static LanguageModelTool ProgrammaticToolCalling()

The programmatic tool calling tool (openai.programmatic_tool_calling).

Returns: LanguageModelTool

View source

Shell(OpenAIShellToolOptions?)

public static LanguageModelTool Shell(OpenAIShellToolOptions? options = null)

The shell tool (openai.shell).

Parameters

Name	Type	Description
options	OpenAIShellToolOptions

Returns: LanguageModelTool

View source

ToolSearch(OpenAIToolSearchToolOptions?)

public static LanguageModelTool ToolSearch(OpenAIToolSearchToolOptions? options = null)

The tool search tool (openai.tool_search).

Parameters

Name	Type	Description
options	OpenAIToolSearchToolOptions

Returns: LanguageModelTool

View source

WebSearch(OpenAIWebSearchToolOptions?)

public static LanguageModelTool WebSearch(OpenAIWebSearchToolOptions? options = null)

The web search tool (openai.web_search).

Parameters

Name	Type	Description
options	OpenAIWebSearchToolOptions

Returns: LanguageModelTool

View source

WebSearchPreview(OpenAIWebSearchPreviewToolOptions?)

public static LanguageModelTool WebSearchPreview(OpenAIWebSearchPreviewToolOptions? options = null)

The web search preview tool (openai.web_search_preview).

Parameters

Name	Type	Description
options	OpenAIWebSearchPreviewToolOptions

Returns: LanguageModelTool

View source