nemo_microservices.types.shared_params.jailbreak_detection_config#
Module Contents#
Classes#
API#
- class nemo_microservices.types.shared_params.jailbreak_detection_config.JailbreakDetectionConfig#
Bases:
typing_extensions.TypedDict- api_key: str#
None
Secret String with API key for use in Jailbreak requests.
Takes precedence over api_key_env_var
- api_key_env_var: str#
None
Environment variable containing API key for jailbreak detection model
- embedding: str#
None
- length_per_perplexity_threshold: float#
None
The length/perplexity threshold.
- nim_base_url: str#
None
Base URL for jailbreak detection model. Example: http://localhost:8000/v1
- nim_port: int#
None
DEPRECATED: Include port in nim_base_url instead
- nim_server_endpoint: str#
None
Classification path uri. Defaults to ‘classify’ for NemoGuard JailbreakDetect.
- nim_url: str#
None
DEPRECATED: Use nim_base_url instead
- prefix_suffix_perplexity_threshold: float#
None
The prefix/suffix perplexity threshold.
- server_endpoint: str#
None
The endpoint for the jailbreak detection heuristics/model container.