ogx_open_client 1.0.3.dev0__py3-none-any.whl

ogx_open_client/models/anthropic_url_image_source.py

@@ -0,0 +1,131 @@
+# coding: utf-8
+
+# Copyright (c) The OGX Contributors.
+# All rights reserved.
+#
+# This source code is licensed under the terms described in the LICENSE file in
+# the root directory of this source tree.
+
+"""
+    OGX Specification - Stable & Experimental APIs
+
+    This is the specification of the OGX that provides                     a set of endpoints and their corresponding interfaces that are     tailored to                     best leverage Llama Models.      **🔗 COMBINED**: This specification includes both stable production-ready APIs     and experimental pre-release APIs. Use stable APIs for production deployments     and experimental APIs for testing new features.
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class AnthropicURLImageSource(BaseModel):
+    """
+    URL image source.
+    """ # noqa: E501
+    type: Optional[StrictStr] = None
+    url: StrictStr = Field(description="URL of the image.")
+    __properties: ClassVar[list[str]] = ["type", "url"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['url']):
+            raise ValueError("must be one of enum values ('url')")
+        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 AnthropicURLImageSource 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 AnthropicURLImageSource 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 {
+            "type": obj.get("type"),
+            "url": obj.get("url"),
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_open_client/models/anthropic_usage.py

@@ -0,0 +1,135 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class AnthropicUsage(BaseModel):
+    """
+    Token usage statistics.
+    """ # noqa: E501
+    input_tokens: Optional[StrictInt] = 0
+    output_tokens: Optional[StrictInt] = 0
+    cache_creation_input_tokens: Optional[StrictInt] = None
+    cache_read_input_tokens: Optional[StrictInt] = None
+    __properties: ClassVar[list[str]] = ["input_tokens", "output_tokens", "cache_creation_input_tokens", "cache_read_input_tokens"]
+
+    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 AnthropicUsage 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,
+        )
+        # set to None if cache_creation_input_tokens (nullable) is None
+        # and model_fields_set contains the field
+        if self.cache_creation_input_tokens is None and "cache_creation_input_tokens" in self.model_fields_set:
+            _dict['cache_creation_input_tokens'] = None
+
+        # set to None if cache_read_input_tokens (nullable) is None
+        # and model_fields_set contains the field
+        if self.cache_read_input_tokens is None and "cache_read_input_tokens" in self.model_fields_set:
+            _dict['cache_read_input_tokens'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of AnthropicUsage 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 {
+            "input_tokens": obj.get("input_tokens") if obj.get("input_tokens") is not None else 0,
+            "output_tokens": obj.get("output_tokens") if obj.get("output_tokens") is not None else 0,
+            "cache_creation_input_tokens": obj.get("cache_creation_input_tokens"),
+            "cache_read_input_tokens": obj.get("cache_read_input_tokens"),
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_open_client/models/anthropic_web_search_tool.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_open_client.models.anthropic_cache_control import AnthropicCacheControl
+from ogx_open_client.models.web_search_user_location import WebSearchUserLocation
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class AnthropicWebSearchTool(BaseModel):
+    """
+    Built-in web search tool (web_search_20250305).
+    """ # noqa: E501
+    type: Optional[StrictStr] = None
+    name: Optional[StrictStr] = None
+    max_uses: Optional[StrictInt] = None
+    allowed_domains: Optional[List[StrictStr]] = None
+    blocked_domains: Optional[List[StrictStr]] = None
+    user_location: Optional[WebSearchUserLocation] = None
+    cache_control: Optional[AnthropicCacheControl] = None
+    __properties: ClassVar[list[str]] = ["type", "name", "max_uses", "allowed_domains", "blocked_domains", "user_location", "cache_control"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['web_search_20250305']):
+            raise ValueError("must be one of enum values ('web_search_20250305')")
+        return value
+
+    @field_validator('name')
+    def name_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['web_search']):
+            raise ValueError("must be one of enum values ('web_search')")
+        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 AnthropicWebSearchTool 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 user_location
+        if self.user_location:
+            if hasattr(self.user_location, 'to_dict'):
+                _dict_value = self.user_location.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['user_location'] = _dict_value
+                elif 'user_location' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['user_location']
+            else:
+                _dict['user_location'] = self.user_location
+        # override the default output from pydantic by calling `to_dict()` of cache_control
+        if self.cache_control:
+            if hasattr(self.cache_control, 'to_dict'):
+                _dict_value = self.cache_control.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['cache_control'] = _dict_value
+                elif 'cache_control' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['cache_control']
+            else:
+                _dict['cache_control'] = self.cache_control
+        # set to None if max_uses (nullable) is None
+        # and model_fields_set contains the field
+        if self.max_uses is None and "max_uses" in self.model_fields_set:
+            _dict['max_uses'] = None
+
+        # set to None if allowed_domains (nullable) is None
+        # and model_fields_set contains the field
+        if self.allowed_domains is None and "allowed_domains" in self.model_fields_set:
+            _dict['allowed_domains'] = None
+
+        # set to None if blocked_domains (nullable) is None
+        # and model_fields_set contains the field
+        if self.blocked_domains is None and "blocked_domains" in self.model_fields_set:
+            _dict['blocked_domains'] = None
+
+        # set to None if user_location (nullable) is None
+        # and model_fields_set contains the field
+        if self.user_location is None and "user_location" in self.model_fields_set:
+            _dict['user_location'] = None
+
+        # set to None if cache_control (nullable) is None
+        # and model_fields_set contains the field
+        if self.cache_control is None and "cache_control" in self.model_fields_set:
+            _dict['cache_control'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of AnthropicWebSearchTool 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 {
+            "type": obj.get("type"),
+            "name": obj.get("name"),
+            "max_uses": obj.get("max_uses"),
+            "allowed_domains": obj.get("allowed_domains"),
+            "blocked_domains": obj.get("blocked_domains"),
+            "user_location": WebSearchUserLocation.from_dict(obj["user_location"]) if obj.get("user_location") is not None else None,
+            "cache_control": AnthropicCacheControl.from_dict(obj["cache_control"]) if obj.get("cache_control") is not None else None,
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_open_client/models/api.py

@@ -0,0 +1,59 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class Api(str, Enum):
+    """
+    Enumeration of all available APIs in the OGX system.
+    """
+
+    """
+    allowed enum values
+    """
+    PROVIDERS = 'providers'
+    INFERENCE = 'inference'
+    RESPONSES = 'responses'
+    BATCHES = 'batches'
+    VECTOR_IO = 'vector_io'
+    TOOL_RUNTIME = 'tool_runtime'
+    MODELS = 'models'
+    VECTOR_STORES = 'vector_stores'
+    TOOL_GROUPS = 'tool_groups'
+    FILES = 'files'
+    FILE_PROCESSORS = 'file_processors'
+    PROMPTS = 'prompts'
+    CONVERSATIONS = 'conversations'
+    CONNECTORS = 'connectors'
+    MESSAGES = 'messages'
+    INTERACTIONS = 'interactions'
+    INSPECT = 'inspect'
+    ADMIN = 'admin'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of Api from a JSON string"""
+        return cls(json.loads(json_str))
+
+

ogx_open_client/models/approval_filter.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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class ApprovalFilter(BaseModel):
+    """
+    Filter configuration for MCP tool approval requirements.
+    """ # noqa: E501
+    always: Optional[List[StrictStr]] = None
+    never: Optional[List[StrictStr]] = None
+    __properties: ClassVar[list[str]] = ["always", "never"]
+
+    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 always field directly
+    # This allows: for item in response: ... and response[0]
+    def __iter__(self):
+        """Iterate over items in the always field"""
+        return iter(self.always if self.always is not None else [])
+
+    def __getitem__(self, index):
+        """Get item by index from the always field"""
+        if self.always is None:
+            raise IndexError("list index out of range")
+        return self.always[index]
+
+    def __len__(self):
+        """Get length of the always field"""
+        return len(self.always) if self.always 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 ApprovalFilter 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,
+        )
+        # set to None if always (nullable) is None
+        # and model_fields_set contains the field
+        if self.always is None and "always" in self.model_fields_set:
+            _dict['always'] = None
+
+        # set to None if never (nullable) is None
+        # and model_fields_set contains the field
+        if self.never is None and "never" in self.model_fields_set:
+            _dict['never'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of ApprovalFilter 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 {
+            "always": obj.get("always"),
+            "never": obj.get("never"),
+            }.items() if k in obj
+        })
+        return _obj
+
+