Class: Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1Candidate
- Inherits:
-
Object
- Object
- Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1Candidate
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/firebaseml_v2beta/classes.rb,
lib/google/apis/firebaseml_v2beta/representations.rb,
lib/google/apis/firebaseml_v2beta/representations.rb
Overview
A response candidate generated from the model.
Instance Attribute Summary collapse
-
#citation_metadata ⇒ Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1CitationMetadata
A collection of source attributions for a piece of content.
-
#content ⇒ Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1Content
The base structured datatype containing multi-part content of a message.
-
#finish_message ⇒ String
Output only.
-
#finish_reason ⇒ String
Output only.
-
#grounding_metadata ⇒ Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GroundingMetadata
Metadata returned to client when grounding is enabled.
-
#index ⇒ Fixnum
Output only.
-
#safety_ratings ⇒ Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1SafetyRating>
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1Candidate
constructor
A new instance of GoogleCloudAiplatformV1beta1Candidate.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1Candidate
Returns a new instance of GoogleCloudAiplatformV1beta1Candidate.
137 138 139 |
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 137 def initialize(**args) update!(**args) end |
Instance Attribute Details
#citation_metadata ⇒ Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1CitationMetadata
A collection of source attributions for a piece of content.
Corresponds to the JSON property citationMetadata
99 100 101 |
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 99 def @citation_metadata end |
#content ⇒ Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1Content
The base structured datatype containing multi-part content of a message. A
Content
includes a role
field designating the producer of the Content
and
a parts
field containing multi-part data that contains the content of the
message turn.
Corresponds to the JSON property content
107 108 109 |
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 107 def content @content end |
#finish_message ⇒ String
Output only. Describes the reason the mode stopped generating tokens in more
detail. This is only filled when finish_reason
is set.
Corresponds to the JSON property finishMessage
113 114 115 |
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 113 def @finish_message end |
#finish_reason ⇒ String
Output only. The reason why the model stopped generating tokens. If empty, the
model has not stopped generating the tokens.
Corresponds to the JSON property finishReason
119 120 121 |
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 119 def finish_reason @finish_reason end |
#grounding_metadata ⇒ Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GroundingMetadata
Metadata returned to client when grounding is enabled.
Corresponds to the JSON property groundingMetadata
124 125 126 |
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 124 def @grounding_metadata end |
#index ⇒ Fixnum
Output only. Index of the candidate.
Corresponds to the JSON property index
129 130 131 |
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 129 def index @index end |
#safety_ratings ⇒ Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1SafetyRating>
Output only. List of ratings for the safety of a response candidate. There is
at most one rating per category.
Corresponds to the JSON property safetyRatings
135 136 137 |
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 135 def @safety_ratings end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
142 143 144 145 146 147 148 149 150 |
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 142 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 |