Tool details of a tool that the model may use to generate a response.

Properties

codeExecution?: ToolCodeExecution

Optional. CodeExecution tool type. Enables the model to execute code as part of generation.

computerUse?: ToolComputerUse

Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.

enterpriseWebSearch?: EnterpriseWebSearch

Optional. Enterprise web search tool type. Specialized retrieval tool that is powered by Vertex AI Search and Sec4 compliance.

functionDeclarations?: FunctionDeclaration[]

List of function declarations that the tool supports.

googleMaps?: GoogleMaps

Optional. Google Maps tool type. Specialized retrieval tool that is powered by Google Maps.

googleSearch?: GoogleSearch

Optional. Google Search tool type. Specialized retrieval tool that is powered by Google Search.

googleSearchRetrieval?: GoogleSearchRetrieval

Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.

retrieval?: Retrieval

Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.

urlContext?: UrlContext

Optional. Tool to support URL context retrieval.