nemoguardrails.guardrails.api_engine

Generic API engine for IORails, calling arbitrary REST endpoints via aiohttp with retry.

Module Contents

Classes

Name	Description
`APIEngine`	Wraps a single API endpoint and makes HTTP calls with retry support.
`APIEngineError`	Raised when an API engine call fails.

Data

log

API

class nemoguardrails.guardrails.api_engine.APIEngine(
    base_url: str,
    endpoint: str,
    api_key: typing.Optional[str] = None,
    timeout_total: float = DEFAULT_TIMEOUT_TOTAL,
    timeout_connect: float = DEFAULT_TIMEOUT_CONNECT,
    max_attempts: int = DEFAULT_MAX_ATTEMPTS
)

Bases: BaseEngine

Wraps a single API endpoint and makes HTTP calls with retry support.

url

str

Full URL for the API endpoint.

nemoguardrails.guardrails.api_engine.APIEngine.call(
    body: dict[str, typing.Any],
    kwargs = {}
) -> dict

async

POST the JSON body to the configured endpoint and return the parsed response.

nemoguardrails.guardrails.api_engine.APIEngine.from_jailbreak_config(
    jailbreak_config: nemoguardrails.rails.llm.config.JailbreakDetectionConfig
) -> nemoguardrails.guardrails.api_engine.APIEngine

classmethod

Create an APIEngine from a JailbreakDetectionConfig.

class nemoguardrails.guardrails.api_engine.APIEngineError(
    message: str,
    endpoint: str,
    status: int | None = None
)

Exception

Bases: Exception

Raised when an API engine call fails.

nemoguardrails.guardrails.api_engine.log = logging.getLogger(__name__)