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.



34925
34926
34927
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34925

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)


34893
34894
34895
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34893

def display_name
  @display_name
end

#extension_operationGoogle::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ToolUseExampleExtensionOperation

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



34898
34899
34900
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34898

def extension_operation
  @extension_operation
end

#function_nameString

Function name to call. Corresponds to the JSON property functionName

Returns:

  • (String)


34903
34904
34905
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34903

def function_name
  @function_name
end

#queryString

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

Returns:

  • (String)


34908
34909
34910
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34908

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


34913
34914
34915
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34913

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


34918
34919
34920
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34918

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)


34923
34924
34925
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34923

def response_summary
  @response_summary
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



34930
34931
34932
34933
34934
34935
34936
34937
34938
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 34930

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