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

nemo_platform/types/guardrail/regex_detection_param.py

@@ -0,0 +1,37 @@
+# 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 .regex_detection_options_param import RegexDetectionOptionsParam
+
+__all__ = ["RegexDetectionParam"]
+
+
+class RegexDetectionParam(TypedDict, total=False):
+    """Configuration for regex pattern detection."""
+
+    input: RegexDetectionOptionsParam
+    """Configuration options for regex pattern detection on a specific source."""
+
+    output: RegexDetectionOptionsParam
+    """Configuration options for regex pattern detection on a specific source."""
+
+    retrieval: RegexDetectionOptionsParam
+    """Configuration options for regex pattern detection on a specific source."""

nemo_platform/types/guardrail/retrieval_rails.py

@@ -0,0 +1,29 @@
+# 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__ = ["RetrievalRails"]
+
+
+class RetrievalRails(BaseModel):
+    """Configuration of retrieval rails."""
+
+    flows: Optional[List[str]] = None
+    """The names of all the flows that implement retrieval rails."""

nemo_platform/types/guardrail/retrieval_rails_param.py

@@ -0,0 +1,31 @@
+# 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__ = ["RetrievalRailsParam"]
+
+
+class RetrievalRailsParam(TypedDict, total=False):
+    """Configuration of retrieval rails."""
+
+    flows: SequenceNotStr[str]
+    """The names of all the flows that implement retrieval rails."""

nemo_platform/types/guardrail/sensitive_data_detection.py

@@ -0,0 +1,43 @@
+# 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 .sensitive_data_detection_options import SensitiveDataDetectionOptions
+
+__all__ = ["SensitiveDataDetection"]
+
+
+class SensitiveDataDetection(BaseModel):
+    """Configuration of what sensitive data should be detected."""
+
+    input: Optional[SensitiveDataDetectionOptions] = None
+    """Configuration of the entities to be detected on the user input."""
+
+    output: Optional[SensitiveDataDetectionOptions] = None
+    """Configuration of the entities to be detected on the bot output."""
+
+    recognizers: Optional[List[Dict[str, object]]] = None
+    """Additional custom recognizers.
+
+    Check out https://microsoft.github.io/presidio/tutorial/08_no_code/ for more
+    details.
+    """
+
+    retrieval: Optional[SensitiveDataDetectionOptions] = None
+    """Configuration of the entities to be detected on retrieved relevant chunks."""

nemo_platform/types/guardrail/sensitive_data_detection_options.py

@@ -0,0 +1,37 @@
+# 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__ = ["SensitiveDataDetectionOptions"]
+
+
+class SensitiveDataDetectionOptions(BaseModel):
+    entities: Optional[List[str]] = None
+    """The list of entities that should be detected.
+
+    Check out https://microsoft.github.io/presidio/supported_entities/ forthe list
+    of supported entities.
+    """
+
+    mask_token: Optional[str] = None
+    """The token that should be used to mask the sensitive data."""
+
+    score_threshold: Optional[float] = None
+    """The score threshold that should be used to detect the sensitive data."""

nemo_platform/types/guardrail/sensitive_data_detection_options_param.py

@@ -0,0 +1,39 @@
+# 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__ = ["SensitiveDataDetectionOptionsParam"]
+
+
+class SensitiveDataDetectionOptionsParam(TypedDict, total=False):
+    entities: SequenceNotStr[str]
+    """The list of entities that should be detected.
+
+    Check out https://microsoft.github.io/presidio/supported_entities/ forthe list
+    of supported entities.
+    """
+
+    mask_token: str
+    """The token that should be used to mask the sensitive data."""
+
+    score_threshold: float
+    """The score threshold that should be used to detect the sensitive data."""

nemo_platform/types/guardrail/sensitive_data_detection_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, Iterable
+from typing_extensions import TypedDict
+
+from .sensitive_data_detection_options_param import SensitiveDataDetectionOptionsParam
+
+__all__ = ["SensitiveDataDetectionParam"]
+
+
+class SensitiveDataDetectionParam(TypedDict, total=False):
+    """Configuration of what sensitive data should be detected."""
+
+    input: SensitiveDataDetectionOptionsParam
+    """Configuration of the entities to be detected on the user input."""
+
+    output: SensitiveDataDetectionOptionsParam
+    """Configuration of the entities to be detected on the bot output."""
+
+    recognizers: Iterable[Dict[str, object]]
+    """Additional custom recognizers.
+
+    Check out https://microsoft.github.io/presidio/tutorial/08_no_code/ for more
+    details.
+    """
+
+    retrieval: SensitiveDataDetectionOptionsParam
+    """Configuration of the entities to be detected on retrieved relevant chunks."""

nemo_platform/types/guardrail/single_call_config.py

@@ -0,0 +1,31 @@
+# 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__ = ["SingleCallConfig"]
+
+
+class SingleCallConfig(BaseModel):
+    """Configuration for the single LLM call option for topical rails."""
+
+    enabled: Optional[bool] = None
+
+    fallback_to_multiple_calls: Optional[bool] = None
+    """Whether to fall back to multiple calls if a single call is not possible."""

nemo_platform/types/guardrail/single_call_config_param.py

@@ -0,0 +1,31 @@
+# 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__ = ["SingleCallConfigParam"]
+
+
+class SingleCallConfigParam(TypedDict, total=False):
+    """Configuration for the single LLM call option for topical rails."""
+
+    enabled: bool
+
+    fallback_to_multiple_calls: bool
+    """Whether to fall back to multiple calls if a single call is not possible."""

nemo_platform/types/guardrail/status_enum.py

@@ -0,0 +1,22 @@
+# 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_extensions import Literal, TypeAlias
+
+__all__ = ["StatusEnum"]
+
+StatusEnum: TypeAlias = Literal["blocked", "success", "unknown"]

nemo_platform/types/guardrail/task_prompt.py

@@ -0,0 +1,63 @@
+# 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, Union, Optional
+from typing_extensions import TypeAlias
+
+from ..._models import BaseModel
+from .message_template import MessageTemplate
+
+__all__ = ["TaskPrompt", "Message"]
+
+Message: TypeAlias = Union[MessageTemplate, str]
+
+
+class TaskPrompt(BaseModel):
+    """Configuration for prompts that will be used for a specific task."""
+
+    task: str
+    """The id of the task associated with this prompt."""
+
+    content: Optional[str] = None
+    """The content of the prompt, if it's a string."""
+
+    max_length: Optional[int] = None
+    """The maximum length of the prompt in number of characters."""
+
+    max_tokens: Optional[int] = None
+    """The maximum number of tokens that can be generated in the chat completion."""
+
+    messages: Optional[List[Message]] = None
+    """The list of messages included in the prompt. Used for chat models."""
+
+    mode: Optional[str] = None
+    """Corresponds to the `prompting_mode` for which this prompt is fetched.
+
+    Default is 'standard'.
+    """
+
+    models: Optional[List[str]] = None
+    """If specified, the prompt will be used only for the given LLM engines/models.
+
+    The format is a list of strings with the format: <engine> or <engine>/<model>.
+    """
+
+    output_parser: Optional[str] = None
+    """The name of the output parser to use for this prompt."""
+
+    stop: Optional[List[str]] = None
+    """If specified, will be configure stop tokens for models that support this."""

nemo_platform/types/guardrail/task_prompt_param.py

@@ -0,0 +1,65 @@
+# 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 Union
+from typing_extensions import Required, TypeAlias, TypedDict
+
+from ..._types import SequenceNotStr
+from .message_template_param import MessageTemplateParam
+
+__all__ = ["TaskPromptParam", "Message"]
+
+Message: TypeAlias = Union[MessageTemplateParam, str]
+
+
+class TaskPromptParam(TypedDict, total=False):
+    """Configuration for prompts that will be used for a specific task."""
+
+    task: Required[str]
+    """The id of the task associated with this prompt."""
+
+    content: str
+    """The content of the prompt, if it's a string."""
+
+    max_length: int
+    """The maximum length of the prompt in number of characters."""
+
+    max_tokens: int
+    """The maximum number of tokens that can be generated in the chat completion."""
+
+    messages: SequenceNotStr[Message]
+    """The list of messages included in the prompt. Used for chat models."""
+
+    mode: str
+    """Corresponds to the `prompting_mode` for which this prompt is fetched.
+
+    Default is 'standard'.
+    """
+
+    models: SequenceNotStr[str]
+    """If specified, the prompt will be used only for the given LLM engines/models.
+
+    The format is a list of strings with the format: <engine> or <engine>/<model>.
+    """
+
+    output_parser: str
+    """The name of the output parser to use for this prompt."""
+
+    stop: SequenceNotStr[str]
+    """If specified, will be configure stop tokens for models that support this."""

nemo_platform/types/guardrail/tool_input_rails.py

@@ -0,0 +1,36 @@
+# 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__ = ["ToolInputRails"]
+
+
+class ToolInputRails(BaseModel):
+    """
+    Configuration of tool input rails.
+    Tool input rails are applied to tool results before they are processed.
+    They can validate, filter, or transform tool outputs for security and safety.
+    """
+
+    flows: Optional[List[str]] = None
+    """The names of all the flows that implement tool input rails."""
+
+    parallel: Optional[bool] = None
+    """If True, the tool input rails are executed in parallel."""

nemo_platform/types/guardrail/tool_input_rails_param.py

@@ -0,0 +1,38 @@
+# 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__ = ["ToolInputRailsParam"]
+
+
+class ToolInputRailsParam(TypedDict, total=False):
+    """
+    Configuration of tool input rails.
+    Tool input rails are applied to tool results before they are processed.
+    They can validate, filter, or transform tool outputs for security and safety.
+    """
+
+    flows: SequenceNotStr[str]
+    """The names of all the flows that implement tool input rails."""
+
+    parallel: bool
+    """If True, the tool input rails are executed in parallel."""

nemo_platform/types/guardrail/tool_output_rails.py

@@ -0,0 +1,36 @@
+# 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__ = ["ToolOutputRails"]
+
+
+class ToolOutputRails(BaseModel):
+    """
+    Configuration of tool output rails.
+    Tool output rails are applied to tool calls before they are executed.
+    They can validate tool names, parameters, and context to ensure safe tool usage.
+    """
+
+    flows: Optional[List[str]] = None
+    """The names of all the flows that implement tool output rails."""
+
+    parallel: Optional[bool] = None
+    """If True, the tool output rails are executed in parallel."""

nemo_platform/types/guardrail/tool_output_rails_param.py

@@ -0,0 +1,38 @@
+# 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__ = ["ToolOutputRailsParam"]
+
+
+class ToolOutputRailsParam(TypedDict, total=False):
+    """
+    Configuration of tool output rails.
+    Tool output rails are applied to tool calls before they are executed.
+    They can validate tool names, parameters, and context to ensure safe tool usage.
+    """
+
+    flows: SequenceNotStr[str]
+    """The names of all the flows that implement tool output rails."""
+
+    parallel: bool
+    """If True, the tool output rails are executed in parallel."""