nemo_microservices.types.shared.jailbreak_detection_config#

Module Contents#

Classes#

API#

class nemo_microservices.types.shared.jailbreak_detection_config.JailbreakDetectionConfig(/, **data: Any)#

Bases: nemo_microservices._models.BaseModel

api_key: str | None#

None

Secret String with API key for use in Jailbreak requests.

Takes precedence over api_key_env_var

api_key_env_var: str | None#

None

Environment variable containing API key for jailbreak detection model

embedding: str | None#

None

length_per_perplexity_threshold: float | None#

None

The length/perplexity threshold.

nim_base_url: str | None#

None

Base URL for jailbreak detection model. Example: http://localhost:8000/v1

nim_port: int | None#

None

DEPRECATED: Include port in nim_base_url instead

nim_server_endpoint: str | None#

None

Classification path uri. Defaults to ‘classify’ for NemoGuard JailbreakDetect.

nim_url: str | None#

None

DEPRECATED: Use nim_base_url instead

prefix_suffix_perplexity_threshold: float | None#

None

The prefix/suffix perplexity threshold.

server_endpoint: str | None#

None

The endpoint for the jailbreak detection heuristics/model container.