Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse

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

Response message for [PredictionService.GenerateContent].

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1GenerateContentResponse

Returns a new instance of GoogleCloudAiplatformV1GenerateContentResponse.



15320
15321
15322
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15320

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

Instance Attribute Details

#candidates ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Candidate>

Output only. Generated candidates. Corresponds to the JSON property candidates

Returns:



15289
15290
15291
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15289

def candidates
  @candidates
end

#create_time ⇒ String

Output only. Timestamp when the request is made to the server. Corresponds to the JSON property createTime

Returns:

  • (String) 


15294
15295
15296
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15294

def create_time
  @create_time
end

#model_version ⇒ String

Output only. The model version used to generate the response. Corresponds to the JSON property modelVersion

Returns:

  • (String) 


15299
15300
15301
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15299

def model_version
  @model_version
end

#prompt_feedback ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback

Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. Corresponds to the JSON property promptFeedback

Returns:



15306
15307
15308
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15306

def prompt_feedback
  @prompt_feedback
end

#response_id ⇒ String

Output only. response_id is used to identify each response. It is the encoding of the event_id. Corresponds to the JSON property responseId

Returns:

  • (String) 


15312
15313
15314
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15312

def response_id
  @response_id
end

#usage_metadata ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata

Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. Corresponds to the JSON property usageMetadata

Returns:



15318
15319
15320
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15318

def usage_metadata
  @usage_metadata
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



15325
15326
15327
15328
15329
15330
15331
15332
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 15325

def update!(**args)
  @candidates = args[:candidates] if args.key?(:candidates)
  @create_time = args[:create_time] if args.key?(:create_time)
  @model_version = args[:model_version] if args.key?(:model_version)
  @prompt_feedback = args[:prompt_feedback] if args.key?(:prompt_feedback)
  @response_id = args[:response_id] if args.key?(:response_id)
  @usage_metadata = args[:usage_metadata] if args.key?(:usage_metadata)
end