shaped 2.0.1__py3-none-any.whl → 2.0.4__py3-none-any.whl

shaped/autogen/models/query_definition.py

@@ -0,0 +1,106 @@
+# coding: utf-8
+
+"""
+    Shaped API
+
+    Welcome to Shaped's API reference docs. These provide a  detailed view of the endpoints and CLI commands that Shaped provides and brief  explanations of how they should be used.  The Shaped API has four main endpoints:  **Tables** - Provision and manage batch and real-time data connectors.   **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc.  **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more.  **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture.  The base URL for each endpoint is: `https://api.shaped.ai/v2`
+
+    The version of the OpenAPI document: 2.0.4
+    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, Optional
+from shaped.autogen.models.parameter_definition import ParameterDefinition
+from shaped.autogen.models.query import Query
+from typing import Optional, Set
+from typing_extensions import Self
+
+class QueryDefinition(BaseModel):
+    """
+    Defines a single, named query recipe (\"stored procedure\").  The query can be either: - A QueryConfig object (structured query configuration) - A SQL query string (will be transpiled to QueryConfig at initialization)
+    """ # noqa: E501
+    query: Query
+    parameters: Optional[Dict[str, ParameterDefinition]] = Field(default=None, description="Dictionary of parameter definitions for query parameterization.")
+    __properties: ClassVar[List[str]] = ["query", "parameters"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    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) -> Optional[Self]:
+        """Create an instance of QueryDefinition 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:
+            _dict['query'] = self.query.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each value in parameters (dict)
+        _field_dict = {}
+        if self.parameters:
+            for _key_parameters in self.parameters:
+                if self.parameters[_key_parameters]:
+                    _field_dict[_key_parameters] = self.parameters[_key_parameters].to_dict()
+            _dict['parameters'] = _field_dict
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of QueryDefinition from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "query": Query.from_dict(obj["query"]) if obj.get("query") is not None else None,
+            "parameters": dict(
+                (_k, ParameterDefinition.from_dict(_v))
+                for _k, _v in obj["parameters"].items()
+            )
+            if obj.get("parameters") is not None
+            else None
+        })
+        return _obj
+
+

shaped/autogen/models/query_encoder.py

@@ -0,0 +1,194 @@
+# coding: utf-8
+
+"""
+    Shaped API
+
+    Welcome to Shaped's API reference docs. These provide a  detailed view of the endpoints and CLI commands that Shaped provides and brief  explanations of how they should be used.  The Shaped API has four main endpoints:  **Tables** - Provision and manage batch and real-time data connectors.   **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc.  **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more.  **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture.  The base URL for each endpoint is: `https://api.shaped.ai/v2`
+
+    The version of the OpenAPI document: 2.0.4
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+from inspect import getfullargspec
+import json
+import pprint
+import re  # noqa: F401
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Optional
+from shaped.autogen.models.interaction_pooling_encoder import InteractionPoolingEncoder
+from shaped.autogen.models.interaction_round_robin_encoder import InteractionRoundRobinEncoder
+from shaped.autogen.models.item_attribute_pooling_encoder import ItemAttributePoolingEncoder
+from shaped.autogen.models.precomputed_item_embedding import PrecomputedItemEmbedding
+from shaped.autogen.models.precomputed_user_embedding import PrecomputedUserEmbedding
+from shaped.autogen.models.user_attribute_pooling_encoder import UserAttributePoolingEncoder
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+QUERYENCODER_ANY_OF_SCHEMAS = ["InteractionPoolingEncoder", "InteractionRoundRobinEncoder", "ItemAttributePoolingEncoder", "PrecomputedItemEmbedding", "PrecomputedUserEmbedding", "UserAttributePoolingEncoder"]
+
+class QueryEncoder(BaseModel):
+    """
+    Encoder to generate query vector from user/item input.
+    """
+
+    # data type: InteractionPoolingEncoder
+    anyof_schema_1_validator: Optional[InteractionPoolingEncoder] = None
+    # data type: InteractionRoundRobinEncoder
+    anyof_schema_2_validator: Optional[InteractionRoundRobinEncoder] = None
+    # data type: UserAttributePoolingEncoder
+    anyof_schema_3_validator: Optional[UserAttributePoolingEncoder] = None
+    # data type: PrecomputedUserEmbedding
+    anyof_schema_4_validator: Optional[PrecomputedUserEmbedding] = None
+    # data type: ItemAttributePoolingEncoder
+    anyof_schema_5_validator: Optional[ItemAttributePoolingEncoder] = None
+    # data type: PrecomputedItemEmbedding
+    anyof_schema_6_validator: Optional[PrecomputedItemEmbedding] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[InteractionPoolingEncoder, InteractionRoundRobinEncoder, ItemAttributePoolingEncoder, PrecomputedItemEmbedding, PrecomputedUserEmbedding, UserAttributePoolingEncoder]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = { "InteractionPoolingEncoder", "InteractionRoundRobinEncoder", "ItemAttributePoolingEncoder", "PrecomputedItemEmbedding", "PrecomputedUserEmbedding", "UserAttributePoolingEncoder" }
+
+    model_config = {
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_anyof(cls, v):
+        instance = QueryEncoder.model_construct()
+        error_messages = []
+        # validate data type: InteractionPoolingEncoder
+        if not isinstance(v, InteractionPoolingEncoder):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `InteractionPoolingEncoder`")
+        else:
+            return v
+
+        # validate data type: InteractionRoundRobinEncoder
+        if not isinstance(v, InteractionRoundRobinEncoder):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `InteractionRoundRobinEncoder`")
+        else:
+            return v
+
+        # validate data type: UserAttributePoolingEncoder
+        if not isinstance(v, UserAttributePoolingEncoder):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `UserAttributePoolingEncoder`")
+        else:
+            return v
+
+        # validate data type: PrecomputedUserEmbedding
+        if not isinstance(v, PrecomputedUserEmbedding):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `PrecomputedUserEmbedding`")
+        else:
+            return v
+
+        # validate data type: ItemAttributePoolingEncoder
+        if not isinstance(v, ItemAttributePoolingEncoder):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ItemAttributePoolingEncoder`")
+        else:
+            return v
+
+        # validate data type: PrecomputedItemEmbedding
+        if not isinstance(v, PrecomputedItemEmbedding):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `PrecomputedItemEmbedding`")
+        else:
+            return v
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in QueryEncoder with anyOf schemas: InteractionPoolingEncoder, InteractionRoundRobinEncoder, ItemAttributePoolingEncoder, PrecomputedItemEmbedding, PrecomputedUserEmbedding, UserAttributePoolingEncoder. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        # anyof_schema_1_validator: Optional[InteractionPoolingEncoder] = None
+        try:
+            instance.actual_instance = InteractionPoolingEncoder.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_2_validator: Optional[InteractionRoundRobinEncoder] = None
+        try:
+            instance.actual_instance = InteractionRoundRobinEncoder.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_3_validator: Optional[UserAttributePoolingEncoder] = None
+        try:
+            instance.actual_instance = UserAttributePoolingEncoder.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_4_validator: Optional[PrecomputedUserEmbedding] = None
+        try:
+            instance.actual_instance = PrecomputedUserEmbedding.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_5_validator: Optional[ItemAttributePoolingEncoder] = None
+        try:
+            instance.actual_instance = ItemAttributePoolingEncoder.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_6_validator: Optional[PrecomputedItemEmbedding] = None
+        try:
+            instance.actual_instance = PrecomputedItemEmbedding.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into QueryEncoder with anyOf schemas: InteractionPoolingEncoder, InteractionRoundRobinEncoder, ItemAttributePoolingEncoder, PrecomputedItemEmbedding, PrecomputedUserEmbedding, UserAttributePoolingEncoder. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], InteractionPoolingEncoder, InteractionRoundRobinEncoder, ItemAttributePoolingEncoder, PrecomputedItemEmbedding, PrecomputedUserEmbedding, UserAttributePoolingEncoder]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+

shaped/autogen/models/query_explanation.py

@@ -0,0 +1,201 @@
+# coding: utf-8
+
+"""
+    Shaped API
+
+    Welcome to Shaped's API reference docs. These provide a  detailed view of the endpoints and CLI commands that Shaped provides and brief  explanations of how they should be used.  The Shaped API has four main endpoints:  **Tables** - Provision and manage batch and real-time data connectors.   **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc.  **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more.  **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture.  The base URL for each endpoint is: `https://api.shaped.ai/v2`
+
+    The version of the OpenAPI document: 2.0.4
+    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 shaped.autogen.models.inner_uid import InnerUid
+from shaped.autogen.models.pipeline_stage_explanation import PipelineStageExplanation
+from typing import Optional, Set
+from typing_extensions import Self
+
+class QueryExplanation(BaseModel):
+    """
+    Detailed explanation of the query execution pipeline.  This follows the declarative query structure, providing explanations for each stage and step in the pipeline. Per-entity journey tracking is attached to individual Result objects in QueryResult.results.
+    """ # noqa: E501
+    query_name: Optional[StrictStr] = None
+    query_type: Optional[StrictStr] = None
+    parameters: Optional[Dict[str, Any]] = Field(default=None, description="Parameters that were passed to the query. Shows the resolved values for any $parameter references used in the query configuration.")
+    pagination_id: Optional[StrictStr] = None
+    retrieve_stage: Optional[PipelineStageExplanation] = None
+    filter_stage: Optional[PipelineStageExplanation] = None
+    score_stage: Optional[PipelineStageExplanation] = None
+    reorder_stage: Optional[PipelineStageExplanation] = None
+    total_execution_time_ms: Optional[Union[StrictFloat, StrictInt]] = None
+    final_result_count: Optional[StrictInt] = None
+    limit_applied: Optional[StrictInt] = None
+    inner_uid: Optional[InnerUid] = None
+    outer_uid: Optional[StrictStr] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["query_name", "query_type", "parameters", "pagination_id", "retrieve_stage", "filter_stage", "score_stage", "reorder_stage", "total_execution_time_ms", "final_result_count", "limit_applied", "inner_uid", "outer_uid"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    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) -> Optional[Self]:
+        """Create an instance of QueryExplanation 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 retrieve_stage
+        if self.retrieve_stage:
+            _dict['retrieve_stage'] = self.retrieve_stage.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of filter_stage
+        if self.filter_stage:
+            _dict['filter_stage'] = self.filter_stage.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of score_stage
+        if self.score_stage:
+            _dict['score_stage'] = self.score_stage.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of reorder_stage
+        if self.reorder_stage:
+            _dict['reorder_stage'] = self.reorder_stage.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of inner_uid
+        if self.inner_uid:
+            _dict['inner_uid'] = self.inner_uid.to_dict()
+        # 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 query_name (nullable) is None
+        # and model_fields_set contains the field
+        if self.query_name is None and "query_name" in self.model_fields_set:
+            _dict['query_name'] = None
+
+        # set to None if query_type (nullable) is None
+        # and model_fields_set contains the field
+        if self.query_type is None and "query_type" in self.model_fields_set:
+            _dict['query_type'] = None
+
+        # set to None if pagination_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.pagination_id is None and "pagination_id" in self.model_fields_set:
+            _dict['pagination_id'] = None
+
+        # set to None if retrieve_stage (nullable) is None
+        # and model_fields_set contains the field
+        if self.retrieve_stage is None and "retrieve_stage" in self.model_fields_set:
+            _dict['retrieve_stage'] = None
+
+        # set to None if filter_stage (nullable) is None
+        # and model_fields_set contains the field
+        if self.filter_stage is None and "filter_stage" in self.model_fields_set:
+            _dict['filter_stage'] = None
+
+        # set to None if score_stage (nullable) is None
+        # and model_fields_set contains the field
+        if self.score_stage is None and "score_stage" in self.model_fields_set:
+            _dict['score_stage'] = None
+
+        # set to None if reorder_stage (nullable) is None
+        # and model_fields_set contains the field
+        if self.reorder_stage is None and "reorder_stage" in self.model_fields_set:
+            _dict['reorder_stage'] = None
+
+        # set to None if total_execution_time_ms (nullable) is None
+        # and model_fields_set contains the field
+        if self.total_execution_time_ms is None and "total_execution_time_ms" in self.model_fields_set:
+            _dict['total_execution_time_ms'] = None
+
+        # set to None if final_result_count (nullable) is None
+        # and model_fields_set contains the field
+        if self.final_result_count is None and "final_result_count" in self.model_fields_set:
+            _dict['final_result_count'] = None
+
+        # set to None if limit_applied (nullable) is None
+        # and model_fields_set contains the field
+        if self.limit_applied is None and "limit_applied" in self.model_fields_set:
+            _dict['limit_applied'] = None
+
+        # set to None if inner_uid (nullable) is None
+        # and model_fields_set contains the field
+        if self.inner_uid is None and "inner_uid" in self.model_fields_set:
+            _dict['inner_uid'] = None
+
+        # set to None if outer_uid (nullable) is None
+        # and model_fields_set contains the field
+        if self.outer_uid is None and "outer_uid" in self.model_fields_set:
+            _dict['outer_uid'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of QueryExplanation from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "query_name": obj.get("query_name"),
+            "query_type": obj.get("query_type"),
+            "parameters": obj.get("parameters"),
+            "pagination_id": obj.get("pagination_id"),
+            "retrieve_stage": PipelineStageExplanation.from_dict(obj["retrieve_stage"]) if obj.get("retrieve_stage") is not None else None,
+            "filter_stage": PipelineStageExplanation.from_dict(obj["filter_stage"]) if obj.get("filter_stage") is not None else None,
+            "score_stage": PipelineStageExplanation.from_dict(obj["score_stage"]) if obj.get("score_stage") is not None else None,
+            "reorder_stage": PipelineStageExplanation.from_dict(obj["reorder_stage"]) if obj.get("reorder_stage") is not None else None,
+            "total_execution_time_ms": obj.get("total_execution_time_ms"),
+            "final_result_count": obj.get("final_result_count"),
+            "limit_applied": obj.get("limit_applied"),
+            "inner_uid": InnerUid.from_dict(obj["inner_uid"]) if obj.get("inner_uid") is not None else None,
+            "outer_uid": obj.get("outer_uid")
+        })
+        # 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
+
+

shaped/autogen/models/query_request.py

@@ -0,0 +1,121 @@
+# coding: utf-8
+
+"""
+    Shaped API
+
+    Welcome to Shaped's API reference docs. These provide a  detailed view of the endpoints and CLI commands that Shaped provides and brief  explanations of how they should be used.  The Shaped API has four main endpoints:  **Tables** - Provision and manage batch and real-time data connectors.   **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc.  **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more.  **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture.  The base URL for each endpoint is: `https://api.shaped.ai/v2`
+
+    The version of the OpenAPI document: 2.0.4
+    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 shaped.autogen.models.parameters_value import ParametersValue
+from shaped.autogen.models.query1 import Query1
+from typing import Optional, Set
+from typing_extensions import Self
+
+class QueryRequest(BaseModel):
+    """
+    Request model for ad-hoc queries.
+    """ # noqa: E501
+    parameters: Optional[Dict[str, ParametersValue]] = Field(default=None, description="Query parameters that can be referenced in the query configuration using $parameter.name syntax. Supports int, float, str, bool, and lists of these types.")
+    query: Query1
+    return_metadata: Optional[StrictBool] = Field(default=True, description="Whether to include entity metadata (attributes) in the response. When true, each result includes an 'attributes' field with entity metadata.")
+    return_explanation: Optional[StrictBool] = Field(default=False, description="Whether to include a detailed explanation of query execution. When true, the response includes an 'explanation' field with information about retrieval, filtering, scoring, and reordering stages.")
+    return_journey_explanations: Optional[StrictBool] = Field(default=False, description="Whether to include per-entity journey tracking in results. When true, each result includes a 'journey' field showing how that entity moved through the query pipeline.")
+    pagination_key: Optional[StrictStr] = None
+    ignore_pagination: Optional[StrictBool] = Field(default=False, description="Whether to ignore pagination and return results from the beginning. When true, pagination_key is ignored and results start from the first page.")
+    __properties: ClassVar[List[str]] = ["parameters", "query", "return_metadata", "return_explanation", "return_journey_explanations", "pagination_key", "ignore_pagination"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    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) -> Optional[Self]:
+        """Create an instance of QueryRequest 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 value in parameters (dict)
+        _field_dict = {}
+        if self.parameters:
+            for _key_parameters in self.parameters:
+                if self.parameters[_key_parameters]:
+                    _field_dict[_key_parameters] = self.parameters[_key_parameters].to_dict()
+            _dict['parameters'] = _field_dict
+        # override the default output from pydantic by calling `to_dict()` of query
+        if self.query:
+            _dict['query'] = self.query.to_dict()
+        # set to None if pagination_key (nullable) is None
+        # and model_fields_set contains the field
+        if self.pagination_key is None and "pagination_key" in self.model_fields_set:
+            _dict['pagination_key'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of QueryRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "parameters": dict(
+                (_k, ParametersValue.from_dict(_v))
+                for _k, _v in obj["parameters"].items()
+            )
+            if obj.get("parameters") is not None
+            else None,
+            "query": Query1.from_dict(obj["query"]) if obj.get("query") is not None else None,
+            "return_metadata": obj.get("return_metadata") if obj.get("return_metadata") is not None else True,
+            "return_explanation": obj.get("return_explanation") if obj.get("return_explanation") is not None else False,
+            "return_journey_explanations": obj.get("return_journey_explanations") if obj.get("return_journey_explanations") is not None else False,
+            "pagination_key": obj.get("pagination_key"),
+            "ignore_pagination": obj.get("ignore_pagination") if obj.get("ignore_pagination") is not None else False
+        })
+        return _obj
+
+