Merge branch 'main' into ODSC-64668/report_misformat

Author: ahosler

ads/aqua/common/decorator.py

@@ -69,6 +69,16 @@ def inner_function(
                 reason=error.message,
                 service_payload=error.args[0] if error.args else None,
                 exc_info=sys.exc_info(),
+                aqua_api_details=dict(
+                    # __qualname__ gives information of class and name of api
+                    aqua_api_name=func.__qualname__,
+                    oci_api_name=getattr(
+                        error, "operation_name", "Unknown OCI Operation"
+                    ),
+                    service_endpoint=getattr(
+                        error, "request_endpoint", "Unknown Request Endpoint"
+                    )
+                )
             )
         except (
             ClientError,

ads/aqua/evaluation/entities.py

@@ -9,11 +9,12 @@
 This module contains dataclasses for aqua evaluation.
 """
 
+from typing import Any, Dict, List, Optional
+
 from pydantic import Field
-from typing import Any, Dict, List, Optional, Union
 
-from ads.aqua.data import AquaResourceIdentifier
 from ads.aqua.config.utils.serializer import Serializable
+from ads.aqua.data import AquaResourceIdentifier
 
 
 class CreateAquaEvaluationDetails(Serializable):
@@ -87,6 +88,8 @@ class CreateAquaEvaluationDetails(Serializable):
 
     class Config:
         extra = "ignore"
+        protected_namespaces = ()
+
 
 class AquaEvalReport(Serializable):
     evaluation_id: str = ""
@@ -95,6 +98,7 @@ class AquaEvalReport(Serializable):
     class Config:
         extra = "ignore"
 
+
 class AquaEvalParams(Serializable):
     shape: str = ""
     dataset_path: str = ""
@@ -103,6 +107,7 @@ class AquaEvalParams(Serializable):
     class Config:
         extra = "allow"
 
+
 class AquaEvalMetric(Serializable):
     key: str
     name: str
@@ -111,6 +116,7 @@ class AquaEvalMetric(Serializable):
     class Config:
         extra = "ignore"
 
+
 class AquaEvalMetricSummary(Serializable):
     metric: str = ""
     score: str = ""
@@ -119,6 +125,7 @@ class AquaEvalMetricSummary(Serializable):
     class Config:
         extra = "ignore"
 
+
 class AquaEvalMetrics(Serializable):
     id: str
     report: str
@@ -128,6 +135,7 @@ class AquaEvalMetrics(Serializable):
     class Config:
         extra = "ignore"
 
+
 class AquaEvaluationCommands(Serializable):
     evaluation_id: str
     evaluation_target_id: str
@@ -139,6 +147,7 @@ class AquaEvaluationCommands(Serializable):
     class Config:
         extra = "ignore"
 
+
 class AquaEvaluationSummary(Serializable):
     """Represents a summary of Aqua evalution."""
 
@@ -157,6 +166,7 @@ class AquaEvaluationSummary(Serializable):
     class Config:
         extra = "ignore"
 
+
 class AquaEvaluationDetail(AquaEvaluationSummary):
     """Represents a details of Aqua evalution."""
 

ads/aqua/extension/aqua_ws_msg_handler.py

@@ -78,10 +78,12 @@ def write_error(self, status_code, **kwargs):
                 logger.warning(reply["message"])
         # telemetry may not be present if there is an error while initializing
         if hasattr(self, "telemetry"):
+            aqua_api_details = kwargs.get("aqua_api_details", {})
             self.telemetry.record_event_async(
                 category="aqua/error",
                 action=str(status_code),
                 value=reason,
+                **aqua_api_details
             )
         response = AquaWsError(
             status=status_code,

ads/aqua/extension/base_handler.py

@@ -98,10 +98,12 @@ def write_error(self, status_code, **kwargs):
 
         # telemetry may not be present if there is an error while initializing
         if hasattr(self, "telemetry"):
+            aqua_api_details = kwargs.get("aqua_api_details", {})
             self.telemetry.record_event_async(
                 category="aqua/error",
                 action=str(status_code),
                 value=reason,
+                **aqua_api_details
             )
 
         self.finish(json.dumps(reply))

docs/source/release_notes.rst

@@ -2,6 +2,14 @@
 Release Notes
 =============
 
+2.12.6
+-------
+Release date: November 12, 2024
+
+* Support using environment variable to override AI Quick Actions Fine Tuning container image.
+* Adding metadata in telemetry error logging for AI Quick Actions.
+
+
 2.12.5
 -------
 Release date: November 10, 2024

pyproject.toml

@@ -21,7 +21,7 @@ build-backend = "flit_core.buildapi"
 
 # Required
 name = "oracle_ads" # the install (PyPI) name; name for local build in [tool.flit.module] section below
-version = "2.12.5"
+version = "2.12.6"
 
 # Optional
 description = "Oracle Accelerated Data Science SDK"

tests/unitary/with_extras/aqua/test_handlers.py

@@ -129,6 +129,11 @@ def test_finish(self, name, payload, expected_call, mock_super_finish):
                         ),
                         None,
                     ),
+                    aqua_api_details=dict(
+                        aqua_api_name="TestDataset.create",
+                        oci_api_name=TestDataset.mock_service_payload_create["operation_name"],
+                        service_endpoint=TestDataset.mock_service_payload_create["request_endpoint"]
+                    )
                 ),
                 "Authorization Failed: The resource you're looking for isn't accessible. Operation Name: get_job_run.",
             ],
@@ -159,12 +164,14 @@ def test_write_error(self, name, input, expected_msg, mock_uuid, mock_logger):
             "request_id": "1234",
         }
         self.test_instance.finish.assert_called_once_with(json.dumps(expected_reply))
+        aqua_api_details = input.get("aqua_api_details", {})
         self.test_instance.telemetry.record_event_async.assert_called_with(
             category="aqua/error",
             action=str(
                 input.get("status_code"),
             ),
             value=input.get("reason"),
+            **aqua_api_details
         )
 
         mock_logger.warning.assert_called_with(expected_msg)