scale-gp-beta 0.1.0a26__py3-none-any.whl → 0.1.0a27__py3-none-any.whl

scale_gp_beta/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "scale_gp_beta"
-__version__ = "0.1.0-alpha.26"  # x-release-please-version
+__version__ = "0.1.0-alpha.27"  # x-release-please-version

scale_gp_beta/lib/tracing/integrations/__init__.py

@@ -0,0 +1,5 @@
+try:
+    from .openai.openai_tracing_sgp_processor import OpenAITracingSGPProcessor  # type: ignore[attr-defined]
+    __all__ = ["OpenAITracingSGPProcessor"]
+except ImportError:
+    pass

scale_gp_beta/lib/tracing/integrations/openai/openai_span_type_map.py

@@ -0,0 +1,29 @@
+from typing import Dict, Optional
+
+from scale_gp_beta.lib.tracing.types import SpanTypeLiterals
+
+OPENAI_SPAN_TYPE_MAP: Dict[str, SpanTypeLiterals] = {
+    "generation": "COMPLETION",
+    "agent": "AGENT_WORKFLOW",
+    "function": "CODE_EXECUTION",
+    "response": "COMPLETION",
+    "handoff": "CUSTOM",
+    "custom": "CUSTOM",
+    "guardrail": "STANDALONE",
+    "transcription": "STANDALONE",
+    "speech": "STANDALONE",
+    "speech_group": "STANDALONE",
+    "mcp_tools": "STANDALONE",
+}
+
+
+def openai_span_type_map(span_type: Optional[str]) -> SpanTypeLiterals:
+    """
+    Maps an OpenAI span type string to its corresponding SGP SpanTypeLiteral.
+
+    Returns "CUSTOM" if the input is None or not found in the map.
+    """
+    if not span_type:
+        return "CUSTOM"
+
+    return OPENAI_SPAN_TYPE_MAP.get(span_type, "CUSTOM")

scale_gp_beta/lib/tracing/integrations/openai/openai_tracing_sgp_processor.py

@@ -0,0 +1,144 @@
+# The following `type: ignore` is necessary because this file provides an optional
+# integration for the 'openai-agents' library. The linter will report missing
+# imports if the library isn't installed in the development environment, but the
+# code handles this gracefully at runtime with a try/except block.
+# type: ignore
+import logging
+from typing import TYPE_CHECKING, Any, Dict, Optional
+
+from scale_gp_beta.lib.tracing.span import BaseSpan
+from scale_gp_beta.lib.tracing.tracing import create_span, flush_queue, create_trace, tracing_queue_manager
+from scale_gp_beta.lib.tracing.trace_queue_manager import TraceQueueManager
+
+from .utils import sgp_span_name, parse_metadata, extract_response, parse_input_output
+from .openai_span_type_map import openai_span_type_map
+
+log: logging.Logger = logging.getLogger(__name__)
+
+try:
+    from agents.tracing import (
+        Span as OpenAISpan,
+        Trace as OpenAITrace,
+        SpanData as OpenAISpanData,
+        ResponseSpanData as OpenAIResponseSpanData,
+        TracingProcessor,
+    )
+
+    _openai_agents_installed = True
+except ImportError:
+    _openai_agents_installed = False
+    TracingProcessor = object
+    class _Fallback:
+        pass
+
+    OpenAISpan = _Fallback
+    OpenAITrace = _Fallback
+    OpenAISpanData = _Fallback
+    OpenAIResponseSpanData = _Fallback
+
+    if TYPE_CHECKING:
+        OpenAISpan = Any
+        OpenAITrace = Any
+        OpenAISpanData = Any
+        OpenAIResponseSpanData = Any
+
+
+class OpenAITracingSGPProcessor(TracingProcessor):
+    """
+    An SGP tracing processor that integrates with OpenAI Agents SDK.
+
+    This processor requires the 'openai-agents' library to be installed.
+    It will raise an ImportError on initialization if the library is not found.
+    """
+
+    def __init__(
+            self,
+            *,
+            queue_manager: Optional[TraceQueueManager] = None,
+    ):
+        """
+        Initializes the processor.
+
+        Args:
+            queue_manager: An optional custom trace queue manager.
+
+        Raises:
+            ImportError: If the 'openai-agents' package is not installed.
+        """
+        # This runtime check is the gatekeeper. If 'openai-agents' isn't
+        # installed, no instance of this class can be created.
+        if not _openai_agents_installed:
+            raise ImportError(
+                "The 'openai-agents' package is required to use the OpenAITracingSGPProcessor. "
+                "Please install it with: pip install 'openai-agents'"
+            )
+
+        self._queue_manager = queue_manager or tracing_queue_manager()
+        self._spans: Dict[str, BaseSpan] = {}
+
+    def on_trace_start(self, openai_trace: "OpenAITrace") -> None:
+        sgp_trace = create_trace(
+            name=openai_trace.name or "Agent Workflow",
+            span_type="AGENT_WORKFLOW",
+            group_id=openai_trace.group_id,
+            trace_id=openai_trace.trace_id,
+            metadata={"openai_metadata": openai_trace.metadata or {}},
+        )
+        sgp_trace.start()
+        self._spans[openai_trace.trace_id] = sgp_trace.root_span
+
+    def on_trace_end(self, openai_trace: "OpenAITrace") -> None:
+        root_span = self._spans.pop(openai_trace.trace_id, None)
+        if root_span is None:
+            log.warning(f"No root span found for trace_id: {openai_trace.trace_id}")
+            return
+        root_span.end()
+
+    def on_span_start(self, openai_span: "OpenAISpan") -> None:
+        _spans_key = openai_span.parent_id or openai_span.trace_id
+        parent_span = self._spans.get(_spans_key)
+        span_data = openai_span.span_data
+
+        if not parent_span:
+            log.warning(f"No parent span found for span_id: {openai_span.span_id}")
+            return
+
+        name = sgp_span_name(openai_span)
+        sgp_span_type = openai_span_type_map(span_data.type if span_data else None)
+
+        new_span = create_span(
+            name=name,
+            span_type=sgp_span_type,
+            span_id=openai_span.span_id,
+            trace_id=parent_span.trace_id,
+            parent_id=parent_span.span_id,
+        )
+        new_span.start()
+        self._spans[openai_span.span_id] = new_span
+
+    def on_span_end(self, openai_span: "OpenAISpan") -> None:
+        sgp_span = self._spans.pop(openai_span.span_id, None)
+        if sgp_span is None:
+            log.warning(f"No existing span found for span_id: {openai_span.span_id}")
+            return
+
+        # special case response type, if there are more like this we should change arch to support this
+        if isinstance(openai_span.span_data, OpenAIResponseSpanData):
+            response = extract_response(openai_span)
+            sgp_span.input = {"input": openai_span.span_data.input}
+            sgp_span.output = {"output": response.get("output", None) if response else None }
+        else:
+            sgp_span.output = parse_input_output(openai_span, "output")
+            sgp_span.input = parse_input_output(openai_span, "input")
+
+        sgp_span.metadata = parse_metadata(openai_span)
+
+        if openai_span.error:
+            sgp_span.set_error(error_message=str(openai_span.error))
+        sgp_span.end()
+
+    def shutdown(self) -> None:
+        self._queue_manager.shutdown()
+
+    def force_flush(self) -> None:
+        flush_queue()

scale_gp_beta/lib/tracing/integrations/openai/utils.py

@@ -0,0 +1,68 @@
+# type: ignore
+import json
+from typing import Any, Dict, Optional
+
+try:
+    from agents.tracing import (
+        Span as OpenAISpan,
+        ResponseSpanData as OpenAIResponseSpanData,
+    )
+except ImportError:
+    OpenAISpan = Any
+    OpenAIResponseSpanData = Any
+
+
+def sgp_span_name(openai_span: "OpenAISpan") -> str:
+    span_data = openai_span.span_data
+    if span_data is None:
+        return "Unnamed Span"
+    default_name = str(type(span_data).__name__).replace("SpanData", "")
+
+    return span_data.export().get("name", default_name)
+
+
+def extract_response(openai_span: "OpenAISpan") -> Optional[Dict[str, Any]]:
+    span_data = openai_span.span_data
+    if not isinstance(span_data, OpenAIResponseSpanData):
+        return None
+
+    return {} if span_data.response is None else span_data.response.model_dump()
+
+
+def parse_metadata(openai_span: "OpenAISpan") -> Dict[str, Any]:
+    """Extracts and formats metadata from an OpenAI span."""
+    if not openai_span.span_data:
+        return {}
+
+    excluded_fields = ("output", "input")
+    exported_span_data: dict = openai_span.span_data.export()
+    exported_span_data["openai_span_id"] = openai_span.span_id
+
+    filtered_span_data: dict = {
+        k: v for k, v in exported_span_data.items() if k not in excluded_fields
+    }
+    response = extract_response(openai_span)
+    if response is not None:
+        filtered_span_data["openai_response"] = response
+    return {"openai_metadata": filtered_span_data}
+
+
+def parse_input_output(openai_span: "OpenAISpan", key: str) -> Dict[str, Any]:
+    """
+    Safely extracts and parses input/output data from a span.
+    The openai-agents SDK sometimes returns this data as a JSON string.
+    """
+    span_data = openai_span.span_data
+    if not span_data:
+        return {}
+    exported_span_data: dict = span_data.export()
+    value: Optional[Any] = exported_span_data.get(key)
+    if value is None:
+        return {}
+
+    if isinstance(value, str):
+        try:
+            return json.loads(value)
+        except (json.JSONDecodeError, TypeError):
+            return {key: value}
+    return {key: value}

{scale_gp_beta-0.1.0a26.dist-info → scale_gp_beta-0.1.0a27.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: scale-gp-beta
-Version: 0.1.0a26
+Version: 0.1.0a27
 Summary: The official Python library for the Scale GP API
 Project-URL: Homepage, https://github.com/scaleapi/sgp-python-beta
 Project-URL: Repository, https://github.com/scaleapi/sgp-python-beta

{scale_gp_beta-0.1.0a26.dist-info → scale_gp_beta-0.1.0a27.dist-info}/RECORD

@@ -11,7 +11,7 @@ scale_gp_beta/_resource.py,sha256=siZly_U6D0AOVLAzaOsqUdEFFzVMbWRj-ml30nvRp7E,11
 scale_gp_beta/_response.py,sha256=GemuybPk0uemovTlGHyHkj-ScYTTDJA0jqH5FQqIPwQ,28852
 scale_gp_beta/_streaming.py,sha256=fcCSGXslmi2SmmkM05g2SACXHk2Mj7k1X5uMBu6U5s8,10112
 scale_gp_beta/_types.py,sha256=0wSs40TefKMPBj2wQKenEeZ0lzedoHClNJeqrpAgkII,6204
-scale_gp_beta/_version.py,sha256=a3A3ZJ3GGbEmFnL4rjXbroDX1dq8r9ZDEI2rLL3BuIU,174
+scale_gp_beta/_version.py,sha256=pH9t8LZndiar4fooop-BkuK6f4yzE0eHL7DxaCUG-24,174
 scale_gp_beta/pagination.py,sha256=t-U86PYxl20VRsz8VXOMJJDe7HxkX7ISFMvRNbBNy9s,4054
 scale_gp_beta/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 scale_gp_beta/_utils/__init__.py,sha256=PNZ_QJuzZEgyYXqkO1HVhGkj5IU9bglVUcw7H-Knjzw,2062
@@ -35,6 +35,11 @@ scale_gp_beta/lib/tracing/trace_queue_manager.py,sha256=RnEDOKi7c1xlKXUsofShzZ8W
 scale_gp_beta/lib/tracing/tracing.py,sha256=_j30MMy-w5Y33t2lAYSFVpMY_Ia2PFcEFaUEG5UN2OI,9368
 scale_gp_beta/lib/tracing/types.py,sha256=07piipdyN0a25gYGtV6dM12ZroJqLUpBmcFmdQPV4jU,1113
 scale_gp_beta/lib/tracing/util.py,sha256=8Oq4wLXRNOzh3CC1zRaBEr0h_WdXLrk536BUNKRddVE,1527
+scale_gp_beta/lib/tracing/integrations/__init__.py,sha256=-1CwzEpjZS0eifPRAqwEA4D4nzEAfEe9WbXrLxCWQvg,187
+scale_gp_beta/lib/tracing/integrations/openai/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scale_gp_beta/lib/tracing/integrations/openai/openai_span_type_map.py,sha256=kjEVpTJBIvyxNeBbc8k2MBI6-mdIOAPahyk8nAT7HEQ,828
+scale_gp_beta/lib/tracing/integrations/openai/openai_tracing_sgp_processor.py,sha256=o-Fp_V7U9cC1kKP0_750GQInKGlF7KAdpIbGTmyu2tg,5270
+scale_gp_beta/lib/tracing/integrations/openai/utils.py,sha256=s6tbNFJ3N7GjqXDM9f2f4r9ugz3wjO0OTU6KzlU_tLQ,2113
 scale_gp_beta/resources/__init__.py,sha256=uquYxoMtAXyfIas331lnYexJZKr7pEYqi_vKlfrHRIg,5431
 scale_gp_beta/resources/completions.py,sha256=4esj9lGTJAxt6wFvON126DvEGkMIChRZ6uZBOf56Aac,31868
 scale_gp_beta/resources/dataset_items.py,sha256=2d7O5zmqVEafJTxVwgbRz9yq-4T81dPPfFuPDRAaWqU,22510
@@ -121,7 +126,7 @@ scale_gp_beta/types/chat/completion_models_params.py,sha256=NdZ3Lkgclq6UKc9iae-e
 scale_gp_beta/types/chat/completion_models_response.py,sha256=Ctgj6o-QWPSdjBKzG9J4Id0-DjXu4UGGw1NR6-840Ec,403
 scale_gp_beta/types/chat/model_definition.py,sha256=XPkHEe4tY442oLSMlaotClNDv5XeQ3j5RrXgLZFo1Qk,841
 scale_gp_beta/types/files/__init__.py,sha256=OKfJYcKb4NObdiRObqJV_dOyDQ8feXekDUge2o_4pXQ,122
-scale_gp_beta-0.1.0a26.dist-info/METADATA,sha256=prd8poY95iVXq74tFDvSORgl6xx0wENE4p7SBf1Po-w,28723
-scale_gp_beta-0.1.0a26.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-scale_gp_beta-0.1.0a26.dist-info/licenses/LICENSE,sha256=x49Bj8r_ZpqfzThbmfHyZ_bE88XvHdIMI_ANyLHFFRE,11338
-scale_gp_beta-0.1.0a26.dist-info/RECORD,,
+scale_gp_beta-0.1.0a27.dist-info/METADATA,sha256=BXtYGBjQHmzC9ciL8a1S5IW29yawXZiefPmJfbMlY3U,28723
+scale_gp_beta-0.1.0a27.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+scale_gp_beta-0.1.0a27.dist-info/licenses/LICENSE,sha256=x49Bj8r_ZpqfzThbmfHyZ_bE88XvHdIMI_ANyLHFFRE,11338
+scale_gp_beta-0.1.0a27.dist-info/RECORD,,