ogx_open_client 1.0.3.dev0__py3-none-any.whl

ogx_client/models/open_ai_response_input_tool_file_search.py

@@ -0,0 +1,166 @@
+# 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_extensions import Annotated
+from ogx_client.models.search_ranking_options import SearchRankingOptions
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class OpenAIResponseInputToolFileSearch(BaseModel):
+    """
+    File search tool configuration for OpenAI response inputs.
+    """ # noqa: E501
+    type: Optional[StrictStr] = None
+    vector_store_ids: List[StrictStr]
+    filters: Optional[Dict[str, Any]] = None
+    max_num_results: Optional[Annotated[int, Field(le=50, strict=True, ge=1)]] = None
+    ranking_options: Optional[SearchRankingOptions] = None
+    __properties: ClassVar[list[str]] = ["type", "vector_store_ids", "filters", "max_num_results", "ranking_options"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['file_search']):
+            raise ValueError("must be one of enum values ('file_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 OpenAIResponseInputToolFileSearch 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 ranking_options
+        if self.ranking_options:
+            if hasattr(self.ranking_options, 'to_dict'):
+                _dict_value = self.ranking_options.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['ranking_options'] = _dict_value
+                elif 'ranking_options' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['ranking_options']
+            else:
+                _dict['ranking_options'] = self.ranking_options
+        # 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 max_num_results (nullable) is None
+        # and model_fields_set contains the field
+        if self.max_num_results is None and "max_num_results" in self.model_fields_set:
+            _dict['max_num_results'] = 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 OpenAIResponseInputToolFileSearch 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"),
+            "vector_store_ids": obj.get("vector_store_ids"),
+            "filters": obj.get("filters"),
+            "max_num_results": obj.get("max_num_results"),
+            "ranking_options": SearchRankingOptions.from_dict(obj["ranking_options"]) if obj.get("ranking_options") is not None else None,
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_client/models/open_ai_response_input_tool_function.py

@@ -0,0 +1,152 @@
+# 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 typing import Any, ClassVar
+from typing_extensions import Self
+
+class OpenAIResponseInputToolFunction(BaseModel):
+    """
+    Function tool configuration for OpenAI response inputs.
+    """ # noqa: E501
+    type: Optional[StrictStr] = None
+    name: StrictStr
+    description: Optional[StrictStr] = None
+    parameters: Optional[Dict[str, Any]]
+    strict: Optional[StrictBool] = None
+    __properties: ClassVar[list[str]] = ["type", "name", "description", "parameters", "strict"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['function']):
+            raise ValueError("must be one of enum values ('function')")
+        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 OpenAIResponseInputToolFunction 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 description (nullable) is None
+        # and model_fields_set contains the field
+        if self.description is None and "description" in self.model_fields_set:
+            _dict['description'] = None
+
+        # set to None if parameters (nullable) is None
+        # and model_fields_set contains the field
+        if self.parameters is None and "parameters" in self.model_fields_set:
+            _dict['parameters'] = None
+
+        # set to None if strict (nullable) is None
+        # and model_fields_set contains the field
+        if self.strict is None and "strict" in self.model_fields_set:
+            _dict['strict'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of OpenAIResponseInputToolFunction 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"),
+            "description": obj.get("description"),
+            "parameters": obj.get("parameters"),
+            "strict": obj.get("strict"),
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_client/models/open_ai_response_input_tool_mcp.py

@@ -0,0 +1,194 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from ogx_client.models.list_string_allowed_tools_filter import ListStringAllowedToolsFilter
+from ogx_client.models.string_approval_filter import StringApprovalFilter
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class OpenAIResponseInputToolMCP(BaseModel):
+    """
+    Model Context Protocol (MCP) tool configuration for OpenAI response inputs.
+    """ # noqa: E501
+    type: Optional[StrictStr] = None
+    server_label: StrictStr
+    connector_id: Optional[StrictStr] = None
+    server_url: Optional[StrictStr] = None
+    headers: Optional[Dict[str, Any]] = None
+    authorization: Optional[StrictStr] = None
+    require_approval: Optional[StringApprovalFilter] = None
+    allowed_tools: Optional[ListStringAllowedToolsFilter] = None
+    __properties: ClassVar[list[str]] = ["type", "server_label", "connector_id", "server_url", "headers", "authorization", "require_approval", "allowed_tools"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['mcp']):
+            raise ValueError("must be one of enum values ('mcp')")
+        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 OpenAIResponseInputToolMCP 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 require_approval
+        if self.require_approval:
+            if hasattr(self.require_approval, 'to_dict'):
+                _dict_value = self.require_approval.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['require_approval'] = _dict_value
+                elif 'require_approval' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['require_approval']
+            else:
+                _dict['require_approval'] = self.require_approval
+        # override the default output from pydantic by calling `to_dict()` of allowed_tools
+        if self.allowed_tools:
+            if hasattr(self.allowed_tools, 'to_dict'):
+                _dict_value = self.allowed_tools.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['allowed_tools'] = _dict_value
+                elif 'allowed_tools' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['allowed_tools']
+            else:
+                _dict['allowed_tools'] = self.allowed_tools
+        # set to None if connector_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.connector_id is None and "connector_id" in self.model_fields_set:
+            _dict['connector_id'] = None
+
+        # set to None if server_url (nullable) is None
+        # and model_fields_set contains the field
+        if self.server_url is None and "server_url" in self.model_fields_set:
+            _dict['server_url'] = None
+
+        # set to None if headers (nullable) is None
+        # and model_fields_set contains the field
+        if self.headers is None and "headers" in self.model_fields_set:
+            _dict['headers'] = None
+
+        # set to None if authorization (nullable) is None
+        # and model_fields_set contains the field
+        if self.authorization is None and "authorization" in self.model_fields_set:
+            _dict['authorization'] = None
+
+        # set to None if allowed_tools (nullable) is None
+        # and model_fields_set contains the field
+        if self.allowed_tools is None and "allowed_tools" in self.model_fields_set:
+            _dict['allowed_tools'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of OpenAIResponseInputToolMCP 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"),
+            "server_label": obj.get("server_label"),
+            "connector_id": obj.get("connector_id"),
+            "server_url": obj.get("server_url"),
+            "headers": obj.get("headers"),
+            "authorization": obj.get("authorization"),
+            "require_approval": StringApprovalFilter.from_dict(obj["require_approval"]) if obj.get("require_approval") is not None else None,
+            "allowed_tools": ListStringAllowedToolsFilter.from_dict(obj["allowed_tools"]) if obj.get("allowed_tools") is not None else None,
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_client/models/open_ai_response_input_tool_web_search.py

@@ -0,0 +1,147 @@
+# 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_extensions import Annotated
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class OpenAIResponseInputToolWebSearch(BaseModel):
+    """
+    Web search tool configuration for OpenAI response inputs.
+    """ # noqa: E501
+    type: Optional[StrictStr] = 'web_search'
+    search_context_size: Optional[Annotated[str, Field(strict=True)]] = None
+    __properties: ClassVar[list[str]] = ["type", "search_context_size"]
+
+    @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', 'web_search_preview', 'web_search_preview_2025_03_11', 'web_search_2025_08_26']):
+            raise ValueError("must be one of enum values ('web_search', 'web_search_preview', 'web_search_preview_2025_03_11', 'web_search_2025_08_26')")
+        return value
+
+    @field_validator('search_context_size')
+    def search_context_size_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^low|medium|high$", value):
+            raise ValueError(r"must validate the regular expression /^low|medium|high$/")
+        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 OpenAIResponseInputToolWebSearch 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 search_context_size (nullable) is None
+        # and model_fields_set contains the field
+        if self.search_context_size is None and "search_context_size" in self.model_fields_set:
+            _dict['search_context_size'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of OpenAIResponseInputToolWebSearch 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") if obj.get("type") is not None else 'web_search',
+            "search_context_size": obj.get("search_context_size"),
+            }.items() if k in obj
+        })
+        return _obj
+
+