OpenAI's provider-defined tools (Effect's OpenAiTool).
Each constant is a tool's constructor: call it with the tool's arguments to put it in a toolkit. Tools OpenAI runs (code interpreter, file search, image generation, MCP, web search) need no handler; apply patch, shell and local shell run on your side, so they do::
kit = toolkit.make(tool.WebSearch(search_context_size="low"), tool.Shell())Arguments, parameters and results use OpenAI's snake_case JSON, with the
fields of the generated schemas (pyfect.ai.openai.generated).
Values#
| Attribute | Type | Description |
|---|---|---|
ApplyPatch | (...) -> ProviderDefined[Literal['OpenAiApplyPatch'], ApplyPatchParameters, ApplyPatchResult, Never, Never, Never] | |
CodeInterpreter | (...) -> ProviderDefined[Literal['OpenAiCodeInterpreter'], CodeInterpreterParameters, CodeInterpreterSuccess, CodeInterpreterFailure, CodeInterpreterFailure, Never] | |
FileSearch | (...) -> ProviderDefined[Literal['OpenAiFileSearch'], object, FileSearchSuccess, FileSearchFailure, FileSearchFailure, Never] | |
ImageGeneration | (...) -> ProviderDefined[Literal['OpenAiImageGeneration'], object, ImageGenerationSuccess, ImageGenerationFailure, ImageGenerationFailure, Never] | |
LocalShell | (...) -> ProviderDefined[Literal['OpenAiLocalShell'], LocalShellParameters, LocalShellResult, Never, Never, Never] | |
Mcp | (...) -> ProviderDefined[Literal['OpenAiMcp'], object, McpSuccess, McpFailure, McpFailure, Never] | |
Shell | (...) -> ProviderDefined[Literal['OpenAiShell'], ShellParameters, ShellResult, Never, Never, Never] | |
WebSearch | (...) -> ProviderDefined[Literal['OpenAiWebSearch'], WebSearchParameters, WebSearchSuccess, WebSearchFailure, WebSearchFailure, Never] | |
WebSearchPreview | (...) -> ProviderDefined[Literal['OpenAiWebSearchPreview'], object, WebSearchSuccess, WebSearchFailure, WebSearchFailure, Never] | |
NAMES | frozenset[str] | The custom names of OpenAI's provider-defined tools. |
Classes#
ApplyPatchParametersApplyPatchResultCodeInterpreterArgsCodeInterpreterParametersCodeInterpreterSuccessCodeInterpreterFailureFileSearchArgsFileSearchSuccessFileSearchFailureImageGenerationSuccessImageGenerationFailureLocalShellParametersLocalShellResultMcpSuccessMcpFailureShellParametersShellResultWebSearchParametersWebSearchSuccessWebSearchFailure