- 1.35.0 (latest)
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
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.
A Tool
is 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 message google.cloud.aiplatform.v1.Tool
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ function_declarations
array< FunctionDeclaration
>
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 populating FunctionCall in the response. User should provide a FunctionResponse for 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.
↳ 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.
↳ google_search
Tool\GoogleSearch
Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
↳ google_search_retrieval
GoogleSearchRetrieval
Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
↳ google_maps
↳ enterprise_web_search
EnterpriseWebSearch
Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
↳ code_execution
Tool\CodeExecution
Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
↳ url_context
↳ computer_use
Tool\ComputerUse
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 populating FunctionCall in the response. User should provide a FunctionResponse for 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.
setFunctionDeclarations
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 populating FunctionCall in the response. User should provide a FunctionResponse for 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.
$this
getRetrieval
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.
hasRetrieval
clearRetrieval
setRetrieval
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
getGoogleSearch
Optional. GoogleSearch tool type.
Tool to support Google Search in Model. Powered by Google.
hasGoogleSearch
clearGoogleSearch
setGoogleSearch
Optional. GoogleSearch tool type.
Tool to support Google Search in Model. Powered by Google.
$this
getGoogleSearchRetrieval
Optional. GoogleSearchRetrieval tool type.
Specialized retrieval tool that is powered by Google search.
hasGoogleSearchRetrieval
clearGoogleSearchRetrieval
setGoogleSearchRetrieval
Optional. GoogleSearchRetrieval tool type.
Specialized retrieval tool that is powered by Google search.
$this
getGoogleMaps
Optional. GoogleMaps tool type.
Tool to support Google Maps in Model.
hasGoogleMaps
clearGoogleMaps
setGoogleMaps
Optional. GoogleMaps tool type.
Tool to support Google Maps in Model.
$this
getEnterpriseWebSearch
Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
hasEnterpriseWebSearch
clearEnterpriseWebSearch
setEnterpriseWebSearch
Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
$this
getCodeExecution
Optional. CodeExecution tool type.
Enables the model to execute code as part of generation.
hasCodeExecution
clearCodeExecution
setCodeExecution
Optional. CodeExecution tool type.
Enables the model to execute code as part of generation.
$this
getUrlContext
Optional. Tool to support URL context retrieval.
hasUrlContext
clearUrlContext
setUrlContext
Optional. Tool to support URL context retrieval.
$this
getComputerUse
Optional. Tool to support the model interacting directly with the computer.
If enabled, it automatically populates computer-use specific Function Declarations.
hasComputerUse
clearComputerUse
setComputerUse
Optional. Tool to support the model interacting directly with the computer.
If enabled, it automatically populates computer-use specific Function Declarations.
$this
