Class: Google::Cloud::AIPlatform::V1::Tool

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/tool.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#function_declarations ⇒ ::Array<::Google::Cloud::AIPlatform::V1::FunctionDeclaration>

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



51
52
53
54
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 51

class Tool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#google_search_retrieval ⇒ ::Google::Cloud::AIPlatform::V1::GoogleSearchRetrieval

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

Returns:



51
52
53
54
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 51

class Tool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#retrieval ⇒ ::Google::Cloud::AIPlatform::V1::Retrieval

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



51
52
53
54
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 51

class Tool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end