GuardrailArgs class
The set of arguments for Guardrail. The set of arguments for Guardrail.
Constructors
-
GuardrailArgs({required Input<
String> blockedInputMessaging, required Input<String> blockedOutputsMessaging, Input<GuardrailContentPolicyConfig?> ? contentPolicyConfig, Input<GuardrailContextualGroundingPolicyConfig?> ? contextualGroundingPolicyConfig, Input<GuardrailCrossRegionConfig?> ? crossRegionConfig, Input<String?> ? description, Input<String?> ? kmsKeyArn, Input<String?> ? name, Input<String?> ? region, Input<GuardrailSensitiveInformationPolicyConfig?> ? sensitiveInformationPolicyConfig, Input<Map< ? tags, Input<String, String> ?>GuardrailTimeouts?> ? timeouts, Input<GuardrailTopicPolicyConfig?> ? topicPolicyConfig, Input<GuardrailWordPolicyConfig?> ? wordPolicyConfig}) -
Creates a new GuardrailArgs.
blockedInputMessagingMessage to return when the guardrail blocks a prompt.blockedOutputsMessagingMessage to return when the guardrail blocks a model response.contentPolicyConfigContent policy config for a guardrail. See Content Policy Config for more information.contextualGroundingPolicyConfigContextual grounding policy config for a guardrail. See Contextual Grounding Policy Config for more information.crossRegionConfigOptional.descriptionDescription of the guardrail or its version.kmsKeyArnThe KMS key with which the guardrail was encrypted at rest.nameName of the guardrail.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.sensitiveInformationPolicyConfigSensitive information policy config for a guardrail. See Sensitive Information Policy Config for more information.tagsKey-value map of resource tags. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.timeoutsOptional.topicPolicyConfigTopic policy config for a guardrail. See Topic Policy Config for more information.wordPolicyConfigWord policy config for a guardrail. See Word Policy Config for more information.const -
GuardrailArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
blockedInputMessaging
→ Input<
String> -
Message to return when the guardrail blocks a prompt.
final
-
blockedOutputsMessaging
→ Input<
String> -
Message to return when the guardrail blocks a model response.
final
-
contentPolicyConfig
→ Input<
GuardrailContentPolicyConfig?> ? -
Content policy config for a guardrail. See Content Policy Config for more information.
final
-
contextualGroundingPolicyConfig
→ Input<
GuardrailContextualGroundingPolicyConfig?> ? -
Contextual grounding policy config for a guardrail. See Contextual Grounding Policy Config for more information.
final
-
crossRegionConfig
→ Input<
GuardrailCrossRegionConfig?> ? -
final
-
description
→ Input<
String?> ? -
Description of the guardrail or its version.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
kmsKeyArn
→ Input<
String?> ? -
The KMS key with which the guardrail was encrypted at rest.
final
-
name
→ Input<
String?> ? -
Name of the guardrail.
final
-
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
sensitiveInformationPolicyConfig
→ Input<
GuardrailSensitiveInformationPolicyConfig?> ? -
Sensitive information policy config for a guardrail. See Sensitive Information Policy Config for more information.
final
-
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
timeouts
→ Input<
GuardrailTimeouts?> ? -
final
-
topicPolicyConfig
→ Input<
GuardrailTopicPolicyConfig?> ? -
Topic policy config for a guardrail. See Topic Policy Config for more information.
final
-
wordPolicyConfig
→ Input<
GuardrailWordPolicyConfig?> ? -
Word policy config for a guardrail. See Word Policy Config for more information.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited