ogx_open_client 1.0.3.dev0__py3-none-any.whl

ogx_open_client/models/embedded_chunk.py

@@ -0,0 +1,157 @@
+# 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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from ogx_open_client.models.chunk_metadata import ChunkMetadata
+from ogx_open_client.models.string_list_image_content_item_text_content_item5 import StringListImageContentItemTextContentItem5
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class EmbeddedChunk(BaseModel):
+    """
+    A chunk of content with its embedding vector for vector database operations. Inherits all fields from Chunk and adds embedding-related fields.
+    """ # noqa: E501
+    content: StringListImageContentItemTextContentItem5
+    chunk_id: StrictStr
+    metadata: Optional[Dict[str, Any]] = None
+    chunk_metadata: ChunkMetadata
+    embedding: List[Union[StrictFloat, StrictInt]]
+    embedding_model: StrictStr
+    embedding_dimension: StrictInt
+    __properties: ClassVar[list[str]] = ["content", "chunk_id", "metadata", "chunk_metadata", "embedding", "embedding_model", "embedding_dimension"]
+
+    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 EmbeddedChunk 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 EmbeddedChunk 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": StringListImageContentItemTextContentItem5.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,
+            "embedding": obj.get("embedding"),
+            "embedding_model": obj.get("embedding_model"),
+            "embedding_dimension": obj.get("embedding_dimension"),
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_open_client/models/embedded_chunk_input.py

@@ -0,0 +1,157 @@
+# 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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from ogx_open_client.models.chunk_metadata import ChunkMetadata
+from ogx_open_client.models.string_list_image_content_item_input_text_content_item1 import StringListImageContentItemInputTextContentItem1
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class EmbeddedChunkInput(BaseModel):
+    """
+    A chunk of content with its embedding vector for vector database operations. Inherits all fields from Chunk and adds embedding-related fields.
+    """ # noqa: E501
+    content: StringListImageContentItemInputTextContentItem1
+    chunk_id: StrictStr
+    metadata: Optional[Dict[str, Any]] = None
+    chunk_metadata: ChunkMetadata
+    embedding: List[Union[StrictFloat, StrictInt]]
+    embedding_model: StrictStr
+    embedding_dimension: StrictInt
+    __properties: ClassVar[list[str]] = ["content", "chunk_id", "metadata", "chunk_metadata", "embedding", "embedding_model", "embedding_dimension"]
+
+    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 EmbeddedChunkInput 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 EmbeddedChunkInput 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": StringListImageContentItemInputTextContentItem1.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,
+            "embedding": obj.get("embedding"),
+            "embedding_model": obj.get("embedding_model"),
+            "embedding_dimension": obj.get("embedding_dimension"),
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_open_client/models/embedded_chunk_output.py

@@ -0,0 +1,157 @@
+# 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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from ogx_open_client.models.chunk_metadata import ChunkMetadata
+from ogx_open_client.models.string_list_image_content_item_output_text_content_item import StringListImageContentItemOutputTextContentItem
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class EmbeddedChunkOutput(BaseModel):
+    """
+    A chunk of content with its embedding vector for vector database operations. Inherits all fields from Chunk and adds embedding-related fields.
+    """ # noqa: E501
+    content: StringListImageContentItemOutputTextContentItem
+    chunk_id: StrictStr
+    metadata: Optional[Dict[str, Any]] = None
+    chunk_metadata: ChunkMetadata
+    embedding: List[Union[StrictFloat, StrictInt]]
+    embedding_model: StrictStr
+    embedding_dimension: StrictInt
+    __properties: ClassVar[list[str]] = ["content", "chunk_id", "metadata", "chunk_metadata", "embedding", "embedding_model", "embedding_dimension"]
+
+    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 EmbeddedChunkOutput 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 EmbeddedChunkOutput 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,
+            "embedding": obj.get("embedding"),
+            "embedding_model": obj.get("embedding_model"),
+            "embedding_dimension": obj.get("embedding_dimension"),
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_open_client/models/embeddings_response.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, Field, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Union
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class EmbeddingsResponse(BaseModel):
+    """
+    Response containing generated embeddings.
+    """ # noqa: E501
+    embeddings: List[List[Union[StrictFloat, StrictInt]]] = Field(description="List of embedding vectors, one per input content. Each embedding is a list of floats. The dimensionality is model-specific.")
+    __properties: ClassVar[list[str]] = ["embeddings"]
+
+    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 embeddings field directly
+    # This allows: for item in response: ... and response[0]
+    def __iter__(self):
+        """Iterate over items in the embeddings field"""
+        return iter(self.embeddings if self.embeddings is not None else [])
+
+    def __getitem__(self, index):
+        """Get item by index from the embeddings field"""
+        if self.embeddings is None:
+            raise IndexError("list index out of range")
+        return self.embeddings[index]
+
+    def __len__(self):
+        """Get length of the embeddings field"""
+        return len(self.embeddings) if self.embeddings 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 EmbeddingsResponse 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 EmbeddingsResponse 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 {
+            "embeddings": obj.get("embeddings"),
+            }.items() if k in obj
+        })
+        return _obj
+
+