ogx_open_client 1.0.3.dev0__py3-none-any.whl

ogx_client/models/vector_store_list_response.py

@@ -0,0 +1,148 @@
+# 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, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from ogx_client.models.vector_store_object import VectorStoreObject
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class VectorStoreListResponse(BaseModel):
+    """
+    Response from listing vector stores.
+    """ # noqa: E501
+    object: Optional[StrictStr] = None
+    data: List[VectorStoreObject]
+    first_id: StrictStr
+    last_id: StrictStr
+    has_more: StrictBool
+    __properties: ClassVar[list[str]] = ["object", "data", "first_id", "last_id", "has_more"]
+
+    @field_validator('object')
+    def object_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['list']):
+            raise ValueError("must be one of enum values ('list')")
+        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 VectorStoreListResponse 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 data (list)
+        _items = []
+        if self.data:
+            for _item_data in self.data:
+                if _item_data:
+                    if hasattr(_item_data, 'to_dict'):
+                        _items.append(_item_data.to_dict())
+                    else:
+                        _items.append(_item_data)
+            _dict['data'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of VectorStoreListResponse 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 {
+            "object": obj.get("object"),
+            "data": [VectorStoreObject.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None,
+            "first_id": obj.get("first_id"),
+            "last_id": obj.get("last_id"),
+            "has_more": obj.get("has_more"),
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_client/models/vector_store_modify_request.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.vector_store_expiration_after import VectorStoreExpirationAfter
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class VectorStoreModifyRequest(BaseModel):
+    """
+    Request to modify a vector store.
+    """ # noqa: E501
+    name: Optional[StrictStr] = None
+    expires_after: Optional[VectorStoreExpirationAfter] = None
+    metadata: Optional[Dict[str, Any]] = None
+    __properties: ClassVar[list[str]] = ["name", "expires_after", "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 VectorStoreModifyRequest 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 expires_after
+        if self.expires_after:
+            if hasattr(self.expires_after, 'to_dict'):
+                _dict_value = self.expires_after.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['expires_after'] = _dict_value
+                elif 'expires_after' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['expires_after']
+            else:
+                _dict['expires_after'] = self.expires_after
+        # 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 expires_after (nullable) is None
+        # and model_fields_set contains the field
+        if self.expires_after is None and "expires_after" in self.model_fields_set:
+            _dict['expires_after'] = None
+
+        # set to None if metadata (nullable) is None
+        # and model_fields_set contains the field
+        if self.metadata is None and "metadata" in self.model_fields_set:
+            _dict['metadata'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of VectorStoreModifyRequest 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"),
+            "expires_after": VectorStoreExpirationAfter.from_dict(obj["expires_after"]) if obj.get("expires_after") is not None else None,
+            "metadata": obj.get("metadata"),
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_client/models/vector_store_object.py

@@ -0,0 +1,202 @@
+# 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.vector_store_expiration_after import VectorStoreExpirationAfter
+from ogx_client.models.vector_store_file_counts import VectorStoreFileCounts
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class VectorStoreObject(BaseModel):
+    """
+    OpenAI Vector Store object.
+    """ # noqa: E501
+    id: StrictStr
+    object: Optional[StrictStr] = None
+    created_at: StrictInt
+    name: Optional[StrictStr] = ''
+    usage_bytes: Optional[StrictInt] = 0
+    file_counts: VectorStoreFileCounts
+    status: StrictStr
+    expires_after: Optional[VectorStoreExpirationAfter] = None
+    expires_at: Optional[StrictInt] = None
+    last_active_at: Optional[StrictInt] = None
+    metadata: Optional[Dict[str, Any]] = None
+    __properties: ClassVar[list[str]] = ["id", "object", "created_at", "name", "usage_bytes", "file_counts", "status", "expires_after", "expires_at", "last_active_at", "metadata"]
+
+    @field_validator('object')
+    def object_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['vector_store']):
+            raise ValueError("must be one of enum values ('vector_store')")
+        return value
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['expired', 'in_progress', 'completed']):
+            raise ValueError("must be one of enum values ('expired', 'in_progress', 'completed')")
+        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 VectorStoreObject 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 file_counts
+        if self.file_counts:
+            if hasattr(self.file_counts, 'to_dict'):
+                _dict_value = self.file_counts.to_dict()
+                # Only include if to_dict() returns a non-None value (handles oneOf wrappers with actual_instance=None)
+                if _dict_value is not None:
+                    _dict['file_counts'] = _dict_value
+                elif 'file_counts' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['file_counts']
+            else:
+                _dict['file_counts'] = self.file_counts
+        # override the default output from pydantic by calling `to_dict()` of expires_after
+        if self.expires_after:
+            if hasattr(self.expires_after, 'to_dict'):
+                _dict_value = self.expires_after.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['expires_after'] = _dict_value
+                elif 'expires_after' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['expires_after']
+            else:
+                _dict['expires_after'] = self.expires_after
+        # set to None if expires_after (nullable) is None
+        # and model_fields_set contains the field
+        if self.expires_after is None and "expires_after" in self.model_fields_set:
+            _dict['expires_after'] = None
+
+        # set to None if expires_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.expires_at is None and "expires_at" in self.model_fields_set:
+            _dict['expires_at'] = None
+
+        # set to None if last_active_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.last_active_at is None and "last_active_at" in self.model_fields_set:
+            _dict['last_active_at'] = None
+
+        # set to None if metadata (nullable) is None
+        # and model_fields_set contains the field
+        if self.metadata is None and "metadata" in self.model_fields_set:
+            _dict['metadata'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of VectorStoreObject 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"),
+            "object": obj.get("object"),
+            "created_at": obj.get("created_at"),
+            "name": obj.get("name") if obj.get("name") is not None else '',
+            "usage_bytes": obj.get("usage_bytes") if obj.get("usage_bytes") is not None else 0,
+            "file_counts": VectorStoreFileCounts.from_dict(obj["file_counts"]) if obj.get("file_counts") is not None else None,
+            "status": obj.get("status"),
+            "expires_after": VectorStoreExpirationAfter.from_dict(obj["expires_after"]) if obj.get("expires_after") is not None else None,
+            "expires_at": obj.get("expires_at"),
+            "last_active_at": obj.get("last_active_at"),
+            "metadata": obj.get("metadata"),
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_client/models/vector_store_search_request.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, Field, StrictBool
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from ogx_client.models.string_list_string2 import StringListString2
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class VectorStoreSearchRequest(BaseModel):
+    """
+    Request to search a vector store.
+    """ # noqa: E501
+    query: StringListString2
+    filters: Optional[Dict[str, Any]] = None
+    max_num_results: Optional[Annotated[int, Field(le=50, strict=True, ge=1)]] = 10
+    ranking_options: Optional[Dict[str, Any]] = None
+    rewrite_query: Optional[StrictBool] = False
+    __properties: ClassVar[list[str]] = ["query", "filters", "max_num_results", "ranking_options", "rewrite_query"]
+
+    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 VectorStoreSearchRequest 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 query
+        if self.query:
+            if hasattr(self.query, 'to_dict'):
+                _dict_value = self.query.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['query'] = _dict_value
+                elif 'query' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['query']
+            else:
+                _dict['query'] = self.query
+        # set to None if filters (nullable) is None
+        # and model_fields_set contains the field
+        if self.filters is None and "filters" in self.model_fields_set:
+            _dict['filters'] = None
+
+        # set to None if ranking_options (nullable) is None
+        # and model_fields_set contains the field
+        if self.ranking_options is None and "ranking_options" in self.model_fields_set:
+            _dict['ranking_options'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of VectorStoreSearchRequest 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 {
+            "query": StringListString2.from_dict(obj["query"]) if obj.get("query") is not None else None,
+            "filters": obj.get("filters"),
+            "max_num_results": obj.get("max_num_results") if obj.get("max_num_results") is not None else 10,
+            "ranking_options": obj.get("ranking_options"),
+            "rewrite_query": obj.get("rewrite_query") if obj.get("rewrite_query") is not None else False,
+            }.items() if k in obj
+        })
+        return _obj
+
+