Class: Google::Apis::AiplatformV1beta1::LearningServingLlmMessageMetadata

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/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.



36862
36863
36864
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36862

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

Instance Attribute Details

#classifier_summary ⇒ Google::Apis::AiplatformV1beta1::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:



36732
36733
36734
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36732

def classifier_summary
  @classifier_summary
end

#codey_output ⇒ Google::Apis::AiplatformV1beta1::LearningGenaiRootCodeyOutput

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

Returns:



36737
36738
36739
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36737

def codey_output
  @codey_output
end

#current_stream_text_length ⇒ Fixnum

Corresponds to the JSON property currentStreamTextLength

Returns:

  • (Fixnum) 


36742
36743
36744
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36742

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) 


36747
36748
36749
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36747

def deleted
  @deleted
end

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

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

Returns:



36753
36754
36755
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36753

def filter_meta
  @filter_meta
end

#final_message_score ⇒ Google::Apis::AiplatformV1beta1::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:



36759
36760
36761
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36759

def final_message_score
  @final_message_score
end

#finish_reason ⇒ String

NOT YET IMPLEMENTED. Corresponds to the JSON property finishReason

Returns:

  • (String) 


36764
36765
36766
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36764

def finish_reason
  @finish_reason
end

#grounding_metadata ⇒ Google::Apis::AiplatformV1beta1::LearningGenaiRootGroundingMetadata

Corresponds to the JSON property groundingMetadata

Returns:



36769
36770
36771
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36769

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) 


36774
36775
36776
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36774

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) 


36781
36782
36783
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36781

def is_fallback
  @is_fallback
end

#langid_result ⇒ Google::Apis::AiplatformV1beta1::NlpSaftLangIdResult

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

Returns:



36788
36789
36790
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36788

def langid_result
  @langid_result
end

#language ⇒ String

Detected language. Corresponds to the JSON property language

Returns:

  • (String) 


36793
36794
36795
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36793

def language
  @language
end

#lm_prefix ⇒ String

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

Returns:

  • (String) 


36798
36799
36800
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36798

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) 


36804
36805
36806
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36804

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) 


36812
36813
36814
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36812

def per_stream_decoded_token_count
  @per_stream_decoded_token_count
end

#rai_outputs ⇒ Array<Google::Apis::AiplatformV1beta1::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:



36819
36820
36821
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36819

def rai_outputs
  @rai_outputs
end

#recitation_result ⇒ Google::Apis::AiplatformV1beta1::LearningGenaiRecitationRecitationResult

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

Returns:



36824
36825
36826
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36824

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) 


36829
36830
36831
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36829

def return_token_count
  @return_token_count
end

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

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

Returns:



36834
36835
36836
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36834

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) 


36840
36841
36842
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36840

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) 


36847
36848
36849
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36847

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


36855
36856
36857
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36855

def translated_user_prompts
  @translated_user_prompts
end

#vertex_rai_result ⇒ Google::Apis::AiplatformV1beta1::CloudAiNlLlmProtoServiceRaiResult

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

Returns:



36860
36861
36862
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36860

def vertex_rai_result
  @vertex_rai_result
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



36867
36868
36869
36870
36871
36872
36873
36874
36875
36876
36877
36878
36879
36880
36881
36882
36883
36884
36885
36886
36887
36888
36889
36890
36891
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36867

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