ogx_open_client 1.0.3.dev0__py3-none-any.whl

ogx_open_client/models/response_format.py

@@ -0,0 +1,396 @@
+# coding: utf-8
+
+# Copyright (c) The OGX Contributors.
+# All rights reserved.
+#
+# This source code is licensed under the terms described in the LICENSE file in
+# the root directory of this source tree.
+
+"""
+    OGX Specification - Stable & Experimental APIs
+
+    This is the specification of the OGX that provides                     a set of endpoints and their corresponding interfaces that are     tailored to                     best leverage Llama Models.      **🔗 COMBINED**: This specification includes both stable production-ready APIs     and experimental pre-release APIs. Use stable APIs for production deployments     and experimental APIs for testing new features.
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+import pprint
+import re
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Any, List, Optional
+from ogx_open_client.models.grammar_response_format import GrammarResponseFormat
+from ogx_open_client.models.json_schema_response_format import JsonSchemaResponseFormat
+from pydantic import StrictStr, Field, model_serializer
+from typing import Any, ClassVar
+from typing_extensions import Literal, Self
+from ogx_open_client.lib._utils import pascal_to_snake_case
+
+RESPONSEFORMAT_ONE_OF_SCHEMAS = ["GrammarResponseFormat", "JsonSchemaResponseFormat"]
+
+class ResponseFormat(BaseModel):
+    """
+    ResponseFormat
+    """
+    # data type: JsonSchemaResponseFormat
+    oneof_schema_1_validator: Optional[JsonSchemaResponseFormat] = None
+    # data type: GrammarResponseFormat
+    oneof_schema_2_validator: Optional[GrammarResponseFormat] = None
+    actual_instance: GrammarResponseFormat | JsonSchemaResponseFormat | None = None
+    one_of_schemas: ClassVar[set[str]] = { "GrammarResponseFormat", "JsonSchemaResponseFormat" }
+
+    model_config = ConfigDict(
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    discriminator_value_class_map: ClassVar[dict[str, str]] = {
+        'grammar': 'GrammarResponseFormat',
+        'json_schema': 'JsonSchemaResponseFormat',
+        '': 'ERRORUNKNOWN'
+    }
+    discriminator_property_name: ClassVar[str] = 'type'
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+
+            # Preprocess the value to handle lists of dicts
+            value = args[0]
+            if isinstance(value, list):
+                # Try to construct model instances from dicts in the list
+                # This ensures default values are applied
+                from pydantic import ValidationError as PydanticValidationError
+                validated = None
+                if validated is not None:
+                    value = validated
+
+            super().__init__(actual_instance=value)
+        else:
+            super().__init__(**kwargs)
+
+    def __getattr__(self, name: str):
+        """Proxy attribute access to actual_instance for transparency."""
+        # Avoid infinite recursion for private attributes and model fields
+        if name.startswith('_') or name in ('actual_instance', 'one_of_schemas', 'model_config', 'model_fields'):
+            raise AttributeError(f"'{type(self).__name__}' object has no attribute '{name}'")
+
+        actual = super().__getattribute__('actual_instance')
+        if actual is None:
+            raise AttributeError(f"'{type(self).__name__}' object has no attribute '{name}' (actual_instance is None)")
+
+        return getattr(actual, name)
+
+    def __iter__(self):
+        """Iterate over items if actual_instance is iterable."""
+        if hasattr(self.actual_instance, '__iter__'):
+            return iter(self.actual_instance)
+        raise TypeError(f"'{type(self.actual_instance).__name__}' object is not iterable")
+
+    def __getitem__(self, index):
+        """Get item by index if actual_instance supports indexing."""
+        if hasattr(self.actual_instance, '__getitem__'):
+            return self.actual_instance[index]
+        raise TypeError(f"'{type(self.actual_instance).__name__}' object is not subscriptable")
+
+    def __len__(self):
+        """Get length if actual_instance supports len()."""
+        if hasattr(self.actual_instance, '__len__'):
+            return len(self.actual_instance)
+        raise TypeError(f"object of type '{type(self.actual_instance).__name__}' has no len()")
+
+    def __bool__(self):
+        """Handle truthiness checks - wrapper is truthy if actual_instance is not None."""
+        return self.actual_instance is not None
+
+    def __eq__(self, other):
+        """Handle equality comparisons transparently."""
+        if hasattr(self, 'actual_instance') and self.actual_instance is not None:
+            other_value = other.actual_instance if hasattr(other, 'actual_instance') else other
+            return self.actual_instance == other_value
+        return super().__eq__(other)
+
+    def __hash__(self):
+        """Handle hashing - use actual_instance's hash if available."""
+        if hasattr(self, 'actual_instance') and self.actual_instance is not None:
+            try:
+                return hash(self.actual_instance)
+            except TypeError:
+                return id(self)
+        return super().__hash__()
+
+    def __repr__(self):
+        """Return repr of actual_instance for debugging."""
+        if hasattr(self, 'actual_instance') and self.actual_instance is not None:
+            return repr(self.actual_instance)
+        return super().__repr__()
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+    @model_serializer(mode='wrap')
+    def serialize_model(self, serializer):
+        """Custom serializer that delegates to actual_instance for proper JSON serialization."""
+        # If actual_instance is None, serialize the wrapper normally
+        if not hasattr(self, 'actual_instance') or self.actual_instance is None:
+            return serializer(self)
+
+        # If actual_instance is a Pydantic model, serialize it using the default serializer
+        # This ensures nested models are also serialized correctly
+        if hasattr(self.actual_instance, '__pydantic_serializer__'):
+            # Use Pydantic's serializer infrastructure to ensure proper serialization
+            from pydantic_core import to_jsonable_python
+            return to_jsonable_python(
+                self.actual_instance,
+                by_alias=True,
+                exclude_none=True,
+                fallback=lambda x: x if isinstance(x, str | int | float | bool | type(None)) else str(x)
+            )
+        # If it's a list of Pydantic models, serialize each one
+        elif isinstance(self.actual_instance, list):
+            from pydantic_core import to_jsonable_python
+            return [
+                to_jsonable_python(
+                    item,
+                    by_alias=True,
+                    exclude_none=True,
+                    fallback=lambda x: x if isinstance(x, str | int | float | bool | type(None)) else str(x)
+                )
+                if hasattr(item, '__pydantic_serializer__')
+                else item
+                for item in self.actual_instance
+            ]
+        # Otherwise return as-is (primitives, dicts, etc.)
+        else:
+            return self.actual_instance
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_oneof(cls, v):
+        instance = ResponseFormat.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: JsonSchemaResponseFormat
+        # Check if we should skip this variant based on discriminator
+        _should_skip_discriminator = False
+        if isinstance(v, dict) and hasattr(cls, 'discriminator_value_class_map'):
+            _disc_value = v.get(cls.discriminator_property_name)
+            if _disc_value is None and cls.discriminator_property_name != 'type':
+                _disc_value = v.get('type')
+            if _disc_value and _disc_value in cls.discriminator_value_class_map:
+                _expected_class = cls.discriminator_value_class_map[_disc_value]
+                if _expected_class != 'JsonSchemaResponseFormat':
+                    _should_skip_discriminator = True
+
+        if _should_skip_discriminator:
+            error_messages.append(f"Skipping JsonSchemaResponseFormat due to discriminator mismatch")
+        elif not isinstance(v, JsonSchemaResponseFormat):
+            # Try to construct from dict if it's a dict - this applies default values
+            if isinstance(v, dict):
+                try:
+                    constructed = JsonSchemaResponseFormat.model_validate(v)
+                    match += 1
+                    # Return the constructed instance to use it instead of raw dict
+                    return constructed
+                except (ValidationError, ValueError) as e:
+                    error_messages.append(f"Error! Cannot construct `JsonSchemaResponseFormat` from dict: {str(e)}")
+            else:
+                error_messages.append(f"Error! Input type `{type(v)}` is not `JsonSchemaResponseFormat`")
+        else:
+            match += 1
+        # validate data type: GrammarResponseFormat
+        # Check if we should skip this variant based on discriminator
+        _should_skip_discriminator = False
+        if isinstance(v, dict) and hasattr(cls, 'discriminator_value_class_map'):
+            _disc_value = v.get(cls.discriminator_property_name)
+            if _disc_value is None and cls.discriminator_property_name != 'type':
+                _disc_value = v.get('type')
+            if _disc_value and _disc_value in cls.discriminator_value_class_map:
+                _expected_class = cls.discriminator_value_class_map[_disc_value]
+                if _expected_class != 'GrammarResponseFormat':
+                    _should_skip_discriminator = True
+
+        if _should_skip_discriminator:
+            error_messages.append(f"Skipping GrammarResponseFormat due to discriminator mismatch")
+        elif not isinstance(v, GrammarResponseFormat):
+            # Try to construct from dict if it's a dict - this applies default values
+            if isinstance(v, dict):
+                try:
+                    constructed = GrammarResponseFormat.model_validate(v)
+                    match += 1
+                    # Return the constructed instance to use it instead of raw dict
+                    return constructed
+                except (ValidationError, ValueError) as e:
+                    error_messages.append(f"Error! Cannot construct `GrammarResponseFormat` from dict: {str(e)}")
+            else:
+                error_messages.append(f"Error! Input type `{type(v)}` is not `GrammarResponseFormat`")
+        else:
+            match += 1
+        if match > 1:
+            # Special case: empty lists can match multiple List[...] schemas in oneOf
+            # This is common in streaming where content starts empty
+            # In this case, just accept the first match (they're functionally equivalent for empty lists)
+            if isinstance(v, list) and len(v) == 0:
+                return v
+            # more than 1 match
+            raise ValueError("Multiple matches found when setting `actual_instance` in ResponseFormat with oneOf schemas: GrammarResponseFormat, JsonSchemaResponseFormat. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when setting `actual_instance` in ResponseFormat with oneOf schemas: GrammarResponseFormat, JsonSchemaResponseFormat. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: str | dict[str, Any]) -> Self:
+        # Handle primitives and lists directly - don't double-serialize them
+        if isinstance(obj, (str, int, float, bool, type(None), list)):
+            # For non-dict content, bypass from_json and use actual_instance_must_validate_oneof
+            instance = cls.model_construct()
+            instance.actual_instance = cls.actual_instance_must_validate_oneof(obj)
+            return instance
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        match = 0
+
+        # use oneOf discriminator to lookup the data type
+        _data_type = json.loads(json_str).get("type")
+        if not _data_type:
+            raise ValueError("Failed to lookup data type from the field `type` in the input.")
+
+        # check if data type is `GrammarResponseFormat`
+        if _data_type == "grammar":
+            instance.actual_instance = GrammarResponseFormat.from_json(json_str)
+            return instance
+
+        # check if data type is `JsonSchemaResponseFormat`
+        if _data_type == "json_schema":
+            instance.actual_instance = JsonSchemaResponseFormat.from_json(json_str)
+            return instance
+
+        # check if data type is `ERRORUNKNOWN`
+        if _data_type == "":
+            instance.actual_instance = ERRORUNKNOWN.from_json(json_str)
+            return instance
+
+        # deserialize data into JsonSchemaResponseFormat
+        try:
+            instance.actual_instance = JsonSchemaResponseFormat.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into GrammarResponseFormat
+        try:
+            instance.actual_instance = GrammarResponseFormat.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if match > 1:
+            # Special case: empty lists can match multiple List[...] schemas in oneOf
+            # This is common in streaming where content starts empty
+            # In this case, just accept the first match (they're functionally equivalent for empty lists)
+            data = json.loads(json_str)
+            if isinstance(data, list) and len(data) == 0:
+                return instance  # First match already set in instance
+            # more than 1 match
+            raise ValueError("Multiple matches found when deserializing the JSON string into ResponseFormat with oneOf schemas: GrammarResponseFormat, JsonSchemaResponseFormat. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match - try lenient fallback for streaming chunks
+            data = json.loads(json_str)
+
+            # Helper to remove None values recursively for streaming chunks
+            def remove_none_values(obj):
+                if isinstance(obj, dict):
+                    return {k: remove_none_values(v) for k, v in obj.items() if v is not None}
+                elif isinstance(obj, list):
+                    return [remove_none_values(item) for item in obj if item is not None]
+                return obj
+
+            # Helper to add default values for commonly missing required fields in streaming
+            def add_streaming_defaults(obj):
+                if isinstance(obj, dict):
+                    result = dict(obj)
+                    # Add empty string for finish_reason if missing (common in streaming chunks)
+                    if 'choices' in result and isinstance(result['choices'], list):
+                        for choice in result['choices']:
+                            if isinstance(choice, dict) and 'finish_reason' not in choice:
+                                choice['finish_reason'] = ''
+                    return result
+                return obj
+
+            # Try each variant with None values removed and defaults added
+            try:
+                cleaned_data = remove_none_values(data)
+                cleaned_data = add_streaming_defaults(cleaned_data)
+                variant = JsonSchemaResponseFormat.model_validate(cleaned_data)
+                instance.actual_instance = variant
+                return instance
+            except Exception:
+                pass
+            try:
+                cleaned_data = remove_none_values(data)
+                cleaned_data = add_streaming_defaults(cleaned_data)
+                variant = GrammarResponseFormat.model_validate(cleaned_data)
+                instance.actual_instance = variant
+                return instance
+            except Exception:
+                pass
+
+            # All variants failed
+            raise ValueError("No match found when deserializing the JSON string into ResponseFormat with oneOf schemas: GrammarResponseFormat, JsonSchemaResponseFormat. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_dict(self) -> dict[str, Any] | GrammarResponseFormat | JsonSchemaResponseFormat | None:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        # Handle lists specially - call to_dict() on each item if it has the method
+        if isinstance(self.actual_instance, list):
+            return [
+                item.to_dict() if hasattr(item, 'to_dict') and callable(item.to_dict)
+                else item
+                for item in self.actual_instance
+            ]
+        # Handle Pydantic models
+        elif hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        # Handle other Pydantic models that don't have to_dict
+        elif hasattr(self.actual_instance, '__pydantic_serializer__'):
+            from pydantic_core import to_jsonable_python
+            return to_jsonable_python(
+                self.actual_instance,
+                by_alias=True,
+                exclude_none=True,
+                fallback=lambda x: x if isinstance(x, str | int | float | bool | type(None)) else str(x)
+            )
+        else:
+            # primitive type
+            return self.actual_instance
+
+

ogx_open_client/models/response_item_include.py

@@ -0,0 +1,48 @@
+# coding: utf-8
+
+# Copyright (c) The OGX Contributors.
+# All rights reserved.
+#
+# This source code is licensed under the terms described in the LICENSE file in
+# the root directory of this source tree.
+
+"""
+    OGX Specification - Stable & Experimental APIs
+
+    This is the specification of the OGX that provides                     a set of endpoints and their corresponding interfaces that are     tailored to                     best leverage Llama Models.      **🔗 COMBINED**: This specification includes both stable production-ready APIs     and experimental pre-release APIs. Use stable APIs for production deployments     and experimental APIs for testing new features.
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class ResponseItemInclude(str, Enum):
+    """
+    Specify additional output data to include in the model response.
+    """
+
+    """
+    allowed enum values
+    """
+    WEB_SEARCH_CALL_DOT_ACTION_DOT_SOURCES = 'web_search_call.action.sources'
+    CODE_INTERPRETER_CALL_DOT_OUTPUTS = 'code_interpreter_call.outputs'
+    COMPUTER_CALL_OUTPUT_DOT_OUTPUT_DOT_IMAGE_URL = 'computer_call_output.output.image_url'
+    FILE_SEARCH_CALL_DOT_RESULTS = 'file_search_call.results'
+    MESSAGE_DOT_INPUT_IMAGE_DOT_IMAGE_URL = 'message.input_image.image_url'
+    MESSAGE_DOT_OUTPUT_TEXT_DOT_LOGPROBS = 'message.output_text.logprobs'
+    REASONING_DOT_ENCRYPTED_CONTENT = 'reasoning.encrypted_content'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ResponseItemInclude from a JSON string"""
+        return cls(json.loads(json_str))
+
+