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.



33734
33735
33736
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33734

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:



33604
33605
33606
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33604

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:



33609
33610
33611
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33609

def codey_output
  @codey_output
end

#current_stream_text_length ⇒ Fixnum

Corresponds to the JSON property currentStreamTextLength

Returns:

  • (Fixnum) 


33614
33615
33616
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33614

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) 


33619
33620
33621
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33619

def deleted
  @deleted
end

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

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

Returns:



33625
33626
33627
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33625

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:



33631
33632
33633
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33631

def final_message_score
  @final_message_score
end

#finish_reason ⇒ String

NOT YET IMPLEMENTED. Corresponds to the JSON property finishReason

Returns:

  • (String) 


33636
33637
33638
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33636

def finish_reason
  @finish_reason
end

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

Corresponds to the JSON property groundingMetadata

Returns:



33641
33642
33643
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33641

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) 


33646
33647
33648
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33646

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) 


33653
33654
33655
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33653

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:



33660
33661
33662
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33660

def langid_result
  @langid_result
end

#language ⇒ String

Detected language. Corresponds to the JSON property language

Returns:

  • (String) 


33665
33666
33667
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33665

def language
  @language
end

#lm_prefix ⇒ String

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

Returns:

  • (String) 


33670
33671
33672
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33670

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) 


33676
33677
33678
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33676

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) 


33684
33685
33686
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33684

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:



33691
33692
33693
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33691

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:



33696
33697
33698
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33696

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) 


33701
33702
33703
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33701

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:



33706
33707
33708
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33706

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) 


33712
33713
33714
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33712

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) 


33719
33720
33721
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33719

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


33727
33728
33729
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33727

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:



33732
33733
33734
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33732

def vertex_rai_result
  @vertex_rai_result
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



33739
33740
33741
33742
33743
33744
33745
33746
33747
33748
33749
33750
33751
33752
33753
33754
33755
33756
33757
33758
33759
33760
33761
33762
33763
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 33739

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