Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FunctionResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/representations.rb

Overview

The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1FunctionResponse

Returns a new instance of GoogleCloudAiplatformV1FunctionResponse.



14926
14927
14928
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14926

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

Instance Attribute Details

#name ⇒ String

Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. Corresponds to the JSON property name

Returns:

  • (String) 


14910
14911
14912
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14910

def name
  @name
end

#parts ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FunctionResponsePart>

Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types. Corresponds to the JSON property parts

Returns:



14916
14917
14918
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14916

def parts
  @parts
end

#response ⇒ Hash<String,Object>

Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If " output" and "error" keys are not specified, then whole "response" is treated as function output. Corresponds to the JSON property response

Returns:

  • (Hash<String,Object>) 


14924
14925
14926
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14924

def response
  @response
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



14931
14932
14933
14934
14935
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14931

def update!(**args)
  @name = args[:name] if args.key?(:name)
  @parts = args[:parts] if args.key?(:parts)
  @response = args[:response] if args.key?(:response)
end