nemo-platform-plugin 0.1.0__py3-none-any.whl

nemo_platform/types/guardrail/guardrails_ai_rail_config.py

@@ -0,0 +1,33 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+from .guardrails_ai_validator_config import GuardrailsAIValidatorConfig
+
+__all__ = ["GuardrailsAIRailConfig"]
+
+
+class GuardrailsAIRailConfig(BaseModel):
+    """Configuration data for Guardrails AI integration."""
+
+    validators: Optional[List[GuardrailsAIValidatorConfig]] = None
+    """List of Guardrails AI validators to apply.
+
+    Each validator can have its own parameters and metadata.
+    """

nemo_platform/types/guardrail/guardrails_ai_rail_config_param.py

@@ -0,0 +1,35 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable
+from typing_extensions import TypedDict
+
+from .guardrails_ai_validator_config_param import GuardrailsAIValidatorConfigParam
+
+__all__ = ["GuardrailsAIRailConfigParam"]
+
+
+class GuardrailsAIRailConfigParam(TypedDict, total=False):
+    """Configuration data for Guardrails AI integration."""
+
+    validators: Iterable[GuardrailsAIValidatorConfigParam]
+    """List of Guardrails AI validators to apply.
+
+    Each validator can have its own parameters and metadata.
+    """

nemo_platform/types/guardrail/guardrails_ai_validator_config.py

@@ -0,0 +1,44 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["GuardrailsAIValidatorConfig"]
+
+
+class GuardrailsAIValidatorConfig(BaseModel):
+    """Configuration for a single Guardrails AI validator."""
+
+    name: str
+    """
+    Unique identifier or import path for the Guardrails AI validator (e.g.,
+    'toxic_language', 'pii', 'regex_match', or 'guardrails/competitor_check').
+    """
+
+    metadata: Optional[Dict[str, object]] = None
+    """
+    Metadata to pass to the validator during validation (e.g., valid_topics,
+    context).
+    """
+
+    parameters: Optional[Dict[str, object]] = None
+    """
+    Parameters to pass to the validator during initialization (e.g., threshold,
+    regex pattern).
+    """

nemo_platform/types/guardrail/guardrails_ai_validator_config_param.py

@@ -0,0 +1,45 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict
+from typing_extensions import Required, TypedDict
+
+__all__ = ["GuardrailsAIValidatorConfigParam"]
+
+
+class GuardrailsAIValidatorConfigParam(TypedDict, total=False):
+    """Configuration for a single Guardrails AI validator."""
+
+    name: Required[str]
+    """
+    Unique identifier or import path for the Guardrails AI validator (e.g.,
+    'toxic_language', 'pii', 'regex_match', or 'guardrails/competitor_check').
+    """
+
+    metadata: Dict[str, object]
+    """
+    Metadata to pass to the validator during validation (e.g., valid_topics,
+    context).
+    """
+
+    parameters: Dict[str, object]
+    """
+    Parameters to pass to the validator during initialization (e.g., threshold,
+    regex pattern).
+    """

nemo_platform/types/guardrail/guardrails_data.py

@@ -0,0 +1,40 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+
+from ..._models import BaseModel
+from .generation_log import GenerationLog
+
+__all__ = ["GuardrailsData"]
+
+
+class GuardrailsData(BaseModel):
+    config_ids: Optional[List[str]] = None
+    """The list of configuration ids that were used."""
+
+    llm_output: Optional[Dict[str, object]] = None
+    """Contains any additional output coming from the LLM."""
+
+    log: Optional[GenerationLog] = None
+    """Contains additional logging information associated with a generation call."""
+
+    output_data: Optional[Dict[str, object]] = None
+    """The output data, i.e.
+
+    a dict with the values corresponding to the `output_vars`.
+    """

nemo_platform/types/guardrail/guardrails_data_param.py

@@ -0,0 +1,67 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Union
+from typing_extensions import TypeAlias, TypedDict
+
+from ..._types import SequenceNotStr
+from .rails_config_param import RailsConfigParam
+from .generation_options_param import GenerationOptionsParam
+
+__all__ = ["GuardrailsDataParam", "Config"]
+
+Config: TypeAlias = Union[str, RailsConfigParam]
+
+
+class GuardrailsDataParam(TypedDict, total=False):
+    config: Config
+    """The id of the configuration or its dict representation to be used."""
+
+    config_id: str
+    """The id of the configuration to be used."""
+
+    config_ids: SequenceNotStr[str]
+    """The list of configuration ids to be used.
+
+    If set, the configurations will be combined.
+    """
+
+    context: Dict[str, object]
+    """Additional context data to be added to the conversation."""
+
+    options: GenerationOptionsParam
+    """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.
+    """
+
+    return_choice: bool
+    """If set, guardrails data will be included as a JSON in the choices array."""
+
+    state: Dict[str, object]
+    """A state object that should be used to continue the interaction."""
+
+    stream: bool
+    """If set, partial message deltas will be sent, like in ChatGPT.
+
+    Tokens will be sent as data-only server-sent events as they become available,
+    with the stream terminated by a data: [DONE] message.
+    """

nemo_platform/types/guardrail/image_u_rl_param.py

@@ -0,0 +1,32 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["ImageURlParam"]
+
+
+class ImageURlParam(TypedDict, total=False):
+    """Image URL for vision requests."""
+
+    url: Required[str]
+    """Either a URL of the image or the base64 encoded image data."""
+
+    detail: Literal["auto", "low", "high"]
+    """Specifies the detail level of the image."""

nemo_platform/types/guardrail/injection_detection.py

@@ -0,0 +1,49 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["InjectionDetection"]
+
+
+class InjectionDetection(BaseModel):
+    action: Optional[str] = None
+    """Action to take.
+
+    Options are 'reject' to offer a rejection message, 'omit' to mask the offending
+    content, and 'sanitize' to pass the content as-is in the safest way. These
+    options are listed in descending order of relative safety. 'sanitize' is not
+    implemented at this time.
+    """
+
+    injections: Optional[List[str]] = None
+    """The list of injection types to detect.
+
+    Options are 'sqli', 'template', 'code', 'xss'.Currently, only SQL injection,
+    template injection, code injection, and markdown cross-site scripting are
+    supported. Custom rules can be added, provided they are in the `yara_path` and
+    have a `.yara` file extension.
+    """
+
+    yara_rules: Optional[Dict[str, str]] = None
+    """Dictionary mapping rule names to YARA rule strings.
+
+    If provided, these rules will be used instead of loading rules from yara_path.
+    Each rule should be a valid YARA rule string.
+    """

nemo_platform/types/guardrail/injection_detection_param.py

@@ -0,0 +1,52 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict
+from typing_extensions import TypedDict
+
+from ..._types import SequenceNotStr
+
+__all__ = ["InjectionDetectionParam"]
+
+
+class InjectionDetectionParam(TypedDict, total=False):
+    action: str
+    """Action to take.
+
+    Options are 'reject' to offer a rejection message, 'omit' to mask the offending
+    content, and 'sanitize' to pass the content as-is in the safest way. These
+    options are listed in descending order of relative safety. 'sanitize' is not
+    implemented at this time.
+    """
+
+    injections: SequenceNotStr[str]
+    """The list of injection types to detect.
+
+    Options are 'sqli', 'template', 'code', 'xss'.Currently, only SQL injection,
+    template injection, code injection, and markdown cross-site scripting are
+    supported. Custom rules can be added, provided they are in the `yara_path` and
+    have a `.yara` file extension.
+    """
+
+    yara_rules: Dict[str, str]
+    """Dictionary mapping rule names to YARA rule strings.
+
+    If provided, these rules will be used instead of loading rules from yara_path.
+    Each rule should be a valid YARA rule string.
+    """

nemo_platform/types/guardrail/input_rails.py

@@ -0,0 +1,32 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["InputRails"]
+
+
+class InputRails(BaseModel):
+    """Configuration of input rails."""
+
+    flows: Optional[List[str]] = None
+    """The names of all the flows that implement input rails."""
+
+    parallel: Optional[bool] = None
+    """If True, the input rails are executed in parallel."""

nemo_platform/types/guardrail/input_rails_param.py

@@ -0,0 +1,34 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+from ..._types import SequenceNotStr
+
+__all__ = ["InputRailsParam"]
+
+
+class InputRailsParam(TypedDict, total=False):
+    """Configuration of input rails."""
+
+    flows: SequenceNotStr[str]
+    """The names of all the flows that implement input rails."""
+
+    parallel: bool
+    """If True, the input rails are executed in parallel."""

nemo_platform/types/guardrail/instruction.py

@@ -0,0 +1,30 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from ..._models import BaseModel
+
+__all__ = ["Instruction"]
+
+
+class Instruction(BaseModel):
+    """
+    Configuration for instructions in natural language that should be passed to the LLM.
+    """
+
+    content: str
+
+    type: str

nemo_platform/types/guardrail/instruction_param.py

@@ -0,0 +1,32 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["InstructionParam"]
+
+
+class InstructionParam(TypedDict, total=False):
+    """
+    Configuration for instructions in natural language that should be passed to the LLM.
+    """
+
+    content: Required[str]
+
+    type: Required[str]

nemo_platform/types/guardrail/jailbreak_detection_config.py

@@ -0,0 +1,52 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["JailbreakDetectionConfig"]
+
+
+class JailbreakDetectionConfig(BaseModel):
+    """Configuration data for jailbreak detection."""
+
+    api_key_env_var: Optional[str] = None
+    """Environment variable containing API key for jailbreak detection model"""
+
+    embedding: Optional[str] = None
+
+    length_per_perplexity_threshold: Optional[float] = None
+    """The length/perplexity threshold."""
+
+    nim_base_url: Optional[str] = None
+    """Base URL for jailbreak detection model. Example: http://localhost:8000/v1"""
+
+    nim_port: Optional[int] = None
+    """DEPRECATED: Include port in nim_base_url instead"""
+
+    nim_server_endpoint: Optional[str] = None
+    """Classification path uri. Defaults to 'classify' for NemoGuard JailbreakDetect."""
+
+    nim_url: Optional[str] = None
+    """DEPRECATED: Use nim_base_url instead"""
+
+    prefix_suffix_perplexity_threshold: Optional[float] = None
+    """The prefix/suffix perplexity threshold."""
+
+    server_endpoint: Optional[str] = None
+    """The endpoint for the jailbreak detection heuristics/model container."""

nemo_platform/types/guardrail/jailbreak_detection_config_param.py

@@ -0,0 +1,58 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["JailbreakDetectionConfigParam"]
+
+
+class JailbreakDetectionConfigParam(TypedDict, total=False):
+    """Configuration data for jailbreak detection."""
+
+    api_key: str
+    """Secret String with API key for use in Jailbreak requests.
+
+    Takes precedence over api_key_env_var
+    """
+
+    api_key_env_var: str
+    """Environment variable containing API key for jailbreak detection model"""
+
+    embedding: str
+
+    length_per_perplexity_threshold: float
+    """The length/perplexity threshold."""
+
+    nim_base_url: str
+    """Base URL for jailbreak detection model. Example: http://localhost:8000/v1"""
+
+    nim_port: int
+    """DEPRECATED: Include port in nim_base_url instead"""
+
+    nim_server_endpoint: str
+    """Classification path uri. Defaults to 'classify' for NemoGuard JailbreakDetect."""
+
+    nim_url: str
+    """DEPRECATED: Use nim_base_url instead"""
+
+    prefix_suffix_perplexity_threshold: float
+    """The prefix/suffix perplexity threshold."""
+
+    server_endpoint: str
+    """The endpoint for the jailbreak detection heuristics/model container."""