Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::Tool (v0.44.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::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).

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#function_declarations

def function_declarations() -> ::Array<::Google::Cloud::AIPlatform::V1::FunctionDeclaration>
Returns
  • (::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][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 64 function declarations can be provided.

#function_declarations=

def function_declarations=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::FunctionDeclaration>
Parameter
  • value (::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][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 64 function declarations can be provided.
Returns
  • (::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][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 64 function declarations can be provided.

#google_search_retrieval

def google_search_retrieval() -> ::Google::Cloud::AIPlatform::V1::GoogleSearchRetrieval
Returns

#google_search_retrieval=

def google_search_retrieval=(value) -> ::Google::Cloud::AIPlatform::V1::GoogleSearchRetrieval
Parameter
Returns

#retrieval

def retrieval() -> ::Google::Cloud::AIPlatform::V1::Retrieval
Returns
  • (::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.

#retrieval=

def retrieval=(value) -> ::Google::Cloud::AIPlatform::V1::Retrieval
Parameter
  • value (::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.
Returns
  • (::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.