Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Tool

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/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) ⇒ GoogleCloudAiplatformV1beta1Tool

Returns a new instance of GoogleCloudAiplatformV1beta1Tool.



34200
34201
34202
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34200

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

Instance Attribute Details

#function_declarations ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FunctionDeclaration>

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:



34188
34189
34190
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34188

def function_declarations
  @function_declarations
end

#google_search_retrieval ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GoogleSearchRetrieval

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

Returns:



34193
34194
34195
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34193

def google_search_retrieval
  @google_search_retrieval
end

#retrieval ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Retrieval

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

Returns:



34198
34199
34200
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34198

def retrieval
  @retrieval
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



34205
34206
34207
34208
34209
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34205

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