@aws-cdk/aws-bedrock-alpha.Topic

Experimental

@aws-cdk/aws-bedrock-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

Topic Class

Represents predefined topics that can be used to filter content.

Stability

Experimental

Source

bedrock/guardrails/guardrail-filters.ts

Example

const guardrail = new bedrock.Guardrail(this, 'bedrockGuardrails', {
  guardrailName: 'my-BedrockGuardrails',
  // Configure tier for topic filters (optional)
  topicsTierConfig: bedrock.TierConfig.STANDARD,
});

// Use a predefined topic
guardrail.addDeniedTopicFilter(bedrock.Topic.FINANCIAL_ADVICE);

// Create a custom topic with input/output actions
guardrail.addDeniedTopicFilter(
  bedrock.Topic.custom({
    name: 'Legal_Advice',
    definition: 'Offering guidance or suggestions on legal matters, legal actions, interpretation of laws, or legal rights and responsibilities.',
    examples: [
      'Can I sue someone for this?',
      'What are my legal rights in this situation?',
      'Is this action against the law?',
      'What should I do to file a legal complaint?',
      'Can you explain this law to me?',
    ],
    // props below are optional
    inputAction: bedrock.GuardrailAction.BLOCK,
    inputEnabled: true,
    outputAction: bedrock.GuardrailAction.NONE,
    outputEnabled: true,
  })
);

Properties

definitionstringdefinitionstrdefinitionStringDefinitionstringDefinition*string#

Definition of the topic.

examples?may be undefinedstring[]examples?may be undefinedtyping.List[str]examples?may be undefinedList<String>Examples?may be undefinedstring[]Examples?may be undefined*[]*string#

Representative phrases that refer to the topic.

FINANCIAL_ADVICETopicfinancial_adviceTopicFINANCIAL_ADVICETopicFINANCIAL_ADVICETopicFINANCIAL_ADVICETopicstatic#

Filter for financial advice and investment recommendations.

INAPPROPRIATE_CONTENTTopicinappropriate_contentTopicINAPPROPRIATE_CONTENTTopicINAPPROPRIATE_CONTENTTopicINAPPROPRIATE_CONTENTTopicstatic#

Filter for inappropriate or explicit content.

inputAction?may be undefinedGuardrailActioninput_action?may be undefinedGuardrailActioninputAction?may be undefinedGuardrailActionInputAction?may be undefinedGuardrailActionInputAction?may be undefinedGuardrailAction= GuardrailAction.BLOCK#

The action to take when a topic is detected in the input.

inputEnabled?may be undefinedbooleaninput_enabled?may be undefinedboolinputEnabled?may be undefinedBooleanInputEnabled?may be undefinedboolInputEnabled?may be undefined*bool= true#

Whether the topic filter is enabled for input.

LEGAL_ADVICETopiclegal_adviceTopicLEGAL_ADVICETopicLEGAL_ADVICETopicLEGAL_ADVICETopicstatic#

Filter for legal advice and recommendations.

MEDICAL_ADVICETopicmedical_adviceTopicMEDICAL_ADVICETopicMEDICAL_ADVICETopicMEDICAL_ADVICETopicstatic#

Filter for medical advice and health recommendations.

namestringnamestrnameStringNamestringName*string#

The name of the topic to deny.

outputAction?may be undefinedGuardrailActionoutput_action?may be undefinedGuardrailActionoutputAction?may be undefinedGuardrailActionOutputAction?may be undefinedGuardrailActionOutputAction?may be undefinedGuardrailAction= GuardrailAction.BLOCK#

The action to take when a topic is detected in the output.

outputEnabled?may be undefinedbooleanoutput_enabled?may be undefinedbooloutputEnabled?may be undefinedBooleanOutputEnabled?may be undefinedboolOutputEnabled?may be undefined*bool= true#

Whether the topic filter is enabled for output.

POLITICAL_ADVICETopicpolitical_adviceTopicPOLITICAL_ADVICETopicPOLITICAL_ADVICETopicPOLITICAL_ADVICETopicstatic#

Filter for political advice and recommendations.

Methods

custom(props: CustomTopicProps): Topic // chainable@staticmethod def custom(props: CustomTopicProps) -> Topicpublic static Topic custom(CustomTopicProps props)public static Topic Custom(CustomTopicProps props)func Custom(Props CustomTopicProps) Topicstatic#

Create a custom topic filter.

1 parameter

Parameters

• propspropspropspropsProps — Properties for the custom topic filter.