ogx_open_client 1.0.3.dev0__py3-none-any.whl

ogx_client/models/open_ai_response_object_stream_response_web_search_call_searching.py

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

ogx_client/models/open_ai_response_object_with_input.py

@@ -0,0 +1,425 @@
+# 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, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from ogx_client.models.open_ai_response_error import OpenAIResponseError
+from ogx_client.models.open_ai_response_incomplete_details import OpenAIResponseIncompleteDetails
+from ogx_client.models.open_ai_response_input_tool_choice_mode1 import OpenAIResponseInputToolChoiceMode1
+from ogx_client.models.open_ai_response_input_tool_web_search4_variants import OpenAIResponseInputToolWebSearch4Variants
+from ogx_client.models.open_ai_response_message_output_union import OpenAIResponseMessageOutputUnion
+from ogx_client.models.open_ai_response_output_item import OpenAIResponseOutputItem
+from ogx_client.models.open_ai_response_prompt import OpenAIResponsePrompt
+from ogx_client.models.open_ai_response_reasoning import OpenAIResponseReasoning
+from ogx_client.models.open_ai_response_text import OpenAIResponseText
+from ogx_client.models.open_ai_response_usage import OpenAIResponseUsage
+from ogx_client.models.response_truncation import ResponseTruncation
+from typing import Any, ClassVar
+from typing_extensions import Self
+
+class OpenAIResponseObjectWithInput(BaseModel):
+    """
+    OpenAI response object extended with input context information.
+    """ # noqa: E501
+    background: Optional[StrictBool] = None
+    created_at: StrictInt
+    completed_at: Optional[StrictInt] = None
+    error: Optional[OpenAIResponseError] = None
+    frequency_penalty: Optional[Union[StrictFloat, StrictInt]] = None
+    id: StrictStr
+    incomplete_details: Optional[OpenAIResponseIncompleteDetails] = None
+    model: StrictStr
+    object: Optional[StrictStr] = 'response'
+    output: List[OpenAIResponseOutputItem]
+    parallel_tool_calls: Optional[StrictBool] = None
+    previous_response_id: Optional[StrictStr] = None
+    prompt_cache_key: Optional[StrictStr] = None
+    prompt: Optional[OpenAIResponsePrompt] = None
+    status: StrictStr
+    temperature: Optional[Union[StrictFloat, StrictInt]] = None
+    text: Optional[OpenAIResponseText] = None
+    top_p: Optional[Union[StrictFloat, StrictInt]] = None
+    top_logprobs: Optional[StrictInt] = None
+    tools: Optional[List[OpenAIResponseInputToolWebSearch4Variants]] = None
+    tool_choice: Optional[OpenAIResponseInputToolChoiceMode1] = None
+    truncation: Optional[ResponseTruncation] = None
+    usage: Optional[OpenAIResponseUsage] = None
+    instructions: Optional[StrictStr] = None
+    max_tool_calls: Optional[StrictInt] = None
+    reasoning: Optional[OpenAIResponseReasoning] = None
+    max_output_tokens: Optional[StrictInt] = None
+    service_tier: Optional[StrictStr] = None
+    metadata: Optional[Dict[str, StrictStr]] = None
+    presence_penalty: Optional[Union[StrictFloat, StrictInt]] = None
+    store: StrictBool
+    input: List[OpenAIResponseMessageOutputUnion]
+    __properties: ClassVar[list[str]] = ["background", "created_at", "completed_at", "error", "frequency_penalty", "id", "incomplete_details", "model", "object", "output", "parallel_tool_calls", "previous_response_id", "prompt_cache_key", "prompt", "status", "temperature", "text", "top_p", "top_logprobs", "tools", "tool_choice", "truncation", "usage", "instructions", "max_tool_calls", "reasoning", "max_output_tokens", "service_tier", "metadata", "presence_penalty", "store", "input"]
+
+    @field_validator('object')
+    def object_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['response']):
+            raise ValueError("must be one of enum values ('response')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    @property
+    def output_text(self) -> str:
+        """Extract text content from output messages.
+
+        This property iterates through the output list and extracts text from
+        message content parts, concatenating them together.
+
+        Returns:
+            str: Concatenated text from all output messages, or empty string if no output field exists
+        """
+        # Check if this model has an output field
+        if not hasattr(self, 'output') or not self.output:
+            return ""
+
+        text_parts = []
+        for item in self.output:
+            # Handle oneOf wrapper - get actual_instance if it exists
+            actual_item = getattr(item, 'actual_instance', item)
+
+            # Check if this is a message type with content
+            if hasattr(actual_item, 'content'):
+                content = actual_item.content
+                # Handle oneOf wrapper for content
+                actual_content = getattr(content, 'actual_instance', content)
+
+                # If content is a string, use it directly
+                if isinstance(actual_content, str):
+                    text_parts.append(actual_content)
+                # If content is a list, iterate through parts
+                elif isinstance(actual_content, list):
+                    for content_part in actual_content:
+                        # Handle oneOf wrapper for content part
+                        actual_part = getattr(content_part, 'actual_instance', content_part)
+                        # Extract text if this part has a text attribute
+                        if hasattr(actual_part, 'text'):
+                            text_parts.append(actual_part.text)
+
+        return "".join(text_parts)
+
+
+    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 OpenAIResponseObjectWithInput 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 error
+        if self.error:
+            if hasattr(self.error, 'to_dict'):
+                _dict_value = self.error.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['error'] = _dict_value
+                elif 'error' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['error']
+            else:
+                _dict['error'] = self.error
+        # override the default output from pydantic by calling `to_dict()` of incomplete_details
+        if self.incomplete_details:
+            if hasattr(self.incomplete_details, 'to_dict'):
+                _dict_value = self.incomplete_details.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['incomplete_details'] = _dict_value
+                elif 'incomplete_details' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['incomplete_details']
+            else:
+                _dict['incomplete_details'] = self.incomplete_details
+        # override the default output from pydantic by calling `to_dict()` of each item in output (list)
+        _items = []
+        if self.output:
+            for _item_output in self.output:
+                if _item_output:
+                    if hasattr(_item_output, 'to_dict'):
+                        _items.append(_item_output.to_dict())
+                    else:
+                        _items.append(_item_output)
+            _dict['output'] = _items
+        # override the default output from pydantic by calling `to_dict()` of prompt
+        if self.prompt:
+            if hasattr(self.prompt, 'to_dict'):
+                _dict_value = self.prompt.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['prompt'] = _dict_value
+                elif 'prompt' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['prompt']
+            else:
+                _dict['prompt'] = self.prompt
+        # override the default output from pydantic by calling `to_dict()` of text
+        if self.text:
+            if hasattr(self.text, 'to_dict'):
+                _dict_value = self.text.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['text'] = _dict_value
+                elif 'text' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['text']
+            else:
+                _dict['text'] = self.text
+        # override the default output from pydantic by calling `to_dict()` of each item in tools (list)
+        _items = []
+        if self.tools:
+            for _item_tools in self.tools:
+                if _item_tools:
+                    if hasattr(_item_tools, 'to_dict'):
+                        _items.append(_item_tools.to_dict())
+                    else:
+                        _items.append(_item_tools)
+            _dict['tools'] = _items
+        # override the default output from pydantic by calling `to_dict()` of tool_choice
+        if self.tool_choice:
+            if hasattr(self.tool_choice, 'to_dict'):
+                _dict_value = self.tool_choice.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['tool_choice'] = _dict_value
+                elif 'tool_choice' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['tool_choice']
+            else:
+                _dict['tool_choice'] = self.tool_choice
+        # override the default output from pydantic by calling `to_dict()` of usage
+        if self.usage:
+            if hasattr(self.usage, 'to_dict'):
+                _dict_value = self.usage.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['usage'] = _dict_value
+                elif 'usage' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['usage']
+            else:
+                _dict['usage'] = self.usage
+        # override the default output from pydantic by calling `to_dict()` of reasoning
+        if self.reasoning:
+            if hasattr(self.reasoning, 'to_dict'):
+                _dict_value = self.reasoning.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['reasoning'] = _dict_value
+                elif 'reasoning' in _dict:
+                    # Remove from dict if to_dict() returned None (oneOf wrapper with no actual instance)
+                    del _dict['reasoning']
+            else:
+                _dict['reasoning'] = self.reasoning
+        # override the default output from pydantic by calling `to_dict()` of each item in input (list)
+        _items = []
+        if self.input:
+            for _item_input in self.input:
+                if _item_input:
+                    if hasattr(_item_input, 'to_dict'):
+                        _items.append(_item_input.to_dict())
+                    else:
+                        _items.append(_item_input)
+            _dict['input'] = _items
+        # set to None if completed_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.completed_at is None and "completed_at" in self.model_fields_set:
+            _dict['completed_at'] = None
+
+        # set to None if error (nullable) is None
+        # and model_fields_set contains the field
+        if self.error is None and "error" in self.model_fields_set:
+            _dict['error'] = None
+
+        # set to None if incomplete_details (nullable) is None
+        # and model_fields_set contains the field
+        if self.incomplete_details is None and "incomplete_details" in self.model_fields_set:
+            _dict['incomplete_details'] = None
+
+        # set to None if previous_response_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.previous_response_id is None and "previous_response_id" in self.model_fields_set:
+            _dict['previous_response_id'] = None
+
+        # set to None if prompt_cache_key (nullable) is None
+        # and model_fields_set contains the field
+        if self.prompt_cache_key is None and "prompt_cache_key" in self.model_fields_set:
+            _dict['prompt_cache_key'] = None
+
+        # set to None if prompt (nullable) is None
+        # and model_fields_set contains the field
+        if self.prompt is None and "prompt" in self.model_fields_set:
+            _dict['prompt'] = None
+
+        # set to None if tool_choice (nullable) is None
+        # and model_fields_set contains the field
+        if self.tool_choice is None and "tool_choice" in self.model_fields_set:
+            _dict['tool_choice'] = None
+
+        # set to None if truncation (nullable) is None
+        # and model_fields_set contains the field
+        if self.truncation is None and "truncation" in self.model_fields_set:
+            _dict['truncation'] = None
+
+        # set to None if usage (nullable) is None
+        # and model_fields_set contains the field
+        if self.usage is None and "usage" in self.model_fields_set:
+            _dict['usage'] = None
+
+        # set to None if instructions (nullable) is None
+        # and model_fields_set contains the field
+        if self.instructions is None and "instructions" in self.model_fields_set:
+            _dict['instructions'] = None
+
+        # set to None if max_tool_calls (nullable) is None
+        # and model_fields_set contains the field
+        if self.max_tool_calls is None and "max_tool_calls" in self.model_fields_set:
+            _dict['max_tool_calls'] = None
+
+        # set to None if reasoning (nullable) is None
+        # and model_fields_set contains the field
+        if self.reasoning is None and "reasoning" in self.model_fields_set:
+            _dict['reasoning'] = None
+
+        # set to None if max_output_tokens (nullable) is None
+        # and model_fields_set contains the field
+        if self.max_output_tokens is None and "max_output_tokens" in self.model_fields_set:
+            _dict['max_output_tokens'] = None
+
+        # set to None if metadata (nullable) is None
+        # and model_fields_set contains the field
+        if self.metadata is None and "metadata" in self.model_fields_set:
+            _dict['metadata'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of OpenAIResponseObjectWithInput 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 {
+            "background": obj.get("background"),
+            "created_at": obj.get("created_at"),
+            "completed_at": obj.get("completed_at"),
+            "error": OpenAIResponseError.from_dict(obj["error"]) if obj.get("error") is not None else None,
+            "frequency_penalty": obj.get("frequency_penalty"),
+            "id": obj.get("id"),
+            "incomplete_details": OpenAIResponseIncompleteDetails.from_dict(obj["incomplete_details"]) if obj.get("incomplete_details") is not None else None,
+            "model": obj.get("model"),
+            "object": obj.get("object") if obj.get("object") is not None else 'response',
+            "output": [OpenAIResponseOutputItem.from_dict(_item) for _item in obj["output"]] if obj.get("output") is not None else None,
+            "parallel_tool_calls": obj.get("parallel_tool_calls"),
+            "previous_response_id": obj.get("previous_response_id"),
+            "prompt_cache_key": obj.get("prompt_cache_key"),
+            "prompt": OpenAIResponsePrompt.from_dict(obj["prompt"]) if obj.get("prompt") is not None else None,
+            "status": obj.get("status"),
+            "temperature": obj.get("temperature"),
+            "text": OpenAIResponseText.from_dict(obj["text"]) if obj.get("text") is not None else None,
+            "top_p": obj.get("top_p"),
+            "top_logprobs": obj.get("top_logprobs"),
+            "tools": [OpenAIResponseInputToolWebSearch4Variants.from_dict(_item) for _item in obj["tools"]] if obj.get("tools") is not None else None,
+            "tool_choice": OpenAIResponseInputToolChoiceMode1.from_dict(obj["tool_choice"]) if obj.get("tool_choice") is not None else None,
+            "truncation": obj.get("truncation"),
+            "usage": OpenAIResponseUsage.from_dict(obj["usage"]) if obj.get("usage") is not None else None,
+            "instructions": obj.get("instructions"),
+            "max_tool_calls": obj.get("max_tool_calls"),
+            "reasoning": OpenAIResponseReasoning.from_dict(obj["reasoning"]) if obj.get("reasoning") is not None else None,
+            "max_output_tokens": obj.get("max_output_tokens"),
+            "service_tier": obj.get("service_tier"),
+            "metadata": obj.get("metadata"),
+            "presence_penalty": obj.get("presence_penalty"),
+            "store": obj.get("store"),
+            "input": [OpenAIResponseMessageOutputUnion.from_dict(_item) for _item in obj["input"]] if obj.get("input") is not None else None,
+            }.items() if k in obj
+        })
+        return _obj
+
+