> 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.options

Generation options give more control over the generation and the result.

For example, to run only the input rails:

```python
# Since everything is enabled by default, we disable explicitly the others
options = {
    "rails": {
        "output": False,
        "dialog": False,
        "retrieval": False
    }
}
messages = [{
    "role": "user",
    "content": "Am I allowed to say this?"
}]

rails.generate(messages=messages, options=options)
```

To invoke only some specific input/output rails:

rails.generate(messages=messages, options=\{
"rails": \{
"input": \["check jailbreak"],
"output": \["output moderation v2"]
}
})

To provide additional parameters to the main LLM call:

rails.generate(messages=messages, options=\{
"llm_params": \{
"temperature": 0.5
}
})

To return additional information from the generation (i.e., context variables):

# This will include the relevant chunks in the returned response, as part

# of the `output_data` field.

rails.generate(messages=messages, options=\{
"output_vars": \["relevant_chunks"]
})

To skip enforcing the rails, and only inform the user if they were triggered:

rails.generate(messages=messages, options=\{
"enforce": False
})

# \{..., log: \{"triggered_rails": \{"type": "input", "name": "check jailbreak"}}}

To get more details on the LLM calls that were executed, including the raw responses:

rails.generate(messages=messages, options=\{
"log": \{
"llm_calls": True
}
})

# \{..., log: \{"llm_calls": \[...]}}

## Module Contents

### Classes

| Name                                                                                 | Description                                                                                         |
| ------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------- |
| [`ActivatedRail`](#nemoguardrails-rails-llm-options-ActivatedRail)                   | A rail that was activated during the generation.                                                    |
| [`ExecutedAction`](#nemoguardrails-rails-llm-options-ExecutedAction)                 | Information about an action that was executed.                                                      |
| [`GenerationLog`](#nemoguardrails-rails-llm-options-GenerationLog)                   | Contains additional logging information associated with a generation call.                          |
| [`GenerationLogOptions`](#nemoguardrails-rails-llm-options-GenerationLogOptions)     | Options for what should be included in the generation log.                                          |
| [`GenerationOptions`](#nemoguardrails-rails-llm-options-GenerationOptions)           | A set of options that should be applied during a generation.                                        |
| [`GenerationRailsOptions`](#nemoguardrails-rails-llm-options-GenerationRailsOptions) | Options for what rails should be used during the generation.                                        |
| [`GenerationResponse`](#nemoguardrails-rails-llm-options-GenerationResponse)         | -                                                                                                   |
| [`GenerationStats`](#nemoguardrails-rails-llm-options-GenerationStats)               | General stats about the generation.                                                                 |
| [`RailStatus`](#nemoguardrails-rails-llm-options-RailStatus)                         | -                                                                                                   |
| [`RailType`](#nemoguardrails-rails-llm-options-RailType)                             | -                                                                                                   |
| [`RailsResult`](#nemoguardrails-rails-llm-options-RailsResult)                       | -                                                                                                   |
| [`ToolViolation`](#nemoguardrails-rails-llm-options-ToolViolation)                   | One tool call or tool result a tool rail blocked, identified so a caller can act on it.             |
| [`ToolViolationType`](#nemoguardrails-rails-llm-options-ToolViolationType)           | What a blocked tool call or tool result violated; callers switch on this, never on the reason text. |

### Data

[`DEPRECATED_TOOL_RAIL_FIELDS`](#nemoguardrails-rails-llm-options-DEPRECATED_TOOL_RAIL_FIELDS)

[`MAX_QUOTED_IDENTITY_LENGTH`](#nemoguardrails-rails-llm-options-MAX_QUOTED_IDENTITY_LENGTH)

[`TOOL_RAIL_TYPES`](#nemoguardrails-rails-llm-options-TOOL_RAIL_TYPES)

### API

```python
class nemoguardrails.rails.llm.options.ActivatedRail()
```

**Bases:** `BaseModel`

A rail that was activated during the generation.

**`additional_info`** `Optional[dict]`

---

**`decisions`** `List[str]`

---

**`duration`** `Optional[float]`

---

**`executed_actions`** `List[ExecutedAction]`

---

**`finished_at`** `Optional[float]`

---

**`name`** `str`

---

**`started_at`** `Optional[float]`

---

**`stop`** `bool`

---

**`type`** `str`

---

```python
class nemoguardrails.rails.llm.options.ExecutedAction()
```

**Bases:** `BaseModel`

Information about an action that was executed.

**`action_name`** `str`

---

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

---

**`duration`** `Optional[float]`

---

**`finished_at`** `Optional[float]`

---

**`llm_calls`** `List[LLMCallInfo]`

---

**`return_value`** `Any`

---

**`started_at`** `Optional[float]`

---

```python
class nemoguardrails.rails.llm.options.GenerationLog()
```

**Bases:** `BaseModel`

Contains additional logging information associated with a generation call.

**`activated_rails`** `List[ActivatedRail]`

---

**`colang_history`** `Optional[str]`

---

**`internal_events`** `Optional[List[dict]]`

---

**`llm_calls`** `Optional[List[LLMCallInfo]]`

---

**`stats`** `GenerationStats`

---

```python
nemoguardrails.rails.llm.options.GenerationLog.print_summary()
```

```python
class nemoguardrails.rails.llm.options.GenerationLogOptions()
```

**Bases:** `BaseModel`

Options for what should be included in the generation log.

**`activated_rails`** `bool`

---

**`colang_history`** `bool`

---

**`internal_events`** `bool`

---

**`llm_calls`** `bool`

---

```python
class nemoguardrails.rails.llm.options.GenerationOptions()
```

**Bases:** `BaseModel`

A set of options that should be applied during a generation.

The GenerationOptions control various things such as what rails are enabled,
additional parameters for the main LLM, whether the rails should be enforced or
ran in parallel, what to be included in the generation log, etc.

**`llm_output`** `bool`

---

**`llm_params`** `Optional[dict]`

---

**`log`** `GenerationLogOptions`

---

**`output_vars`** `Optional[Union[bool, List[str]]]`

---

**`rails`** `GenerationRailsOptions`

---

```python
nemoguardrails.rails.llm.options.GenerationOptions.check_fields(
    values
)
```

classmethod

```python
class nemoguardrails.rails.llm.options.GenerationRailsOptions()
```

**Bases:** `BaseModel`

Options for what rails should be used during the generation.

**`dialog`** `bool`

---

**`input`** `Union[bool, List[str]]`

---

**`output`** `Union[bool, List[str]]`

---

**`retrieval`** `Union[bool, List[str]]`

---

**`tool_call`** `Union[bool, List[str]]`

---

**`tool_input`** `Union[bool, List[str]]`

---

**`tool_output`** `Union[bool, List[str]]`

---

**`tool_result`** `Union[bool, List[str]]`

---

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

```python
nemoguardrails.rails.llm.options.GenerationRailsOptions._sync_deprecated_tool_rail_fields() -> None
```

```python
nemoguardrails.rails.llm.options.GenerationRailsOptions.migrate_deprecated_tool_rail_fields(
    values: typing.Any
) -> typing.Any
```

classmethod

```python
nemoguardrails.rails.llm.options.GenerationRailsOptions.sync_deprecated_tool_rail_fields() -> nemoguardrails.rails.llm.options.GenerationRailsOptions
```

```python
class nemoguardrails.rails.llm.options.GenerationResponse()
```

**Bases:** `BaseModel`

**`llm_metadata`** `Optional[dict]`

---

**`llm_output`** `Optional[dict]`

---

**`log`** `Optional[GenerationLog]`

---

**`output_data`** `Optional[dict]`

---

**`reasoning_content`** `Optional[str]`

---

**`response`** `Union[str, List[dict]]`

---

**`state`** `Optional[dict]`

---

**`tool_calls`** `Optional[list]`

---

```python
class nemoguardrails.rails.llm.options.GenerationStats()
```

**Bases:** `BaseModel`

General stats about the generation.

**`dialog_rails_duration`** `Optional[float]`

---

**`generation_rails_duration`** `Optional[float]`

---

**`input_rails_duration`** `Optional[float]`

---

**`llm_calls_count`** `Optional[int]`

---

**`llm_calls_duration`** `Optional[float]`

---

**`llm_calls_total_completion_tokens`** `Optional[int]`

---

**`llm_calls_total_prompt_tokens`** `Optional[int]`

---

**`llm_calls_total_tokens`** `Optional[int]`

---

**`output_rails_duration`** `Optional[float]`

---

**`total_duration`** `Optional[float]`

---

```python
class nemoguardrails.rails.llm.options.RailStatus
```

**Bases:** `enum.Enum`

**`BLOCKED`** `= 'blocked'`

---

**`MODIFIED`** `= 'modified'`

---

**`PASSED`** `= 'passed'`

---

```python
class nemoguardrails.rails.llm.options.RailType
```

**Bases:** `enum.Enum`

**`INPUT`** `= 'input'`

---

**`OUTPUT`** `= 'output'`

---

**`TOOL_CALL`** `= 'tool_call'`

---

**`TOOL_RESULT`** `= 'tool_result'`

---

```python
class nemoguardrails.rails.llm.options.RailsResult()
```

**Bases:** `BaseModel`

**`content`** `str`

---

**`rail`** `Optional[str]`

---

**`reason`** `Optional[str]`

---

**`status`** `RailStatus`

---

**`tool_violations`** `Optional[List[ToolViolation]]`

---

```python
class nemoguardrails.rails.llm.options.ToolViolation()
```

**Bases:** `BaseModel`

One tool call or tool result a tool rail blocked, identified so a caller can act on it.

**`argument_path`** `Optional[str]`

---

**`index`** `Optional[int]`

---

**`kind`** `Literal['tool_call', 'tool_result']`

---

**`model_config`** `= ConfigDict(frozen=True)`

---

**`rail`** `Optional[str]`

---

**`reason`** `str`

---

**`schema_keyword`** `Optional[str]`

---

**`tool_call_id`** `Optional[str]`

---

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

---

**`violation_type`** `ToolViolationType`

---

```python
nemoguardrails.rails.llm.options.ToolViolation._capped_tool_name(
    value: typing.Optional[str]
) -> typing.Optional[str]
```

classmethod

Cut a tool name to `MAX_QUOTED_IDENTITY_LENGTH` characters, since an undeclared one is model-made.

```python
nemoguardrails.rails.llm.options.ToolViolation._string_identity_or_none(
    value: typing.Any
) -> typing.Optional[str]
```

classmethod

Store a non-string id or name as None, so a malformed message cannot break building its violation.

```python
class nemoguardrails.rails.llm.options.ToolViolationType
```

**Bases:** `enum.Enum`

What a blocked tool call or tool result violated; callers switch on this, never on the reason text.

**`ARGUMENTS_INVALID`** `= 'arguments_invalid'`

---

**`DUPLICATE_PRIOR_CALL_ID`** `= 'duplicate_prior_call_id'`

---

**`DUPLICATE_RESULT`** `= 'duplicate_result'`

---

**`EXTRACTION_FAILED`** `= 'extraction_failed'`

---

**`INVALID_TOOLSET`** `= 'invalid_toolset'`

---

**`INVALID_TOOL_SCHEMA`** `= 'invalid_tool_schema'`

---

**`LEGACY_FUNCTION_CALL`** `= 'legacy_function_call'`

---

**`MALFORMED_ARGUMENTS`** `= 'malformed_arguments'`

---

**`MALFORMED_CONTENT`** `= 'malformed_content'`

---

**`MALFORMED_TOOL_CALL`** `= 'malformed_tool_call'`

---

**`MISSING_CALL_ID`** `= 'missing_call_id'`

---

**`NAME_MISMATCH`** `= 'name_mismatch'`

---

**`PER_TOOL_RAIL`** `= 'per_tool_rail'`

---

**`RAIL_FAILED`** `= 'rail_failed'`

---

**`TOOL_NOT_ALLOWED`** `= 'tool_not_allowed'`

---

**`UNEXPECTED_ARGUMENTS`** `= 'unexpected_arguments'`

---

**`UNKNOWN_CALL_ID`** `= 'unknown_call_id'`

---

**`UNLINKABLE_RESULT`** `= 'unlinkable_result'`

---

```python
nemoguardrails.rails.llm.options.DEPRECATED_TOOL_RAIL_FIELDS = {'tool_output': 'tool_call', 'tool_input': 'tool_result'}
```

```python
nemoguardrails.rails.llm.options.MAX_QUOTED_IDENTITY_LENGTH = 64
```

```python
nemoguardrails.rails.llm.options.TOOL_RAIL_TYPES = frozenset({RailType.TOOL_CALL, RailType.TOOL_RESULT})
```