Class: Google::Apis::FirebasemlV2beta::Tool

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firebaseml_v2beta/classes.rb,
lib/google/apis/firebaseml_v2beta/representations.rb,
lib/google/apis/firebaseml_v2beta/representations.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 Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Tool

Returns a new instance of Tool.



1147
1148
1149
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1147

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#function_declarations ⇒ Array<Google::Apis::FirebasemlV2beta::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. Corresponds to the JSON property functionDeclarations

Returns:



1135
1136
1137
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1135

def function_declarations
  @function_declarations
end

#google_search_retrieval ⇒ Google::Apis::FirebasemlV2beta::GoogleSearchRetrieval

Tool to retrieve public web data for grounding, powered by Google. Corresponds to the JSON property googleSearchRetrieval

Returns:



1140
1141
1142
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1140

def google_search_retrieval
  @google_search_retrieval
end

#retrieval ⇒ Google::Apis::FirebasemlV2beta::Retrieval

Defines a retrieval tool that model can call to access external knowledge. Corresponds to the JSON property retrieval

Returns:



1145
1146
1147
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1145

def retrieval
  @retrieval
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1152
1153
1154
1155
1156
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1152

def update!(**args)
  @function_declarations = args[:function_declarations] if args.key?(:function_declarations)
  @google_search_retrieval = args[:google_search_retrieval] if args.key?(:google_search_retrieval)
  @retrieval = args[:retrieval] if args.key?(:retrieval)
end