- 1.100.0 (latest)
- 1.99.0
- 1.98.0
- 1.97.0
- 1.96.0
- 1.95.1
- 1.94.0
- 1.93.1
- 1.92.0
- 1.91.0
- 1.90.0
- 1.89.0
- 1.88.0
- 1.87.0
- 1.86.0
- 1.85.0
- 1.84.0
- 1.83.0
- 1.82.0
- 1.81.0
- 1.80.0
- 1.79.0
- 1.78.0
- 1.77.0
- 1.76.0
- 1.75.0
- 1.74.0
- 1.73.0
- 1.72.0
- 1.71.1
- 1.70.0
- 1.69.0
- 1.68.0
- 1.67.1
- 1.66.0
- 1.65.0
- 1.63.0
- 1.62.0
- 1.60.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.1
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.39.0
- 1.38.1
- 1.37.0
- 1.36.4
- 1.35.0
- 1.34.0
- 1.33.1
- 1.32.0
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.1
- 1.27.1
- 1.26.1
- 1.25.0
- 1.24.1
- 1.23.0
- 1.22.1
- 1.21.0
- 1.20.0
- 1.19.1
- 1.18.3
- 1.17.1
- 1.16.1
- 1.15.1
- 1.14.0
- 1.13.1
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.1
- 1.7.1
- 1.6.2
- 1.5.0
- 1.4.3
- 1.3.0
- 1.2.0
- 1.1.1
- 1.0.1
- 0.9.0
- 0.8.0
- 0.7.1
- 0.6.0
- 0.5.1
- 0.4.0
- 0.3.1
Tool(mapping=None, *, ignore_unknown_fields=False, **kwargs)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).
Attributes |
|
|---|---|
| Name | Description |
function_declarations |
MutableSequence[google.cloud.aiplatform_v1.types.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 |
google.cloud.aiplatform_v1.types.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 |
google.cloud.aiplatform_v1.types.Tool.GoogleSearch
Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. |
google_search_retrieval |
google.cloud.aiplatform_v1.types.GoogleSearchRetrieval
Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. |
enterprise_web_search |
google.cloud.aiplatform_v1.types.EnterpriseWebSearch
Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. |
code_execution |
google.cloud.aiplatform_v1.types.Tool.CodeExecution
Optional. CodeExecution tool type. Enables the model to execute code as part of generation. |
url_context |
google.cloud.aiplatform_v1.types.UrlContext
Optional. Tool to support URL context retrieval. |
Classes
CodeExecution
CodeExecution(mapping=None, *, ignore_unknown_fields=False, **kwargs)Tool that executes code generated by the model, and automatically returns the result to the model.
See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool.
GoogleSearch
GoogleSearch(mapping=None, *, ignore_unknown_fields=False, **kwargs)GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
Methods
Tool
Tool(mapping=None, *, ignore_unknown_fields=False, **kwargs)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).