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.



17197
17198
17199
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 17197

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

Instance Attribute Details

#id ⇒ String

Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call id. Corresponds to the JSON property id

Returns:

  • (String) 


17168
17169
17170
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 17168

def id
  @id
end

#name ⇒ String

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

Returns:

  • (String) 


17174
17175
17176
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 17174

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:



17180
17181
17182
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 17180

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


17188
17189
17190
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 17188

def response
  @response
end

#scheduling ⇒ String

Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. Corresponds to the JSON property scheduling

Returns:

  • (String) 


17195
17196
17197
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 17195

def scheduling
  @scheduling
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



17202
17203
17204
17205
17206
17207
17208
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 17202

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