Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CandidateResponse

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

Responses from model or agent.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1CandidateResponse

Returns a new instance of GoogleCloudAiplatformV1beta1CandidateResponse.



10536
10537
10538
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10536

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

Instance Attribute Details

#agent_data ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AgentData

Represents data specific to multi-turn agent evaluations. Corresponds to the JSON property agentData

Returns:



10503
10504
10505
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10503

def agent_data
  @agent_data
end

#candidate ⇒ String

Required. The name of the candidate that produced the response. Corresponds to the JSON property candidate

Returns:

  • (String) 


10508
10509
10510
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10508

def candidate
  @candidate
end

#error ⇒ Google::Apis::AiplatformV1beta1::GoogleRpcStatus

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property error

Returns:



10518
10519
10520
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10518

def error
  @error
end

#events ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content>

Optional. Intermediate events (such as tool calls and responses) that led to the final response. Corresponds to the JSON property events

Returns:



10524
10525
10526
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10524

def events
  @events
end

#text ⇒ String

Text response. Corresponds to the JSON property text

Returns:

  • (String) 


10529
10530
10531
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10529

def text
  @text
end

#value ⇒ Object

Fields and values that can be used to populate the response template. Corresponds to the JSON property value

Returns:

  • (Object) 


10534
10535
10536
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10534

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10541
10542
10543
10544
10545
10546
10547
10548
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10541

def update!(**args)
  @agent_data = args[:agent_data] if args.key?(:agent_data)
  @candidate = args[:candidate] if args.key?(:candidate)
  @error = args[:error] if args.key?(:error)
  @events = args[:events] if args.key?(:events)
  @text = args[:text] if args.key?(:text)
  @value = args[:value] if args.key?(:value)
end