Class: Google::Apis::AiplatformV1::CloudAiNlLlmProtoServiceRaiResult

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

The RAI results for a given text.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CloudAiNlLlmProtoServiceRaiResult

Returns a new instance of CloudAiNlLlmProtoServiceRaiResult.



939
940
941
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 939

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

Instance Attribute Details

#aida_recitation_result ⇒ Google::Apis::AiplatformV1::LanguageLabsAidaTrustRecitationProtoRecitationResult

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

Returns:



887
888
889
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 887

def aida_recitation_result
  @aida_recitation_result
end

#blocked ⇒ Boolean Also known as: blocked?

Use triggered_blocklist. Corresponds to the JSON property blocked

Returns:

  • (Boolean) 


892
893
894
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 892

def blocked
  @blocked
end

#error_codes ⇒ Array<Fixnum>

The error codes indicate which RAI filters block the response. Corresponds to the JSON property errorCodes

Returns:

  • (Array<Fixnum>) 


898
899
900
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 898

def error_codes
  @error_codes
end

#filtered ⇒ Boolean Also known as: filtered?

Whether the text should be filtered and not shown to the end user. This is determined based on a combination of triggered_recitation, triggered_blocklist, language_filter_result, and triggered_safety_filter. Corresponds to the JSON property filtered

Returns:

  • (Boolean) 


905
906
907
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 905

def filtered
  @filtered
end

#language_filter_result ⇒ Google::Apis::AiplatformV1::LearningServingLlmLanguageFilterResult

Language filter result from SAFT LangId. Corresponds to the JSON property languageFilterResult

Returns:



911
912
913
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 911

def language_filter_result
  @language_filter_result
end

#rai_signals ⇒ Array<Google::Apis::AiplatformV1::CloudAiNlLlmProtoServiceRaiSignal>

The RAI signals for the text. Corresponds to the JSON property raiSignals

Returns:



916
917
918
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 916

def rai_signals
  @rai_signals
end

#triggered_blocklist ⇒ Boolean Also known as: triggered_blocklist?

Whether the text triggered the blocklist. Corresponds to the JSON property triggeredBlocklist

Returns:

  • (Boolean) 


921
922
923
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 921

def triggered_blocklist
  @triggered_blocklist
end

#triggered_recitation ⇒ Boolean Also known as: triggered_recitation?

Whether the text should be blocked by the recitation result from Aida recitation checker. It is determined from aida_recitation_result. Corresponds to the JSON property triggeredRecitation

Returns:

  • (Boolean) 


928
929
930
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 928

def triggered_recitation
  @triggered_recitation
end

#triggered_safety_filter ⇒ Boolean Also known as: triggered_safety_filter?

Whether the text triggered the safety filter. Currently, this is due to CSAI triggering or one of four categories (derogatory, sexual, toxic, violent) having a score over the filter threshold. Corresponds to the JSON property triggeredSafetyFilter

Returns:

  • (Boolean) 


936
937
938
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 936

def triggered_safety_filter
  @triggered_safety_filter
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



944
945
946
947
948
949
950
951
952
953
954
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 944

def update!(**args)
  @aida_recitation_result = args[:aida_recitation_result] if args.key?(:aida_recitation_result)
  @blocked = args[:blocked] if args.key?(:blocked)
  @error_codes = args[:error_codes] if args.key?(:error_codes)
  @filtered = args[:filtered] if args.key?(:filtered)
  @language_filter_result = args[:language_filter_result] if args.key?(:language_filter_result)
  @rai_signals = args[:rai_signals] if args.key?(:rai_signals)
  @triggered_blocklist = args[:triggered_blocklist] if args.key?(:triggered_blocklist)
  @triggered_recitation = args[:triggered_recitation] if args.key?(:triggered_recitation)
  @triggered_safety_filter = args[:triggered_safety_filter] if args.key?(:triggered_safety_filter)
end