chore(website): exclude schema from generated variables file (generated)

algolia/api-clients-automation#5306

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Thomas Raffray <[email protected]>

Author: algolia-bot

algoliasearch/composition/models/__init__.py

@@ -21,6 +21,8 @@
 from .compositions_search_response import CompositionsSearchResponse
 from .error_base import ErrorBase
 from .exhaustive import Exhaustive
+from .external_injected_item import ExternalInjectedItem
+from .external_injection import ExternalInjection
 from .facet_filters import FacetFilters
 from .facet_hits import FacetHits
 from .facet_ordering import FacetOrdering
@@ -77,6 +79,8 @@
     "CompositionsSearchResponse",
     "ErrorBase",
     "Exhaustive",
+    "ExternalInjectedItem",
+    "ExternalInjection",
     "FacetFilters",
     "FacetHits",
     "FacetOrdering",

algoliasearch/composition/models/external_injected_item.py

@@ -0,0 +1,80 @@
+# coding: utf-8
+
+"""
+Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+"""
+
+from __future__ import annotations
+
+from json import loads
+from sys import version_info
+from typing import Any, Dict, List, Optional
+
+from pydantic import BaseModel, ConfigDict
+
+if version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing_extensions import Self
+
+
+from algoliasearch.composition.models.external_injection import ExternalInjection
+
+_ALIASES = {
+    "items": "items",
+}
+
+
+def _alias_generator(name: str) -> str:
+    return _ALIASES.get(name, name)
+
+
+class ExternalInjectedItem(BaseModel):
+    """
+    ExternalInjectedItem
+    """
+
+    items: List[ExternalInjection]
+
+    model_config = ConfigDict(
+        strict=False,
+        use_enum_values=True,
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+        alias_generator=_alias_generator,
+        extra="allow",
+    )
+
+    def to_json(self) -> str:
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ExternalInjectedItem from a JSON string"""
+        return cls.from_dict(loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias."""
+        return self.model_dump(
+            by_alias=True,
+            exclude_none=True,
+            exclude_unset=True,
+        )
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ExternalInjectedItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        obj["items"] = (
+            [ExternalInjection.from_dict(_item) for _item in obj["items"]]
+            if obj.get("items") is not None
+            else None
+        )
+
+        return cls.model_validate(obj)

algoliasearch/composition/models/external_injection.py

@@ -0,0 +1,76 @@
+# coding: utf-8
+
+"""
+Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+"""
+
+from __future__ import annotations
+
+from json import loads
+from sys import version_info
+from typing import Any, Dict, Optional
+
+from pydantic import BaseModel, ConfigDict
+
+if version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing_extensions import Self
+
+
+_ALIASES = {
+    "object_id": "objectID",
+    "metadata": "metadata",
+}
+
+
+def _alias_generator(name: str) -> str:
+    return _ALIASES.get(name, name)
+
+
+class ExternalInjection(BaseModel):
+    """
+    ExternalInjection
+    """
+
+    object_id: str
+    """ An objectID injected into an external source. """
+    metadata: Optional[Dict[str, object]] = None
+    """ User-defined key-values that will be added to the injected item in the response. This is identical to Hits metadata defined in Composition or Composition Rule, with the benefit of being set at runtime.  """
+
+    model_config = ConfigDict(
+        strict=False,
+        use_enum_values=True,
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+        alias_generator=_alias_generator,
+        extra="allow",
+    )
+
+    def to_json(self) -> str:
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ExternalInjection from a JSON string"""
+        return cls.from_dict(loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias."""
+        return self.model_dump(
+            by_alias=True,
+            exclude_none=True,
+            exclude_unset=True,
+        )
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ExternalInjection from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        return cls.model_validate(obj)

algoliasearch/composition/models/params.py

@@ -20,6 +20,7 @@
 
 from algoliasearch.composition.models.around_precision import AroundPrecision
 from algoliasearch.composition.models.around_radius import AroundRadius
+from algoliasearch.composition.models.external_injected_item import ExternalInjectedItem
 from algoliasearch.composition.models.facet_filters import FacetFilters
 from algoliasearch.composition.models.inside_bounding_box import InsideBoundingBox
 from algoliasearch.composition.models.numeric_filters import NumericFilters
@@ -53,6 +54,7 @@
     "analytics_tags": "analyticsTags",
     "enable_ab_test": "enableABTest",
     "enable_re_ranking": "enableReRanking",
+    "injected_items": "injectedItems",
 }
 
 
@@ -111,6 +113,8 @@ class Params(BaseModel):
     """ Whether to enable index level A/B testing for this run request. If the composition mixes multiple indices, the A/B test is ignored.  """
     enable_re_ranking: Optional[bool] = None
     """ Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.  """
+    injected_items: Optional[Dict[str, ExternalInjectedItem]] = None
+    """ A list of extenrally injected objectID groups into from an external source.  """
 
     model_config = ConfigDict(
         strict=False,
@@ -179,5 +183,13 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         )
         obj["queryLanguages"] = obj.get("queryLanguages")
         obj["naturalLanguages"] = obj.get("naturalLanguages")
+        obj["injectedItems"] = (
+            dict(
+                (_k, ExternalInjectedItem.from_dict(_v))
+                for _k, _v in obj["injectedItems"].items()
+            )
+            if obj.get("injectedItems") is not None
+            else None
+        )
 
         return cls.model_validate(obj)