Google Cloud Ai Platform V1 Client - Class Tool (1.2.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 \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ function_declarations array<Google\Cloud\AIPlatform\V1\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 64 function declarations can be provided.
↳ retrieval Google\Cloud\AIPlatform\V1\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\GoogleSearchRetrieval

Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.

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 64 function declarations can be provided.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

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 64 function declarations can be provided.

Parameter
Name Description
var array<Google\Cloud\AIPlatform\V1\FunctionDeclaration>
Returns
Type Description
$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.

Returns
Type Description
Google\Cloud\AIPlatform\V1\Retrieval|null

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.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\Retrieval
Returns
Type Description
$this

getGoogleSearchRetrieval

Optional. GoogleSearchRetrieval tool type.

Specialized retrieval tool that is powered by Google search.

Returns
Type Description
Google\Cloud\AIPlatform\V1\GoogleSearchRetrieval|null

hasGoogleSearchRetrieval

clearGoogleSearchRetrieval

setGoogleSearchRetrieval

Optional. GoogleSearchRetrieval tool type.

Specialized retrieval tool that is powered by Google search.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\GoogleSearchRetrieval
Returns
Type Description
$this