langwatch-scenario 0.4.0__py3-none-any.whl → 0.7.1__py3-none-any.whl

scenario/_generated/langwatch_api_client/lang_watch_api_client/models/trace.py

@@ -0,0 +1,225 @@
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any, TypeVar, Union, cast
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+if TYPE_CHECKING:
+    from ..models.evaluation import Evaluation
+    from ..models.input_ import Input
+    from ..models.metadata import Metadata
+    from ..models.metrics import Metrics
+    from ..models.output import Output
+    from ..models.timestamps import Timestamps
+
+
+T = TypeVar("T", bound="Trace")
+
+
+@_attrs_define
+class Trace:
+    """
+    Attributes:
+        trace_id (Union[Unset, str]):
+        project_id (Union[Unset, str]):
+        timestamps (Union[Unset, Timestamps]):
+        input_ (Union[Unset, Input]):
+        output (Union[Unset, Output]):
+        metadata (Union[Unset, Metadata]):
+        metrics (Union[Unset, Metrics]):
+        indexing_md5s (Union[Unset, list[str]]):
+        error (Union[None, Unset, str]):
+        evaluations (Union[Unset, list['Evaluation']]):
+        contexts (Union[Unset, list[Any]]):
+    """
+
+    trace_id: Union[Unset, str] = UNSET
+    project_id: Union[Unset, str] = UNSET
+    timestamps: Union[Unset, "Timestamps"] = UNSET
+    input_: Union[Unset, "Input"] = UNSET
+    output: Union[Unset, "Output"] = UNSET
+    metadata: Union[Unset, "Metadata"] = UNSET
+    metrics: Union[Unset, "Metrics"] = UNSET
+    indexing_md5s: Union[Unset, list[str]] = UNSET
+    error: Union[None, Unset, str] = UNSET
+    evaluations: Union[Unset, list["Evaluation"]] = UNSET
+    contexts: Union[Unset, list[Any]] = UNSET
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        trace_id = self.trace_id
+
+        project_id = self.project_id
+
+        timestamps: Union[Unset, dict[str, Any]] = UNSET
+        if not isinstance(self.timestamps, Unset):
+            timestamps = self.timestamps.to_dict()
+
+        input_: Union[Unset, dict[str, Any]] = UNSET
+        if not isinstance(self.input_, Unset):
+            input_ = self.input_.to_dict()
+
+        output: Union[Unset, dict[str, Any]] = UNSET
+        if not isinstance(self.output, Unset):
+            output = self.output.to_dict()
+
+        metadata: Union[Unset, dict[str, Any]] = UNSET
+        if not isinstance(self.metadata, Unset):
+            metadata = self.metadata.to_dict()
+
+        metrics: Union[Unset, dict[str, Any]] = UNSET
+        if not isinstance(self.metrics, Unset):
+            metrics = self.metrics.to_dict()
+
+        indexing_md5s: Union[Unset, list[str]] = UNSET
+        if not isinstance(self.indexing_md5s, Unset):
+            indexing_md5s = self.indexing_md5s
+
+        error: Union[None, Unset, str]
+        if isinstance(self.error, Unset):
+            error = UNSET
+        else:
+            error = self.error
+
+        evaluations: Union[Unset, list[dict[str, Any]]] = UNSET
+        if not isinstance(self.evaluations, Unset):
+            evaluations = []
+            for evaluations_item_data in self.evaluations:
+                evaluations_item = evaluations_item_data.to_dict()
+                evaluations.append(evaluations_item)
+
+        contexts: Union[Unset, list[Any]] = UNSET
+        if not isinstance(self.contexts, Unset):
+            contexts = self.contexts
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update({})
+        if trace_id is not UNSET:
+            field_dict["trace_id"] = trace_id
+        if project_id is not UNSET:
+            field_dict["project_id"] = project_id
+        if timestamps is not UNSET:
+            field_dict["timestamps"] = timestamps
+        if input_ is not UNSET:
+            field_dict["input"] = input_
+        if output is not UNSET:
+            field_dict["output"] = output
+        if metadata is not UNSET:
+            field_dict["metadata"] = metadata
+        if metrics is not UNSET:
+            field_dict["metrics"] = metrics
+        if indexing_md5s is not UNSET:
+            field_dict["indexing_md5s"] = indexing_md5s
+        if error is not UNSET:
+            field_dict["error"] = error
+        if evaluations is not UNSET:
+            field_dict["evaluations"] = evaluations
+        if contexts is not UNSET:
+            field_dict["contexts"] = contexts
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.evaluation import Evaluation
+        from ..models.input_ import Input
+        from ..models.metadata import Metadata
+        from ..models.metrics import Metrics
+        from ..models.output import Output
+        from ..models.timestamps import Timestamps
+
+        d = dict(src_dict)
+        trace_id = d.pop("trace_id", UNSET)
+
+        project_id = d.pop("project_id", UNSET)
+
+        _timestamps = d.pop("timestamps", UNSET)
+        timestamps: Union[Unset, Timestamps]
+        if isinstance(_timestamps, Unset):
+            timestamps = UNSET
+        else:
+            timestamps = Timestamps.from_dict(_timestamps)
+
+        _input_ = d.pop("input", UNSET)
+        input_: Union[Unset, Input]
+        if isinstance(_input_, Unset):
+            input_ = UNSET
+        else:
+            input_ = Input.from_dict(_input_)
+
+        _output = d.pop("output", UNSET)
+        output: Union[Unset, Output]
+        if isinstance(_output, Unset):
+            output = UNSET
+        else:
+            output = Output.from_dict(_output)
+
+        _metadata = d.pop("metadata", UNSET)
+        metadata: Union[Unset, Metadata]
+        if isinstance(_metadata, Unset):
+            metadata = UNSET
+        else:
+            metadata = Metadata.from_dict(_metadata)
+
+        _metrics = d.pop("metrics", UNSET)
+        metrics: Union[Unset, Metrics]
+        if isinstance(_metrics, Unset):
+            metrics = UNSET
+        else:
+            metrics = Metrics.from_dict(_metrics)
+
+        indexing_md5s = cast(list[str], d.pop("indexing_md5s", UNSET))
+
+        def _parse_error(data: object) -> Union[None, Unset, str]:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(Union[None, Unset, str], data)
+
+        error = _parse_error(d.pop("error", UNSET))
+
+        evaluations = []
+        _evaluations = d.pop("evaluations", UNSET)
+        for evaluations_item_data in _evaluations or []:
+            evaluations_item = Evaluation.from_dict(evaluations_item_data)
+
+            evaluations.append(evaluations_item)
+
+        contexts = cast(list[Any], d.pop("contexts", UNSET))
+
+        trace = cls(
+            trace_id=trace_id,
+            project_id=project_id,
+            timestamps=timestamps,
+            input_=input_,
+            output=output,
+            metadata=metadata,
+            metrics=metrics,
+            indexing_md5s=indexing_md5s,
+            error=error,
+            evaluations=evaluations,
+            contexts=contexts,
+        )
+
+        trace.additional_properties = d
+        return trace
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

scenario/_generated/langwatch_api_client/lang_watch_api_client/py.typed

@@ -0,0 +1 @@
+# Marker file for PEP 561

scenario/_generated/langwatch_api_client/lang_watch_api_client/types.py

@@ -0,0 +1,46 @@
+"""Contains some shared types for properties"""
+
+from collections.abc import MutableMapping
+from http import HTTPStatus
+from typing import BinaryIO, Generic, Literal, Optional, TypeVar
+
+from attrs import define
+
+
+class Unset:
+    def __bool__(self) -> Literal[False]:
+        return False
+
+
+UNSET: Unset = Unset()
+
+FileJsonType = tuple[Optional[str], BinaryIO, Optional[str]]
+
+
+@define
+class File:
+    """Contains information for file uploads"""
+
+    payload: BinaryIO
+    file_name: Optional[str] = None
+    mime_type: Optional[str] = None
+
+    def to_tuple(self) -> FileJsonType:
+        """Return a tuple representation that httpx will accept for multipart/form-data"""
+        return self.file_name, self.payload, self.mime_type
+
+
+T = TypeVar("T")
+
+
+@define
+class Response(Generic[T]):
+    """A response from an endpoint"""
+
+    status_code: HTTPStatus
+    content: bytes
+    headers: MutableMapping[str, str]
+    parsed: Optional[T]
+
+
+__all__ = ["UNSET", "File", "FileJsonType", "Response", "Unset"]

scenario/_generated/langwatch_api_client/pyproject.toml

@@ -0,0 +1,27 @@
+[tool.poetry]
+name = "lang-watch-api-client"
+version = "1.0.0"
+description = "A client library for accessing LangWatch API"
+authors = []
+readme = "README.md"
+packages = [
+    {include = "lang_watch_api_client"},
+]
+include = ["CHANGELOG.md", "lang_watch_api_client/py.typed"]
+
+
+[tool.poetry.dependencies]
+python = "^3.9"
+httpx = ">=0.20.0,<0.29.0"
+attrs = ">=22.2.0"
+python-dateutil = "^2.8.0"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = ["F", "I", "UP"]

scenario/_utils/__init__.py

@@ -0,0 +1,32 @@
+"""
+Utility functions for scenario execution and message handling.
+
+This module provides various utility functions used throughout the Scenario framework,
+including message formatting, validation, role reversal, and UI components like spinners
+for better user experience during scenario execution.
+"""
+
+from .message_conversion import convert_agent_return_types_to_openai_messages
+from .ids import get_or_create_batch_run_id, generate_scenario_run_id
+from .utils import (
+    SerializableAndPydanticEncoder,
+    SerializableWithStringFallback,
+    print_openai_messages,
+    show_spinner,
+    check_valid_return_type,
+    reverse_roles,
+    await_if_awaitable,
+)
+
+__all__ = [
+    "convert_agent_return_types_to_openai_messages",
+    "get_or_create_batch_run_id",
+    "generate_scenario_run_id",
+    "SerializableAndPydanticEncoder",
+    "SerializableWithStringFallback",
+    "print_openai_messages",
+    "show_spinner",
+    "check_valid_return_type",
+    "reverse_roles",
+    "await_if_awaitable",
+]

scenario/_utils/ids.py

@@ -0,0 +1,58 @@
+"""
+ID generation and management utilities for scenario execution.
+
+This module provides functions for generating and managing unique identifiers
+used throughout the scenario execution pipeline, particularly for batch runs
+and scenario tracking.
+"""
+
+import os
+import uuid
+
+
+def get_or_create_batch_run_id() -> str:
+    """
+    Gets or creates a batch run ID for the current scenario execution.
+    
+    The batch run ID is consistent across all scenarios in the same process
+    execution, allowing grouping of related scenario runs. This is useful
+    for tracking and reporting on batches of scenarios run together.
+    
+    Returns:
+        str: A unique batch run ID that persists for the process lifetime
+        
+    Example:
+        ```python
+        # All scenarios in same process will share this ID
+        batch_id = get_or_create_batch_run_id()
+        print(f"Running scenario in batch: {batch_id}")
+        ```
+    """
+    
+    # Check if batch ID already exists in environment
+    if not os.environ.get("SCENARIO_BATCH_ID"):
+        # Generate new batch ID if not set
+        os.environ["SCENARIO_BATCH_ID"] = f"batch-run-{uuid.uuid4()}"
+    
+    return os.environ["SCENARIO_BATCH_ID"]
+
+
+def generate_scenario_run_id() -> str:
+    """
+    Generates a unique scenario run ID for a single scenario execution.
+    
+    Each scenario run gets a unique identifier that distinguishes it from
+    other runs, even within the same batch. This is used for tracking
+    individual scenario executions and correlating events.
+    
+    Returns:
+        str: A unique scenario run ID
+        
+    Example:
+        ```python
+        # Each scenario gets its own unique ID
+        scenario_id = generate_scenario_run_id()
+        print(f"Running scenario with ID: {scenario_id}")
+        ```
+    """
+    return f"scenario-run-{uuid.uuid4()}" 

scenario/_utils/message_conversion.py

@@ -0,0 +1,103 @@
+"""
+Message conversion utilities for scenario execution.
+
+This module provides functions for converting between different message formats
+used in scenario execution, particularly for normalizing agent return types
+to OpenAI-compatible message formats.
+"""
+
+import json
+from typing import Any, List, Literal, TypeVar, cast
+from pydantic import BaseModel
+from openai.types.chat import ChatCompletionMessageParam
+
+from scenario.types import AgentReturnTypes, ScenarioResult
+from scenario._utils.utils import SerializableAndPydanticEncoder
+
+T = TypeVar("T")
+
+
+def convert_agent_return_types_to_openai_messages(
+    agent_response: AgentReturnTypes, role: Literal["user", "assistant"]
+) -> List[ChatCompletionMessageParam]:
+    """
+    Convert various agent return types to standardized OpenAI message format.
+
+    This function normalizes different return types from agent adapters into
+    a consistent list of OpenAI-compatible messages that can be used throughout
+    the scenario execution pipeline.
+
+    Args:
+        agent_response: Response from an agent adapter call
+        role: The role to assign to string responses ("user" or "assistant")
+
+    Returns:
+        List of OpenAI-compatible messages
+
+    Raises:
+        ValueError: If agent_response is a ScenarioResult (which should be handled separately)
+
+    Example:
+        ```
+        # String response
+        messages = convert_agent_return_types_to_openai_messages("Hello", "assistant")
+        # Result: [{"role": "assistant", "content": "Hello"}]
+
+        # Dict response
+        response = {"role": "assistant", "content": "Hi", "tool_calls": [...]}
+        messages = convert_agent_return_types_to_openai_messages(response, "assistant")
+        # Result: [{"role": "assistant", "content": "Hi", "tool_calls": [...]}]
+
+        # List response
+        responses = [
+            {"role": "assistant", "content": "Thinking..."},
+            {"role": "assistant", "content": "Here's the answer"}
+        ]
+        messages = convert_agent_return_types_to_openai_messages(responses, "assistant")
+        # Result: Same list, validated and normalized
+        ```
+    """
+    if isinstance(agent_response, ScenarioResult):
+        raise ValueError(
+            "Unexpectedly tried to convert a ScenarioResult to openai messages",
+            agent_response.__repr__(),
+        )
+
+    def convert_maybe_object_to_openai_message(
+        obj: Any,
+    ) -> ChatCompletionMessageParam:
+        if isinstance(obj, dict):
+            return cast(ChatCompletionMessageParam, obj)
+        elif isinstance(obj, BaseModel):
+            return cast(
+                ChatCompletionMessageParam,
+                obj.model_dump(
+                    exclude_unset=True,
+                    exclude_none=True,
+                    exclude_defaults=True,
+                    warnings=False,
+                ),
+            )
+        else:
+            raise ValueError(f"Unexpected agent response type: {type(obj).__name__}")
+
+    def ensure_dict(
+        obj: T,
+    ) -> T:
+        return json.loads(json.dumps(obj, cls=SerializableAndPydanticEncoder))
+
+    if isinstance(agent_response, str):
+        return [
+            (
+                {"role": "user", "content": agent_response}
+                if role == "user"
+                else {"role": "assistant", "content": agent_response}
+            )
+        ]
+    elif isinstance(agent_response, list):
+        return [
+            ensure_dict(convert_maybe_object_to_openai_message(message))
+            for message in agent_response
+        ]
+    else:
+        return [ensure_dict(convert_maybe_object_to_openai_message(agent_response))]