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.



30733
30734
30735
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30733

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:



30614
30615
30616
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30614

def classifier_summary
  @classifier_summary
end

#current_stream_text_length ⇒ Fixnum

Corresponds to the JSON property currentStreamTextLength

Returns:

  • (Fixnum) 


30619
30620
30621
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30619

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) 


30624
30625
30626
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30624

def deleted
  @deleted
end

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

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

Returns:



30630
30631
30632
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30630

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:



30636
30637
30638
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30636

def final_message_score
  @final_message_score
end

#finish_reason ⇒ String

NOT YET IMPLEMENTED. Corresponds to the JSON property finishReason

Returns:

  • (String) 


30641
30642
30643
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30641

def finish_reason
  @finish_reason
end

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

Corresponds to the JSON property groundingMetadata

Returns:



30646
30647
30648
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30646

def grounding_metadata
  @grounding_metadata
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) 


30652
30653
30654
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30652

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:



30659
30660
30661
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30659

def langid_result
  @langid_result
end

#language ⇒ String

Detected language. Corresponds to the JSON property language

Returns:

  • (String) 


30664
30665
30666
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30664

def language
  @language
end

#lm_prefix ⇒ String

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

Returns:

  • (String) 


30669
30670
30671
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30669

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) 


30675
30676
30677
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30675

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) 


30683
30684
30685
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30683

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:



30690
30691
30692
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30690

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:



30695
30696
30697
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30695

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) 


30700
30701
30702
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30700

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:



30705
30706
30707
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30705

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) 


30711
30712
30713
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30711

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) 


30718
30719
30720
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30718

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


30726
30727
30728
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30726

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:



30731
30732
30733
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30731

def vertex_rai_result
  @vertex_rai_result
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



30738
30739
30740
30741
30742
30743
30744
30745
30746
30747
30748
30749
30750
30751
30752
30753
30754
30755
30756
30757
30758
30759
30760
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 30738

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