Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Tool.
Tool details that the model may use to generate response.
AToolis a piece of code that enables the system to interact with
external systems to perform an action, or set of actions, outside of
knowledge and scope of the model. A Tool object should contain exactly
one type of Tool (e.g FunctionDeclaration, Retrieval or
GoogleSearchRetrieval).
Generated from protobuf messagegoogle.cloud.aiplatform.v1.Tool
Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populatingFunctionCallin the response. User should provide aFunctionResponsefor each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided.
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.
Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.
getFunctionDeclarations
Optional. Function tool type.
One or more function declarations to be passed to the model along with the
current user query. Model may decide to call a subset of these functions
by populatingFunctionCallin the response. User should provide aFunctionResponsefor
each function call in the next turn. Based on the function responses, Model
will generate the final response back to the user. Maximum 128 function
declarations can be provided.
One or more function declarations to be passed to the model along with the
current user query. Model may decide to call a subset of these functions
by populatingFunctionCallin the response. User should provide aFunctionResponsefor
each function call in the next turn. Based on the function responses, Model
will generate the final response back to the user. Maximum 128 function
declarations can be provided.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Ai Platform V1 Client - Class Tool (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.Tool)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.Tool)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.Tool)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.Tool)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.Tool)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.Tool)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.Tool)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.Tool)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.Tool)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.Tool)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.Tool)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.Tool)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.Tool)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.Tool)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.Tool)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.Tool)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.Tool)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.Tool)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.Tool)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.Tool)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.Tool)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.Tool)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.Tool)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.Tool)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.Tool)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.Tool)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.Tool)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.Tool)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.Tool)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.Tool)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.Tool)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.Tool)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.Tool)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.Tool)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.Tool)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.Tool)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.Tool)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.Tool)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.Tool)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.Tool)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.Tool)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.Tool)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.Tool)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.Tool)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.Tool)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.Tool)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.Tool)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.Tool)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.Tool)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.Tool)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.Tool)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.Tool)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.Tool)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.Tool)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.Tool)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.Tool) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class Tool.\n\nTool details that the model may use to generate response.\n\nA `Tool` is a piece of code that enables the system to interact with\nexternal systems to perform an action, or set of actions, outside of\nknowledge and scope of the model. A Tool object should contain exactly\none type of Tool (e.g FunctionDeclaration, Retrieval or\nGoogleSearchRetrieval).\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.Tool`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AIPlatform \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getFunctionDeclarations\n\nOptional. Function tool type.\n\nOne or more function declarations to be passed to the model along with the\ncurrent user query. Model may decide to call a subset of these functions\nby populating [FunctionCall](/php/docs/reference/cloud-ai-platform/latest/V1.Part#_Google_Cloud_AIPlatform_V1_Part__getFunctionCall__)\nin the response. User should provide a\n[FunctionResponse](/php/docs/reference/cloud-ai-platform/latest/V1.Part#_Google_Cloud_AIPlatform_V1_Part__getFunctionResponse__) for\neach function call in the next turn. Based on the function responses, Model\nwill generate the final response back to the user. Maximum 128 function\ndeclarations can be provided.\n\n### setFunctionDeclarations\n\nOptional. Function tool type.\n\nOne or more function declarations to be passed to the model along with the\ncurrent user query. Model may decide to call a subset of these functions\nby populating [FunctionCall](/php/docs/reference/cloud-ai-platform/latest/V1.Part#_Google_Cloud_AIPlatform_V1_Part__getFunctionCall__)\nin the response. User should provide a\n[FunctionResponse](/php/docs/reference/cloud-ai-platform/latest/V1.Part#_Google_Cloud_AIPlatform_V1_Part__getFunctionResponse__) for\neach function call in the next turn. Based on the function responses, Model\nwill generate the final response back to the user. Maximum 128 function\ndeclarations can be provided.\n\n### getRetrieval\n\nOptional. Retrieval tool type.\n\nSystem will always execute the provided retrieval tool(s) to get external\nknowledge to answer the prompt. Retrieval results are presented to the\nmodel for generation.\n\n### hasRetrieval\n\n### clearRetrieval\n\n### setRetrieval\n\nOptional. Retrieval tool type.\n\nSystem will always execute the provided retrieval tool(s) to get external\nknowledge to answer the prompt. Retrieval results are presented to the\nmodel for generation.\n\n### getGoogleSearch\n\nOptional. GoogleSearch tool type.\n\nTool to support Google Search in Model. Powered by Google.\n\n### hasGoogleSearch\n\n### clearGoogleSearch\n\n### setGoogleSearch\n\nOptional. GoogleSearch tool type.\n\nTool to support Google Search in Model. Powered by Google.\n\n### getGoogleSearchRetrieval\n\nOptional. GoogleSearchRetrieval tool type.\n\nSpecialized retrieval tool that is powered by Google search.\n\n### hasGoogleSearchRetrieval\n\n### clearGoogleSearchRetrieval\n\n### setGoogleSearchRetrieval\n\nOptional. GoogleSearchRetrieval tool type.\n\nSpecialized retrieval tool that is powered by Google search.\n\n### getGoogleMaps\n\nOptional. GoogleMaps tool type.\n\nTool to support Google Maps in Model.\n\n### hasGoogleMaps\n\n### clearGoogleMaps\n\n### setGoogleMaps\n\nOptional. GoogleMaps tool type.\n\nTool to support Google Maps in Model.\n\n### getEnterpriseWebSearch\n\nOptional. Tool to support searching public web data, powered by Vertex AI\nSearch and Sec4 compliance.\n\n### hasEnterpriseWebSearch\n\n### clearEnterpriseWebSearch\n\n### setEnterpriseWebSearch\n\nOptional. Tool to support searching public web data, powered by Vertex AI\nSearch and Sec4 compliance.\n\n### getCodeExecution\n\nOptional. CodeExecution tool type.\n\nEnables the model to execute code as part of generation.\n\n### hasCodeExecution\n\n### clearCodeExecution\n\n### setCodeExecution\n\nOptional. CodeExecution tool type.\n\nEnables the model to execute code as part of generation.\n\n### getUrlContext\n\nOptional. Tool to support URL context retrieval.\n\n### hasUrlContext\n\n### clearUrlContext\n\n### setUrlContext\n\nOptional. Tool to support URL context retrieval.\n\n### getComputerUse\n\nOptional. Tool to support the model interacting directly with the computer.\n\nIf enabled, it automatically populates computer-use specific Function\nDeclarations.\n\n### hasComputerUse\n\n### clearComputerUse\n\n### setComputerUse\n\nOptional. Tool to support the model interacting directly with the computer.\n\nIf enabled, it automatically populates computer-use specific Function\nDeclarations."]]
