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.



32066
32067
32068
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32066

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:



31947
31948
31949
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31947

def classifier_summary
  @classifier_summary
end

#current_stream_text_length ⇒ Fixnum

Corresponds to the JSON property currentStreamTextLength

Returns:

  • (Fixnum) 


31952
31953
31954
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31952

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) 


31957
31958
31959
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31957

def deleted
  @deleted
end

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

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

Returns:



31963
31964
31965
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31963

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:



31969
31970
31971
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31969

def final_message_score
  @final_message_score
end

#finish_reason ⇒ String

NOT YET IMPLEMENTED. Corresponds to the JSON property finishReason

Returns:

  • (String) 


31974
31975
31976
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31974

def finish_reason
  @finish_reason
end

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

Corresponds to the JSON property groundingMetadata

Returns:



31979
31980
31981
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31979

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) 


31985
31986
31987
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31985

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:



31992
31993
31994
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31992

def langid_result
  @langid_result
end

#language ⇒ String

Detected language. Corresponds to the JSON property language

Returns:

  • (String) 


31997
31998
31999
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31997

def language
  @language
end

#lm_prefix ⇒ String

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

Returns:

  • (String) 


32002
32003
32004
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32002

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) 


32008
32009
32010
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32008

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) 


32016
32017
32018
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32016

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:



32023
32024
32025
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32023

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:



32028
32029
32030
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32028

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) 


32033
32034
32035
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32033

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:



32038
32039
32040
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32038

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) 


32044
32045
32046
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32044

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) 


32051
32052
32053
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32051

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


32059
32060
32061
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32059

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:



32064
32065
32066
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32064

def vertex_rai_result
  @vertex_rai_result
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



32071
32072
32073
32074
32075
32076
32077
32078
32079
32080
32081
32082
32083
32084
32085
32086
32087
32088
32089
32090
32091
32092
32093
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32071

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