ReferencePython SDK ReferenceNemoguardrailsLibraryPangea

nemoguardrails.library.pangea.actions

View as Markdown

Module Contents

Classes

Functions

NameDescription
_pangea_outcome-
get_pangea_config-
pangea_ai_guardEvaluate input or output content with Pangea AI Guard.

Data

log

API

class nemoguardrails.library.pangea.actions.Message()

Bases: BaseModel

content
str
role
str
class nemoguardrails.library.pangea.actions.TextGuardResponse()

Bases: BaseModel

result
TextGuardResult
class nemoguardrails.library.pangea.actions.TextGuardResult()

Bases: BaseModel

blocked
Optional[bool] = None

Whether or not the prompt triggered a block detection.

bot_message
Optional[str] = None
prompt_messages
Optional[list[Message]] = None

Updated structured prompt, if applicable.

transformed
Optional[bool] = None

Whether or not the original input was transformed.

user_message
Optional[str] = None
nemoguardrails.library.pangea.actions._pangea_outcome(
    result: nemoguardrails.library.pangea.actions.TextGuardResult,
    mode: typing_extensions.Literal['input', 'output']
) -> nemoguardrails.actions.rail_outcome.RailOutcome
 
nemoguardrails.library.pangea.actions.get_pangea_config(
    config: nemoguardrails.rails.llm.config.RailsConfig
) -> nemoguardrails.rails.llm.config.PangeaRailConfig
 
nemoguardrails.library.pangea.actions.pangea_ai_guard(
    mode: typing_extensions.Literal['input', 'output'],
    config: nemoguardrails.rails.llm.config.RailsConfig,
    context: collections.abc.Mapping[str, typing.Any] = {},
    user_message: typing.Optional[str] = None,
    bot_message: typing.Optional[str] = None,
    http_client: typing.Optional[nemoguardrails.http.HTTPClient] = None
) -> nemoguardrails.actions.rail_outcome.RailOutcome
async

Evaluate input or output content with Pangea AI Guard.

Provider results may allow, block, or transform the selected message. Failures while calling or validating the provider response are logged and fail open with the original content.

Parameters:

mode
Literal['input', 'output']

Whether to evaluate input or output content.

config
RailsConfig

Rails configuration containing the Pangea settings.

context
Mapping[str, Any]Defaults to {}

Runtime context used to resolve messages.

user_message
Optional[str]Defaults to None

Optional user message overriding the context value.

bot_message
Optional[str]Defaults to None

Optional bot message overriding the context value.

http_client
Optional[HTTPClient]Defaults to None

Optional caller-owned HTTP client.

Returns: RailOutcome

The provider decision, or an allow outcome after a provider failure.

Raises:

  • ValueError: If the API token or content is missing.
nemoguardrails.library.pangea.actions.log = logging.getLogger(__name__)