nemoguardrails.library.patronusai.rail_config

Module Contents

Classes

Name	Description
`PatronusEvaluateApiParams`	Config to parameterize the Patronus Evaluate API call
`PatronusEvaluateConfig`	Config for the Patronus Evaluate API call
`PatronusEvaluationSuccessStrategy`	Strategy for determining whether a Patronus Evaluation API
`PatronusRailConfig`	Configuration data for the Patronus Evaluate API

Functions

Name	Description
`build_config_spec`	-

API

class nemoguardrails.library.patronusai.rail_config.PatronusEvaluateApiParams()

Bases: RailConfigBaseModel

Config to parameterize the Patronus Evaluate API call

params

Dict[str, Any]

success_strategy

Optional[PatronusEvaluationSuccessStrategy]

class nemoguardrails.library.patronusai.rail_config.PatronusEvaluateConfig()

Bases: RailConfigBaseModel

Config for the Patronus Evaluate API call

evaluate_config

PatronusEvaluateApiParams

class nemoguardrails.library.patronusai.rail_config.PatronusEvaluationSuccessStrategy

Bases: enum.Enum

Strategy for determining whether a Patronus Evaluation API request should pass, especially when multiple evaluators are called in a single request. ALL_PASS requires all evaluators to pass for success. ANY_PASS requires only one evaluator to pass for success.

ALL_PASS

= 'all_pass'

ANY_PASS

= 'any_pass'

class nemoguardrails.library.patronusai.rail_config.PatronusRailConfig()

Bases: RailConfigBaseModel

Configuration data for the Patronus Evaluate API

input

Optional[PatronusEvaluateConfig]

output

Optional[PatronusEvaluateConfig]

nemoguardrails.library.patronusai.rail_config.build_config_spec() -> nemoguardrails.manifests.config_schema.RailConfigSpec