ogx_open_client 1.0.3.dev0__py3-none-any.whl

ogx_client/models/chat_completion_message_tool_call_chat_completion_message_custom_tool_call1.py

@@ -0,0 +1,206 @@
+# 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
+from inspect import getfullargspec
+import json
+import pprint
+import re  # noqa: F401
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Optional
+from ogx_client.models.chat_completion_message_custom_tool_call import ChatCompletionMessageCustomToolCall
+from ogx_client.models.chat_completion_message_tool_call import ChatCompletionMessageToolCall
+from typing import Any, TYPE_CHECKING
+from typing_extensions import Literal, Self
+from pydantic import Field
+from ogx_client.lib._utils import pascal_to_snake_case
+
+CHATCOMPLETIONMESSAGETOOLCALLCHATCOMPLETIONMESSAGECUSTOMTOOLCALL1_ANY_OF_SCHEMAS = ["ChatCompletionMessageCustomToolCall", "ChatCompletionMessageToolCall"]
+
+class ChatCompletionMessageToolCallChatCompletionMessageCustomToolCall1(BaseModel):
+    """
+    ChatCompletionMessageToolCallChatCompletionMessageCustomToolCall1
+    """
+
+    # data type: ChatCompletionMessageToolCall
+    anyof_schema_1_validator: Optional[ChatCompletionMessageToolCall] = None
+    # data type: ChatCompletionMessageCustomToolCall
+    anyof_schema_2_validator: Optional[ChatCompletionMessageCustomToolCall] = None
+    if TYPE_CHECKING:
+        actual_instance: ChatCompletionMessageCustomToolCall | ChatCompletionMessageToolCall | None = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: set[str] = { "ChatCompletionMessageCustomToolCall", "ChatCompletionMessageToolCall" }
+
+    model_config = {
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+    discriminator_value_class_map: dict[str, str] = {
+    }
+
+    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.")
+            super().__init__(actual_instance=args[0])
+        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', 'any_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())
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_anyof(cls, v):
+        instance = ChatCompletionMessageToolCallChatCompletionMessageCustomToolCall1.model_construct()
+        error_messages = []
+        # validate data type: ChatCompletionMessageToolCall
+        if not isinstance(v, ChatCompletionMessageToolCall):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ChatCompletionMessageToolCall`")
+        else:
+            return v
+
+        # validate data type: ChatCompletionMessageCustomToolCall
+        if not isinstance(v, ChatCompletionMessageCustomToolCall):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ChatCompletionMessageCustomToolCall`")
+        else:
+            return v
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in ChatCompletionMessageToolCallChatCompletionMessageCustomToolCall1 with anyOf schemas: ChatCompletionMessageCustomToolCall, ChatCompletionMessageToolCall. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | list | 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_anyof
+            instance = cls.model_construct()
+            instance.actual_instance = cls.actual_instance_must_validate_anyof(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 = []
+        # anyof_schema_1_validator: Optional[ChatCompletionMessageToolCall] = None
+        try:
+            instance.actual_instance = ChatCompletionMessageToolCall.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_2_validator: Optional[ChatCompletionMessageCustomToolCall] = None
+        try:
+            instance.actual_instance = ChatCompletionMessageCustomToolCall.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into ChatCompletionMessageToolCallChatCompletionMessageCustomToolCall1 with anyOf schemas: ChatCompletionMessageCustomToolCall, ChatCompletionMessageToolCall. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_dict(self) -> dict[str, Any] | ChatCompletionMessageCustomToolCall | ChatCompletionMessageToolCall | None:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            return self.actual_instance
+
+

ogx_client/models/chat_completion_message_tool_call_function.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 ChatCompletionMessageToolCallFunction(BaseModel):
+    """
+    Function call details.
+    """ # 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 ChatCompletionMessageToolCallFunction 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 ChatCompletionMessageToolCallFunction 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
+
+

ogx_client/models/chunk.py

@@ -0,0 +1,151 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from ogx_client.models.chunk_metadata import ChunkMetadata
+from ogx_client.models.string_list_image_content_item_output_text_content_item import StringListImageContentItemOutputTextContentItem
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class Chunk(BaseModel):
+    """
+    A chunk of content from file processing.
+    """ # noqa: E501
+    content: StringListImageContentItemOutputTextContentItem
+    chunk_id: StrictStr
+    metadata: Optional[Dict[str, Any]] = None
+    chunk_metadata: ChunkMetadata
+    __properties: ClassVar[list[str]] = ["content", "chunk_id", "metadata", "chunk_metadata"]
+
+    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 Chunk 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 content
+        if self.content:
+            if hasattr(self.content, 'to_dict'):
+                _dict_value = self.content.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['content'] = _dict_value
+                elif 'content' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['content']
+            else:
+                _dict['content'] = self.content
+        # override the default output from pydantic by calling `to_dict()` of chunk_metadata
+        if self.chunk_metadata:
+            if hasattr(self.chunk_metadata, 'to_dict'):
+                _dict_value = self.chunk_metadata.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['chunk_metadata'] = _dict_value
+                elif 'chunk_metadata' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['chunk_metadata']
+            else:
+                _dict['chunk_metadata'] = self.chunk_metadata
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of Chunk 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": StringListImageContentItemOutputTextContentItem.from_dict(obj["content"]) if obj.get("content") is not None else None,
+            "chunk_id": obj.get("chunk_id"),
+            "metadata": obj.get("metadata"),
+            "chunk_metadata": ChunkMetadata.from_dict(obj["chunk_metadata"]) if obj.get("chunk_metadata") is not None else None,
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_client/models/chunk_for_deletion.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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class ChunkForDeletion(BaseModel):
+    """
+    Information needed to delete a chunk from a vector store.
+    """ # noqa: E501
+    chunk_id: StrictStr
+    document_id: StrictStr
+    __properties: ClassVar[list[str]] = ["chunk_id", "document_id"]
+
+    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 ChunkForDeletion 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 ChunkForDeletion 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 {
+            "chunk_id": obj.get("chunk_id"),
+            "document_id": obj.get("document_id"),
+            }.items() if k in obj
+        })
+        return _obj
+
+