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.



11638
11639
11640
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11638

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:



11605
11606
11607
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11605

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) 


11610
11611
11612
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11610

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:



11620
11621
11622
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11620

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:



11626
11627
11628
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11626

def events
  @events
end

#text ⇒ String

Text response. Corresponds to the JSON property text

Returns:

  • (String) 


11631
11632
11633
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11631

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) 


11636
11637
11638
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11636

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11643
11644
11645
11646
11647
11648
11649
11650
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 11643

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