ogx_open_client 1.0.3.dev0__py3-none-any.whl

ogx_client/models/open_ai_choice_logprobs.py

@@ -0,0 +1,169 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from ogx_client.models.open_ai_token_log_prob import OpenAITokenLogProb
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class OpenAIChoiceLogprobs(BaseModel):
+    """
+    OpenAIChoiceLogprobs
+    """ # noqa: E501
+    content: Optional[List[OpenAITokenLogProb]] = None
+    refusal: Optional[List[OpenAITokenLogProb]] = None
+    __properties: ClassVar[list[str]] = ["content", "refusal"]
+
+    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
+
+
+    # Make this model iterable/indexable to access the content field directly
+    # This allows: for item in response: ... and response[0]
+    def __iter__(self):
+        """Iterate over items in the content field"""
+        return iter(self.content if self.content is not None else [])
+
+    def __getitem__(self, index):
+        """Get item by index from the content field"""
+        if self.content is None:
+            raise IndexError("list index out of range")
+        return self.content[index]
+
+    def __len__(self):
+        """Get length of the content field"""
+        return len(self.content) if self.content is not None else 0
+
+
+
+    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 OpenAIChoiceLogprobs 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.
+        """
+        excluded_fields: set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in content (list)
+        _items = []
+        if self.content:
+            for _item_content in self.content:
+                if _item_content:
+                    if hasattr(_item_content, 'to_dict'):
+                        _items.append(_item_content.to_dict())
+                    else:
+                        _items.append(_item_content)
+            _dict['content'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in refusal (list)
+        _items = []
+        if self.refusal:
+            for _item_refusal in self.refusal:
+                if _item_refusal:
+                    if hasattr(_item_refusal, 'to_dict'):
+                        _items.append(_item_refusal.to_dict())
+                    else:
+                        _items.append(_item_refusal)
+            _dict['refusal'] = _items
+        # set to None if content (nullable) is None
+        # and model_fields_set contains the field
+        if self.content is None and "content" in self.model_fields_set:
+            _dict['content'] = None
+
+        # set to None if refusal (nullable) is None
+        # and model_fields_set contains the field
+        if self.refusal is None and "refusal" in self.model_fields_set:
+            _dict['refusal'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of OpenAIChoiceLogprobs 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 {
+            "content": [OpenAITokenLogProb.from_dict(_item) for _item in obj["content"]] if obj.get("content") is not None else None,
+            "refusal": [OpenAITokenLogProb.from_dict(_item) for _item in obj["refusal"]] if obj.get("refusal") is not None else None,
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_client/models/open_ai_chunk_choice.py

@@ -0,0 +1,162 @@
+# 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, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from ogx_client.models.open_ai_choice_delta import OpenAIChoiceDelta
+from ogx_client.models.open_ai_chunk_choice_logprobs import OpenAIChunkChoiceLogprobs
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class OpenAIChunkChoice(BaseModel):
+    """
+    A chunk choice from an OpenAI-compatible chat completion streaming response.
+    """ # noqa: E501
+    delta: OpenAIChoiceDelta = Field(description="The delta from the chunk.")
+    finish_reason: Optional[StrictStr] = Field(default=None, description="The reason the model stopped generating.")
+    index: Annotated[int, Field(strict=True, ge=0)] = Field(description="The index of the choice.")
+    logprobs: Optional[OpenAIChunkChoiceLogprobs] = None
+    __properties: ClassVar[list[str]] = ["delta", "finish_reason", "index", "logprobs"]
+
+    @field_validator('finish_reason')
+    def finish_reason_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['stop', 'length', 'tool_calls', 'content_filter', 'function_call']):
+            raise ValueError("must be one of enum values ('stop', 'length', 'tool_calls', 'content_filter', 'function_call')")
+        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 OpenAIChunkChoice 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.
+        """
+        excluded_fields: set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of delta
+        if self.delta:
+            if hasattr(self.delta, 'to_dict'):
+                _dict_value = self.delta.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['delta'] = _dict_value
+                elif 'delta' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['delta']
+            else:
+                _dict['delta'] = self.delta
+        # override the default output from pydantic by calling `to_dict()` of logprobs
+        if self.logprobs:
+            if hasattr(self.logprobs, 'to_dict'):
+                _dict_value = self.logprobs.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['logprobs'] = _dict_value
+                elif 'logprobs' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['logprobs']
+            else:
+                _dict['logprobs'] = self.logprobs
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of OpenAIChunkChoice 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 {
+            "delta": OpenAIChoiceDelta.from_dict(obj["delta"]) if obj.get("delta") is not None else None,
+            "finish_reason": obj.get("finish_reason"),
+            "index": obj.get("index"),
+            "logprobs": OpenAIChunkChoiceLogprobs.from_dict(obj["logprobs"]) if obj.get("logprobs") is not None else None,
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_client/models/open_ai_chunk_choice_logprobs.py

@@ -0,0 +1,169 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from ogx_client.models.open_ai_token_log_prob import OpenAITokenLogProb
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class OpenAIChunkChoiceLogprobs(BaseModel):
+    """
+    The log probabilities for the tokens in the message.
+    """ # noqa: E501
+    content: Optional[List[OpenAITokenLogProb]] = None
+    refusal: Optional[List[OpenAITokenLogProb]] = None
+    __properties: ClassVar[list[str]] = ["content", "refusal"]
+
+    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
+
+
+    # Make this model iterable/indexable to access the content field directly
+    # This allows: for item in response: ... and response[0]
+    def __iter__(self):
+        """Iterate over items in the content field"""
+        return iter(self.content if self.content is not None else [])
+
+    def __getitem__(self, index):
+        """Get item by index from the content field"""
+        if self.content is None:
+            raise IndexError("list index out of range")
+        return self.content[index]
+
+    def __len__(self):
+        """Get length of the content field"""
+        return len(self.content) if self.content is not None else 0
+
+
+
+    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 OpenAIChunkChoiceLogprobs 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.
+        """
+        excluded_fields: set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in content (list)
+        _items = []
+        if self.content:
+            for _item_content in self.content:
+                if _item_content:
+                    if hasattr(_item_content, 'to_dict'):
+                        _items.append(_item_content.to_dict())
+                    else:
+                        _items.append(_item_content)
+            _dict['content'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in refusal (list)
+        _items = []
+        if self.refusal:
+            for _item_refusal in self.refusal:
+                if _item_refusal:
+                    if hasattr(_item_refusal, 'to_dict'):
+                        _items.append(_item_refusal.to_dict())
+                    else:
+                        _items.append(_item_refusal)
+            _dict['refusal'] = _items
+        # set to None if content (nullable) is None
+        # and model_fields_set contains the field
+        if self.content is None and "content" in self.model_fields_set:
+            _dict['content'] = None
+
+        # set to None if refusal (nullable) is None
+        # and model_fields_set contains the field
+        if self.refusal is None and "refusal" in self.model_fields_set:
+            _dict['refusal'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of OpenAIChunkChoiceLogprobs 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 {
+            "content": [OpenAITokenLogProb.from_dict(_item) for _item in obj["content"]] if obj.get("content") is not None else None,
+            "refusal": [OpenAITokenLogProb.from_dict(_item) for _item in obj["refusal"]] if obj.get("refusal") is not None else None,
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_client/models/open_ai_compacted_response.py

@@ -0,0 +1,161 @@
+# 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.open_ai_response_message_output_union import OpenAIResponseMessageOutputUnion
+from ogx_client.models.open_ai_response_usage import OpenAIResponseUsage
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class OpenAICompactedResponse(BaseModel):
+    """
+    Response from compacting a conversation.
+    """ # noqa: E501
+    id: StrictStr
+    created_at: StrictInt
+    object: Optional[StrictStr] = 'response.compaction'
+    output: List[OpenAIResponseMessageOutputUnion]
+    usage: OpenAIResponseUsage
+    __properties: ClassVar[list[str]] = ["id", "created_at", "object", "output", "usage"]
+
+    @field_validator('object')
+    def object_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['response.compaction']):
+            raise ValueError("must be one of enum values ('response.compaction')")
+        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 OpenAICompactedResponse 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.
+        """
+        excluded_fields: set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in output (list)
+        _items = []
+        if self.output:
+            for _item_output in self.output:
+                if _item_output:
+                    if hasattr(_item_output, 'to_dict'):
+                        _items.append(_item_output.to_dict())
+                    else:
+                        _items.append(_item_output)
+            _dict['output'] = _items
+        # 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
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of OpenAICompactedResponse 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"),
+            "created_at": obj.get("created_at"),
+            "object": obj.get("object") if obj.get("object") is not None else 'response.compaction',
+            "output": [OpenAIResponseMessageOutputUnion.from_dict(_item) for _item in obj["output"]] if obj.get("output") is not None else None,
+            "usage": OpenAIResponseUsage.from_dict(obj["usage"]) if obj.get("usage") is not None else None,
+            }.items() if k in obj
+        })
+        return _obj
+
+