ReferencePython SDK ReferenceNemoguardrailsLibraryJailbreak Detection

nemoguardrails.library.jailbreak_detection.rail_config

View as Markdown

Module Contents

Classes

NameDescription
JailbreakDetectionConfigConfiguration data for jailbreak detection.

Functions

NameDescription
build_config_spec-

Data

log

API

class nemoguardrails.library.jailbreak_detection.rail_config.JailbreakDetectionConfig()

Bases: RailConfigBaseModel

Configuration data for jailbreak detection.

api_key
Optional[SecretStr]
api_key_env_var
Optional[str]
embedding
Optional[str]
length_per_perplexity_threshold
float
nim_base_url
Optional[str]
nim_port
Optional[int]
nim_server_endpoint
Optional[str]
nim_url
Optional[str]
prefix_suffix_perplexity_threshold
float
server_endpoint
Optional[str]
nemoguardrails.library.jailbreak_detection.rail_config.JailbreakDetectionConfig.get_api_key() -> typing.Optional[str]

Helper to return an API key (if it exists) from a Jailbreak configuration. This can come from (in descending order of priority):

  1. The api_key field, a Pydantic SecretStr from which we extract the full string.
  2. The api_key_env_var field, a string stored in this environment variable.

If neither is found, None is returned.

Migrate deprecated nim_url/nim_port fields to nim_base_url format.

Validate URL formats for endpoints.

nemoguardrails.library.jailbreak_detection.rail_config.build_config_spec() -> nemoguardrails.manifests.config_schema.RailConfigSpec
 
nemoguardrails.library.jailbreak_detection.rail_config.log = logging.getLogger(__name__)