ogx_open_client 1.0.3.dev0__py3-none-any.whl

ogx_client/models/chat_completion_message.py

@@ -0,0 +1,216 @@
+# 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 ogx_client.models.chat_completion_message_function_call import ChatCompletionMessageFunctionCall
+from ogx_client.models.chat_completion_message_tool_call_chat_completion_message_custom_tool_call import ChatCompletionMessageToolCallChatCompletionMessageCustomToolCall
+from ogx_client.models.open_ai_chat_completion_content_part_text_param_open_ai_chat_completion_content_part_image_param import OpenAIChatCompletionContentPartTextParamOpenAIChatCompletionContentPartImageParam
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class ChatCompletionMessage(BaseModel):
+    """
+    A message from a stored chat completion.
+    """ # noqa: E501
+    id: StrictStr = Field(description="The identifier of the chat message.")
+    role: StrictStr = Field(description="The role of the message author.")
+    content: Optional[StrictStr] = None
+    content_parts: Optional[List[OpenAIChatCompletionContentPartTextParamOpenAIChatCompletionContentPartImageParam]] = None
+    name: Optional[StrictStr] = None
+    tool_calls: Optional[List[ChatCompletionMessageToolCallChatCompletionMessageCustomToolCall]] = Field(default=None, description="The tool calls generated by the message, when applicable.")
+    tool_call_id: Optional[StrictStr] = None
+    refusal: Optional[StrictStr] = None
+    function_call: Optional[ChatCompletionMessageFunctionCall] = None
+    annotations: Optional[List[Dict[str, Any]]] = None
+    audio: Optional[Dict[str, Any]] = None
+    __properties: ClassVar[list[str]] = ["id", "role", "content", "content_parts", "name", "tool_calls", "tool_call_id", "refusal", "function_call", "annotations", "audio"]
+
+    @field_validator('role')
+    def role_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['developer', 'system', 'user', 'assistant', 'tool']):
+            raise ValueError("must be one of enum values ('developer', 'system', 'user', 'assistant', 'tool')")
+        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 ChatCompletionMessage 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_parts (list)
+        _items = []
+        if self.content_parts:
+            for _item_content_parts in self.content_parts:
+                if _item_content_parts:
+                    if hasattr(_item_content_parts, 'to_dict'):
+                        _items.append(_item_content_parts.to_dict())
+                    else:
+                        _items.append(_item_content_parts)
+            _dict['content_parts'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in tool_calls (list)
+        _items = []
+        if self.tool_calls:
+            for _item_tool_calls in self.tool_calls:
+                if _item_tool_calls:
+                    if hasattr(_item_tool_calls, 'to_dict'):
+                        _items.append(_item_tool_calls.to_dict())
+                    else:
+                        _items.append(_item_tool_calls)
+            _dict['tool_calls'] = _items
+        # override the default output from pydantic by calling `to_dict()` of function_call
+        if self.function_call:
+            if hasattr(self.function_call, 'to_dict'):
+                _dict_value = self.function_call.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['function_call'] = _dict_value
+                elif 'function_call' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['function_call']
+            else:
+                _dict['function_call'] = self.function_call
+        # 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 content_parts (nullable) is None
+        # and model_fields_set contains the field
+        if self.content_parts is None and "content_parts" in self.model_fields_set:
+            _dict['content_parts'] = None
+
+        # set to None if name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict['name'] = None
+
+        # set to None if tool_call_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.tool_call_id is None and "tool_call_id" in self.model_fields_set:
+            _dict['tool_call_id'] = 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
+
+        # set to None if annotations (nullable) is None
+        # and model_fields_set contains the field
+        if self.annotations is None and "annotations" in self.model_fields_set:
+            _dict['annotations'] = None
+
+        # set to None if audio (nullable) is None
+        # and model_fields_set contains the field
+        if self.audio is None and "audio" in self.model_fields_set:
+            _dict['audio'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of ChatCompletionMessage 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"),
+            "role": obj.get("role"),
+            "content": obj.get("content"),
+            "content_parts": [OpenAIChatCompletionContentPartTextParamOpenAIChatCompletionContentPartImageParam.from_dict(_item) for _item in obj["content_parts"]] if obj.get("content_parts") is not None else None,
+            "name": obj.get("name"),
+            "tool_calls": [ChatCompletionMessageToolCallChatCompletionMessageCustomToolCall.from_dict(_item) for _item in obj["tool_calls"]] if obj.get("tool_calls") is not None else None,
+            "tool_call_id": obj.get("tool_call_id"),
+            "refusal": obj.get("refusal"),
+            "function_call": ChatCompletionMessageFunctionCall.from_dict(obj["function_call"]) if obj.get("function_call") is not None else None,
+            "annotations": obj.get("annotations"),
+            "audio": obj.get("audio"),
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_client/models/chat_completion_message_custom_tool_call.py

@@ -0,0 +1,143 @@
+# 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
+from ogx_client.models.chat_completion_message_custom_tool_call_custom import ChatCompletionMessageCustomToolCallCustom
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class ChatCompletionMessageCustomToolCall(BaseModel):
+    """
+    A call to a custom tool created by the model.
+    """ # noqa: E501
+    id: StrictStr = Field(description="The ID of the tool call.")
+    type: StrictStr = Field(description="The type of the tool. Always 'custom'.")
+    custom: ChatCompletionMessageCustomToolCallCustom
+    __properties: ClassVar[list[str]] = ["id", "type", "custom"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['custom']):
+            raise ValueError("must be one of enum values ('custom')")
+        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 ChatCompletionMessageCustomToolCall 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 custom
+        if self.custom:
+            if hasattr(self.custom, 'to_dict'):
+                _dict_value = self.custom.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['custom'] = _dict_value
+                elif 'custom' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['custom']
+            else:
+                _dict['custom'] = self.custom
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of ChatCompletionMessageCustomToolCall 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"),
+            "type": obj.get("type"),
+            "custom": ChatCompletionMessageCustomToolCallCustom.from_dict(obj["custom"]) if obj.get("custom") is not None else None,
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_client/models/chat_completion_message_custom_tool_call_custom.py

@@ -0,0 +1,121 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class ChatCompletionMessageCustomToolCallCustom(BaseModel):
+    """
+    The custom tool that the model called.
+    """ # noqa: E501
+    name: StrictStr = Field(description="The name of the custom tool to call.")
+    input: StrictStr = Field(description="The input for the custom tool call generated by the model.")
+    __properties: ClassVar[list[str]] = ["name", "input"]
+
+    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 ChatCompletionMessageCustomToolCallCustom 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,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of ChatCompletionMessageCustomToolCallCustom 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 {
+            "name": obj.get("name"),
+            "input": obj.get("input"),
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_client/models/chat_completion_message_function_call.py

@@ -0,0 +1,121 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class ChatCompletionMessageFunctionCall(BaseModel):
+    """
+    Deprecated: the name and arguments of a function that should be called.
+    """ # noqa: E501
+    name: StrictStr = Field(description="Name of the function to call.")
+    arguments: StrictStr = Field(description="Arguments to pass to the function as a JSON string.")
+    __properties: ClassVar[list[str]] = ["name", "arguments"]
+
+    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 ChatCompletionMessageFunctionCall 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,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of ChatCompletionMessageFunctionCall 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 {
+            "name": obj.get("name"),
+            "arguments": obj.get("arguments"),
+            }.items() if k in obj
+        })
+        return _obj
+
+