nemoguardrails.cli

Submodules

Package Contents

Classes

Name	Description
`ColangVersions`	-

Functions

Name	Description
`action_server`	Start a NeMo Guardrails actions server.
`cli`	-
`convert`	Convert Colang files and configs from older version to the latest.
`find_providers`	List and select LLM providers interactively.
`server`	Start a NeMo Guardrails server.
`version_callback`	-

Data

_COLANG_VERSIONS

app

API

class nemoguardrails.cli.ColangVersions

Bases: enum.Enum

one

= '1.0'

two_alpha

= '2.0-alpha'

nemoguardrails.cli.action_server(
    port: int = typer.Option(default=8001, ...
)

Start a NeMo Guardrails actions server.

nemoguardrails.cli.cli(
    _: typing.Optional[bool] = typer.Option(None, '-v', '-...
)

nemoguardrails.cli.convert(
    path: str = typer.Argument(..., help='T...,
    from_version: nemoguardrails.cli.ColangVersions = typer.Option(default=(Colan...,
    verbose: bool = typer.Option(default=False,...,
    validate: bool = typer.Option(default=False,...,
    use_active_decorator: bool = typer.Option(default=True, ...,
    include_main_flow: bool = typer.Option(default=True, ...
)

Convert Colang files and configs from older version to the latest.

nemoguardrails.cli.find_providers(
    list_only: bool = typer.Option(False, '--list...
)

List and select LLM providers interactively.

This command provides an interactive interface to explore and select LLM providers. It supports both text completion and chat completion model providers.

When run without options:

First, you’ll be prompted to select a provider type:

Type to filter between “text completion” and “chat completion”
Use arrow keys to navigate through matches
Press Tab to autocomplete
Press Enter to select

Then, you’ll be prompted to select a specific provider:

Type to filter through available providers
Use arrow keys to navigate through matches
Press Tab to autocomplete
Press Enter to select

When run with —list:

Simply lists all available providers
No selection is made

nemoguardrails.cli.server(
    port: int = typer.Option(default=8000, ...,
    config: typing.List[str] = typer.Option(default=[], ex...,
    default_config_id: typing.Optional[str] = typer.Option(default=None, ...,
    verbose: bool = typer.Option(default=False,...,
    disable_chat_ui: bool = typer.Option(default=False,...,
    auto_reload: bool = typer.Option(default=False,...,
    prefix: str = typer.Option(default='', he...
)

Start a NeMo Guardrails server.

nemoguardrails.cli.version_callback(
    value: bool
)

nemoguardrails.cli._COLANG_VERSIONS = [(version.value) for version in ColangVersions]

nemoguardrails.cli.app = typer.Typer()