Interface Tool

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

interface Tool {
    codeExecution?: ToolCodeExecution;
    computerUse?: ComputerUse;
    enterpriseWebSearch?: EnterpriseWebSearch;
    fileSearch?: FileSearch;
    functionDeclarations?: FunctionDeclaration[];
    googleMaps?: GoogleMaps;
    googleSearch?: GoogleSearch;
    googleSearchRetrieval?: GoogleSearchRetrieval;
    retrieval?: Retrieval;
    urlContext?: UrlContext;
}

Properties

codeExecution? computerUse? enterpriseWebSearch? fileSearch? functionDeclarations? googleMaps? googleSearch? googleSearchRetrieval? retrieval? urlContext?

Properties

OptionalcodeExecution

codeExecution?: ToolCodeExecution

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

OptionalcomputerUse

computerUse?: ComputerUse

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

OptionalenterpriseWebSearch

enterpriseWebSearch?: EnterpriseWebSearch

Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. This field is not supported in Gemini API.

OptionalfileSearch

fileSearch?: FileSearch

Optional. Tool to retrieve knowledge from the File Search Stores.

OptionalfunctionDeclarations

functionDeclarations?: FunctionDeclaration[]

List of function declarations that the tool supports.

OptionalgoogleMaps

googleMaps?: GoogleMaps

Optional. GoogleMaps tool type. Tool to support Google Maps in Model.

OptionalgoogleSearch

googleSearch?: GoogleSearch

Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.

OptionalgoogleSearchRetrieval

googleSearchRetrieval?: GoogleSearchRetrieval

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

Optionalretrieval

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. This field is not supported in Gemini API.

OptionalurlContext

urlContext?: UrlContext

Optional. Tool to support URL context retrieval.

Settings

On This Page

Properties