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.



32222
32223
32224
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32222

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:



32092
32093
32094
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32092

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:



32097
32098
32099
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32097

def codey_output
  @codey_output
end

#current_stream_text_length ⇒ Fixnum

Corresponds to the JSON property currentStreamTextLength

Returns:

  • (Fixnum) 


32102
32103
32104
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32102

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) 


32107
32108
32109
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32107

def deleted
  @deleted
end

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

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

Returns:



32113
32114
32115
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32113

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:



32119
32120
32121
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32119

def final_message_score
  @final_message_score
end

#finish_reason ⇒ String

NOT YET IMPLEMENTED. Corresponds to the JSON property finishReason

Returns:

  • (String) 


32124
32125
32126
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32124

def finish_reason
  @finish_reason
end

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

Corresponds to the JSON property groundingMetadata

Returns:



32129
32130
32131
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32129

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) 


32134
32135
32136
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32134

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) 


32141
32142
32143
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32141

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:



32148
32149
32150
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32148

def langid_result
  @langid_result
end

#language ⇒ String

Detected language. Corresponds to the JSON property language

Returns:

  • (String) 


32153
32154
32155
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32153

def language
  @language
end

#lm_prefix ⇒ String

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

Returns:

  • (String) 


32158
32159
32160
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32158

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) 


32164
32165
32166
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32164

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) 


32172
32173
32174
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32172

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:



32179
32180
32181
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32179

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:



32184
32185
32186
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32184

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) 


32189
32190
32191
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32189

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:



32194
32195
32196
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32194

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) 


32200
32201
32202
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32200

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) 


32207
32208
32209
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32207

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


32215
32216
32217
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32215

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:



32220
32221
32222
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32220

def vertex_rai_result
  @vertex_rai_result
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



32227
32228
32229
32230
32231
32232
32233
32234
32235
32236
32237
32238
32239
32240
32241
32242
32243
32244
32245
32246
32247
32248
32249
32250
32251
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 32227

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