> This page is for version v0.25.0.
> For other versions, use one of these documentation indexes:
> - Latest (default): https://docs.nvidia.com/nemo/guardrails/latest/llms.txt
> - v0.25.0: https://docs.nvidia.com/nemo/guardrails/v0.25.0/llms.txt
> - v0.24.1: https://docs.nvidia.com/nemo/guardrails/v0.24.1/llms.txt
> - v0.24.0: https://docs.nvidia.com/nemo/guardrails/v0.24.0/llms.txt
> - v0.23.0: https://docs.nvidia.com/nemo/guardrails/v0.23.0/llms.txt
> - v0.22.0: https://docs.nvidia.com/nemo/guardrails/v0.22.0/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/nemo/guardrails/llms.txt.

# nemoguardrails.rails.llm.config

Module for the configuration of rails.

## Module Contents

### Classes

| Name                                                                                        | Description                                                                                             |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| [`ActionRails`](#nemoguardrails-rails-llm-config-ActionRails)                               | Configuration of action rails.                                                                          |
| [`CacheStatsConfig`](#nemoguardrails-rails-llm-config-CacheStatsConfig)                     | Configuration for cache statistics tracking and logging.                                                |
| [`CoreConfig`](#nemoguardrails-rails-llm-config-CoreConfig)                                 | Settings for core internal mechanics.                                                                   |
| [`DialogRails`](#nemoguardrails-rails-llm-config-DialogRails)                               | Configuration of topical rails.                                                                         |
| [`Document`](#nemoguardrails-rails-llm-config-Document)                                     | Configuration for documents that should be used for question answering.                                 |
| [`EmbeddingSearchProvider`](#nemoguardrails-rails-llm-config-EmbeddingSearchProvider)       | Configuration of a embedding search provider.                                                           |
| [`EmbeddingsCacheConfig`](#nemoguardrails-rails-llm-config-EmbeddingsCacheConfig)           | Configuration for the caching embeddings.                                                               |
| [`HooksServerConfig`](#nemoguardrails-rails-llm-config-HooksServerConfig)                   | The tool policy `nemoguardrails hooks-server` applies to each hook's call; no engine reads it.          |
| [`InputRails`](#nemoguardrails-rails-llm-config-InputRails)                                 | Configuration of input rails.                                                                           |
| [`Instruction`](#nemoguardrails-rails-llm-config-Instruction)                               | Configuration for instructions in natural language that should be passed to the LLM.                    |
| [`KnowledgeBaseConfig`](#nemoguardrails-rails-llm-config-KnowledgeBaseConfig)               | -                                                                                                       |
| [`LogAdapterConfig`](#nemoguardrails-rails-llm-config-LogAdapterConfig)                     | -                                                                                                       |
| [`MessageTemplate`](#nemoguardrails-rails-llm-config-MessageTemplate)                       | Template for a message structure.                                                                       |
| [`MetricsConfig`](#nemoguardrails-rails-llm-config-MetricsConfig)                           | OpenTelemetry Metrics Configuration.                                                                    |
| [`Model`](#nemoguardrails-rails-llm-config-Model)                                           | Configuration of a model used by the rails engine.                                                      |
| [`ModelCacheConfig`](#nemoguardrails-rails-llm-config-ModelCacheConfig)                     | Configuration for model caching.                                                                        |
| [`OutputRails`](#nemoguardrails-rails-llm-config-OutputRails)                               | Configuration of output rails.                                                                          |
| [`OutputRailsStreamingConfig`](#nemoguardrails-rails-llm-config-OutputRailsStreamingConfig) | Configuration for managing streaming output of LLM tokens.                                              |
| [`Rails`](#nemoguardrails-rails-llm-config-Rails)                                           | Configuration of specific rails.                                                                        |
| [`RailsConfig`](#nemoguardrails-rails-llm-config-RailsConfig)                               | Configuration object for the models and the rails.                                                      |
| [`RailsConfigData`](#nemoguardrails-rails-llm-config-RailsConfigData)                       | -                                                                                                       |
| [`RetrievalRails`](#nemoguardrails-rails-llm-config-RetrievalRails)                         | Configuration of retrieval rails.                                                                       |
| [`SingleCallConfig`](#nemoguardrails-rails-llm-config-SingleCallConfig)                     | Configuration for the single LLM call option for topical rails.                                         |
| [`SpanFormat`](#nemoguardrails-rails-llm-config-SpanFormat)                                 | -                                                                                                       |
| [`TaskPrompt`](#nemoguardrails-rails-llm-config-TaskPrompt)                                 | Configuration for prompts that will be used for a specific task.                                        |
| [`ToolCallRails`](#nemoguardrails-rails-llm-config-ToolCallRails)                           | Configuration of tool call rails.                                                                       |
| [`ToolEntry`](#nemoguardrails-rails-llm-config-ToolEntry)                                   | A tool in `hooks_server.allowed_tools` or `blocked_tools`, named with the arguments its entry is about. |
| [`ToolResultRails`](#nemoguardrails-rails-llm-config-ToolResultRails)                       | Configuration of tool result rails.                                                                     |
| [`TracingConfig`](#nemoguardrails-rails-llm-config-TracingConfig)                           | -                                                                                                       |
| [`UserMessagesConfig`](#nemoguardrails-rails-llm-config-UserMessagesConfig)                 | Configuration for how the user messages are interpreted.                                                |
| [`_RailsConfigDataBase`](#nemoguardrails-rails-llm-config-_RailsConfigDataBase)             | Configuration data for specific rails that are supported out-of-the-box.                                |
| [`_ToolRailFlow`](#nemoguardrails-rails-llm-config-_ToolRailFlow)                           | A configured tool rail flow, with its section, its direction and, for a per-tool flow, its tool.        |

### Functions

| Name                                                                                                      | Description                                                                                                 |
| --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| [`__dir__`](#nemoguardrails-rails-llm-config-__dir__)                                                     | -                                                                                                           |
| [`__getattr__`](#nemoguardrails-rails-llm-config-__getattr__)                                             | -                                                                                                           |
| [`_bound_model_types`](#nemoguardrails-rails-llm-config-_bound_model_types)                               | Yield the model types *surface* binds for a flow's *params*: baked-in literals and model `$params` it sets. |
| [`_first_repeated_tool_name`](#nemoguardrails-rails-llm-config-_first_repeated_tool_name)                 | The first tool *tool_list* names a second time, or None when it names each tool once.                       |
| [`_generate_rails_flows`](#nemoguardrails-rails-llm-config-_generate_rails_flows)                         | Generates flow definitions from the list of flows.                                                          |
| [`_get_flow_model`](#nemoguardrails-rails-llm-config-_get_flow_model)                                     | Helper to return a model name from a flow definition                                                        |
| [`_get_flow_name`](#nemoguardrails-rails-llm-config-_get_flow_name)                                       | Helper to return a model name from a flow definition                                                        |
| [`_get_rails_flows`](#nemoguardrails-rails-llm-config-_get_rails_flows)                                   | Extracts the list of flows from the raw_config dictionary.                                                  |
| [`_has_input_output_config_rails`](#nemoguardrails-rails-llm-config-_has_input_output_config_rails)       | Checks if the raw configuration has input/output rails configured.                                          |
| [`_join_config`](#nemoguardrails-rails-llm-config-_join_config)                                           | Helper to join two configuration; *source* names where *additional_config* was read from, for errors.       |
| [`_join_dict`](#nemoguardrails-rails-llm-config-_join_dict)                                               | Joins two dictionaries recursively.                                                                         |
| [`_join_rails_configs`](#nemoguardrails-rails-llm-config-_join_rails_configs)                             | Helper to join two rails configuration.                                                                     |
| [`_load_imported_paths`](#nemoguardrails-rails-llm-config-_load_imported_paths)                           | Load recursively all the imported path in the specified raw_config.                                         |
| [`_load_path`](#nemoguardrails-rails-llm-config-_load_path)                                               | Load a configuration object from the specified path.                                                        |
| [`_parse_colang_files_recursively`](#nemoguardrails-rails-llm-config-_parse_colang_files_recursively)     | Helper function to parse all the Colang files.                                                              |
| [`_tool_entry_name`](#nemoguardrails-rails-llm-config-_tool_entry_name)                                   | The tool a list entry names.                                                                                |
| [`_tool_rail_flows`](#nemoguardrails-rails-llm-config-_tool_rail_flows)                                   | Yield each tool rail flow, global flows before per-tool ones.                                               |
| [`_unique_list_concat`](#nemoguardrails-rails-llm-config-_unique_list_concat)                             | Concatenates two lists ensuring all elements are unique.                                                    |
| [`_validate_rail_prompts`](#nemoguardrails-rails-llm-config-_validate_rail_prompts)                       | -                                                                                                           |
| [`_validate_self_check_rail_prompts`](#nemoguardrails-rails-llm-config-_validate_self_check_rail_prompts) | Ensure every enabled self-check rail has a prompt for its resolved task.                                    |
| [`_warn_unknown_config_key`](#nemoguardrails-rails-llm-config-_warn_unknown_config_key)                   | -                                                                                                           |
| [`_warn_unknown_config_keys`](#nemoguardrails-rails-llm-config-_warn_unknown_config_keys)                 | Compare with validated values to follow the selected union and preserve open dictionaries.                  |
| [`merge_two_dicts`](#nemoguardrails-rails-llm-config-merge_two_dicts)                                     | Merges the fields of two dictionaries recursively.                                                          |

### Data

[`JAILBREAK_FLOW_HEURISTICS`](#nemoguardrails-rails-llm-config-JAILBREAK_FLOW_HEURISTICS)

[`JAILBREAK_FLOW_MODEL`](#nemoguardrails-rails-llm-config-JAILBREAK_FLOW_MODEL)

[`MODEL_PREFIX`](#nemoguardrails-rails-llm-config-MODEL_PREFIX)

[`ToolInputRails`](#nemoguardrails-rails-llm-config-ToolInputRails)

[`ToolOutputRails`](#nemoguardrails-rails-llm-config-ToolOutputRails)

[`_default_config`](#nemoguardrails-rails-llm-config-_default_config)

[`_default_config_v2`](#nemoguardrails-rails-llm-config-_default_config_v2)

[`colang_path_dirs`](#nemoguardrails-rails-llm-config-colang_path_dirs)

[`guardrails_stdlib_path`](#nemoguardrails-rails-llm-config-guardrails_stdlib_path)

[`log`](#nemoguardrails-rails-llm-config-log)

[`standard_library_path`](#nemoguardrails-rails-llm-config-standard_library_path)

### API

```python
class nemoguardrails.rails.llm.config.ActionRails()
```

**Bases:** `BaseModel`

Configuration of action rails.

Action rails control various options related to the execution of actions.
Currently, only

In the future multiple options will be added, e.g., what input validation should be
performed per action, output validation, throttling, disabling, etc.

**`instant_actions`** `Optional[List[str]]`

---

```python
class nemoguardrails.rails.llm.config.CacheStatsConfig()
```

**Bases:** `BaseModel`

Configuration for cache statistics tracking and logging.

**`enabled`** `bool`

---

**`log_interval`** `Optional[float]`

---

```python
class nemoguardrails.rails.llm.config.CoreConfig()
```

**Bases:** `BaseModel`

Settings for core internal mechanics.

**`embedding_search_provider`** `EmbeddingSearchProvider`

---

```python
class nemoguardrails.rails.llm.config.DialogRails()
```

**Bases:** `BaseModel`

Configuration of topical rails.

**`single_call`** `SingleCallConfig`

---

**`user_messages`** `UserMessagesConfig`

---

```python
class nemoguardrails.rails.llm.config.Document()
```

**Bases:** `BaseModel`

Configuration for documents that should be used for question answering.

**`content`** `str`

---

**`format`** `str`

---

```python
class nemoguardrails.rails.llm.config.EmbeddingSearchProvider()
```

**Bases:** `BaseModel`

Configuration of a embedding search provider.

**`cache`** `EmbeddingsCacheConfig = Field(default_factory=EmbeddingsCacheConfig)`

---

**`name`** `str`

---

**`parameters`** `Dict[str, Any] = Field(default_factory=dict)`

---

```python
class nemoguardrails.rails.llm.config.EmbeddingsCacheConfig()
```

**Bases:** `BaseModel`

Configuration for the caching embeddings.

**`enabled`** `bool`

---

**`key_generator`** `str`

---

**`store`** `str`

---

**`store_config`** `Dict[str, Any]`

---

```python
nemoguardrails.rails.llm.config.EmbeddingsCacheConfig.to_dict()
```

```python
class nemoguardrails.rails.llm.config.HooksServerConfig()
```

**Bases:** `BaseModel`

The tool policy `nemoguardrails hooks-server` applies to each hook's call; no engine reads it.

**`allow_unlisted_tools`** `bool`

---

**`allowed_tools`** `List[Union[str, ToolEntry]]`

---

**`blocked_tools`** `List[Union[str, ToolEntry]]`

---

**`can_deny`** `bool`

Whether the policy can deny a call: it blocks something, denies unlisted tools, or limits a tool's arguments.

---

**`model_config`** `= ConfigDict(extra='forbid')`

---

```python
nemoguardrails.rails.llm.config.HooksServerConfig.check_tool_lists() -> nemoguardrails.rails.llm.config.HooksServerConfig
```

Refuse tool lists that name a tool twice, or that allow a tool they block by name.

```python
class nemoguardrails.rails.llm.config.InputRails()
```

**Bases:** `BaseModel`

Configuration of input rails.

**`flows`** `List[str]`

---

**`parallel`** `Optional[bool]`

---

**`speculative_generation`** `Optional[bool]`

---

```python
class nemoguardrails.rails.llm.config.Instruction()
```

**Bases:** `BaseModel`

Configuration for instructions in natural language that should be passed to the LLM.

**`content`** `str`

---

**`type`** `str`

---

```python
class nemoguardrails.rails.llm.config.KnowledgeBaseConfig()
```

**Bases:** `BaseModel`

**`embedding_search_provider`** `EmbeddingSearchProvider`

---

**`folder`** `str`

---

```python
class nemoguardrails.rails.llm.config.LogAdapterConfig()
```

**Bases:** `BaseModel`

**`model_config`** `= ConfigDict(extra='allow')`

---

**`name`** `str`

---

```python
class nemoguardrails.rails.llm.config.MessageTemplate()
```

**Bases:** `BaseModel`

Template for a message structure.

**`content`** `str = Field(description='The content of the message.')`

---

**`type`** `str`

---

```python
class nemoguardrails.rails.llm.config.MetricsConfig()
```

**Bases:** `BaseModel`

OpenTelemetry Metrics Configuration.
Configures and enables Metrics independent of OTEL Traces.

**`enabled`** `bool`

---

```python
class nemoguardrails.rails.llm.config.Model()
```

**Bases:** `BaseModel`

Configuration of a model used by the rails engine.

Typically, the main model is configured e.g.:
\{
"type": "main",
"engine": "openai",
"model": "gpt-4o-mini"
}

**`api_key_env_var`** `Optional[str]`

---

**`cache`** `Optional[ModelCacheConfig]`

---

**`engine`** `str`

---

**`mode`** `Literal['chat', 'text']`

---

**`model`** `Optional[str]`

---

**`parameters`** `Dict[str, Any] = Field(default_factory=dict)`

---

**`type`** `str`

---

```python
nemoguardrails.rails.llm.config.Model.model_must_be_none_empty() -> nemoguardrails.rails.llm.config.Model
```

Validate that a model name is present either directly or in parameters.

```python
nemoguardrails.rails.llm.config.Model.set_and_validate_model(
    data: typing.Any
) -> typing.Any
```

classmethod

```python
class nemoguardrails.rails.llm.config.ModelCacheConfig()
```

**Bases:** `BaseModel`

Configuration for model caching.

**`enabled`** `bool`

---

**`maxsize`** `int`

---

**`stats`** `CacheStatsConfig`

---

```python
class nemoguardrails.rails.llm.config.OutputRails()
```

**Bases:** `BaseModel`

Configuration of output rails.

**`flows`** `List[str]`

---

**`parallel`** `Optional[bool]`

---

**`streaming`** `OutputRailsStreamingConfig`

---

```python
class nemoguardrails.rails.llm.config.OutputRailsStreamingConfig()
```

**Bases:** `BaseModel`

Configuration for managing streaming output of LLM tokens.

**`chunk_size`** `int`

---

**`context_size`** `int`

---

**`enabled`** `bool`

---

**`model_config`** `= ConfigDict(extra='allow')`

---

**`stream_first`** `bool`

---

```python
class nemoguardrails.rails.llm.config.Rails()
```

**Bases:** `BaseModel`

Configuration of specific rails.

**`actions`** `ActionRails`

---

**`config`** `RailsConfigData`

---

**`dialog`** `DialogRails`

---

**`input`** `InputRails`

---

**`output`** `OutputRails`

---

**`retrieval`** `RetrievalRails`

---

**`tool_call`** `ToolCallRails`

---

**`tool_input`** `ToolResultRails`

---

**`tool_output`** `ToolCallRails`

---

**`tool_result`** `ToolResultRails`

---

```python
nemoguardrails.rails.llm.config.Rails.__setattr__(
    name: str,
    value: typing.Any
) -> None
```

```python
nemoguardrails.rails.llm.config.Rails._sync_deprecated_tool_rail_fields() -> None
```

```python
nemoguardrails.rails.llm.config.Rails.migrate_deprecated_tool_rail_fields(
    values: typing.Any
) -> typing.Any
```

classmethod

```python
nemoguardrails.rails.llm.config.Rails.sync_deprecated_tool_rail_fields() -> nemoguardrails.rails.llm.config.Rails
```

```python
class nemoguardrails.RailsConfig()
```

**Bases:** `BaseModel`

Configuration object for the models and the rails.

TODO: add typed config for user_messages, bot_messages, and flows.

**`actions_server_url`** `Optional[str]`

---

**`bot_messages`** `Dict[str, List[str]]`

---

**`colang_version`** `str`

---

**`config_path`** `Optional[str]`

---

**`core`** `CoreConfig`

---

**`custom_data`** `Dict`

---

**`docs`** `Optional[List[Document]]`

---

**`enable_multi_step_generation`** `Optional[bool]`

---

**`enable_rails_exceptions`** `bool`

---

**`event_source_uid`** `str`

---

**`flows`** `List[Union[Dict, Any]]`

---

**`hooks_server`** `HooksServerConfig`

---

**`import_paths`** `Optional[List[str]]`

---

**`imported_paths`** `Optional[Dict[str, str]]`

---

**`instructions`** `Optional[List[Instruction]]`

---

**`knowledge_base`** `KnowledgeBaseConfig`

---

**`lowest_temperature`** `Optional[float]`

---

**`metrics`** `MetricsConfig`

---

**`models`** `List[Model]`

---

**`passthrough`** `Optional[bool]`

---

**`prompting_mode`** `Optional[str]`

---

**`prompts`** `Optional[List[TaskPrompt]]`

---

**`rails`** `Rails`

---

**`raw_llm_call_action`** `Optional[str]`

---

**`sample_conversation`** `Optional[str]`

---

**`streaming`** `bool`

---

**`tracing`** `TracingConfig`

---

**`user_messages`** `Dict[str, List[str]]`

---

```python
nemoguardrails.RailsConfig.__add__(
    other
)
```

Adds two RailsConfig objects.

```python
nemoguardrails.RailsConfig.check_jailbreak_detection_config(
    values
)
```

classmethod

Validate jailbreak detection configuration against enabled flows.

```python
nemoguardrails.RailsConfig.check_model_exists_for_input_rails(
    values
)
```

classmethod

Make sure we have a model for each input rail where one is provided using \$model=\<model_type>

```python
nemoguardrails.RailsConfig.check_model_exists_for_output_rails(
    values
)
```

classmethod

Make sure we have a model for each output rail where one is provided using \$model=\<model_type>

```python
nemoguardrails.RailsConfig.check_model_exists_for_tool_rails() -> nemoguardrails.rails.llm.config.RailsConfig
```

Make sure we have every model a tool rail's manifest binds, such as the judge named by `$model=`

```python
nemoguardrails.RailsConfig.check_output_parser_exists(
    values
)
```

classmethod

```python
nemoguardrails.RailsConfig.check_prompt_exist_for_self_check_rails(
    values
)
```

classmethod

```python
nemoguardrails.RailsConfig.check_streaming_can_apply_output_rewrites(
    values
)
```

classmethod

Reject configs whose output rails transform response with `stream_first` == True

```python
nemoguardrails.RailsConfig.fill_in_default_values_for_v2_x(
    values
)
```

classmethod

```python
nemoguardrails.RailsConfig.from_content(
    colang_content: typing.Optional[str] = None,
    yaml_content: typing.Optional[str] = None,
    config: typing.Optional[dict] = None
)
```

classmethod

Loads a configuration from the provided colang/YAML content/config dict.

```python
nemoguardrails.RailsConfig.from_path(
    config_path: str
)
```

classmethod

Loads a configuration from a given path.

Supports loading a from a single file, or from a directory.

```python
nemoguardrails.RailsConfig.parse_object(
    obj
)
```

classmethod

Parses a configuration object from a given dictionary.

```python
nemoguardrails.RailsConfig.validate_models_api_key_env_var(
    models
)
```

classmethod

Model API Key Env var must be set to make LLM calls

```python
nemoguardrails.RailsConfig.warn_unknown_keys(
    values: typing.Any,
    handler: pydantic.ModelWrapValidatorHandler[nemoguardrails.rails.llm.config.RailsConfig]
) -> nemoguardrails.rails.llm.config.RailsConfig
```

classmethod

```python
class nemoguardrails.rails.llm.config.RailsConfigData()
```

**Bases:** [\_RailsConfigDataBase](#nemoguardrails-rails-llm-config-_RailsConfigDataBase)

```python
nemoguardrails.rails.llm.config.RailsConfigData.__getattr__(
    name: str
) -> typing.Any
```

```python
class nemoguardrails.rails.llm.config.RetrievalRails()
```

**Bases:** `BaseModel`

Configuration of retrieval rails.

**`flows`** `List[str]`

---

```python
class nemoguardrails.rails.llm.config.SingleCallConfig()
```

**Bases:** `BaseModel`

Configuration for the single LLM call option for topical rails.

**`enabled`** `bool = False`

---

**`fallback_to_multiple_calls`** `bool`

---

```python
class nemoguardrails.rails.llm.config.SpanFormat
```

**Bases:** `enum.Enum`

**`legacy`** `= 'legacy'`

---

**`opentelemetry`** `= 'opentelemetry'`

---

```python
class nemoguardrails.rails.llm.config.TaskPrompt()
```

**Bases:** `BaseModel`

Configuration for prompts that will be used for a specific task.

**`content`** `Optional[str]`

---

**`max_length`** `Optional[int]`

---

**`max_tokens`** `Optional[int]`

---

**`messages`** `Optional[List[Union[MessageTemplate, str]]]`

---

**`mode`** `Optional[str]`

---

**`models`** `Optional[List[str]]`

---

**`output_parser`** `Optional[str]`

---

**`stop`** `Optional[List[str]]`

---

**`task`** `str`

---

```python
nemoguardrails.rails.llm.config.TaskPrompt.check_fields(
    values
)
```

classmethod

```python
class nemoguardrails.rails.llm.config.ToolCallRails()
```

**Bases:** `BaseModel`

Configuration of tool call rails.

Tool call rails are applied to tool calls before they are executed.
They can validate tool names, parameters, and context to ensure safe tool usage.

**`flows`** `List[str]`

---

**`parallel`** `Optional[bool]`

---

**`per_tool`** `Dict[str, List[str]]`

---

```python
class nemoguardrails.rails.llm.config.ToolEntry()
```

**Bases:** `BaseModel`

A tool in `hooks_server.allowed_tools` or `blocked_tools`, named with the arguments its entry is about.

**`arguments`** `List[str]`

---

**`model_config`** `= ConfigDict(extra='forbid')`

---

**`name`** `str`

---

```python
nemoguardrails.rails.llm.config.ToolEntry.check_arguments_are_unique(
    arguments: typing.List[str]
) -> typing.List[str]
```

classmethod

Refuse an entry that names an argument twice.

```python
class nemoguardrails.rails.llm.config.ToolResultRails()
```

**Bases:** `BaseModel`

Configuration of tool result rails.

Tool result rails are applied to tool results before they are processed.
They can validate, filter, or transform tool results for security and safety.

**`flows`** `List[str]`

---

**`parallel`** `Optional[bool]`

---

**`per_tool`** `Dict[str, List[str]]`

---

```python
class nemoguardrails.rails.llm.config.TracingConfig()
```

**Bases:** `BaseModel`

**`adapters`** `List[LogAdapterConfig]`

---

**`enable_content_capture`** `bool`

---

**`enabled`** `bool = False`

---

**`span_format`** `str`

---

```python
class nemoguardrails.rails.llm.config.UserMessagesConfig()
```

**Bases:** `BaseModel`

Configuration for how the user messages are interpreted.

**`embeddings_only`** `bool`

---

**`embeddings_only_fallback_intent`** `Optional[str]`

---

**`embeddings_only_similarity_threshold`** `Optional[float]`

---

```python
class nemoguardrails.rails.llm.config._RailsConfigDataBase()
```

**Bases:** `BaseModel`

Configuration data for specific rails that are supported out-of-the-box.

```python
class nemoguardrails.rails.llm.config._ToolRailFlow(
    section: str,
    direction: str,
    tool_name: typing.Optional[str],
    flow: str
)
```

Dataclass

A configured tool rail flow, with its section, its direction and, for a per-tool flow, its tool.

**`direction`** `str`

---

**`flow`** `str`

---

**`section`** `str`

---

**`tool_name`** `Optional[str]`

---

```python
nemoguardrails.rails.llm.config.__dir__()
```

```python
nemoguardrails.rails.llm.config.__getattr__(
    name: str
)
```

```python
nemoguardrails.rails.llm.config._bound_model_types(
    surface: nemoguardrails.manifests.RailSurface,
    params: typing.Dict[str, str]
) -> typing.Iterator[str]
```

Yield the model types *surface* binds for a flow's *params*: baked-in literals and model `$params` it sets.

```python
nemoguardrails.rails.llm.config._first_repeated_tool_name(
    tool_list: typing.List[typing.Union[str, nemoguardrails.rails.llm.config.ToolEntry]]
) -> typing.Optional[str]
```

The first tool *tool_list* names a second time, or None when it names each tool once.

```python
nemoguardrails.rails.llm.config._generate_rails_flows(
    flows
)
```

Generates flow definitions from the list of flows.
Args:
flows (dict): The dictionary of flows.
Returns:
str: The flow definitions.

```python
nemoguardrails.rails.llm.config._get_flow_model(
    flow_text
) -> typing.Optional[str]
```

Helper to return a model name from a flow definition

```python
nemoguardrails.rails.llm.config._get_flow_name(
    flow_text
) -> typing.Optional[str]
```

Helper to return a model name from a flow definition

```python
nemoguardrails.rails.llm.config._get_rails_flows(
    raw_config
)
```

Extracts the list of flows from the raw_config dictionary.

**Parameters:**

**`raw_config`** `dict`

The raw configuration dictionary.

---

**Returns:**

The list of flows.

```python
nemoguardrails.rails.llm.config._has_input_output_config_rails(
    raw_config
)
```

Checks if the raw configuration has input/output rails configured.

```python
nemoguardrails.rails.llm.config._join_config(
    dest_config: dict,
    additional_config: dict,
    source: typing.Optional[str] = None
)
```

Helper to join two configuration; *source* names where *additional_config* was read from, for errors.

```python
nemoguardrails.rails.llm.config._join_dict(
    dict1,
    dict2
)
```

Joins two dictionaries recursively.

* If values are dictionaries, it applies \_join_dict recursively.
* If values are lists, it concatenates them, ensuring unique elements.
* For other types, values from dict2 overwrite dict1.

```python
nemoguardrails.rails.llm.config._join_rails_configs(
    base_rails_config: nemoguardrails.rails.llm.config.RailsConfig,
    updated_rails_config: nemoguardrails.rails.llm.config.RailsConfig
)
```

Helper to join two rails configuration.

```python
nemoguardrails.rails.llm.config._load_imported_paths(
    raw_config: dict,
    colang_files: typing.List[typing.Tuple[str, str]]
)
```

Load recursively all the imported path in the specified raw_config.

**Parameters:**

**`raw_config`** `dict`

The starting raw configuration (i.e., a dict)

---

**`colang_files`** `List[Tuple[str, str]]`

The current set of colang files which will be extended as new
configurations are loaded.

---

```python
nemoguardrails.rails.llm.config._load_path(
    config_path: str
) -> typing.Tuple[dict, typing.List[typing.Tuple[str, str]]]
```

Load a configuration object from the specified path.

**Parameters:**

**`config_path`** `str`

The path from which to load.

---

**Returns:** `Tuple[dict, List[Tuple[str, str]]]`

(raw_config, colang_files) The raw config object and the list of colang files.

```python
nemoguardrails.rails.llm.config._parse_colang_files_recursively(
    raw_config: dict,
    colang_files: typing.List[typing.Tuple[str, str]],
    parsed_colang_files: typing.List[dict]
)
```

Helper function to parse all the Colang files.

If there are imports, they will be imported recursively

```python
nemoguardrails.rails.llm.config._tool_entry_name(
    entry: typing.Union[str, nemoguardrails.rails.llm.config.ToolEntry]
) -> str
```

The tool a list entry names.

```python
nemoguardrails.rails.llm.config._tool_rail_flows(
    rails: nemoguardrails.rails.llm.config.Rails
) -> typing.Iterator[nemoguardrails.rails.llm.config._ToolRailFlow]
```

Yield each tool rail flow, global flows before per-tool ones.

```python
nemoguardrails.rails.llm.config._unique_list_concat(
    list1,
    list2
)
```

Concatenates two lists ensuring all elements are unique.
Handles unhashable types like dictionaries.

```python
nemoguardrails.rails.llm.config._validate_rail_prompts(
    rails: list[str],
    prompts: list[typing.Any],
    validation_rail: str
) -> None
```

```python
nemoguardrails.rails.llm.config._validate_self_check_rail_prompts(
    rails: list[str],
    prompts: list[typing.Any],
    validation_rail: str,
    default_task: str
) -> None
```

Ensure every enabled self-check rail has a prompt for its resolved task.

A self-check rail may select a custom task via `$variant=...`; the task falls
back to `default_task` when omitted. Custom prompts are scoped under the
default task name.

```python
nemoguardrails.rails.llm.config._warn_unknown_config_key(
    key: str,
    known_keys: collections.abc.Collection[str],
    path: str = ''
) -> None
```

```python
nemoguardrails.rails.llm.config._warn_unknown_config_keys(
    raw: typing.Any,
    parsed: typing.Any,
    path: str = ''
) -> None
```

Compare with validated values to follow the selected union and preserve open dictionaries.

```python
nemoguardrails.rails.llm.config.merge_two_dicts(
    dict_1: dict,
    dict_2: dict,
    ignore_keys: typing.Set[str]
) -> None
```

Merges the fields of two dictionaries recursively.

```python
nemoguardrails.rails.llm.config.JAILBREAK_FLOW_HEURISTICS = 'jailbreak detection heuristics'
```

```python
nemoguardrails.rails.llm.config.JAILBREAK_FLOW_MODEL = 'jailbreak detection model'
```

```python
nemoguardrails.rails.llm.config.MODEL_PREFIX = '$model='
```

```python
nemoguardrails.rails.llm.config.ToolInputRails = ToolResultRails
```

```python
nemoguardrails.rails.llm.config.ToolOutputRails = ToolCallRails
```

```python
nemoguardrails.rails.llm.config._default_config = yaml.safe_load(_fc)
```

```python
nemoguardrails.rails.llm.config._default_config_v2 = yaml.safe_load(_fc)
```

```python
nemoguardrails.rails.llm.config.colang_path_dirs = [(_path.strip()) for _path in (os.environ.get('COLANGPATH', '').split(os.pathsep...
```

```python
nemoguardrails.rails.llm.config.guardrails_stdlib_path = os.path.normpath(os.path.join(os.path.dirname(__file__), '..', '..', '..'))
```

```python
nemoguardrails.rails.llm.config.log = logging.getLogger(__name__)
```

```python
nemoguardrails.rails.llm.config.standard_library_path = os.path.normpath(os.path.join(os.path.dirname(__file__), '..', '..', 'colang', '...
```