Class: Aws::QConnect::Types::AIGuardrailData

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-qconnect/types.rb

Overview

The data for the AI Guardrail

See Also:

Constant Summary collapse

SENSITIVE = 
[:blocked_input_messaging, :blocked_outputs_messaging, :description]

Instance Attribute Summary collapse

Instance Attribute Details

#ai_guardrail_arn ⇒ String

The Amazon Resource Name (ARN) of the AI Guardrail.

Returns:

  • (String) 


402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/aws-sdk-qconnect/types.rb', line 402

class AIGuardrailData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_guardrail_arn,
  :ai_guardrail_id,
  :name,
  :visibility_status,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags,
  :status,
  :modified_time)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#ai_guardrail_id ⇒ String

The identifier of the Amazon Q in Connect AI Guardrail.

Returns:

  • (String) 


402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/aws-sdk-qconnect/types.rb', line 402

class AIGuardrailData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_guardrail_arn,
  :ai_guardrail_id,
  :name,
  :visibility_status,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags,
  :status,
  :modified_time)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#assistant_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

Returns:

  • (String) 


402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/aws-sdk-qconnect/types.rb', line 402

class AIGuardrailData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_guardrail_arn,
  :ai_guardrail_id,
  :name,
  :visibility_status,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags,
  :status,
  :modified_time)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#assistant_id ⇒ String

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

  • (String) 


402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/aws-sdk-qconnect/types.rb', line 402

class AIGuardrailData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_guardrail_arn,
  :ai_guardrail_id,
  :name,
  :visibility_status,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags,
  :status,
  :modified_time)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#blocked_input_messaging ⇒ String

The message to return when the AI Guardrail blocks a prompt.

Returns:

  • (String) 


402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/aws-sdk-qconnect/types.rb', line 402

class AIGuardrailData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_guardrail_arn,
  :ai_guardrail_id,
  :name,
  :visibility_status,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags,
  :status,
  :modified_time)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#blocked_outputs_messaging ⇒ String

The message to return when the AI Guardrail blocks a model response.

Returns:

  • (String) 


402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/aws-sdk-qconnect/types.rb', line 402

class AIGuardrailData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_guardrail_arn,
  :ai_guardrail_id,
  :name,
  :visibility_status,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags,
  :status,
  :modified_time)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#content_policy_config ⇒ Types::AIGuardrailContentPolicyConfig

Contains details about how to handle harmful content.

Returns:



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/aws-sdk-qconnect/types.rb', line 402

class AIGuardrailData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_guardrail_arn,
  :ai_guardrail_id,
  :name,
  :visibility_status,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags,
  :status,
  :modified_time)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#contextual_grounding_policy_config ⇒ Types::AIGuardrailContextualGroundingPolicyConfig

The policy configuration details for the AI Guardrail’s contextual grounding policy.

Returns:



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/aws-sdk-qconnect/types.rb', line 402

class AIGuardrailData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_guardrail_arn,
  :ai_guardrail_id,
  :name,
  :visibility_status,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags,
  :status,
  :modified_time)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#description ⇒ String

A description of the AI Guardrail.

Returns:

  • (String) 


402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/aws-sdk-qconnect/types.rb', line 402

class AIGuardrailData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_guardrail_arn,
  :ai_guardrail_id,
  :name,
  :visibility_status,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags,
  :status,
  :modified_time)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#modified_time ⇒ Time

The time the AI Guardrail was last modified.

Returns:

  • (Time) 


402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/aws-sdk-qconnect/types.rb', line 402

class AIGuardrailData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_guardrail_arn,
  :ai_guardrail_id,
  :name,
  :visibility_status,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags,
  :status,
  :modified_time)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#name ⇒ String

The name of the AI Guardrail.

Returns:

  • (String) 


402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/aws-sdk-qconnect/types.rb', line 402

class AIGuardrailData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_guardrail_arn,
  :ai_guardrail_id,
  :name,
  :visibility_status,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags,
  :status,
  :modified_time)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#sensitive_information_policy_config ⇒ Types::AIGuardrailSensitiveInformationPolicyConfig

Contains details about PII entities and regular expressions to configure for the AI Guardrail.

Returns:



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/aws-sdk-qconnect/types.rb', line 402

class AIGuardrailData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_guardrail_arn,
  :ai_guardrail_id,
  :name,
  :visibility_status,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags,
  :status,
  :modified_time)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#status ⇒ String

The status of the AI Guardrail.

Returns:

  • (String) 


402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/aws-sdk-qconnect/types.rb', line 402

class AIGuardrailData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_guardrail_arn,
  :ai_guardrail_id,
  :name,
  :visibility_status,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags,
  :status,
  :modified_time)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags used to organize, track, or control access for this resource.

Returns:

  • (Hash<String,String>) 


402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/aws-sdk-qconnect/types.rb', line 402

class AIGuardrailData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_guardrail_arn,
  :ai_guardrail_id,
  :name,
  :visibility_status,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags,
  :status,
  :modified_time)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#topic_policy_config ⇒ Types::AIGuardrailTopicPolicyConfig

Contains details about topics that the AI Guardrail should identify and deny.

Returns:



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/aws-sdk-qconnect/types.rb', line 402

class AIGuardrailData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_guardrail_arn,
  :ai_guardrail_id,
  :name,
  :visibility_status,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags,
  :status,
  :modified_time)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#visibility_status ⇒ String

The visibility status of the AI Guardrail.

Returns:

  • (String) 


402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/aws-sdk-qconnect/types.rb', line 402

class AIGuardrailData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_guardrail_arn,
  :ai_guardrail_id,
  :name,
  :visibility_status,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags,
  :status,
  :modified_time)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#word_policy_config ⇒ Types::AIGuardrailWordPolicyConfig

Contains details about the word policy to configured for the AI Guardrail.

Returns:



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/aws-sdk-qconnect/types.rb', line 402

class AIGuardrailData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_guardrail_arn,
  :ai_guardrail_id,
  :name,
  :visibility_status,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags,
  :status,
  :modified_time)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end