ogx_open_client 1.0.3.dev0__py3-none-any.whl

ogx_client/models/batch.py

@@ -0,0 +1,302 @@
+# 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 pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from ogx_client.models.batch_request_counts import BatchRequestCounts
+from ogx_client.models.batch_usage import BatchUsage
+from ogx_client.models.errors import Errors
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class Batch(BaseModel):
+    """
+    Batch
+    """ # noqa: E501
+    id: StrictStr
+    completion_window: StrictStr
+    created_at: StrictInt
+    endpoint: StrictStr
+    input_file_id: StrictStr
+    object: StrictStr
+    status: StrictStr
+    cancelled_at: Optional[StrictInt] = None
+    cancelling_at: Optional[StrictInt] = None
+    completed_at: Optional[StrictInt] = None
+    error_file_id: Optional[StrictStr] = None
+    errors: Optional[Errors] = None
+    expired_at: Optional[StrictInt] = None
+    expires_at: Optional[StrictInt] = None
+    failed_at: Optional[StrictInt] = None
+    finalizing_at: Optional[StrictInt] = None
+    in_progress_at: Optional[StrictInt] = None
+    metadata: Optional[Dict[str, StrictStr]] = None
+    model: Optional[StrictStr] = None
+    output_file_id: Optional[StrictStr] = None
+    request_counts: Optional[BatchRequestCounts] = None
+    usage: Optional[BatchUsage] = None
+    additional_properties: dict[str, Any] = {}
+    __properties: ClassVar[list[str]] = ["id", "completion_window", "created_at", "endpoint", "input_file_id", "object", "status", "cancelled_at", "cancelling_at", "completed_at", "error_file_id", "errors", "expired_at", "expires_at", "failed_at", "finalizing_at", "in_progress_at", "metadata", "model", "output_file_id", "request_counts", "usage"]
+
+    @field_validator('object')
+    def object_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['batch']):
+            raise ValueError("must be one of enum values ('batch')")
+        return value
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['validating', 'failed', 'in_progress', 'finalizing', 'completed', 'expired', 'cancelling', 'cancelled']):
+            raise ValueError("must be one of enum values ('validating', 'failed', 'in_progress', 'finalizing', 'completed', 'expired', 'cancelling', 'cancelled')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+
+    def __getattribute__(self, name):
+        """Override to automatically unwrap OneOf/AnyOf instances."""
+        value = super().__getattribute__(name)
+
+        # Unwrap OneOf/AnyOf wrappers directly
+        if hasattr(value, 'actual_instance') and value.actual_instance is not None:
+            return value.actual_instance
+
+        # If the value is a dict, unwrap any OneOf instances in its values
+        if isinstance(value, dict):
+            unwrapped = {}
+            for k, v in value.items():
+                # Check if this is a OneOf wrapper with actual_instance
+                if hasattr(v, 'actual_instance') and v.actual_instance is not None:
+                    unwrapped[k] = v.actual_instance
+                else:
+                    unwrapped[k] = v
+            return unwrapped
+
+        return value
+
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self | None:
+        """Create an instance of Batch from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of errors
+        if self.errors:
+            if hasattr(self.errors, 'to_dict'):
+                _dict_value = self.errors.to_dict()
+                # Only include if to_dict() returns a non-None value (handles oneOf wrappers with actual_instance=None)
+                if _dict_value is not None:
+                    _dict['errors'] = _dict_value
+                elif 'errors' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['errors']
+            else:
+                _dict['errors'] = self.errors
+        # override the default output from pydantic by calling `to_dict()` of request_counts
+        if self.request_counts:
+            if hasattr(self.request_counts, 'to_dict'):
+                _dict_value = self.request_counts.to_dict()
+                # Only include if to_dict() returns a non-None value (handles oneOf wrappers with actual_instance=None)
+                if _dict_value is not None:
+                    _dict['request_counts'] = _dict_value
+                elif 'request_counts' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['request_counts']
+            else:
+                _dict['request_counts'] = self.request_counts
+        # override the default output from pydantic by calling `to_dict()` of usage
+        if self.usage:
+            if hasattr(self.usage, 'to_dict'):
+                _dict_value = self.usage.to_dict()
+                # Only include if to_dict() returns a non-None value (handles oneOf wrappers with actual_instance=None)
+                if _dict_value is not None:
+                    _dict['usage'] = _dict_value
+                elif 'usage' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['usage']
+            else:
+                _dict['usage'] = self.usage
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        # set to None if cancelled_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.cancelled_at is None and "cancelled_at" in self.model_fields_set:
+            _dict['cancelled_at'] = None
+
+        # set to None if cancelling_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.cancelling_at is None and "cancelling_at" in self.model_fields_set:
+            _dict['cancelling_at'] = None
+
+        # set to None if completed_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.completed_at is None and "completed_at" in self.model_fields_set:
+            _dict['completed_at'] = None
+
+        # set to None if error_file_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.error_file_id is None and "error_file_id" in self.model_fields_set:
+            _dict['error_file_id'] = None
+
+        # set to None if errors (nullable) is None
+        # and model_fields_set contains the field
+        if self.errors is None and "errors" in self.model_fields_set:
+            _dict['errors'] = None
+
+        # set to None if expired_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.expired_at is None and "expired_at" in self.model_fields_set:
+            _dict['expired_at'] = None
+
+        # set to None if expires_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.expires_at is None and "expires_at" in self.model_fields_set:
+            _dict['expires_at'] = None
+
+        # set to None if failed_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.failed_at is None and "failed_at" in self.model_fields_set:
+            _dict['failed_at'] = None
+
+        # set to None if finalizing_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.finalizing_at is None and "finalizing_at" in self.model_fields_set:
+            _dict['finalizing_at'] = None
+
+        # set to None if in_progress_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.in_progress_at is None and "in_progress_at" in self.model_fields_set:
+            _dict['in_progress_at'] = None
+
+        # set to None if metadata (nullable) is None
+        # and model_fields_set contains the field
+        if self.metadata is None and "metadata" in self.model_fields_set:
+            _dict['metadata'] = None
+
+        # set to None if model (nullable) is None
+        # and model_fields_set contains the field
+        if self.model is None and "model" in self.model_fields_set:
+            _dict['model'] = None
+
+        # set to None if output_file_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.output_file_id is None and "output_file_id" in self.model_fields_set:
+            _dict['output_file_id'] = None
+
+        # set to None if request_counts (nullable) is None
+        # and model_fields_set contains the field
+        if self.request_counts is None and "request_counts" in self.model_fields_set:
+            _dict['request_counts'] = None
+
+        # set to None if usage (nullable) is None
+        # and model_fields_set contains the field
+        if self.usage is None and "usage" in self.model_fields_set:
+            _dict['usage'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of Batch from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            k: v for k, v in {
+            "id": obj.get("id"),
+            "completion_window": obj.get("completion_window"),
+            "created_at": obj.get("created_at"),
+            "endpoint": obj.get("endpoint"),
+            "input_file_id": obj.get("input_file_id"),
+            "object": obj.get("object"),
+            "status": obj.get("status"),
+            "cancelled_at": obj.get("cancelled_at"),
+            "cancelling_at": obj.get("cancelling_at"),
+            "completed_at": obj.get("completed_at"),
+            "error_file_id": obj.get("error_file_id"),
+            "errors": Errors.from_dict(obj["errors"]) if obj.get("errors") is not None else None,
+            "expired_at": obj.get("expired_at"),
+            "expires_at": obj.get("expires_at"),
+            "failed_at": obj.get("failed_at"),
+            "finalizing_at": obj.get("finalizing_at"),
+            "in_progress_at": obj.get("in_progress_at"),
+            "metadata": obj.get("metadata"),
+            "model": obj.get("model"),
+            "output_file_id": obj.get("output_file_id"),
+            "request_counts": BatchRequestCounts.from_dict(obj["request_counts"]) if obj.get("request_counts") is not None else None,
+            "usage": BatchUsage.from_dict(obj["usage"]) if obj.get("usage") is not None else None,
+            }.items() if k in obj
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

ogx_client/models/batch_error.py

@@ -0,0 +1,158 @@
+# 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 pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class BatchError(BaseModel):
+    """
+    BatchError
+    """ # noqa: E501
+    code: Optional[StrictStr] = None
+    line: Optional[StrictInt] = None
+    message: Optional[StrictStr] = None
+    param: Optional[StrictStr] = None
+    additional_properties: dict[str, Any] = {}
+    __properties: ClassVar[list[str]] = ["code", "line", "message", "param"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+
+    def __getattribute__(self, name):
+        """Override to automatically unwrap OneOf/AnyOf instances."""
+        value = super().__getattribute__(name)
+
+        # Unwrap OneOf/AnyOf wrappers directly
+        if hasattr(value, 'actual_instance') and value.actual_instance is not None:
+            return value.actual_instance
+
+        # If the value is a dict, unwrap any OneOf instances in its values
+        if isinstance(value, dict):
+            unwrapped = {}
+            for k, v in value.items():
+                # Check if this is a OneOf wrapper with actual_instance
+                if hasattr(v, 'actual_instance') and v.actual_instance is not None:
+                    unwrapped[k] = v.actual_instance
+                else:
+                    unwrapped[k] = v
+            return unwrapped
+
+        return value
+
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self | None:
+        """Create an instance of BatchError from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        # set to None if code (nullable) is None
+        # and model_fields_set contains the field
+        if self.code is None and "code" in self.model_fields_set:
+            _dict['code'] = None
+
+        # set to None if line (nullable) is None
+        # and model_fields_set contains the field
+        if self.line is None and "line" in self.model_fields_set:
+            _dict['line'] = None
+
+        # set to None if message (nullable) is None
+        # and model_fields_set contains the field
+        if self.message is None and "message" in self.model_fields_set:
+            _dict['message'] = None
+
+        # set to None if param (nullable) is None
+        # and model_fields_set contains the field
+        if self.param is None and "param" in self.model_fields_set:
+            _dict['param'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of BatchError from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            k: v for k, v in {
+            "code": obj.get("code"),
+            "line": obj.get("line"),
+            "message": obj.get("message"),
+            "param": obj.get("param"),
+            }.items() if k in obj
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

ogx_client/models/batch_request_counts.py

@@ -0,0 +1,136 @@
+# 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 pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictInt
+from typing import Any, ClassVar, Dict, List
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class BatchRequestCounts(BaseModel):
+    """
+    The request counts for different statuses within the batch.
+    """ # noqa: E501
+    completed: StrictInt
+    failed: StrictInt
+    total: StrictInt
+    additional_properties: dict[str, Any] = {}
+    __properties: ClassVar[list[str]] = ["completed", "failed", "total"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+
+    def __getattribute__(self, name):
+        """Override to automatically unwrap OneOf/AnyOf instances."""
+        value = super().__getattribute__(name)
+
+        # Unwrap OneOf/AnyOf wrappers directly
+        if hasattr(value, 'actual_instance') and value.actual_instance is not None:
+            return value.actual_instance
+
+        # If the value is a dict, unwrap any OneOf instances in its values
+        if isinstance(value, dict):
+            unwrapped = {}
+            for k, v in value.items():
+                # Check if this is a OneOf wrapper with actual_instance
+                if hasattr(v, 'actual_instance') and v.actual_instance is not None:
+                    unwrapped[k] = v.actual_instance
+                else:
+                    unwrapped[k] = v
+            return unwrapped
+
+        return value
+
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self | None:
+        """Create an instance of BatchRequestCounts from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of BatchRequestCounts from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            k: v for k, v in {
+            "completed": obj.get("completed"),
+            "failed": obj.get("failed"),
+            "total": obj.get("total"),
+            }.items() if k in obj
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+