feat(specs): add transformation copilot to ingestion (generated)

algolia/api-clients-automation#3479

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

Author: algolia-bot

algoliasearch/ingestion/client.py

@@ -99,6 +99,7 @@
 from algoliasearch.ingestion.models.transformation_create_response import (
     TransformationCreateResponse,
 )
+from algoliasearch.ingestion.models.transformation_models import TransformationModels
 from algoliasearch.ingestion.models.transformation_search import TransformationSearch
 from algoliasearch.ingestion.models.transformation_try import TransformationTry
 from algoliasearch.ingestion.models.transformation_try_response import (
@@ -3149,6 +3150,48 @@ async def list_tasks_v1(
             )
         ).deserialize(ListTasksResponseV1)
 
+    async def list_transformation_models_with_http_info(
+        self, request_options: Optional[Union[dict, RequestOptions]] = None
+    ) -> ApiResponse[str]:
+        """
+        Retrieves a list of existing LLM transformation helpers.
+
+        Required API Key ACLs:
+          - addObject
+                  - deleteIndex
+                  - editSettings
+
+        :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
+        :return: Returns the raw algoliasearch 'APIResponse' object.
+        """
+
+        return await self._transporter.request(
+            verb=Verb.GET,
+            path="/1/transformations/copilot",
+            request_options=self._request_options.merge(
+                user_request_options=request_options,
+            ),
+            use_read_transporter=False,
+        )
+
+    async def list_transformation_models(
+        self, request_options: Optional[Union[dict, RequestOptions]] = None
+    ) -> TransformationModels:
+        """
+        Retrieves a list of existing LLM transformation helpers.
+
+        Required API Key ACLs:
+          - addObject
+                  - deleteIndex
+                  - editSettings
+
+        :param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
+        :return: Returns the deserialized response in a 'TransformationModels' result object.
+        """
+        return (
+            await self.list_transformation_models_with_http_info(request_options)
+        ).deserialize(TransformationModels)
+
     async def list_transformations_with_http_info(
         self,
         items_per_page: Annotated[

algoliasearch/ingestion/models/model.py

@@ -0,0 +1,73 @@
+# 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 typing import Any, Dict, Self
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+
+
+class Model(BaseModel):
+    """
+    Model
+    """
+
+    fullname: StrictStr
+    model_name: StrictStr = Field(alias="modelName")
+    system_prompt: StrictStr = Field(alias="systemPrompt")
+    id: StrictStr
+    provider: StrictStr
+
+    model_config = ConfigDict(
+        use_enum_values=True, populate_by_name=True, validate_assignment=True
+    )
+
+    def to_json(self) -> str:
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of Model 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.
+
+        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.
+        """
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude={},
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict) -> Self:
+        """Create an instance of Model from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "fullname": obj.get("fullname"),
+                "modelName": obj.get("modelName"),
+                "systemPrompt": obj.get("systemPrompt"),
+                "id": obj.get("id"),
+                "provider": obj.get("provider"),
+            }
+        )
+        return _obj

algoliasearch/ingestion/models/transformation_models.py

@@ -0,0 +1,77 @@
+# 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 typing import Any, Dict, List, Self
+
+from pydantic import BaseModel, ConfigDict
+
+from algoliasearch.ingestion.models.model import Model
+
+
+class TransformationModels(BaseModel):
+    """
+    List of available AI models for transformation purposes.
+    """
+
+    llms: List[Model]
+
+    model_config = ConfigDict(
+        use_enum_values=True, populate_by_name=True, validate_assignment=True
+    )
+
+    def to_json(self) -> str:
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of TransformationModels 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.
+
+        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.
+        """
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude={},
+            exclude_none=True,
+        )
+        _items = []
+        if self.llms:
+            for _item in self.llms:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["llms"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict) -> Self:
+        """Create an instance of TransformationModels from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "llms": (
+                    [Model.from_dict(_item) for _item in obj.get("llms")]
+                    if obj.get("llms") is not None
+                    else None
+                )
+            }
+        )
+        return _obj