Class Tool (1.81.0)

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][content.part.function_call] in the response. User should provide a FunctionResponse][content.part.function_response] 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_retrieval google.cloud.aiplatform_v1.types.GoogleSearchRetrieval
Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
code_execution google.cloud.aiplatform_v1.types.Tool.CodeExecution
Optional. CodeExecution tool type. Enables the model to execute code as part of generation. This field is only used by the Gemini Developer API services.

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.

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).