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

nemo_platform/types/inference/middleware_call_param.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 __future__ import annotations
+
+from typing import Dict
+from typing_extensions import Required, TypedDict
+
+__all__ = ["MiddlewareCallParam"]
+
+
+class MiddlewareCallParam(TypedDict, total=False):
+    """One entry in a VirtualModel middleware pipeline.
+
+    Declares which plugin to invoke and how to resolve its configuration.
+    Exactly one of ``config`` (inline dict) or ``config_id`` (entity reference)
+    should be provided. ``config_type`` is always required regardless of which
+    is used — it is the discriminator that tells IGW (and the plugin) which
+    config schema applies.
+
+    Attributes:
+        name: The entry-point key of the plugin to invoke
+            (e.g. ``"nemo-switchyard"``). Must match the plugin's
+            ``nemo.inference_middleware`` entry-point key.
+        config_type: Always required. Maps to the ``entity_type`` of the plugin's
+            config ``NemoEntity`` subclass (e.g. ``"routellm_config"``). Used by
+            IGW to call :meth:`~NemoInferenceMiddleware.validate_middleware_config`
+            with the right discriminator, and by the plugin to dispatch to the
+            correct schema when it supports multiple config types.
+        config: Inline config dict. Mutually exclusive with ``config_id``.
+        config_id: ``"workspace/name"`` reference to a stored config entity.
+            Mutually exclusive with ``config``. IGW resolves this by calling
+            :meth:`~NemoInferenceMiddleware.get_middleware_config` on the plugin.
+    """
+
+    config_type: Required[str]
+
+    name: Required[str]
+
+    config: Dict[str, object]
+
+    config_id: str

nemo_platform/types/inference/model_deployment.py

@@ -0,0 +1,97 @@
+# 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 datetime import datetime
+
+from ..._compat import PYDANTIC_V1, ConfigDict
+from ..._models import BaseModel
+from ..shared.auth_context import AuthContext
+from .model_deployment_status import ModelDeploymentStatus
+from .model_deployment_status_history_item import ModelDeploymentStatusHistoryItem
+
+__all__ = ["ModelDeployment"]
+
+
+class ModelDeployment(BaseModel):
+    """
+    ModelDeployment represents a deployed instance of a model with a specific configuration.
+    These objects are immutable with automatic versioning, except for status updates.
+
+    The unique identifier is the combination of workspace/name/entity_version.
+    """
+
+    config: str
+    """Reference to the ModelDeploymentConfig name"""
+
+    config_version: int
+    """Reference to the specific ModelDeploymentConfig version"""
+
+    created_at: datetime
+    """The timestamp of model entity creation"""
+
+    entity_version: int
+    """Version of this deployment. Automatically managed."""
+
+    name: str
+    """Name of the entity.
+
+    Name/workspace combo must be unique across all entities. Allowed characters:
+    letters (a-z, A-Z), digits (0-9), underscores, hyphens, and dots.
+    """
+
+    updated_at: datetime
+    """The timestamp of the last model entity update"""
+
+    workspace: str
+    """The workspace of the entity.
+
+    Allowed characters: letters (a-z, A-Z), digits (0-9), underscores, hyphens, and
+    dots.
+    """
+
+    id: Optional[str] = None
+    """Unique identifier for the deployment"""
+
+    auth_context: Optional[AuthContext] = None
+    """Auth context captured at resource creation for delegated access.
+
+    Stores a snapshot of the creating principal's identity so that controllers can
+    later act on their behalf (e.g., accessing secrets).
+    """
+
+    model_provider_id: Optional[str] = None
+    """
+    Optional reference to the auto-created ModelProvider workspace/name (format:
+    workspace/name)
+    """
+
+    project: Optional[str] = None
+    """The URN of the project associated with this entity."""
+
+    status: Optional[ModelDeploymentStatus] = None
+    """Status enum for ModelDeployment objects."""
+
+    status_history: Optional[List[ModelDeploymentStatusHistoryItem]] = None
+    """History of status changes, ordered chronologically (oldest first)"""
+
+    status_message: Optional[str] = None
+    """Detailed status message, populated by models controller"""
+
+    if not PYDANTIC_V1:
+        # allow fields with a `model_` prefix
+        model_config = ConfigDict(protected_namespaces=tuple())

nemo_platform/types/inference/model_deployment_config.py

@@ -0,0 +1,76 @@
+# 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 ..._compat import PYDANTIC_V1, ConfigDict
+from ..._models import BaseModel
+from .nim_deployment import NIMDeployment
+
+__all__ = ["ModelDeploymentConfig"]
+
+
+class ModelDeploymentConfig(BaseModel):
+    """
+    ModelDeploymentConfig stores the configuration details for deploying a model.
+    These objects are immutable with automatic versioning.
+
+    The unique identifier is the combination of workspace/name/entity_version.
+    """
+
+    created_at: datetime
+    """The timestamp of model entity creation"""
+
+    entity_version: int
+    """Version of this deployment config. Automatically managed."""
+
+    name: str
+    """Name of the entity.
+
+    Name/workspace combo must be unique across all entities. Allowed characters:
+    letters (a-z, A-Z), digits (0-9), underscores, hyphens, and dots.
+    """
+
+    nim_deployment: NIMDeployment
+    """Configuration for NIM-based model deployment."""
+
+    updated_at: datetime
+    """The timestamp of the last model entity update"""
+
+    workspace: str
+    """The workspace of the entity.
+
+    Allowed characters: letters (a-z, A-Z), digits (0-9), underscores, hyphens, and
+    dots.
+    """
+
+    id: Optional[str] = None
+    """Unique identifier for the deployment config"""
+
+    description: Optional[str] = None
+    """Optional description of the deployment configuration"""
+
+    model_entity_id: Optional[str] = None
+    """Optional reference to the base model entity ID for this deployment"""
+
+    project: Optional[str] = None
+    """The URN of the project associated with this entity."""
+
+    if not PYDANTIC_V1:
+        # allow fields with a `model_` prefix
+        model_config = ConfigDict(protected_namespaces=tuple())

nemo_platform/types/inference/model_deployment_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__ = ["ModelDeploymentConfigFilterParam"]
+
+
+class ModelDeploymentConfigFilterParam(TypedDict, total=False):
+    """Filter for ModelDeploymentConfig queries."""
+
+    created_at: DatetimeFilter
+    """Filter by creation date."""
+
+    description: str
+    """Filter by description."""
+
+    model_entity_id: str
+    """Filter by associated model entity ID."""
+
+    name: str
+    """Filter by config name."""
+
+    project: str
+    """Filter by project URN."""
+
+    updated_at: DatetimeFilter
+    """Filter by update date."""
+
+    workspace: str
+    """Filter by workspace."""

nemo_platform/types/inference/model_deployment_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 ..shared.pagination_data import PaginationData
+from .model_deployment_config import ModelDeploymentConfig
+
+__all__ = ["ModelDeploymentConfigsPage"]
+
+
+class ModelDeploymentConfigsPage(BaseModel):
+    data: List[ModelDeploymentConfig]
+
+    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."""

nemo_platform/types/inference/model_deployment_filter_param.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 __future__ import annotations
+
+from typing_extensions import TypedDict
+
+from .model_deployment_status import ModelDeploymentStatus
+from ..shared_params.datetime_filter import DatetimeFilter
+
+__all__ = ["ModelDeploymentFilterParam"]
+
+
+class ModelDeploymentFilterParam(TypedDict, total=False):
+    """Filter for ModelDeployment queries."""
+
+    config: str
+    """Filter by config name."""
+
+    created_at: DatetimeFilter
+    """Filter by creation date."""
+
+    model_provider_id: str
+    """Filter by model provider ID."""
+
+    name: str
+    """Filter by deployment name."""
+
+    project: str
+    """Filter by project URN."""
+
+    status: ModelDeploymentStatus
+    """Status enum for ModelDeployment objects."""
+
+    status_message: str
+    """Filter by status message."""
+
+    updated_at: DatetimeFilter
+    """Filter by update date."""
+
+    workspace: str
+    """Filter by workspace."""

nemo_platform/types/inference/model_deployment_status.py

@@ -0,0 +1,24 @@
+# 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__ = ["ModelDeploymentStatus"]
+
+ModelDeploymentStatus: TypeAlias = Literal[
+    "UNKNOWN", "CREATED", "PENDING", "READY", "ERROR", "DELETING", "DELETED", "LOST"
+]

nemo_platform/types/inference/model_deployment_status_history_item.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 Optional
+from datetime import datetime
+
+from ..._models import BaseModel
+from .model_deployment_status import ModelDeploymentStatus
+
+__all__ = ["ModelDeploymentStatusHistoryItem"]
+
+
+class ModelDeploymentStatusHistoryItem(BaseModel):
+    """Record of a status change in ModelDeployment history."""
+
+    status: ModelDeploymentStatus
+    """Status enum for ModelDeployment objects."""
+
+    timestamp: datetime
+    """When this status was recorded"""
+
+    status_message: Optional[str] = None
+    """Status message"""

nemo_platform/types/inference/model_deployments_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 .model_deployment import ModelDeployment
+from ..shared.pagination_data import PaginationData
+
+__all__ = ["ModelDeploymentsPage"]
+
+
+class ModelDeploymentsPage(BaseModel):
+    data: List[ModelDeployment]
+
+    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."""

nemo_platform/types/inference/model_provider.py

@@ -0,0 +1,134 @@
+# 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 datetime import datetime
+
+from ..._compat import PYDANTIC_V1, ConfigDict
+from ..._models import BaseModel
+from ..shared.auth_context import AuthContext
+from .served_model_mapping import ServedModelMapping
+from .model_provider_status import ModelProviderStatus
+
+__all__ = ["ModelProvider"]
+
+
+class ModelProvider(BaseModel):
+    """
+    A ModelProvider defines a reachable network endpoint that provides an inference
+    service for one or more Model Entities. Examples of Model Providers include
+    OpenAI, NIMs, Bedrock, NVIDIA Build, etc. A ModelProvider may be provisioned
+    automatically by Models Controller for ModelDeployments, or it may be provisioned
+    manually by an end user for an endpoint that does not have its lifecycle managed
+    by models service (like an external provider.)
+
+    The unique identifier for a ModelProvider is the combination of workspace/name.
+    """
+
+    created_at: datetime
+    """The timestamp of model entity creation"""
+
+    host_url: str
+    """The network endpoint URL for the model provider"""
+
+    name: str
+    """Name of the entity.
+
+    Name/workspace combo must be unique across all entities. Allowed characters:
+    letters (a-z, A-Z), digits (0-9), underscores, hyphens, and dots.
+    """
+
+    updated_at: datetime
+    """The timestamp of the last model entity update"""
+
+    workspace: str
+    """The workspace of the entity.
+
+    Allowed characters: letters (a-z, A-Z), digits (0-9), underscores, hyphens, and
+    dots.
+    """
+
+    id: Optional[str] = None
+    """Unique identifier for the model provider"""
+
+    api_key_secret_name: Optional[str] = None
+    """Reference to the API key stored in Secrets service"""
+
+    auth_context: Optional[AuthContext] = None
+    """Auth context captured at resource creation for delegated access.
+
+    Stores a snapshot of the creating principal's identity so that controllers can
+    later act on their behalf (e.g., accessing secrets).
+    """
+
+    auth_header_format: Optional[str] = None
+    """
+    Jinja2 template string controlling how the API key secret is sent to the
+    upstream. Must contain exactly one variable named `auth_secret`, which is
+    substituted with the resolved secret value at request time. Example:
+    `'X-Api-Key: {{ auth_secret }}'`. If not set, defaults to
+    `'Authorization: Bearer {{ auth_secret }}'`.
+    """
+
+    default_extra_body: Optional[Dict[str, object]] = None
+    """Default body parameters for inference requests.
+
+    Can be overridden by user requests.
+    """
+
+    default_extra_headers: Optional[Dict[str, str]] = None
+    """Default headers for inference requests. Can be overridden by user requests."""
+
+    description: Optional[str] = None
+    """Optional description of the model provider"""
+
+    enabled_models: Optional[List[str]] = None
+    """Optional list of specific models to enable from this provider.
+
+    If not set, all discovered models are enabled.
+    """
+
+    model_deployment_id: Optional[str] = None
+    """
+    Optional reference to the ModelDeployment ID if this provider was auto-created
+    for a deployment
+    """
+
+    project: Optional[str] = None
+    """The URN of the project associated with this entity."""
+
+    required_extra_body: Optional[Dict[str, object]] = None
+    """Required body parameters for inference requests.
+
+    Cannot be overridden by user requests.
+    """
+
+    required_extra_headers: Optional[Dict[str, str]] = None
+    """Required headers for inference requests. Cannot be overridden by user requests."""
+
+    served_models: Optional[List[ServedModelMapping]] = None
+    """List of models served by this provider with routing information for IGW"""
+
+    status: Optional[ModelProviderStatus] = None
+    """Status enum for ModelProvider objects."""
+
+    status_message: Optional[str] = None
+    """Detailed status message, populated by models service"""
+
+    if not PYDANTIC_V1:
+        # allow fields with a `model_` prefix
+        model_config = ConfigDict(protected_namespaces=tuple())

nemo_platform/types/inference/model_provider_filter_param.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 __future__ import annotations
+
+from typing_extensions import TypedDict
+
+from .model_provider_status import ModelProviderStatus
+from ..shared_params.datetime_filter import DatetimeFilter
+
+__all__ = ["ModelProviderFilterParam"]
+
+
+class ModelProviderFilterParam(TypedDict, total=False):
+    """Filter for ModelProvider queries."""
+
+    created_at: DatetimeFilter
+    """Filter by creation date."""
+
+    description: str
+    """Filter by description."""
+
+    host_url: str
+    """Filter by host URL."""
+
+    model_deployment_id: str
+    """Filter by associated deployment ID."""
+
+    name: str
+    """Filter by name."""
+
+    project: str
+    """Filter by project URN."""
+
+    status: ModelProviderStatus
+    """Status enum for ModelProvider objects."""
+
+    updated_at: DatetimeFilter
+    """Filter by update date."""
+
+    workspace: str
+    """Filter by workspace."""