Class: Aws::QConnect::Types::CreateAIGuardrailRequest

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

Overview

See Also:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Attribute Details

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


2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
 
# File 'lib/aws-sdk-qconnect/types.rb', line 2357

class CreateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :visibility_status,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags)
  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) 


2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
 
# File 'lib/aws-sdk-qconnect/types.rb', line 2357

class CreateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :visibility_status,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags)
  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) 


2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
 
# File 'lib/aws-sdk-qconnect/types.rb', line 2357

class CreateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :visibility_status,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags)
  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) 


2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
 
# File 'lib/aws-sdk-qconnect/types.rb', line 2357

class CreateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :visibility_status,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags)
  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:



2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
 
# File 'lib/aws-sdk-qconnect/types.rb', line 2357

class CreateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :visibility_status,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags)
  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:



2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
 
# File 'lib/aws-sdk-qconnect/types.rb', line 2357

class CreateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :visibility_status,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#description ⇒ String

A description of the AI Guardrail.

Returns:

  • (String) 


2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
 
# File 'lib/aws-sdk-qconnect/types.rb', line 2357

class CreateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :visibility_status,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#name ⇒ String

The name of the AI Guardrail.

Returns:

  • (String) 


2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
 
# File 'lib/aws-sdk-qconnect/types.rb', line 2357

class CreateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :visibility_status,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags)
  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:



2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
 
# File 'lib/aws-sdk-qconnect/types.rb', line 2357

class CreateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :visibility_status,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags)
  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>) 


2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
 
# File 'lib/aws-sdk-qconnect/types.rb', line 2357

class CreateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :visibility_status,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags)
  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:



2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
 
# File 'lib/aws-sdk-qconnect/types.rb', line 2357

class CreateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :visibility_status,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end

#visibility_status ⇒ String

The visibility status of the AI Guardrail.

Returns:

  • (String) 


2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
 
# File 'lib/aws-sdk-qconnect/types.rb', line 2357

class CreateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :visibility_status,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags)
  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:



2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
 
# File 'lib/aws-sdk-qconnect/types.rb', line 2357

class CreateAIGuardrailRequest < Struct.new(
  :client_token,
  :assistant_id,
  :name,
  :blocked_input_messaging,
  :blocked_outputs_messaging,
  :visibility_status,
  :description,
  :topic_policy_config,
  :content_policy_config,
  :word_policy_config,
  :sensitive_information_policy_config,
  :contextual_grounding_policy_config,
  :tags)
  SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
  include Aws::Structure
end