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

nemo_platform/types/guardrail/g_li_ner_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_extensions import TypedDict
+
+from .g_li_ner_detection_options_param import GLiNERDetectionOptionsParam
+
+__all__ = ["GLiNERDetectionParam"]
+
+
+class GLiNERDetectionParam(TypedDict, total=False):
+    """Configuration for GLiNER PII detection."""
+
+    chunk_length: int
+    """Length of text chunks for processing."""
+
+    flat_ner: bool
+    """Whether to use flat NER mode. Setting to False allows for nested entities."""
+
+    input: GLiNERDetectionOptionsParam
+    """Configuration options for GLiNER."""
+
+    output: GLiNERDetectionOptionsParam
+    """Configuration options for GLiNER."""
+
+    overlap: int
+    """Overlap between chunks."""
+
+    retrieval: GLiNERDetectionOptionsParam
+    """Configuration options for GLiNER."""
+
+    server_endpoint: str
+    """The endpoint for the GLiNER detection server."""
+
+    threshold: float
+    """Confidence threshold for entity detection (0.0 to 1.0)."""

nemo_platform/types/guardrail/generation_log.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, List, Optional
+
+from ..._models import BaseModel
+from .llm_call_info import LLMCallInfo
+from .activated_rail import ActivatedRail
+from .generation_stats import GenerationStats
+
+__all__ = ["GenerationLog"]
+
+
+class GenerationLog(BaseModel):
+    """Contains additional logging information associated with a generation call."""
+
+    activated_rails: Optional[List[ActivatedRail]] = None
+    """The list of rails that were activated during generation."""
+
+    colang_history: Optional[str] = None
+    """The Colang history associated with the generation."""
+
+    internal_events: Optional[List[Dict[str, object]]] = None
+    """The complete sequence of internal events generated."""
+
+    llm_calls: Optional[List[LLMCallInfo]] = None
+    """The list of LLM calls that have been made to fulfill the generation request."""
+
+    stats: Optional[GenerationStats] = None
+    """General stats about the generation."""

nemo_platform/types/guardrail/generation_log_options_param.py

@@ -0,0 +1,50 @@
+# 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__ = ["GenerationLogOptionsParam"]
+
+
+class GenerationLogOptionsParam(TypedDict, total=False):
+    """Options for what should be included in the generation log."""
+
+    activated_rails: bool
+    """
+    Include detailed information about the rails that were activated during
+    generation.
+    """
+
+    colang_history: bool
+    """Include the history of the conversation in Colang format."""
+
+    internal_events: bool
+    """Include the array of internal generated events."""
+
+    llm_calls: bool
+    """Include information about all the LLM calls that were made.
+
+    This includes: prompt, completion, token usage, raw response, etc.
+    """
+
+    stats: bool
+    """
+    Include generation statistics — rail durations, LLM call counts, and token
+    usage.
+    """

nemo_platform/types/guardrail/generation_options_param.py

@@ -0,0 +1,55 @@
+# 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 TypedDict
+
+from ..._types import SequenceNotStr
+from .generation_log_options_param import GenerationLogOptionsParam
+from .generation_rails_options_param import GenerationRailsOptionsParam
+
+__all__ = ["GenerationOptionsParam"]
+
+
+class GenerationOptionsParam(TypedDict, total=False):
+    """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
+    """Whether the response should also include any custom LLM output."""
+
+    llm_params: Dict[str, object]
+    """Additional parameters that should be used for the LLM call"""
+
+    log: GenerationLogOptionsParam
+    """Options for what should be included in the generation log."""
+
+    output_vars: Union[bool, SequenceNotStr[str]]
+    """Whether additional context information should be returned.
+
+    When True is specified, the whole context is returned. Otherwise, a list of key
+    names can be specified.
+    """
+
+    rails: GenerationRailsOptionsParam
+    """Options for what rails should be used during the generation."""

nemo_platform/types/guardrail/generation_rails_options_param.py

@@ -0,0 +1,53 @@
+# 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 TypedDict
+
+from ..._types import SequenceNotStr
+
+__all__ = ["GenerationRailsOptionsParam"]
+
+
+class GenerationRailsOptionsParam(TypedDict, total=False):
+    """Options for what rails should be used during the generation."""
+
+    dialog: bool
+    """Whether the dialog rails are enabled or not."""
+
+    input: Union[bool, SequenceNotStr[str]]
+    """Whether the input rails are enabled or not.
+
+    If a list of names is specified, then only the specified input rails will be
+    applied.
+    """
+
+    output: Union[bool, SequenceNotStr[str]]
+    """Whether the output rails are enabled or not.
+
+    If a list of names is specified, then only the specified output rails will be
+    applied.
+    """
+
+    retrieval: Union[bool, SequenceNotStr[str]]
+    """Whether the retrieval rails are enabled or not.
+
+    If a list of names is specified, then only the specified retrieval rails will be
+    applied.
+    """

nemo_platform/types/guardrail/generation_stats.py

@@ -0,0 +1,56 @@
+# 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__ = ["GenerationStats"]
+
+
+class GenerationStats(BaseModel):
+    """General stats about the generation."""
+
+    dialog_rails_duration: Optional[float] = None
+    """The time in seconds spent in processing the dialog rails."""
+
+    generation_rails_duration: Optional[float] = None
+    """The time in seconds spent in generation rails."""
+
+    input_rails_duration: Optional[float] = None
+    """The time in seconds spent in processing the input rails."""
+
+    llm_calls_count: Optional[int] = None
+    """The number of LLM calls in total."""
+
+    llm_calls_duration: Optional[float] = None
+    """The time in seconds spent in LLM calls."""
+
+    llm_calls_total_completion_tokens: Optional[int] = None
+    """The total number of completion tokens."""
+
+    llm_calls_total_prompt_tokens: Optional[int] = None
+    """The total number of prompt tokens."""
+
+    llm_calls_total_tokens: Optional[int] = None
+    """The total number of tokens."""
+
+    output_rails_duration: Optional[float] = None
+    """The time in seconds spent in processing the output rails."""
+
+    total_duration: Optional[float] = None
+    """The total time in seconds."""

nemo_platform/types/guardrail/guardrail_check_params.py

@@ -0,0 +1,164 @@
+# 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, Iterable
+from typing_extensions import Required, TypeAlias, TypedDict
+
+from ..._types import SequenceNotStr
+from .guardrails_data_param import GuardrailsDataParam
+from .chat_completion_tool_message_param import ChatCompletionToolMessageParam
+from .chat_completion_user_message_param import ChatCompletionUserMessageParam
+from .chat_completion_system_message_param import ChatCompletionSystemMessageParam
+from .chat_completion_function_message_param import ChatCompletionFunctionMessageParam
+from .chat_completion_assistant_message_param import ChatCompletionAssistantMessageParam
+
+__all__ = ["GuardrailCheckParams", "Message"]
+
+
+class GuardrailCheckParams(TypedDict, total=False):
+    workspace: str
+
+    messages: Required[Iterable[Message]]
+    """A list of messages comprising the conversation so far"""
+
+    model: Required[str]
+    """The model to use for completion. Must be one of the available models."""
+
+    frequency_penalty: float
+    """
+    Positive values penalize new tokens based on their existing frequency in the
+    text.
+    """
+
+    function_call: Union[str, Dict[str, object]]
+    """Deprecated in favor of tool_choice.
+
+    'none' means the model will not call a function and instead generates a message.
+    'auto' means the model can pick between generating a message or calling a
+    function. Specifying a particular function via {'name': 'my_function'} forces
+    the model to call that function.
+    """
+
+    guardrails: GuardrailsDataParam
+    """Guardrails specific options for the request."""
+
+    ignore_eos: bool
+    """Ignore the eos when running"""
+
+    logit_bias: Dict[str, float]
+    """Modify the likelihood of specified tokens appearing in the completion.
+
+    Maps token IDs (as strings) to bias values from -100 to 100.
+    """
+
+    logprobs: bool
+    """Whether to return log probabilities of the output tokens or not.
+
+    If true, returns the log probabilities of each output token returned in the
+    content of message
+    """
+
+    max_completion_tokens: int
+    """
+    An upper bound for the number of tokens that can be generated for a completion,
+    including visible output tokens and reasoning tokens. Preferred over max_tokens
+    for reasoning models.
+    """
+
+    max_tokens: int
+    """The maximum number of tokens that can be generated in the chat completion."""
+
+    n: int
+    """How many chat completion choices to generate for each input message."""
+
+    presence_penalty: float
+    """
+    Positive values penalize new tokens based on whether they appear in the text so
+    far.
+    """
+
+    reasoning_effort: str
+    """Constrains effort on reasoning for reasoning models.
+
+    Reducing reasoning effort can result in faster responses and fewer tokens used
+    on reasoning in a response.
+    """
+
+    response_format: Dict[str, object]
+    """Format of the response.
+
+    Use {'type': 'json_object'} for JSON mode or {'type': 'json_schema',
+    'json_schema': {...}} for structured outputs.
+    """
+
+    seed: int
+    """If specified, attempts to sample deterministically."""
+
+    stop: Union[str, SequenceNotStr[str]]
+    """Up to 4 sequences where the API will stop generating further tokens."""
+
+    stream: bool
+    """If set, partial message deltas will be sent, like in ChatGPT."""
+
+    stream_options: Dict[str, bool]
+    """Options for streaming response.
+
+    Only set this when stream=True. Supports include_usage to receive token usage in
+    the final stream chunk.
+    """
+
+    temperature: float
+    """What sampling temperature to use, between 0 and 2."""
+
+    tool_choice: Union[str, Dict[str, object]]
+    """Controls which (if any) tool is called by the model.
+
+    'none' means no tool is called, 'auto' lets the model decide, 'required' forces
+    a tool call.
+    """
+
+    tools: Iterable[Dict[str, object]]
+    """A list of tools the model may call.
+
+    Each tool is an object with a 'type' field and a 'function' definition.
+    """
+
+    top_logprobs: int
+    """The number of most likely tokens to return at each token position."""
+
+    top_p: float
+    """An alternative to sampling with temperature, called nucleus sampling."""
+
+    user: str
+    """
+    A unique identifier representing your end-user, used by some providers for abuse
+    monitoring.
+    """
+
+    vision: bool
+    """Whether this is a vision-capable request with image inputs."""
+
+
+Message: TypeAlias = Union[
+    ChatCompletionSystemMessageParam,
+    ChatCompletionUserMessageParam,
+    ChatCompletionAssistantMessageParam,
+    ChatCompletionToolMessageParam,
+    ChatCompletionFunctionMessageParam,
+]

nemo_platform/types/guardrail/guardrail_check_response.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 Dict, Optional
+
+from ..._models import BaseModel
+from .rail_status import RailStatus
+from .status_enum import StatusEnum
+from .guardrails_data import GuardrailsData
+
+__all__ = ["GuardrailCheckResponse"]
+
+
+class GuardrailCheckResponse(BaseModel):
+    rails_status: Dict[str, RailStatus]
+    """Dictionary mapping each rail to its status."""
+
+    status: StatusEnum
+    """Overall status indicating if all rails passed or if any failed."""
+
+    guardrails_data: Optional[GuardrailsData] = None
+    """Additional data related to guardrails."""

nemo_platform/types/guardrail/guardrail_config.py

@@ -0,0 +1,59 @@
+# 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 datetime import datetime
+
+from ..._models import BaseModel
+from .rails_config import RailsConfig
+
+__all__ = ["GuardrailConfig"]
+
+
+class GuardrailConfig(BaseModel):
+    """A guardrail configuration entity."""
+
+    id: str
+
+    created_at: datetime
+
+    created_by: Optional[str] = None
+
+    entity_id: str
+    """Alias for id for backwards compatibility."""
+
+    parent: str
+    """Parent entity ID for nested entities."""
+
+    updated_at: datetime
+
+    updated_by: Optional[str] = None
+
+    workspace: str
+    """Workspace identifier"""
+
+    data: Optional[RailsConfig] = None
+    """Configuration object for the models and the rails."""
+
+    description: Optional[str] = None
+    """Description of the guardrail config"""
+
+    name: Optional[str] = None
+    """Entity name within the workspace"""
+
+    project: Optional[str] = None
+    """The name of the project associated with this entity."""

nemo_platform/types/guardrail/guardrail_config_filter_param.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 __future__ import annotations
+
+from typing_extensions import TypedDict
+
+from ..shared_params.datetime_filter import DatetimeFilter
+
+__all__ = ["GuardrailConfigFilterParam"]
+
+
+class GuardrailConfigFilterParam(TypedDict, total=False):
+    """Filter schema for listing guardrail configs."""
+
+    created_at: DatetimeFilter
+    """Filter by creation date.
+
+    Supports '$gte' (on or after) and '$lte' (on or before) datetime filters.
+    """
+
+    description: str
+    """Filter by config description."""
+
+    name: str
+    """Filter by config name."""
+
+    project: str
+    """Filter by project name."""
+
+    updated_at: DatetimeFilter
+    """Filter by update date.
+
+    Supports '$gte' (on or after) and '$lte' (on or before) datetime filters.
+    """

nemo_platform/types/guardrail/guardrail_configs_page.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 Dict, List, Optional
+
+from ..._models import BaseModel
+from .guardrail_config import GuardrailConfig
+from ..shared.pagination_data import PaginationData
+
+__all__ = ["GuardrailConfigsPage"]
+
+
+class GuardrailConfigsPage(BaseModel):
+    data: List[GuardrailConfig]
+
+    filter: Optional[Dict[str, object]] = None
+    """Filtering information."""
+
+    pagination: Optional[PaginationData] = None
+    """Pagination information."""
+
+    sort: Optional[str] = None
+    """The field on which the results are sorted."""