Interface Tool
- All Known Implementing Classes:
Tool.CodeExecution,Tool.ComputerUse,Tool.FileSearch,Tool.Function,Tool.GoogleSearch,Tool.McpServer,Tool.UrlContext
public sealed interface Tool
permits Tool.Function, Tool.GoogleSearch, Tool.CodeExecution, Tool.UrlContext, Tool.ComputerUse, Tool.McpServer, Tool.FileSearch
Represents a tool definition that the model can use.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final recordAllowed tools configuration.static final recordTool definition for Code Execution.static final recordTool definition for Computer Use.static final recordTool definition for File Search.static final recordTool definition for a function.static final recordTool definition for Google Search.static final recordTool definition for an MCP Server.static enumTool choice mode.static final recordConfiguration for tool choice.static final recordTool definition for URL Context. -
Method Summary
-
Method Details
-
type
String type()Returns the type of the tool.- Returns:
- The tool type.
-