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

nemo_platform/types/intake/span_sort_field.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__ = ["SpanSortField"]
+
+SpanSortField: TypeAlias = Literal["started_at", "-started_at"]

nemo_platform/types/intake/span_status.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__ = ["SpanStatus"]
+
+SpanStatus: TypeAlias = Literal["success", "error", "cancelled", "unknown"]

nemo_platform/types/intake/spans/__init__.py

@@ -0,0 +1,20 @@
+# 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 .evaluator_result_list_response import EvaluatorResultListResponse as EvaluatorResultListResponse

nemo_platform/types/intake/spans/evaluator_result_list_response.py

@@ -0,0 +1,25 @@
+# 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
+from typing_extensions import TypeAlias
+
+from ..evaluator_result import EvaluatorResult
+
+__all__ = ["EvaluatorResultListResponse"]
+
+EvaluatorResultListResponse: TypeAlias = List[EvaluatorResult]

nemo_platform/types/intake/spans_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 .span import Span
+from ..._models import BaseModel
+from ..shared.pagination_data import PaginationData
+
+__all__ = ["SpansPage"]
+
+
+class SpansPage(BaseModel):
+    data: List[Span]
+
+    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/intake/thumb_direction.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__ = ["ThumbDirection"]
+
+ThumbDirection: TypeAlias = Literal["up", "down"]

nemo_platform/types/intake/trace.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 typing import Optional
+from datetime import datetime
+
+from ..._models import BaseModel
+from .span_status import SpanStatus
+from .span_evaluation_context import SpanEvaluationContext
+
+__all__ = ["Trace"]
+
+
+class Trace(BaseModel):
+    id: str
+
+    session_id: str
+
+    started_at: datetime
+
+    status: SpanStatus
+
+    workspace: str
+
+    cached_tokens: Optional[int] = None
+
+    cost_input_usd: Optional[float] = None
+
+    cost_output_usd: Optional[float] = None
+
+    cost_usd: Optional[float] = None
+
+    duration_ms: Optional[float] = None
+
+    ended_at: Optional[datetime] = None
+
+    error_count: Optional[int] = None
+
+    evaluation_context: Optional[SpanEvaluationContext] = None
+
+    input_tokens: Optional[int] = None
+
+    name: Optional[str] = None
+
+    output_tokens: Optional[int] = None
+
+    root_span_id: Optional[str] = None
+
+    span_count: Optional[int] = None
+
+    total_tokens: Optional[int] = None

nemo_platform/types/intake/trace_filter_param.py

@@ -0,0 +1,60 @@
+# 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 .span_status import SpanStatus
+from ..shared_params.datetime_filter import DatetimeFilter
+
+__all__ = ["TraceFilterParam"]
+
+
+class TraceFilterParam(TypedDict, total=False):
+    id: str
+    """Filter by canonical Intake trace id."""
+
+    dataset_id: str
+    """Filter by root-span dataset id."""
+
+    dataset_name: str
+    """Filter by root-span dataset name."""
+
+    dataset_version: str
+    """Filter by root-span dataset version."""
+
+    evaluation_id: str
+    """Filter by root-span evaluation id."""
+
+    evaluation_run_id: str
+    """Filter by root-span evaluation run id."""
+
+    evaluation_sha: str
+    """Filter by root-span evaluation sha."""
+
+    session_id: str
+    """Filter by session id."""
+
+    started_at: DatetimeFilter
+    """Filter by root span start timestamp."""
+
+    status: SpanStatus
+    """Filter by rolled-up trace status."""
+
+    test_case_id: str
+    """Filter by root-span dataset test case id."""

nemo_platform/types/intake/trace_list_params.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 Literal, TypedDict
+
+from .trace_sort_field import TraceSortField
+from .trace_filter_param import TraceFilterParam
+
+__all__ = ["TraceListParams"]
+
+
+class TraceListParams(TypedDict, total=False):
+    workspace: str
+
+    filter: TraceFilterParam
+    """
+    Filter root-span-backed traces by id, session_id, rolled-up status, root span
+    started_at, and root-span evaluation context fields.
+    """
+
+    mode: Literal["summary", "detailed"]
+    """
+    Use summary for root-span trace fields only, or detailed to include token, cost,
+    and span-count rollups.
+    """
+
+    page: int
+    """Page number."""
+
+    page_size: int
+    """Page size."""
+
+    sort: TraceSortField

nemo_platform/types/intake/trace_retrieve_params.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, TypedDict
+
+__all__ = ["TraceRetrieveParams"]
+
+
+class TraceRetrieveParams(TypedDict, total=False):
+    workspace: str
+
+    mode: Literal["summary", "detailed"]
+    """
+    Use summary for root-span trace fields only, or detailed to include token, cost,
+    and span-count rollups.
+    """

nemo_platform/types/intake/trace_sort_field.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__ = ["TraceSortField"]
+
+TraceSortField: TypeAlias = Literal["started_at", "-started_at"]

nemo_platform/types/intake/traces_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 .trace import Trace
+from ..._models import BaseModel
+from ..shared.pagination_data import PaginationData
+
+__all__ = ["TracesPage"]
+
+
+class TracesPage(BaseModel):
+    data: List[Trace]
+
+    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/intake/usage.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 typing import Optional
+from datetime import datetime
+
+from ..._models import BaseModel
+
+__all__ = ["Usage"]
+
+
+class Usage(BaseModel):
+    """Structured usage metrics captured at log time.
+
+    Every field is optional so producers can populate whatever they have without
+    schema breakage. Stored as the entry-level ``usage`` field so filters can
+    reach it via ``data.usage.<field>`` entity-store paths.
+    """
+
+    cached_tokens: Optional[int] = None
+    """Number of input tokens served from a prompt cache (subset of input_tokens)."""
+
+    cost_input_usd: Optional[float] = None
+    """Estimated cost attributed to input tokens, in USD."""
+
+    cost_output_usd: Optional[float] = None
+    """Estimated cost attributed to output tokens, in USD."""
+
+    cost_usd: Optional[float] = None
+    """Total estimated cost of this call, in USD."""
+
+    ended_at: Optional[datetime] = None
+    """UTC timestamp when the upstream LLM call ended."""
+
+    input_tokens: Optional[int] = None
+    """Number of input tokens consumed."""
+
+    latency_ms: Optional[int] = None
+    """Wall-clock latency of the upstream LLM call, in milliseconds."""
+
+    model: Optional[str] = None
+    """The actual model that served the request (after any routing).
+
+    May differ from the model in the request body.
+    """
+
+    output_tokens: Optional[int] = None
+    """Number of output tokens produced."""
+
+    started_at: Optional[datetime] = None
+    """UTC timestamp when the upstream LLM call started."""

nemo_platform/types/intake/usage_param.py

@@ -0,0 +1,68 @@
+# 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 datetime import datetime
+from typing_extensions import Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["UsageParam"]
+
+
+class UsageParam(TypedDict, total=False):
+    """Structured usage metrics captured at log time.
+
+    Every field is optional so producers can populate whatever they have without
+    schema breakage. Stored as the entry-level ``usage`` field so filters can
+    reach it via ``data.usage.<field>`` entity-store paths.
+    """
+
+    cached_tokens: int
+    """Number of input tokens served from a prompt cache (subset of input_tokens)."""
+
+    cost_input_usd: float
+    """Estimated cost attributed to input tokens, in USD."""
+
+    cost_output_usd: float
+    """Estimated cost attributed to output tokens, in USD."""
+
+    cost_usd: float
+    """Total estimated cost of this call, in USD."""
+
+    ended_at: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """UTC timestamp when the upstream LLM call ended."""
+
+    input_tokens: int
+    """Number of input tokens consumed."""
+
+    latency_ms: int
+    """Wall-clock latency of the upstream LLM call, in milliseconds."""
+
+    model: str
+    """The actual model that served the request (after any routing).
+
+    May differ from the model in the request body.
+    """
+
+    output_tokens: int
+    """Number of output tokens produced."""
+
+    started_at: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """UTC timestamp when the upstream LLM call started."""

nemo_platform/types/intake/user_action_event.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 typing import Dict, List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["UserActionEvent"]
+
+
+class UserActionEvent(BaseModel):
+    """Free-form user action captured by the client application.
+
+    Use this to track arbitrary user interactions with AI responses, such as copying code,
+    clicking share buttons, making purchases, or any other measurable action.
+
+    The action identifier must be ≤256 characters and should use snake-case or kebab-case
+    for consistency (e.g., ``share_clicked``, ``code_copied``, ``purchase_made``).
+    """
+
+    action: str
+    """
+    Descriptive name for the action taken by the user (e.g., 'share_clicked',
+    'code_copied', 'link_followed'). Use snake-case or kebab-case. This is a label,
+    not a unique identifier—multiple events can have the same action name.
+    """
+
+    id: Optional[str] = None
+    """Unique identifier for the event. Populated when retrieved from database."""
+
+    created_at: Optional[datetime] = None
+    """UTC timestamp when the record was created."""
+
+    created_by: Optional[Dict[str, str]] = None
+    """Identifier of the user or system that generated the record.
+
+    Can be set of key-value pairs.
+    """
+
+    event_type: Optional[Literal["user_action"]] = None
+
+    metadata: Optional[Dict[str, Union[str, List[str], bool, float]]] = None
+    """
+    Optional key-value pairs with additional context about the action (max 16
+    entries). Use this for details like user IDs, item IDs, timestamps, A/B test
+    variants, or any other information useful for downstream training or evaluation
+    pipelines. Example: {'user_id': '12345', 'experiment': 'variant_b',
+    'item_purchased': 'product_456'}.
+    """