Class: Google::Apis::AiplatformV1::CloudAiNlLlmProtoServiceCandidate

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CloudAiNlLlmProtoServiceCandidate

Returns a new instance of CloudAiNlLlmProtoServiceCandidate.



488
489
490
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 488

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

Instance Attribute Details

#citation_metadata ⇒ Google::Apis::AiplatformV1::CloudAiNlLlmProtoServiceCitationMetadata

A collection of source attributions for a piece of content. Corresponds to the JSON property citationMetadata

Returns:



454
455
456
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 454

def citation_metadata
  @citation_metadata
end

#content ⇒ Google::Apis::AiplatformV1::CloudAiNlLlmProtoServiceContent

The content of a single message from a participant. Corresponds to the JSON property content

Returns:



459
460
461
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 459

def content
  @content
end

#finish_message ⇒ String

A string that describes the filtering behavior in more detail. Only filled when reason is set. Corresponds to the JSON property finishMessage

Returns:

  • (String) 


465
466
467
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 465

def finish_message
  @finish_message
end

#finish_reason ⇒ String

The reason why the model stopped generating tokens. Corresponds to the JSON property finishReason

Returns:

  • (String) 


470
471
472
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 470

def finish_reason
  @finish_reason
end

#grounding_metadata ⇒ Google::Apis::AiplatformV1::LearningGenaiRootGroundingMetadata

Grounding metadata. Combine with the facts list from response to generate grounding citations for this choice. Corresponds to the JSON property groundingMetadata

Returns:



476
477
478
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 476

def grounding_metadata
  @grounding_metadata
end

#index ⇒ Fixnum

Index of the candidate. Corresponds to the JSON property index

Returns:

  • (Fixnum) 


481
482
483
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 481

def index
  @index
end

#safety_ratings ⇒ Array<Google::Apis::AiplatformV1::CloudAiNlLlmProtoServiceSafetyRating>

Safety ratings of the generated content. Corresponds to the JSON property safetyRatings

Returns:



486
487
488
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 486

def safety_ratings
  @safety_ratings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



493
494
495
496
497
498
499
500
501
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 493

def update!(**args)
  @citation_metadata = args[:citation_metadata] if args.key?(:citation_metadata)
  @content = args[:content] if args.key?(:content)
  @finish_message = args[:finish_message] if args.key?(:finish_message)
  @finish_reason = args[:finish_reason] if args.key?(:finish_reason)
  @grounding_metadata = args[:grounding_metadata] if args.key?(:grounding_metadata)
  @index = args[:index] if args.key?(:index)
  @safety_ratings = args[:safety_ratings] if args.key?(:safety_ratings)
end