ogx_open_client 1.0.3.dev0__py3-none-any.whl

ogx_open_client/models/remote_provider_spec.py

@@ -0,0 +1,178 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from ogx_open_client.models.api import Api
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class RemoteProviderSpec(BaseModel):
+    """
+    Provider specification for remote providers accessed via an adapter.
+    """ # noqa: E501
+    api: Api
+    provider_type: StrictStr
+    config_class: StrictStr = Field(description="Fully-qualified classname of the config for this provider")
+    api_dependencies: Optional[List[Api]] = Field(default=None, description="Higher-level API surfaces may depend on other providers to provide their functionality")
+    optional_api_dependencies: Optional[List[Api]] = None
+    deprecation_warning: Optional[StrictStr] = None
+    deprecation_error: Optional[StrictStr] = None
+    module: Optional[StrictStr] = None
+    pip_packages: Optional[List[StrictStr]] = Field(default=None, description="The pip dependencies needed for this implementation")
+    provider_data_validator: Optional[StrictStr] = None
+    is_external: Optional[StrictBool] = Field(default=False, description="Notes whether this provider is an external provider.")
+    toolgroup_id: Optional[StrictStr] = None
+    deps__: Optional[List[StrictStr]] = None
+    adapter_type: StrictStr = Field(description="Unique identifier for this adapter")
+    description: Optional[StrictStr] = None
+    __properties: ClassVar[list[str]] = ["api", "provider_type", "config_class", "api_dependencies", "optional_api_dependencies", "deprecation_warning", "deprecation_error", "module", "pip_packages", "provider_data_validator", "is_external", "toolgroup_id", "deps__", "adapter_type", "description"]
+
+    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 RemoteProviderSpec 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 deprecation_warning (nullable) is None
+        # and model_fields_set contains the field
+        if self.deprecation_warning is None and "deprecation_warning" in self.model_fields_set:
+            _dict['deprecation_warning'] = None
+
+        # set to None if deprecation_error (nullable) is None
+        # and model_fields_set contains the field
+        if self.deprecation_error is None and "deprecation_error" in self.model_fields_set:
+            _dict['deprecation_error'] = None
+
+        # set to None if module (nullable) is None
+        # and model_fields_set contains the field
+        if self.module is None and "module" in self.model_fields_set:
+            _dict['module'] = None
+
+        # set to None if provider_data_validator (nullable) is None
+        # and model_fields_set contains the field
+        if self.provider_data_validator is None and "provider_data_validator" in self.model_fields_set:
+            _dict['provider_data_validator'] = None
+
+        # set to None if toolgroup_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.toolgroup_id is None and "toolgroup_id" in self.model_fields_set:
+            _dict['toolgroup_id'] = None
+
+        # 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
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of RemoteProviderSpec 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 {
+            "api": obj.get("api"),
+            "provider_type": obj.get("provider_type"),
+            "config_class": obj.get("config_class"),
+            "api_dependencies": obj.get("api_dependencies"),
+            "optional_api_dependencies": obj.get("optional_api_dependencies"),
+            "deprecation_warning": obj.get("deprecation_warning"),
+            "deprecation_error": obj.get("deprecation_error"),
+            "module": obj.get("module"),
+            "pip_packages": obj.get("pip_packages"),
+            "provider_data_validator": obj.get("provider_data_validator"),
+            "is_external": obj.get("is_external") if obj.get("is_external") is not None else False,
+            "toolgroup_id": obj.get("toolgroup_id"),
+            "deps__": obj.get("deps__"),
+            "adapter_type": obj.get("adapter_type"),
+            "description": obj.get("description"),
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_open_client/models/rerank_data.py

@@ -0,0 +1,122 @@
+# 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_extensions import Annotated
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class RerankData(BaseModel):
+    """
+    A single rerank result from a reranking response.
+    """ # noqa: E501
+    index: Annotated[int, Field(strict=True, ge=0)] = Field(description="The original index of the document in the input list.")
+    relevance_score: Union[StrictFloat, StrictInt] = Field(description="The relevance score from the model output. Higher scores indicate greater relevance.")
+    __properties: ClassVar[list[str]] = ["index", "relevance_score"]
+
+    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 RerankData 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 RerankData 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 {
+            "index": obj.get("index"),
+            "relevance_score": obj.get("relevance_score"),
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_open_client/models/rerank_request.py

@@ -0,0 +1,155 @@
+# coding: utf-8
+
+# Copyright (c) The OGX Contributors.
+# All rights reserved.
+#
+# This source code is licensed under the terms described in the LICENSE file in
+# the root directory of this source tree.
+
+"""
+    OGX Specification - Stable & Experimental APIs
+
+    This is the specification of the OGX that provides                     a set of endpoints and their corresponding interfaces that are     tailored to                     best leverage Llama Models.      **🔗 COMBINED**: This specification includes both stable production-ready APIs     and experimental pre-release APIs. Use stable APIs for production deployments     and experimental APIs for testing new features.
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from ogx_open_client.models.string_open_ai_chat_completion_content_part_text_param_open_ai_chat_completion_content_part_image_param import StringOpenAIChatCompletionContentPartTextParamOpenAIChatCompletionContentPartImageParam
+from ogx_open_client.models.string_open_ai_chat_completion_content_part_text_param_open_ai_chat_completion_content_part_image_param1 import StringOpenAIChatCompletionContentPartTextParamOpenAIChatCompletionContentPartImageParam1
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class RerankRequest(BaseModel):
+    """
+    Request model for reranking documents.
+    """ # noqa: E501
+    model: StrictStr = Field(description="The identifier of the reranking model to use.")
+    query: StringOpenAIChatCompletionContentPartTextParamOpenAIChatCompletionContentPartImageParam
+    items: Annotated[List[StringOpenAIChatCompletionContentPartTextParamOpenAIChatCompletionContentPartImageParam1], Field(min_length=1)] = Field(description="List of items to rerank. Each item can be a string, text content part, or image content part.")
+    max_num_results: Optional[Annotated[int, Field(strict=True, ge=1)]] = None
+    __properties: ClassVar[list[str]] = ["model", "query", "items", "max_num_results"]
+
+    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 RerankRequest 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
+        # override the default output from pydantic by calling `to_dict()` of each item in items (list)
+        _items = []
+        if self.items:
+            for _item_items in self.items:
+                if _item_items:
+                    if hasattr(_item_items, 'to_dict'):
+                        _items.append(_item_items.to_dict())
+                    else:
+                        _items.append(_item_items)
+            _dict['items'] = _items
+        # 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
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of RerankRequest 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 {
+            "model": obj.get("model"),
+            "query": StringOpenAIChatCompletionContentPartTextParamOpenAIChatCompletionContentPartImageParam.from_dict(obj["query"]) if obj.get("query") is not None else None,
+            "items": [StringOpenAIChatCompletionContentPartTextParamOpenAIChatCompletionContentPartImageParam1.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None,
+            "max_num_results": obj.get("max_num_results"),
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_open_client/models/rerank_response.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
+from typing import Any, ClassVar, Dict, List
+from ogx_open_client.models.rerank_data import RerankData
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class RerankResponse(BaseModel):
+    """
+    Response from a reranking request.
+    """ # noqa: E501
+    data: List[RerankData] = Field(description="List of rerank result objects, sorted by relevance score (descending).")
+    __properties: ClassVar[list[str]] = ["data"]
+
+    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 data field directly
+    # This allows: for item in response: ... and response[0]
+    def __iter__(self):
+        """Iterate over items in the data field"""
+        return iter(self.data if self.data is not None else [])
+
+    def __getitem__(self, index):
+        """Get item by index from the data field"""
+        if self.data is None:
+            raise IndexError("list index out of range")
+        return self.data[index]
+
+    def __len__(self):
+        """Get length of the data field"""
+        return len(self.data) if self.data 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 RerankResponse 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 RerankResponse 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 {
+            "data": [RerankData.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None,
+            }.items() if k in obj
+        })
+        return _obj
+
+