fix(python): remove warnings for HighlightResult and SnippetResult (#5284) (generated) [skip ci]

Co-authored-by: Clément Vannicatte <[email protected]>

Author: algolia-bot

clients/algoliasearch-client-python/algoliasearch/search/models/hit.py

@@ -10,7 +10,7 @@
 from sys import version_info
 from typing import Any, Dict, Optional
 
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel, ConfigDict, field_serializer
 
 if version_info >= (3, 11):
     from typing import Self
@@ -59,6 +59,43 @@ class Hit(BaseModel):
         extra="allow",
     )
 
+    @staticmethod
+    def __dump_item(item):
+        return (
+            item.model_dump(
+                by_alias=True,
+                exclude_none=True,
+                exclude_unset=True,
+                warnings="none",
+            )
+            if isinstance(item, BaseModel)
+            else item
+        )
+
+    @field_serializer("highlight_result")
+    def serialize_highlight_result(self, v: HighlightResult | None):
+        if v is None:
+            return None
+
+        if isinstance(v, dict):
+            return {k: self.__dump_item(val) for k, val in v.items()}
+        elif isinstance(v, list):
+            return [self.__dump_item(val) for val in v]
+        else:
+            return self.__dump_item(v)
+
+    @field_serializer("snippet_result")
+    def serialize_snippet_result(self, v: SnippetResult | None):
+        if v is None:
+            return None
+
+        if isinstance(v, dict):
+            return {k: self.__dump_item(val) for k, val in v.items()}
+        elif isinstance(v, list):
+            return [self.__dump_item(val) for val in v]
+        else:
+            return self.__dump_item(v)
+
     def to_json(self) -> str:
         return self.model_dump_json(by_alias=True, exclude_unset=True)
 

docs/bundled/search.json

@@ -6958,6 +6958,7 @@
         "type": "object",
         "description": "Search result.\n\nA hit is a record from your index, augmented with special attributes for highlighting, snippeting, and ranking.\n",
         "x-is-generic": true,
+        "x-is-hit-object": true,
         "additionalProperties": true,
         "required": [
           "objectID"

docs/bundled/search.yml

@@ -21218,6 +21218,7 @@ components:
         A hit is a record from your index, augmented with special attributes for
         highlighting, snippeting, and ranking.
       x-is-generic: true
+      x-is-hit-object: true
       additionalProperties: true
       required:
         - objectID

specs/bundled/algoliasearch.yml

@@ -2755,6 +2755,7 @@ components:
         A hit is a record from your index, augmented with special attributes for
         highlighting, snippeting, and ranking.
       x-is-generic: true
+      x-is-hit-object: true
       additionalProperties: true
       required:
         - objectID

specs/bundled/search.yml

@@ -6448,6 +6448,7 @@ components:
         A hit is a record from your index, augmented with special attributes for
         highlighting, snippeting, and ranking.
       x-is-generic: true
+      x-is-hit-object: true
       additionalProperties: true
       required:
         - objectID