Class: Google::Apis::CesV1::Guardrail

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/ces_v1/classes.rb,
lib/google/apis/ces_v1/representations.rb,
lib/google/apis/ces_v1/representations.rb

Overview

Guardrail contains a list of checks and balances to keep the agents safe and secure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Guardrail

Returns a new instance of Guardrail.



3846
3847
3848
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3846

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

Instance Attribute Details

#action ⇒ Google::Apis::CesV1::TriggerAction

Action that is taken when a certain precondition is met. Corresponds to the JSON property action

Returns:



3776
3777
3778
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3776

def action
  @action
end

#code_callback ⇒ Google::Apis::CesV1::GuardrailCodeCallback

Guardrail that blocks the conversation based on the code callbacks provided. Corresponds to the JSON property codeCallback

Returns:



3781
3782
3783
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3781

def code_callback
  @code_callback
end

#content_filter ⇒ Google::Apis::CesV1::GuardrailContentFilter

Guardrail that bans certain content from being used in the conversation. Corresponds to the JSON property contentFilter

Returns:



3786
3787
3788
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3786

def content_filter
  @content_filter
end

#create_time ⇒ String

Output only. Timestamp when the guardrail was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


3791
3792
3793
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3791

def create_time
  @create_time
end

#description ⇒ String

Optional. Description of the guardrail. Corresponds to the JSON property description

Returns:

  • (String) 


3796
3797
3798
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3796

def description
  @description
end

#display_name ⇒ String

Required. Display name of the guardrail. Corresponds to the JSON property displayName

Returns:

  • (String) 


3801
3802
3803
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3801

def display_name
  @display_name
end

#enabled ⇒ Boolean Also known as: enabled?

Optional. Whether the guardrail is enabled. Corresponds to the JSON property enabled

Returns:

  • (Boolean) 


3806
3807
3808
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3806

def enabled
  @enabled
end

#etag ⇒ String

Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. Corresponds to the JSON property etag

Returns:

  • (String) 


3814
3815
3816
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3814

def etag
  @etag
end

#llm_policy ⇒ Google::Apis::CesV1::GuardrailLlmPolicy

Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. Corresponds to the JSON property llmPolicy

Returns:



3820
3821
3822
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3820

def llm_policy
  @llm_policy
end

#llm_prompt_security ⇒ Google::Apis::CesV1::GuardrailLlmPromptSecurity

Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification. Corresponds to the JSON property llmPromptSecurity

Returns:



3826
3827
3828
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3826

def llm_prompt_security
  @llm_prompt_security
end

#model_safety ⇒ Google::Apis::CesV1::GuardrailModelSafety

Model safety settings overrides. When this is set, it will override the default settings and trigger the guardrail if the response is considered unsafe. Corresponds to the JSON property modelSafety

Returns:



3833
3834
3835
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3833

def model_safety
  @model_safety
end

#name ⇒ String

Identifier. The unique identifier of the guardrail. Format: projects/project /locations/location/apps/app/guardrails/guardrail` Corresponds to the JSON propertyname`

Returns:

  • (String) 


3839
3840
3841
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3839

def name
  @name
end

#update_time ⇒ String

Output only. Timestamp when the guardrail was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


3844
3845
3846
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3844

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3851

def update!(**args)
  @action = args[:action] if args.key?(:action)
  @code_callback = args[:code_callback] if args.key?(:code_callback)
  @content_filter = args[:content_filter] if args.key?(:content_filter)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @enabled = args[:enabled] if args.key?(:enabled)
  @etag = args[:etag] if args.key?(:etag)
  @llm_policy = args[:llm_policy] if args.key?(:llm_policy)
  @llm_prompt_security = args[:llm_prompt_security] if args.key?(:llm_prompt_security)
  @model_safety = args[:model_safety] if args.key?(:model_safety)
  @name = args[:name] if args.key?(:name)
  @update_time = args[:update_time] if args.key?(:update_time)
end