Skip to content

Helper

Helper utilities for guardrail components.

generate_colang_config(allowed_topics=None, denied_topics=None, topic_safety_mode=TopicSafetyMode.HYBRID, include_core_restrictions=True, enabled_core_restrictions=None)

Generate Colang configuration based on topic safety settings.

Parameters:

Name Type Description Default
allowed_topics list[str] | None

List of allowed topics. If None, uses default allowed topics.

None
denied_topics list[str] | None

List of business-specific denied topics. If None, uses default business denied topics. Note: Core safety restrictions (violence, medical advice, etc.) are included by default.

None
topic_safety_mode TopicSafetyMode | str

Topic safety mode. Options: "allowlist", "denylist", "hybrid", "disabled". Defaults to TopicSafetyMode.HYBRID.

HYBRID
include_core_restrictions bool

Whether to include core safety restrictions. If False, only business-specific topic safety will be included. Defaults to True.

True
enabled_core_restrictions list[str] | None

List of enabled core restriction categories. If None, uses default enabled core restrictions. Only used when include_core_restrictions is True.

None

Returns:

Name Type Description
str str

Generated Colang configuration string.

Raises:

Type Description
ValueError

If topic_safety_mode is invalid or configuration is invalid.