refactor: update to_json methods to use model_dump_json for JSON serialization

a-klos · a-klos · commit 245f4b395cbd · 2025-01-21T12:56:18.000+01:00
diff --git a/libs/admin-api-lib/src/admin_api_lib/extractor_api_client/openapi_client/models/confluence_parameters.py b/libs/admin-api-lib/src/admin_api_lib/extractor_api_client/openapi_client/models/confluence_parameters.py
@@ -65,8 +65,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
diff --git a/libs/admin-api-lib/src/admin_api_lib/extractor_api_client/openapi_client/models/extraction_request.py b/libs/admin-api-lib/src/admin_api_lib/extractor_api_client/openapi_client/models/extraction_request.py
@@ -41,8 +41,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
diff --git a/libs/admin-api-lib/src/admin_api_lib/extractor_api_client/openapi_client/models/information_piece.py b/libs/admin-api-lib/src/admin_api_lib/extractor_api_client/openapi_client/models/information_piece.py
@@ -52,8 +52,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
diff --git a/libs/admin-api-lib/src/admin_api_lib/extractor_api_client/openapi_client/models/key_value_pair.py b/libs/admin-api-lib/src/admin_api_lib/extractor_api_client/openapi_client/models/key_value_pair.py
@@ -42,8 +42,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
diff --git a/libs/admin-api-lib/src/admin_api_lib/models/document_status.py b/libs/admin-api-lib/src/admin_api_lib/models/document_status.py
@@ -48,8 +48,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:
diff --git a/libs/admin-api-lib/src/admin_api_lib/rag_backend_client/openapi_client/models/chat_history.py b/libs/admin-api-lib/src/admin_api_lib/rag_backend_client/openapi_client/models/chat_history.py
@@ -45,8 +45,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
diff --git a/libs/admin-api-lib/src/admin_api_lib/rag_backend_client/openapi_client/models/chat_history_message.py b/libs/admin-api-lib/src/admin_api_lib/rag_backend_client/openapi_client/models/chat_history_message.py
@@ -44,8 +44,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
diff --git a/libs/admin-api-lib/src/admin_api_lib/rag_backend_client/openapi_client/models/chat_request.py b/libs/admin-api-lib/src/admin_api_lib/rag_backend_client/openapi_client/models/chat_request.py
@@ -46,8 +46,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
diff --git a/libs/admin-api-lib/src/admin_api_lib/rag_backend_client/openapi_client/models/chat_response.py b/libs/admin-api-lib/src/admin_api_lib/rag_backend_client/openapi_client/models/chat_response.py
@@ -47,8 +47,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
diff --git a/libs/admin-api-lib/src/admin_api_lib/rag_backend_client/openapi_client/models/delete_request.py b/libs/admin-api-lib/src/admin_api_lib/rag_backend_client/openapi_client/models/delete_request.py
@@ -45,8 +45,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
diff --git a/libs/admin-api-lib/src/admin_api_lib/rag_backend_client/openapi_client/models/information_piece.py b/libs/admin-api-lib/src/admin_api_lib/rag_backend_client/openapi_client/models/information_piece.py
@@ -54,8 +54,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
diff --git a/libs/admin-api-lib/src/admin_api_lib/rag_backend_client/openapi_client/models/key_value_pair.py b/libs/admin-api-lib/src/admin_api_lib/rag_backend_client/openapi_client/models/key_value_pair.py
@@ -44,8 +44,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
diff --git a/libs/extractor-api-lib/src/extractor_api_lib/models/confluence_parameters.py b/libs/extractor-api-lib/src/extractor_api_lib/models/confluence_parameters.py
@@ -69,8 +69,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:
diff --git a/libs/extractor-api-lib/src/extractor_api_lib/models/extraction_request.py b/libs/extractor-api-lib/src/extractor_api_lib/models/extraction_request.py
@@ -45,8 +45,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:
diff --git a/libs/extractor-api-lib/src/extractor_api_lib/models/information_piece.py b/libs/extractor-api-lib/src/extractor_api_lib/models/information_piece.py
@@ -52,8 +52,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:
diff --git a/libs/extractor-api-lib/src/extractor_api_lib/models/key_value_pair.py b/libs/extractor-api-lib/src/extractor_api_lib/models/key_value_pair.py
@@ -46,8 +46,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:
diff --git a/libs/rag-core-api/src/rag_core_api/impl/reranking/flashrank_reranker.py b/libs/rag-core-api/src/rag_core_api/impl/reranking/flashrank_reranker.py
@@ -55,7 +55,7 @@ def _re_add_metadata(
         all_documents: list[Document],
         relevant_document: Document,
     ) -> Document:
-        # TODO: This is only needed because langchains wrapper around FlashRerank
+        # NOTE: This is only needed because langchains wrapper around FlashRerank
         # is destructive in terms of metadata. This could be fixed in their wrapper implementation.
         for doc in all_documents:
             if doc.page_content == relevant_document.page_content:
diff --git a/libs/rag-core-api/src/rag_core_api/models/chat_history.py b/libs/rag-core-api/src/rag_core_api/models/chat_history.py
@@ -47,8 +47,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:
diff --git a/libs/rag-core-api/src/rag_core_api/models/chat_history_message.py b/libs/rag-core-api/src/rag_core_api/models/chat_history_message.py
@@ -48,8 +48,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:
diff --git a/libs/rag-core-api/src/rag_core_api/models/chat_request.py b/libs/rag-core-api/src/rag_core_api/models/chat_request.py
@@ -48,8 +48,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:
diff --git a/libs/rag-core-api/src/rag_core_api/models/chat_response.py b/libs/rag-core-api/src/rag_core_api/models/chat_response.py
@@ -49,8 +49,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:
diff --git a/libs/rag-core-api/src/rag_core_api/models/delete_request.py b/libs/rag-core-api/src/rag_core_api/models/delete_request.py
@@ -47,8 +47,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:
diff --git a/libs/rag-core-api/src/rag_core_api/models/information_piece.py b/libs/rag-core-api/src/rag_core_api/models/information_piece.py
@@ -54,8 +54,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:
diff --git a/libs/rag-core-api/src/rag_core_api/models/key_value_pair.py b/libs/rag-core-api/src/rag_core_api/models/key_value_pair.py
@@ -48,8 +48,7 @@ def to_str(self) -> str:
 
     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())
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:
diff --git a/libs/rag-core-lib/src/rag_core_lib/llms/secured_llm.py b/libs/rag-core-lib/src/rag_core_lib/llms/secured_llm.py
