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

shaped/autogen/models/score_step_explanation.py

@@ -0,0 +1,224 @@
+# 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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from shaped.autogen.models.retrieval_scores_value import RetrievalScoresValue
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ScoreStepExplanation(BaseModel):
+    """
+    Explanation for a scoring step.
+    """ # noqa: E501
+    step_name: Optional[StrictStr] = None
+    step_type: Optional[StrictStr] = Field(default='', description="Type of step. Examples: 'column_order', 'similarity', 'text_search', 'prebuilt', 'expression', 'score_ensemble', 'diversity', etc.")
+    input_count: Optional[StrictInt] = None
+    output_count: Optional[StrictInt] = None
+    filtered_count: Optional[StrictInt] = None
+    execution_time_ms: Optional[Union[StrictFloat, StrictInt]] = None
+    metadata: Optional[Dict[str, Any]] = Field(default=None, description="Additional step-specific metadata. Contains implementation details specific to the step type.")
+    score_type: Optional[StrictStr] = None
+    value_model: Optional[StrictStr] = None
+    score_distribution: Optional[Dict[str, Union[StrictFloat, StrictInt]]] = None
+    items_scored: Optional[StrictInt] = None
+    scoring_policy_scores: Optional[Dict[str, List[Optional[RetrievalScoresValue]]]] = None
+    is_user_found_in_feature_store: Optional[StrictBool] = None
+    user_interaction_count: Optional[StrictInt] = None
+    user_feature_column_count: Optional[StrictInt] = None
+    item_feature_column_count: Optional[StrictInt] = None
+    candidate_item_features_count: Optional[StrictInt] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["step_name", "step_type", "input_count", "output_count", "filtered_count", "execution_time_ms", "metadata", "score_type", "value_model", "score_distribution", "items_scored", "scoring_policy_scores", "is_user_found_in_feature_store", "user_interaction_count", "user_feature_column_count", "item_feature_column_count", "candidate_item_features_count"]
+
+    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 ScoreStepExplanation 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 value in scoring_policy_scores (dict of array)
+        _field_dict_of_array = {}
+        if self.scoring_policy_scores:
+            for _key_scoring_policy_scores in self.scoring_policy_scores:
+                if self.scoring_policy_scores[_key_scoring_policy_scores] is not None:
+                    _field_dict_of_array[_key_scoring_policy_scores] = [
+                        _item.to_dict() for _item in self.scoring_policy_scores[_key_scoring_policy_scores]
+                    ]
+            _dict['scoring_policy_scores'] = _field_dict_of_array
+        # 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 step_name (nullable) is None
+        # and model_fields_set contains the field
+        if self.step_name is None and "step_name" in self.model_fields_set:
+            _dict['step_name'] = None
+
+        # set to None if input_count (nullable) is None
+        # and model_fields_set contains the field
+        if self.input_count is None and "input_count" in self.model_fields_set:
+            _dict['input_count'] = None
+
+        # set to None if output_count (nullable) is None
+        # and model_fields_set contains the field
+        if self.output_count is None and "output_count" in self.model_fields_set:
+            _dict['output_count'] = None
+
+        # set to None if filtered_count (nullable) is None
+        # and model_fields_set contains the field
+        if self.filtered_count is None and "filtered_count" in self.model_fields_set:
+            _dict['filtered_count'] = None
+
+        # set to None if execution_time_ms (nullable) is None
+        # and model_fields_set contains the field
+        if self.execution_time_ms is None and "execution_time_ms" in self.model_fields_set:
+            _dict['execution_time_ms'] = None
+
+        # set to None if score_type (nullable) is None
+        # and model_fields_set contains the field
+        if self.score_type is None and "score_type" in self.model_fields_set:
+            _dict['score_type'] = None
+
+        # set to None if value_model (nullable) is None
+        # and model_fields_set contains the field
+        if self.value_model is None and "value_model" in self.model_fields_set:
+            _dict['value_model'] = None
+
+        # set to None if score_distribution (nullable) is None
+        # and model_fields_set contains the field
+        if self.score_distribution is None and "score_distribution" in self.model_fields_set:
+            _dict['score_distribution'] = None
+
+        # set to None if items_scored (nullable) is None
+        # and model_fields_set contains the field
+        if self.items_scored is None and "items_scored" in self.model_fields_set:
+            _dict['items_scored'] = None
+
+        # set to None if scoring_policy_scores (nullable) is None
+        # and model_fields_set contains the field
+        if self.scoring_policy_scores is None and "scoring_policy_scores" in self.model_fields_set:
+            _dict['scoring_policy_scores'] = None
+
+        # set to None if is_user_found_in_feature_store (nullable) is None
+        # and model_fields_set contains the field
+        if self.is_user_found_in_feature_store is None and "is_user_found_in_feature_store" in self.model_fields_set:
+            _dict['is_user_found_in_feature_store'] = None
+
+        # set to None if user_interaction_count (nullable) is None
+        # and model_fields_set contains the field
+        if self.user_interaction_count is None and "user_interaction_count" in self.model_fields_set:
+            _dict['user_interaction_count'] = None
+
+        # set to None if user_feature_column_count (nullable) is None
+        # and model_fields_set contains the field
+        if self.user_feature_column_count is None and "user_feature_column_count" in self.model_fields_set:
+            _dict['user_feature_column_count'] = None
+
+        # set to None if item_feature_column_count (nullable) is None
+        # and model_fields_set contains the field
+        if self.item_feature_column_count is None and "item_feature_column_count" in self.model_fields_set:
+            _dict['item_feature_column_count'] = None
+
+        # set to None if candidate_item_features_count (nullable) is None
+        # and model_fields_set contains the field
+        if self.candidate_item_features_count is None and "candidate_item_features_count" in self.model_fields_set:
+            _dict['candidate_item_features_count'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ScoreStepExplanation from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "step_name": obj.get("step_name"),
+            "step_type": obj.get("step_type") if obj.get("step_type") is not None else '',
+            "input_count": obj.get("input_count"),
+            "output_count": obj.get("output_count"),
+            "filtered_count": obj.get("filtered_count"),
+            "execution_time_ms": obj.get("execution_time_ms"),
+            "metadata": obj.get("metadata"),
+            "score_type": obj.get("score_type"),
+            "value_model": obj.get("value_model"),
+            "score_distribution": obj.get("score_distribution"),
+            "items_scored": obj.get("items_scored"),
+            "scoring_policy_scores": dict(
+                (_k,
+                        [RetrievalScoresValue.from_dict(_item) for _item in _v]
+                        if _v is not None
+                        else None
+                )
+                for _k, _v in obj.get("scoring_policy_scores", {}).items()
+            ),
+            "is_user_found_in_feature_store": obj.get("is_user_found_in_feature_store"),
+            "user_interaction_count": obj.get("user_interaction_count"),
+            "user_feature_column_count": obj.get("user_feature_column_count"),
+            "item_feature_column_count": obj.get("item_feature_column_count"),
+            "candidate_item_features_count": obj.get("candidate_item_features_count")
+        })
+        # 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/search_config.py

@@ -0,0 +1,105 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from shaped.autogen.models.tokenizer import Tokenizer
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SearchConfig(BaseModel):
+    """
+    SearchConfig
+    """ # noqa: E501
+    tokenizer: Optional[Tokenizer] = None
+    user_fields: Optional[List[StrictStr]] = None
+    item_fields: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["tokenizer", "user_fields", "item_fields"]
+
+    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 SearchConfig 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 tokenizer
+        if self.tokenizer:
+            _dict['tokenizer'] = self.tokenizer.to_dict()
+        # set to None if user_fields (nullable) is None
+        # and model_fields_set contains the field
+        if self.user_fields is None and "user_fields" in self.model_fields_set:
+            _dict['user_fields'] = None
+
+        # set to None if item_fields (nullable) is None
+        # and model_fields_set contains the field
+        if self.item_fields is None and "item_fields" in self.model_fields_set:
+            _dict['item_fields'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SearchConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "tokenizer": Tokenizer.from_dict(obj["tokenizer"]) if obj.get("tokenizer") is not None else None,
+            "user_fields": obj.get("user_fields"),
+            "item_fields": obj.get("item_fields")
+        })
+        return _obj
+
+

shaped/autogen/models/segment_table_config.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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SegmentTableConfig(BaseModel):
+    """
+    SegmentTableConfig
+    """ # noqa: E501
+    schema_type: Optional[StrictStr] = Field(default='SEGMENT', description="Schema type discriminator for Segment datasets.")
+    name: StrictStr = Field(description="Unique identifier for the Segment dataset.")
+    description: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["schema_type", "name", "description"]
+
+    @field_validator('schema_type')
+    def schema_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['SEGMENT']):
+            raise ValueError("must be one of enum values ('SEGMENT')")
+        return value
+
+    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 SegmentTableConfig from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if description (nullable) is None
+        # and model_fields_set contains the field
+        if self.description is None and "description" in self.model_fields_set:
+            _dict['description'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SegmentTableConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "schema_type": obj.get("schema_type") if obj.get("schema_type") is not None else 'SEGMENT',
+            "name": obj.get("name"),
+            "description": obj.get("description")
+        })
+        return _obj
+
+

shaped/autogen/models/sequence_length.py

@@ -0,0 +1,136 @@
+# 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, StrictInt, StrictStr, ValidationError, field_validator
+from typing import Optional
+from shaped.autogen.models.tunable_int_categorical import TunableIntCategorical
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+SEQUENCELENGTH_ANY_OF_SCHEMAS = ["TunableIntCategorical", "int"]
+
+class SequenceLength(BaseModel):
+    """
+    Maximum length of input sequences.
+    """
+
+    # data type: int
+    anyof_schema_1_validator: Optional[StrictInt] = None
+    # data type: TunableIntCategorical
+    anyof_schema_2_validator: Optional[TunableIntCategorical] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[TunableIntCategorical, int]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = { "TunableIntCategorical", "int" }
+
+    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 = SequenceLength.model_construct()
+        error_messages = []
+        # validate data type: int
+        try:
+            instance.anyof_schema_1_validator = v
+            return v
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # validate data type: TunableIntCategorical
+        if not isinstance(v, TunableIntCategorical):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `TunableIntCategorical`")
+        else:
+            return v
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in SequenceLength with anyOf schemas: TunableIntCategorical, int. 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 = []
+        # deserialize data into int
+        try:
+            # validation
+            instance.anyof_schema_1_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.anyof_schema_1_validator
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # anyof_schema_2_validator: Optional[TunableIntCategorical] = None
+        try:
+            instance.actual_instance = TunableIntCategorical.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 SequenceLength with anyOf schemas: TunableIntCategorical, int. 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], TunableIntCategorical, int]]:
+        """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/server_config.py

@@ -0,0 +1,100 @@
+# 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, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ServerConfig(BaseModel):
+    """
+    Low-level configuration for the inference server process.
+    """ # noqa: E501
+    worker_count: Optional[StrictInt] = Field(default=1, description="Number of worker processes per inference pod.")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["worker_count"]
+
+    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 ServerConfig 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: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ServerConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "worker_count": obj.get("worker_count") if obj.get("worker_count") is not None else 1
+        })
+        # 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
+
+