ogx_open_client 1.0.3.dev0__py3-none-any.whl

ogx_open_client/models/google_thought_output.py

@@ -0,0 +1,149 @@
+# 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 typing import Any, ClassVar
+from typing_extensions import Self
+
+class GoogleThoughtOutput(BaseModel):
+    """
+    A thought/reasoning output item (model's internal reasoning).
+    """ # noqa: E501
+    type: Optional[StrictStr] = None
+    signature: Optional[StrictStr] = None
+    additional_properties: dict[str, Any] = {}
+    __properties: ClassVar[list[str]] = ["type", "signature"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['thought']):
+            raise ValueError("must be one of enum values ('thought')")
+        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 GoogleThoughtOutput 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        # set to None if signature (nullable) is None
+        # and model_fields_set contains the field
+        if self.signature is None and "signature" in self.model_fields_set:
+            _dict['signature'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of GoogleThoughtOutput 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"),
+            "signature": obj.get("signature"),
+            }.items() if k in obj
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

ogx_open_client/models/google_tool.py

@@ -0,0 +1,145 @@
+# 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 ogx_open_client.models.google_function_declaration import GoogleFunctionDeclaration
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class GoogleTool(BaseModel):
+    """
+    A tool containing function declarations.
+    """ # noqa: E501
+    type: Optional[StrictStr] = Field(default='function', description="Tool type.")
+    function_declarations: List[GoogleFunctionDeclaration] = Field(description="List of function declarations.")
+    additional_properties: dict[str, Any] = {}
+    __properties: ClassVar[list[str]] = ["type", "function_declarations"]
+
+    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 GoogleTool 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: set[str] = set([
+            "additional_properties",
+        ])
+
+        _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 function_declarations (list)
+        _items = []
+        if self.function_declarations:
+            for _item_function_declarations in self.function_declarations:
+                if _item_function_declarations:
+                    if hasattr(_item_function_declarations, 'to_dict'):
+                        _items.append(_item_function_declarations.to_dict())
+                    else:
+                        _items.append(_item_function_declarations)
+            _dict['function_declarations'] = _items
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of GoogleTool 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 'function',
+            "function_declarations": [GoogleFunctionDeclaration.from_dict(_item) for _item in obj["function_declarations"]] if obj.get("function_declarations") is not None else None,
+            }.items() if k in obj
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

ogx_open_client/models/google_usage.py

@@ -0,0 +1,136 @@
+# coding: utf-8
+
+# Copyright (c) The OGX Contributors.
+# All rights reserved.
+#
+# This source code is licensed under the terms described in the LICENSE file in
+# the root directory of this source tree.
+
+"""
+    OGX Specification - Stable & Experimental APIs
+
+    This is the specification of the OGX that provides                     a set of endpoints and their corresponding interfaces that are     tailored to                     best leverage Llama Models.      **🔗 COMBINED**: This specification includes both stable production-ready APIs     and experimental pre-release APIs. Use stable APIs for production deployments     and experimental APIs for testing new features.
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class GoogleUsage(BaseModel):
+    """
+    Token usage statistics.
+    """ # noqa: E501
+    total_input_tokens: Optional[StrictInt] = 0
+    total_output_tokens: Optional[StrictInt] = 0
+    total_tokens: Optional[StrictInt] = 0
+    additional_properties: dict[str, Any] = {}
+    __properties: ClassVar[list[str]] = ["total_input_tokens", "total_output_tokens", "total_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 GoogleUsage 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of GoogleUsage 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 {
+            "total_input_tokens": obj.get("total_input_tokens") if obj.get("total_input_tokens") is not None else 0,
+            "total_output_tokens": obj.get("total_output_tokens") if obj.get("total_output_tokens") is not None else 0,
+            "total_tokens": obj.get("total_tokens") if obj.get("total_tokens") is not None else 0,
+            }.items() if k in obj
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

ogx_open_client/models/grammar_response_format.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 GrammarResponseFormat(BaseModel):
+    """
+    Configuration for grammar-guided response generation.
+    """ # noqa: E501
+    type: Optional[StrictStr] = Field(default=None, description="Must be 'grammar' to identify this format type.")
+    bnf: Dict[str, Any] = Field(description="The BNF grammar specification the response should conform to.")
+    __properties: ClassVar[list[str]] = ["type", "bnf"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['grammar']):
+            raise ValueError("must be one of enum values ('grammar')")
+        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 GrammarResponseFormat 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 GrammarResponseFormat 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"),
+            "bnf": obj.get("bnf"),
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_open_client/models/greedy_sampling_strategy.py

@@ -0,0 +1,129 @@
+# 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 GreedySamplingStrategy(BaseModel):
+    """
+    Greedy sampling strategy that selects the highest probability token at each step.
+    """ # noqa: E501
+    type: Optional[StrictStr] = Field(default=None, description="Must be 'greedy' to identify this sampling strategy.")
+    __properties: ClassVar[list[str]] = ["type"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['greedy']):
+            raise ValueError("must be one of enum values ('greedy')")
+        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 GreedySamplingStrategy 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 GreedySamplingStrategy 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"),
+            }.items() if k in obj
+        })
+        return _obj
+
+