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.



31351
31352
31353
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31351

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:



31221
31222
31223
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31221

def classifier_summary
  @classifier_summary
end

#codey_output ⇒ Google::Apis::AiplatformV1::LearningGenaiRootCodeyOutput

Top-level wrapper used to store all things codey-related. Corresponds to the JSON property codeyOutput

Returns:



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

def codey_output
  @codey_output
end

#current_stream_text_length ⇒ Fixnum

Corresponds to the JSON property currentStreamTextLength

Returns:

  • (Fixnum) 


31231
31232
31233
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31231

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) 


31236
31237
31238
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31236

def deleted
  @deleted
end

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

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

Returns:



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

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:



31248
31249
31250
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31248

def final_message_score
  @final_message_score
end

#finish_reason ⇒ String

NOT YET IMPLEMENTED. Corresponds to the JSON property finishReason

Returns:

  • (String) 


31253
31254
31255
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31253

def finish_reason
  @finish_reason
end

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

Corresponds to the JSON property groundingMetadata

Returns:



31258
31259
31260
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31258

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) 


31263
31264
31265
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31263

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) 


31270
31271
31272
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31270

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:



31277
31278
31279
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31277

def langid_result
  @langid_result
end

#language ⇒ String

Detected language. Corresponds to the JSON property language

Returns:

  • (String) 


31282
31283
31284
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31282

def language
  @language
end

#lm_prefix ⇒ String

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

Returns:

  • (String) 


31287
31288
31289
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31287

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) 


31293
31294
31295
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31293

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) 


31301
31302
31303
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31301

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:



31308
31309
31310
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31308

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:



31313
31314
31315
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31313

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) 


31318
31319
31320
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31318

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:



31323
31324
31325
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31323

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) 


31329
31330
31331
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31329

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) 


31336
31337
31338
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31336

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>) 


31344
31345
31346
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31344

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:



31349
31350
31351
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31349

def vertex_rai_result
  @vertex_rai_result
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



31356
31357
31358
31359
31360
31361
31362
31363
31364
31365
31366
31367
31368
31369
31370
31371
31372
31373
31374
31375
31376
31377
31378
31379
31380
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31356

def update!(**args)
  @classifier_summary = args[:classifier_summary] if args.key?(:classifier_summary)
  @codey_output = args[:codey_output] if args.key?(:codey_output)
  @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