Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ToolUseExample

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

A single example of the tool usage.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1ToolUseExample

Returns a new instance of GoogleCloudAiplatformV1beta1ToolUseExample.



34305
34306
34307
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34305

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

Instance Attribute Details

#display_nameString

Required. The display name for example. Corresponds to the JSON property displayName

Returns:

  • (String)


34273
34274
34275
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34273

def display_name
  @display_name
end

#extension_operationGoogle::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ToolUseExampleExtensionOperation

Identifies one operation of the extension. Corresponds to the JSON property extensionOperation



34278
34279
34280
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34278

def extension_operation
  @extension_operation
end

#function_nameString

Function name to call. Corresponds to the JSON property functionName

Returns:

  • (String)


34283
34284
34285
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34283

def function_name
  @function_name
end

#queryString

Required. Query that should be routed to this tool. Corresponds to the JSON property query

Returns:

  • (String)


34288
34289
34290
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34288

def query
  @query
end

#request_paramsHash<String,Object>

Request parameters used for executing this tool. Corresponds to the JSON property requestParams

Returns:

  • (Hash<String,Object>)


34293
34294
34295
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34293

def request_params
  @request_params
end

#response_paramsHash<String,Object>

Response parameters generated by this tool. Corresponds to the JSON property responseParams

Returns:

  • (Hash<String,Object>)


34298
34299
34300
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34298

def response_params
  @response_params
end

#response_summaryString

Summary of the tool response to the user query. Corresponds to the JSON property responseSummary

Returns:

  • (String)


34303
34304
34305
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34303

def response_summary
  @response_summary
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



34310
34311
34312
34313
34314
34315
34316
34317
34318
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34310

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @extension_operation = args[:extension_operation] if args.key?(:extension_operation)
  @function_name = args[:function_name] if args.key?(:function_name)
  @query = args[:query] if args.key?(:query)
  @request_params = args[:request_params] if args.key?(:request_params)
  @response_params = args[:response_params] if args.key?(:response_params)
  @response_summary = args[:response_summary] if args.key?(:response_summary)
end