ogx_open_client 1.0.3.dev0__py3-none-any.whl

ogx_open_client/models/open_ai_search_vector_store_request.py

@@ -0,0 +1,171 @@
+# 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 typing_extensions import Annotated
+from ogx_open_client.models.search_ranking_options import SearchRankingOptions
+from ogx_open_client.models.string_list_string1 import StringListString1
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class OpenAISearchVectorStoreRequest(BaseModel):
+    """
+    Request body for searching a vector store.
+    """ # noqa: E501
+    query: StringListString1
+    filters: Optional[Dict[str, Any]] = None
+    max_num_results: Optional[Annotated[int, Field(le=50, strict=True, ge=1)]] = Field(default=10, description="Maximum number of results to return.")
+    ranking_options: Optional[SearchRankingOptions] = None
+    rewrite_query: Optional[StrictBool] = Field(default=False, description="Whether to rewrite the query for better results.")
+    search_mode: Optional[StrictStr] = None
+    __properties: ClassVar[list[str]] = ["query", "filters", "max_num_results", "ranking_options", "rewrite_query", "search_mode"]
+
+    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 OpenAISearchVectorStoreRequest 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 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 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
+
+        # set to None if search_mode (nullable) is None
+        # and model_fields_set contains the field
+        if self.search_mode is None and "search_mode" in self.model_fields_set:
+            _dict['search_mode'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of OpenAISearchVectorStoreRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            k: v for k, v in {
+            "query": StringListString1.from_dict(obj["query"]) if obj.get("query") is not None else None,
+            "filters": obj.get("filters"),
+            "max_num_results": obj.get("max_num_results") if obj.get("max_num_results") is not None else 10,
+            "ranking_options": SearchRankingOptions.from_dict(obj["ranking_options"]) if obj.get("ranking_options") is not None else None,
+            "rewrite_query": obj.get("rewrite_query") if obj.get("rewrite_query") is not None else False,
+            "search_mode": obj.get("search_mode"),
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_open_client/models/open_ai_system_message_param.py

@@ -0,0 +1,151 @@
+# coding: utf-8
+
+# Copyright (c) The OGX Contributors.
+# All rights reserved.
+#
+# This source code is licensed under the terms described in the LICENSE file in
+# the root directory of this source tree.
+
+"""
+    OGX Specification - Stable & Experimental APIs
+
+    This is the specification of the OGX that provides                     a set of endpoints and their corresponding interfaces that are     tailored to                     best leverage Llama Models.      **🔗 COMBINED**: This specification includes both stable production-ready APIs     and experimental pre-release APIs. Use stable APIs for production deployments     and experimental APIs for testing new features.
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from ogx_open_client.models.string_list_open_ai_chat_completion_content_part_text_param2 import StringListOpenAIChatCompletionContentPartTextParam2
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class OpenAISystemMessageParam(BaseModel):
+    """
+    A system message providing instructions or context to the model.
+    """ # noqa: E501
+    role: Optional[StrictStr] = Field(default=None, description="Must be 'system' to identify this as a system message.")
+    content: StringListOpenAIChatCompletionContentPartTextParam2
+    name: Optional[StrictStr] = None
+    __properties: ClassVar[list[str]] = ["role", "content", "name"]
+
+    @field_validator('role')
+    def role_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['system']):
+            raise ValueError("must be one of enum values ('system')")
+        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 OpenAISystemMessageParam 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 content
+        if self.content:
+            if hasattr(self.content, 'to_dict'):
+                _dict_value = self.content.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['content'] = _dict_value
+                elif 'content' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['content']
+            else:
+                _dict['content'] = self.content
+        # set to None if name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict['name'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of OpenAISystemMessageParam 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 {
+            "role": obj.get("role"),
+            "content": StringListOpenAIChatCompletionContentPartTextParam2.from_dict(obj["content"]) if obj.get("content") is not None else None,
+            "name": obj.get("name"),
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_open_client/models/open_ai_token_log_prob.py

@@ -0,0 +1,146 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from ogx_open_client.models.open_ai_top_log_prob import OpenAITopLogProb
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class OpenAITokenLogProb(BaseModel):
+    """
+    The log probability for a token from an OpenAI-compatible chat completion response.
+    """ # noqa: E501
+    token: StrictStr = Field(description="The token.")
+    bytes: Optional[List[StrictInt]] = None
+    logprob: Union[StrictFloat, StrictInt] = Field(description="The log probability of the token.")
+    top_logprobs: Optional[List[OpenAITopLogProb]] = None
+    __properties: ClassVar[list[str]] = ["token", "bytes", "logprob", "top_logprobs"]
+
+    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 OpenAITokenLogProb 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 top_logprobs (list)
+        _items = []
+        if self.top_logprobs:
+            for _item_top_logprobs in self.top_logprobs:
+                if _item_top_logprobs:
+                    if hasattr(_item_top_logprobs, 'to_dict'):
+                        _items.append(_item_top_logprobs.to_dict())
+                    else:
+                        _items.append(_item_top_logprobs)
+            _dict['top_logprobs'] = _items
+        # set to None if bytes (nullable) is None
+        # and model_fields_set contains the field
+        if self.bytes is None and "bytes" in self.model_fields_set:
+            _dict['bytes'] = None
+
+        # set to None if top_logprobs (nullable) is None
+        # and model_fields_set contains the field
+        if self.top_logprobs is None and "top_logprobs" in self.model_fields_set:
+            _dict['top_logprobs'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of OpenAITokenLogProb 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 {
+            "token": obj.get("token"),
+            "bytes": obj.get("bytes"),
+            "logprob": obj.get("logprob"),
+            "top_logprobs": [OpenAITopLogProb.from_dict(_item) for _item in obj["top_logprobs"]] if obj.get("top_logprobs") is not None else None,
+            }.items() if k in obj
+        })
+        return _obj
+
+

ogx_open_client/models/open_ai_tool_message_param.py

@@ -0,0 +1,146 @@
+# 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 ogx_open_client.models.string_list_open_ai_chat_completion_content_part_text_param3 import StringListOpenAIChatCompletionContentPartTextParam3
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class OpenAIToolMessageParam(BaseModel):
+    """
+    A message representing the result of a tool invocation in an OpenAI-compatible chat completion request.
+    """ # noqa: E501
+    role: Optional[StrictStr] = Field(default=None, description="Must be 'tool' to identify this as a tool response.")
+    tool_call_id: StrictStr = Field(description="Unique identifier for the tool call this response is for.")
+    content: StringListOpenAIChatCompletionContentPartTextParam3
+    __properties: ClassVar[list[str]] = ["role", "tool_call_id", "content"]
+
+    @field_validator('role')
+    def role_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['tool']):
+            raise ValueError("must be one of enum values ('tool')")
+        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 OpenAIToolMessageParam 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 content
+        if self.content:
+            if hasattr(self.content, 'to_dict'):
+                _dict_value = self.content.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['content'] = _dict_value
+                elif 'content' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['content']
+            else:
+                _dict['content'] = self.content
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of OpenAIToolMessageParam 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 {
+            "role": obj.get("role"),
+            "tool_call_id": obj.get("tool_call_id"),
+            "content": StringListOpenAIChatCompletionContentPartTextParam3.from_dict(obj["content"]) if obj.get("content") is not None else None,
+            }.items() if k in obj
+        })
+        return _obj
+
+