Class: Google::Apis::AiplatformV1::LearningServingLlmMessageMetadata

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

LINT.IfChange This metadata contains additional information required for debugging.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ LearningServingLlmMessageMetadata

Returns a new instance of LearningServingLlmMessageMetadata.



31241
31242
31243
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31241

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

Instance Attribute Details

#classifier_summary ⇒ Google::Apis::AiplatformV1::LearningGenaiRootClassifierOutputSummary

Summary of classifier output. We attach this to all messages regardless of whether classification rules triggered or not. Corresponds to the JSON property classifierSummary

Returns:



31116
31117
31118
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31116

def classifier_summary
  @classifier_summary
end

#current_stream_text_length ⇒ Fixnum

Corresponds to the JSON property currentStreamTextLength

Returns:

  • (Fixnum) 


31121
31122
31123
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31121

def current_stream_text_length
  @current_stream_text_length
end

#deleted ⇒ Boolean Also known as: deleted?

Whether the corresponding message has been deleted. Corresponds to the JSON property deleted

Returns:

  • (Boolean) 


31126
31127
31128
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31126

def deleted
  @deleted
end

#filter_meta ⇒ Array<Google::Apis::AiplatformV1::LearningGenaiRootFilterMetadata>

Metadata for filters that triggered. Corresponds to the JSON property filterMeta

Returns:



31132
31133
31134
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31132

def filter_meta
  @filter_meta
end

#final_message_score ⇒ Google::Apis::AiplatformV1::LearningGenaiRootScore

This score is finally used for ranking the message. This will be same as the score present in Message.score field. Corresponds to the JSON property finalMessageScore

Returns:



31138
31139
31140
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31138

def final_message_score
  @final_message_score
end

#finish_reason ⇒ String

NOT YET IMPLEMENTED. Corresponds to the JSON property finishReason

Returns:

  • (String) 


31143
31144
31145
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31143

def finish_reason
  @finish_reason
end

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

Corresponds to the JSON property groundingMetadata

Returns:



31148
31149
31150
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31148

def grounding_metadata
  @grounding_metadata
end

#is_code ⇒ Boolean Also known as: is_code?

Applies to streaming response message only. Whether the message is a code. Corresponds to the JSON property isCode

Returns:

  • (Boolean) 


31153
31154
31155
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31153

def is_code
  @is_code
end

#is_fallback ⇒ Boolean Also known as: is_fallback?

Applies to Response message only. Indicates whether the message is a fallback and the response would have otherwise been empty. Corresponds to the JSON property isFallback

Returns:

  • (Boolean) 


31160
31161
31162
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31160

def is_fallback
  @is_fallback
end

#langid_result ⇒ Google::Apis::AiplatformV1::NlpSaftLangIdResult

Result from nlp_saft DetectLanguage method. Currently the predicted language code and language probability is used. Corresponds to the JSON property langidResult

Returns:



31167
31168
31169
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31167

def langid_result
  @langid_result
end

#language ⇒ String

Detected language. Corresponds to the JSON property language

Returns:

  • (String) 


31172
31173
31174
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31172

def language
  @language
end

#lm_prefix ⇒ String

The LM prefix used to generate this response. Corresponds to the JSON property lmPrefix

Returns:

  • (String) 


31177
31178
31179
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31177

def lm_prefix
  @lm_prefix
end

#original_text ⇒ String

The original text generated by LLM. This is the raw output for debugging purposes. Corresponds to the JSON property originalText

Returns:

  • (String) 


31183
31184
31185
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31183

def original_text
  @original_text
end

#per_stream_decoded_token_count ⇒ Fixnum

NOT YET IMPLEMENTED. Applies to streaming only. Number of tokens decoded / emitted by the model as part of this stream. This may be different from token_count, which contains number of tokens returned in this response after any response rewriting / truncation. Corresponds to the JSON property perStreamDecodedTokenCount

Returns:

  • (Fixnum) 


31191
31192
31193
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31191

def per_stream_decoded_token_count
  @per_stream_decoded_token_count
end

#rai_outputs ⇒ Array<Google::Apis::AiplatformV1::LearningGenaiRootRaiOutput>

Results of running RAI on the query or this response candidate. One output per rai_config. It will be populated regardless of whether the threshold is exceeded or not. Corresponds to the JSON property raiOutputs

Returns:



31198
31199
31200
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31198

def rai_outputs
  @rai_outputs
end

#recitation_result ⇒ Google::Apis::AiplatformV1::LearningGenaiRecitationRecitationResult

The recitation result for one input Corresponds to the JSON property recitationResult

Returns:



31203
31204
31205
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31203

def recitation_result
  @recitation_result
end

#return_token_count ⇒ Fixnum

NOT YET IMPLEMENTED. Number of tokens returned as part of this candidate. Corresponds to the JSON property returnTokenCount

Returns:

  • (Fixnum) 


31208
31209
31210
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31208

def return_token_count
  @return_token_count
end

#scores ⇒ Array<Google::Apis::AiplatformV1::LearningGenaiRootScore>

All the different scores for a message are logged here. Corresponds to the JSON property scores

Returns:



31213
31214
31215
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31213

def scores
  @scores
end

#stream_terminated ⇒ Boolean Also known as: stream_terminated?

Whether the response is terminated during streaming return. Only used for streaming requests. Corresponds to the JSON property streamTerminated

Returns:

  • (Boolean) 


31219
31220
31221
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31219

def stream_terminated
  @stream_terminated
end

#total_decoded_token_count ⇒ Fixnum

NOT YET IMPLEMENTED. Aggregated number of total tokens decoded so far. For streaming, this is sum of all the tokens decoded so far i.e. aggregated count. Corresponds to the JSON property totalDecodedTokenCount

Returns:

  • (Fixnum) 


31226
31227
31228
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31226

def total_decoded_token_count
  @total_decoded_token_count
end

#translated_user_prompts ⇒ Array<String>

Translated user-prompt used for RAI post processing. This is for internal processing only. We will translate in pre-processor and pass the translated text to the post processor using this field. It will be empty if non of the signals requested need translation. Corresponds to the JSON property translatedUserPrompts

Returns:

  • (Array<String>) 


31234
31235
31236
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31234

def translated_user_prompts
  @translated_user_prompts
end

#vertex_rai_result ⇒ Google::Apis::AiplatformV1::CloudAiNlLlmProtoServiceRaiResult

The RAI results for a given text. Corresponds to the JSON property vertexRaiResult

Returns:



31239
31240
31241
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31239

def vertex_rai_result
  @vertex_rai_result
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



31246
31247
31248
31249
31250
31251
31252
31253
31254
31255
31256
31257
31258
31259
31260
31261
31262
31263
31264
31265
31266
31267
31268
31269
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31246

def update!(**args)
  @classifier_summary = args[:classifier_summary] if args.key?(:classifier_summary)
  @current_stream_text_length = args[:current_stream_text_length] if args.key?(:current_stream_text_length)
  @deleted = args[:deleted] if args.key?(:deleted)
  @filter_meta = args[:filter_meta] if args.key?(:filter_meta)
  @final_message_score = args[:final_message_score] if args.key?(:final_message_score)
  @finish_reason = args[:finish_reason] if args.key?(:finish_reason)
  @grounding_metadata = args[:grounding_metadata] if args.key?(:grounding_metadata)
  @is_code = args[:is_code] if args.key?(:is_code)
  @is_fallback = args[:is_fallback] if args.key?(:is_fallback)
  @langid_result = args[:langid_result] if args.key?(:langid_result)
  @language = args[:language] if args.key?(:language)
  @lm_prefix = args[:lm_prefix] if args.key?(:lm_prefix)
  @original_text = args[:original_text] if args.key?(:original_text)
  @per_stream_decoded_token_count = args[:per_stream_decoded_token_count] if args.key?(:per_stream_decoded_token_count)
  @rai_outputs = args[:rai_outputs] if args.key?(:rai_outputs)
  @recitation_result = args[:recitation_result] if args.key?(:recitation_result)
  @return_token_count = args[:return_token_count] if args.key?(:return_token_count)
  @scores = args[:scores] if args.key?(:scores)
  @stream_terminated = args[:stream_terminated] if args.key?(:stream_terminated)
  @total_decoded_token_count = args[:total_decoded_token_count] if args.key?(:total_decoded_token_count)
  @translated_user_prompts = args[:translated_user_prompts] if args.key?(:translated_user_prompts)
  @vertex_rai_result = args[:vertex_rai_result] if args.key?(:vertex_rai_result)
end