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.



32675
32676
32677
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32675

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:



32545
32546
32547
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32545

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:



32550
32551
32552
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32550

def codey_output
  @codey_output
end

#current_stream_text_length ⇒ Fixnum

Corresponds to the JSON property currentStreamTextLength

Returns:

  • (Fixnum) 


32555
32556
32557
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32555

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) 


32560
32561
32562
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32560

def deleted
  @deleted
end

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

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

Returns:



32566
32567
32568
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32566

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:



32572
32573
32574
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32572

def final_message_score
  @final_message_score
end

#finish_reason ⇒ String

NOT YET IMPLEMENTED. Corresponds to the JSON property finishReason

Returns:

  • (String) 


32577
32578
32579
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32577

def finish_reason
  @finish_reason
end

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

Corresponds to the JSON property groundingMetadata

Returns:



32582
32583
32584
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32582

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) 


32587
32588
32589
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32587

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) 


32594
32595
32596
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32594

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:



32601
32602
32603
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32601

def langid_result
  @langid_result
end

#language ⇒ String

Detected language. Corresponds to the JSON property language

Returns:

  • (String) 


32606
32607
32608
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32606

def language
  @language
end

#lm_prefix ⇒ String

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

Returns:

  • (String) 


32611
32612
32613
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32611

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) 


32617
32618
32619
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32617

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) 


32625
32626
32627
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32625

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:



32632
32633
32634
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32632

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:



32637
32638
32639
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32637

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) 


32642
32643
32644
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32642

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:



32647
32648
32649
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32647

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) 


32653
32654
32655
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32653

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) 


32660
32661
32662
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32660

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


32668
32669
32670
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32668

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:



32673
32674
32675
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32673

def vertex_rai_result
  @vertex_rai_result
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



32680
32681
32682
32683
32684
32685
32686
32687
32688
32689
32690
32691
32692
32693
32694
32695
32696
32697
32698
32699
32700
32701
32702
32703
32704
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32680

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