Class: Aws::QConnect::Types::UpdateAIGuardrailRequest

Inherits:

Struct

• Object
• Struct
• Aws::QConnect::Types::UpdateAIGuardrailRequest

Includes:

Structure

Defined in:

lib/aws-sdk-qconnect/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:blocked_input_messaging, :blocked_outputs_messaging, :description]

Instance Attribute Summary

• #ai_guardrail_id ⇒ String

  The identifier of the Amazon Q in Connect AI Guardrail.

• #assistant_id ⇒ String

  The identifier of the Amazon Q in Connect assistant.

• #blocked_input_messaging ⇒ String

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

• #blocked_outputs_messaging ⇒ String

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

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #content_policy_config ⇒ Types::AIGuardrailContentPolicyConfig

  The content filter policies to configure for the AI Guardrail.

• #contextual_grounding_policy_config ⇒ Types::AIGuardrailContextualGroundingPolicyConfig

  The contextual grounding policy configuration used to create an AI Guardrail.

• #description ⇒ String

  A description of the AI Guardrail.

• #sensitive_information_policy_config ⇒ Types::AIGuardrailSensitiveInformationPolicyConfig

  The sensitive information policy to configure for the AI Guardrail.

• #topic_policy_config ⇒ Types::AIGuardrailTopicPolicyConfig

  The topic policies to configure for the AI Guardrail.

• #visibility_status ⇒ String

  The visibility status of the Amazon Q in Connect AI Guardrail.

• #word_policy_config ⇒ Types::AIGuardrailWordPolicyConfig

  The word policy you configure for the AI Guardrail.

Instance Attribute Details

#ai_guardrail_id ⇒ String

The identifier of the Amazon Q in Connect AI Guardrail.

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 11788

class UpdateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_guardrail_id,
  :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)
  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)

# File 'lib/aws-sdk-qconnect/types.rb', line 11788

class UpdateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_guardrail_id,
  :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)
  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)

# File 'lib/aws-sdk-qconnect/types.rb', line 11788

class UpdateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_guardrail_id,
  :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)
  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)

# File 'lib/aws-sdk-qconnect/types.rb', line 11788

class UpdateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_guardrail_id,
  :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)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs]..

**A suitable default value is auto-generated.** You should normally not need to pass this option.

[1]: aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 11788

class UpdateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_guardrail_id,
  :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)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#content_policy_config ⇒ Types::AIGuardrailContentPolicyConfig

The content filter policies to configure for the AI Guardrail.

Returns:

• (Types::AIGuardrailContentPolicyConfig)

# File 'lib/aws-sdk-qconnect/types.rb', line 11788

class UpdateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_guardrail_id,
  :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)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#contextual_grounding_policy_config ⇒ Types::AIGuardrailContextualGroundingPolicyConfig

The contextual grounding policy configuration used to create an AI Guardrail.

Returns:

• (Types::AIGuardrailContextualGroundingPolicyConfig)

# File 'lib/aws-sdk-qconnect/types.rb', line 11788

class UpdateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_guardrail_id,
  :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)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#description ⇒ String

A description of the AI Guardrail.

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 11788

class UpdateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_guardrail_id,
  :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)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#sensitive_information_policy_config ⇒ Types::AIGuardrailSensitiveInformationPolicyConfig

The sensitive information policy to configure for the AI Guardrail.

Returns:

• (Types::AIGuardrailSensitiveInformationPolicyConfig)

# File 'lib/aws-sdk-qconnect/types.rb', line 11788

class UpdateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_guardrail_id,
  :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)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#topic_policy_config ⇒ Types::AIGuardrailTopicPolicyConfig

The topic policies to configure for the AI Guardrail.

Returns:

• (Types::AIGuardrailTopicPolicyConfig)

# File 'lib/aws-sdk-qconnect/types.rb', line 11788

class UpdateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_guardrail_id,
  :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)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#visibility_status ⇒ String

The visibility status of the Amazon Q in Connect AI Guardrail.

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 11788

class UpdateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_guardrail_id,
  :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)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#word_policy_config ⇒ Types::AIGuardrailWordPolicyConfig

The word policy you configure for the AI Guardrail.

Returns:

• (Types::AIGuardrailWordPolicyConfig)

# File 'lib/aws-sdk-qconnect/types.rb', line 11788

class UpdateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_guardrail_id,
  :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)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end