lexsi-sdk 0.1.16__py3-none-any.whl

lexsi_sdk/common/utils.py

@@ -0,0 +1,93 @@
+from datetime import datetime
+from typing import Callable, Optional
+from lexsi_sdk.client.client import APIClient
+from IPython.display import display, HTML
+
+from lexsi_sdk.common.xai_uris import POLL_EVENTS
+
+
+def parse_float(s):
+    """parse float from string, return None if not possible
+
+    :param s: string to parse
+    :return: float or None
+    """
+    try:
+        return float(s)
+    except ValueError:
+        return None
+
+
+def parse_datetime(s, format="%Y-%m-%d %H:%M:%S"):
+    """Parse datetime from string, return None if not possible
+
+    :param s: string to parse
+    :param format: format string for datetime parsing
+    :return: datetime or None
+    """
+    try:
+        return datetime.strptime(s, format)
+    except ValueError:
+        return None
+
+
+def pretty_date(date: str) -> str:
+    """return date in format dd-mm-YYYY HH:MM:SS
+
+    :param date: str datetime
+    :return: pretty datetime
+    """
+    try:
+        datetime_obj = datetime.strptime(date, "%Y-%m-%dT%H:%M:%S.%f")
+    except ValueError:
+        try:
+            datetime_obj = datetime.strptime(date, "%Y-%m-%d %H:%M:%S.%f")
+        except ValueError:
+            print("Date format invalid.")
+
+    return datetime_obj.strftime("%d-%m-%Y %H:%M:%S")
+
+
+def poll_events(
+    api_client: APIClient,
+    project_name: str,
+    event_id: str,
+    handle_failed_event: Optional[Callable] = None,
+    progress_message: str = "progress",
+):
+    """Poll long-running event stream and print incremental progress.
+
+    :param api_client: API client with streaming support.
+    :param project_name: Project name owning the event.
+    :param event_id: Identifier of the event to track.
+    :param handle_failed_event: Optional callback to invoke on failure.
+    :param progress_message: Label used when printing progress.
+    :return: None. Raises on failure events.
+    """
+    last_message = ""
+    log_length = 0
+    progress = 0
+
+    for event in api_client.stream(
+        uri=f"{POLL_EVENTS}?project_name={project_name}&event_id={event_id}",
+        method="GET"
+    ):
+        details = event.get("details")
+
+        if not event.get("success"):
+            raise Exception(details)
+        if details.get("event_logs"):
+            print(details.get("event_logs")[log_length:])
+            log_length = len(details.get("event_logs"))
+        if details.get("message") != last_message:
+            last_message = details.get("message")
+            print(f"{details.get('message')}")
+        if details.get("progress"):
+            if details.get("progress") != progress:
+                progress = details.get("progress")
+                print(f"{progress_message}: {progress}%")
+            # display(HTML(f"<progress style='width:100%' value='{progress}' max='100'></progress>"))
+        if details.get("status") == "failed":
+            if handle_failed_event:
+                handle_failed_event()
+            raise Exception(details.get("message"))

lexsi_sdk/common/validation.py

@@ -0,0 +1,110 @@
+from __future__ import annotations
+from typing import List, Optional, Callable
+
+
+class Validate:
+    """Lightweight validation helpers for SDK inputs."""
+
+    @staticmethod
+    def string(field_name: str, value: str):
+        """Ensure a non-empty string was provided for the given field.
+
+        :param field_name: Name of the field being validated.
+        :param value: Incoming string value to validate.
+        :raises Exception: If the string is empty or only whitespace.
+        """
+        if not (value and value.strip()):
+            raise Exception(f"{field_name} is not valid, cannot be empty")
+
+    @staticmethod
+    def list(field_name: str, value: List):
+        """Ensure a list value is provided and not empty.
+
+        :param field_name: Name of the field being validated.
+        :param value: Incoming list value to validate.
+        :raises Exception: If the list is missing or empty.
+        """
+        if not value:
+            raise Exception(f"{field_name} is required, cannot be empty list")
+
+    @staticmethod
+    def value_against_list(
+        field_name: str,
+        value: str | List,
+        valid_list: List,
+        handle_error: Optional[Callable] = None,
+    ):
+        """Validate whether a value (or list of values) exists in a whitelist.
+
+        :param field_name: Name of the field being validated.
+        :param value: String or list of values to check.
+        :param valid_list: Allowed set of values.
+        :param handle_error: Optional callback invoked before raising an error.
+        :raises Exception: If the provided value(s) are not in the allowed list.
+        """
+        try:
+            if isinstance(value, str):
+                if value not in valid_list:
+                    raise Exception(
+                        f"{value} is not valid {field_name}, select from \n{valid_list}"
+                    )
+            if isinstance(value, List):
+                Validate.list(field_name, value)
+                for val in value:
+                    if val not in valid_list:
+                        raise Exception(
+                            f"{val} is not a valid {field_name}, pick valid {field_name} from \n{valid_list}"
+                        )
+        except Exception as e:
+            if handle_error:
+                handle_error()
+            raise e
+
+    @staticmethod
+    def check_for_missing_keys(value: dict, required_keys: list):
+        """Validate that required keys are present in a dict.
+
+        :param value: Dictionary to inspect.
+        :param required_keys: Keys that must be present.
+        :raises Exception: If any required keys are missing.
+        """
+        missing_keys = [key for key in required_keys if key not in value]
+
+        if missing_keys:
+            raise Exception(f"Keys not present: {missing_keys}")
+
+    @staticmethod
+    def validate_date_feature_val(payload: dict, all_datetime_features: List[str]):
+        """Validate date feature payload shape and values.
+
+        :param payload: Incoming date feature payload.
+        :param all_datetime_features: Valid datetime feature names.
+        :raises Exception: If the payload is malformed or contains invalid values.
+        """
+        if payload.get("date_feature", None):
+            if payload["date_feature"] not in all_datetime_features:
+                raise Exception(
+                    f"{payload} is not a valid date_feature. Pick a valid payload from {all_datetime_features}."
+                )
+
+            if not payload["baseline_date"]:
+                raise Exception(
+                    "baseline_date is required when date_feature is passed."
+                )
+            if not payload["current_date"]:
+                raise Exception("current_date is required when date_feature is passed.")
+
+            if (
+                payload["baseline_date"]["start_date"]
+                > payload["baseline_date"]["end_date"]
+            ):
+                raise Exception(
+                    "start_date of baseline_date should be less than end_date."
+                )
+            if (
+                payload["current_date"]["start_date"]
+                > payload["current_date"]["end_date"]
+            ):
+                raise Exception(
+                    "start_date of current_date should be less than end_date."
+                )

lexsi_sdk/common/xai_uris.py

@@ -0,0 +1,197 @@
+import os
+
+# API version
+API_VERSION = os.getenv("XAI_API_VERSION", "v1")
+API_VERSION_V2 = "v2"
+
+# APP
+XAI_APP_URI = "https://console.lexsi.ai"
+
+# URIs of XAI base service starts here
+# Auth
+LOGIN_URI = f"{API_VERSION_V2}/access-token/authorize"
+
+# User
+GET_WORKSPACES_URI = f"{API_VERSION_V2}/users/workspaces"
+GET_WORKSPACES_DETAILS_URI = f"{API_VERSION_V2}/project/details/workspace"
+CREATE_WORKSPACE_URI = f"{API_VERSION_V2}/users/create_workspace"
+
+# Custom Server
+AVAILABLE_CUSTOM_SERVERS_URI = f"{API_VERSION_V2}/project/server_types"
+START_CUSTOM_SERVER_URI = f"{API_VERSION_V2}/project/start_server"
+STOP_CUSTOM_SERVER_URI = f"{API_VERSION_V2}/project/stop_server"
+
+# Batch Server
+AVAILABLE_BATCH_SERVERS_URI = f"{API_VERSION_V2}/users/automl_custom_servers"
+
+# Notifications
+GET_NOTIFICATIONS_URI = f"{API_VERSION_V2}/notifications/fetch"
+CLEAR_NOTIFICATIONS_URI = f"{API_VERSION_V2}/notifications/clear"
+
+# Workspace
+UPDATE_WORKSPACE_URI = f"{API_VERSION_V2}/users/workspace_config_update"
+CREATE_PROJECT_URI = f"{API_VERSION_V2}/users/create_project"
+
+# Project
+UPDATE_PROJECT_URI = f"{API_VERSION_V2}/users/project_config_update"
+UPLOAD_DATA_FILE_URI = f"{API_VERSION_V2}/project/uploadfile_with_info"
+UPLOAD_DATA_FILE_INFO_URI = f"{API_VERSION_V2}/project/get_Uploaded_file_info"
+DELETE_DATA_FILE_URI = f"{API_VERSION_V2}/project/delete_data"
+ALL_DATA_FILE_URI = f"{API_VERSION_V2}/project/get_all_uploaded_files"
+UPLOAD_DATA_URI = f"{API_VERSION_V2}/project/upload_data"
+UPLOAD_DATA_WITH_CHECK_URI = f"{API_VERSION_V2}/project/upload_data_with_check"
+UPLOAD_MODEL_URI = f"{API_VERSION_V2}/project/upload_model"
+GET_MODEL_TYPES_URI = f"{API_VERSION_V2}/project/get_model_types"
+GET_DATA_SUMMARY_URI = f"{API_VERSION_V2}/project/data_summary"
+GET_DATA_DIAGNOSIS_URI = f"{API_VERSION_V2}/project/get_data_diagnosis"
+RUN_DATA_DRIFT_DIAGNOSIS_URI = f"{API_VERSION_V2}/project/run_data_drift_diagnosis"
+GET_DATA_DRIFT_DIAGNOSIS_URI = f"{API_VERSION_V2}/project/get_data_drift_diagnosis"
+GET_PROJECT_CONFIG = f"{API_VERSION_V2}/users/get_xai_config"
+AVAILABLE_TAGS_URI = f"{API_VERSION_V2}/project/get_all_available_tags_info"
+TAG_DATA_URI = f"{API_VERSION_V2}/project/tag_data"
+GET_FEATURE_IMPORTANCE_URI = f"{API_VERSION_V2}/project/get_feature_importance"
+
+# Monitoring
+GENERATE_DASHBOARD_URI = f"{API_VERSION_V2}/dashboards/generate_dashboard"
+DASHBOARD_CONFIG_URI = f"{API_VERSION_V2}/dashboards/config"
+MODEL_PERFORMANCE_DASHBOARD_URI = (
+    f"{API_VERSION_V2}/dashboards/model_performance_dashboard"
+)
+DASHBOARD_LOGS_URI = f"{API_VERSION_V2}/dashboards/get_dashboard_logs"
+GET_DASHBOARD_URI = f"{API_VERSION_V2}/dashboards/get_dashboard"
+DOWNLOAD_DASHBOARD_LOGS_URI = f"{API_VERSION_V2}/dashboards/download_dashboard_logs"
+GET_DASHBOARD_SCORE_URI = f"{API_VERSION_V2}/dashboards/get_dashboard_score"
+
+# Auto ML
+MODEL_PARAMETERS_URI = f"{API_VERSION_V2}/users/get_xai_model_parameters"
+TRAIN_MODEL_URI = f"{API_VERSION_V2}/users/xai_config_update"
+GET_MODELS_URI = f"{API_VERSION_V2}/ai-models/get_all_models"
+UPDATE_ACTIVE_MODEL_URI = f"{API_VERSION_V2}/ai-models/update_active_model"
+UPDATE_ACTIVE_INFERENCE_MODEL_URI = (
+    f"{API_VERSION_V2}/ai-models/update_active_inference"
+)
+REMOVE_MODEL_URI = f"{API_VERSION_V2}/ai-models/remove_model"
+RUN_MODEL_ON_DATA_URI = f"{API_VERSION_V2}/ai-models/run_model_on_data"
+DOWNLOAD_TAG_DATA_URI = f"{API_VERSION_V2}/ai-models/download_tag_data"
+MODEL_SUMMARY_URI = f"{API_VERSION_V2}/project/get_model_perfermance"
+PROJECT_OVERVIEW_TEXT_URI = f"{API_VERSION_V2}/ai-models/project_overview"
+MODEL_SVG_URI = f"{API_VERSION_V2}/project/get_model_svg_plot"
+MODEL_INFERENCES_URI = f"{API_VERSION_V2}/ai-models/get_all_tags_for_models"
+UPLOAD_DATA_PROJECT_URI = f"{API_VERSION_V2}/project/case-register"
+GET_CASE_PROFILE_URI = f"{API_VERSION_V2}/project/get-case-profile"
+
+# Explainability
+GET_CASES_URI = f"{API_VERSION_V2}/ai-models/get_cases"
+SEARCH_CASE_URI = f"{API_VERSION_V2}/ai-models/search_case"
+CASE_INFO_URI = f"{API_VERSION_V2}/ai-models/get_case_info_components"
+CASE_INFO_TEXT_URI = f"{API_VERSION_V2}/ai-models/get_case_info_text"
+CASE_DTREE_URI = f"{API_VERSION_V2}/ai-models/get_case_dtree"
+DELETE_CASE_URI = f"{API_VERSION_V2}/project/delete_data_with_filter"
+CASE_LOGS_URI = f"{API_VERSION_V2}/ai-models/explainability_logs"
+CASE_LOGS_TEXT_URI = f"{API_VERSION_V2}/ai-models/explainability_logs_text"
+GET_VIEWED_CASE_URI = f"{API_VERSION_V2}/ai-models/get_viewed_case"
+GENERATE_TEXT_CASE_URI = f"{API_VERSION_V2}/ai-models/run_model_on_data_text"
+GENERATE_TEXT_CASE_STREAM_URI = f"{API_VERSION_V2}/ai-models/run_model_on_data_text_stream"
+
+# Observations
+GET_OBSERVATIONS_URI = f"{API_VERSION_V2}/observations/get_observations"
+GET_OBSERVATION_PARAMS_URI = f"{API_VERSION_V2}/observations/get_observation_params"
+CREATE_OBSERVATION_URI = f"{API_VERSION_V2}/observations/create_observation"
+UPDATE_OBSERVATION_URI = f"{API_VERSION_V2}/observations/observation_config_update"
+DUPLICATE_OBSERVATION_URI = f"{API_VERSION_V2}/observations/duplicate_observation"
+
+# Policies
+GET_POLICIES_URI = f"{API_VERSION_V2}/policies/get_policies"
+GET_POLICY_PARAMS_URI = f"{API_VERSION_V2}/policies/get_policy_params"
+CREATE_POLICY_URI = f"{API_VERSION_V2}/policies/create_policy"
+UPDATE_POLICY_URI = f"{API_VERSION_V2}/policies/policy_config_update"
+VALIDATE_POLICY_URI = f"{API_VERSION_V2}/policies/validate_policy"
+DUPLICATE_POLICY_URI = f"{API_VERSION_V2}/policies/duplicate_policy"
+
+# Alerts
+GET_TRIGGERS_URI = f"{API_VERSION_V2}/triggers/get_triggers"
+CREATE_TRIGGER_URI = f"{API_VERSION_V2}/triggers/update_triggers"
+DELETE_TRIGGER_URI = f"{API_VERSION_V2}/triggers/update_triggers"
+DUPLICATE_MONITORS_URI = f"{API_VERSION_V2}/triggers/duplicate_monitors"
+EXECUTED_TRIGGER_URI = f"{API_VERSION_V2}/triggers/get_executed_triggers"
+GET_EXECUTED_TRIGGER_INFO = f"{API_VERSION_V2}/triggers/get_trigger_details"
+GET_LABELS_URI = f"{API_VERSION_V2}/triggers/get_label_classes"
+GET_TRIGGERS_DAYS_URI = f"{API_VERSION_V2}/triggers/get_alerts"
+GET_MONITORS_ALERTS = f"{API_VERSION_V2}/triggers/get_monitors_alerts"
+
+# Synthetic AI
+AVAILABLE_SYNTHETIC_CUSTOM_SERVERS_URI = f"{API_VERSION_V2}/synthetics/custom_servers"
+GET_SYNTHETIC_MODEL_PARAMS_URI = (
+    f"{API_VERSION_V2}/synthetics/get_synthetic_model_parameters"
+)
+TRAIN_SYNTHETIC_MODEL_URI = f"{API_VERSION_V2}/synthetics/train_synthetic_model"
+GET_SYNTHETIC_MODELS_URI = f"{API_VERSION_V2}/synthetics/get_synthetics_models"
+DELETE_SYNTHETIC_MODEL_URI = f"{API_VERSION_V2}/synthetics/delete_synthetic_model"
+GET_SYNTHETIC_MODEL_DETAILS_URI = (
+    f"{API_VERSION_V2}/synthetics/get_synthetic_model_details"
+)
+GENERATE_SYNTHETIC_DATA_URI = f"{API_VERSION_V2}/synthetics/generate_synthetic_data"
+GENERATE_ANONYMITY_SCORE_URI = f"{API_VERSION_V2}/synthetics/generate_anonimity_score"
+GET_ANONYMITY_SCORE_URI = f"{API_VERSION_V2}/synthetics/get_anonimity_score"
+
+GET_SYNTHETIC_DATA_TAGS_URI = f"{API_VERSION_V2}/synthetics/get_synthetic_data_tags"
+DOWNLOAD_SYNTHETIC_DATA_URI = f"{API_VERSION_V2}/synthetics/download_synthetic_data"
+DELETE_SYNTHETIC_TAG_URI = f"{API_VERSION_V2}/project/delete_data_with_filter"
+
+CREATE_SYNTHETIC_PROMPT_URI = f"{API_VERSION_V2}/synthetics/create_synthetic_prompts"
+UPDATE_SYNTHETIC_PROMPT_URI = f"{API_VERSION_V2}/synthetics/synthetic_prompts_update"
+GET_SYNTHETIC_PROMPT_URI = f"{API_VERSION_V2}/synthetics/get_synthetics_promts"
+
+# Events
+POLL_EVENTS = f"{API_VERSION_V2}/events/poll"
+FETCH_EVENTS = f"{API_VERSION_V2}/events/fetch"
+
+# Organization
+USER_ORGANIZATION_URI = f"{API_VERSION_V2}/organization/user_organization"
+CREATE_ORGANIZATION_URI = f"{API_VERSION_V2}/organization/create_organization"
+INVITE_USER_ORGANIZATION_URI = f"{API_VERSION_V2}/organization/invite_user"
+REMOVE_USER_ORGANIZATION_URI = f"{API_VERSION_V2}/organization/organization_user_delete"
+ORGANIZATION_MEMBERS_URI = f"{API_VERSION_V2}/organization/organization_users"
+UPDATE_ORGANIZATION_URI = f"{API_VERSION_V2}/organization/organization_user_update"
+
+# Data Connectors
+CREATE_DATA_CONNECTORS = f"{API_VERSION_V2}/linkservices/create"
+TEST_DATA_CONNECTORS = f"{API_VERSION_V2}/linkservices/test_connection"
+LIST_BUCKETS = f"{API_VERSION_V2}/linkservices/list_buckets"
+LIST_FILEPATHS = f"{API_VERSION_V2}/linkservices/list_filepath"
+LIST_DATA_CONNECTORS = f"{API_VERSION_V2}/linkservices/list"
+DELETE_DATA_CONNECTORS = f"{API_VERSION_V2}/linkservices/delete"
+UPLOAD_FILE_DATA_CONNECTORS = f"{API_VERSION_V2}/project/uploadfile_with_linkservices"
+DROPBOX_OAUTH = f"{API_VERSION_V2}/linkservices/dropbox_auth"
+
+# Credits
+COMPUTE_CREDIT_URI = f"{API_VERSION_V2}/plans/compute_credit"
+
+# evals
+TABULAR_ML = f"{API_VERSION_V2}/evals/evals-tabular"
+TABULAR_DL = f"{API_VERSION_V2}/evals/evals-tabular"
+IMAGE_DL = f"{API_VERSION_V2}/evals/"
+
+
+# Agents 
+EXPLAINABILITY_SUMMARY = f"{API_VERSION_V2}/agents/explainability_summary"
+
+#Text
+MESSAGES_URI =  f"sessions/get_session_messages"
+SESSIONS_URI = f"sessions/get_sessions"
+TRACES_URI = f"traces/get_traces"
+GET_GUARDRAILS_URI = f"guardrails/active_guardrails"
+UPDATE_GUARDRAILS_STATUS_URI = f"guardrails/update_guardrail_status"
+DELETE_GUARDRAILS_URI = f"guardrails/delete_guardrail"
+AVAILABLE_GUARDRAILS_URI = f"guardrails/all"
+CONFIGURE_GUARDRAILS_URI = f"guardrails/configure"
+RUN_GUARDRAILS_URI=f"guardrails/run_guardrail"
+GET_AVAILABLE_TEXT_MODELS_URI = f"{API_VERSION_V2}/users/get_available_text_models"
+QUANTIZE_MODELS_URI = f"{API_VERSION_V2}/ai-models/run_quantization_on_model"
+INITIALIZE_TEXT_MODEL_URI = f"{API_VERSION_V2}/users/initalize_text_model"
+TEXT_MODEL_INFERENCE_SETTINGS_URI = f"{API_VERSION_V2}/ai-models/update_inference_settings"
+RUN_GUARDRAILS_PARALLEL_URI=f"guardrails/run_guardrail_parallel"
+RUN_CHAT_COMPLETION = f"gateway/v1/chat/completions" 
+RUN_IMAGE_GENERATION = f"gateway/v1/images/generations"
+RUN_CREATE_EMBEDDING = f"gateway/v1/embeddings"
+RUN_COMPLETION = f"gateway/v1/completions"

lexsi_sdk/core/agent.py

@@ -0,0 +1,62 @@
+from lexsi_sdk.common.xai_uris import (
+    AVAILABLE_GUARDRAILS_URI,
+    CONFIGURE_GUARDRAILS_URI,
+    DELETE_GUARDRAILS_URI,
+    GET_AVAILABLE_TEXT_MODELS_URI,
+    GET_GUARDRAILS_URI,
+    INITIALIZE_TEXT_MODEL_URI,
+    MESSAGES_URI,
+    SESSIONS_URI,
+    TRACES_URI,
+    UPDATE_GUARDRAILS_STATUS_URI,
+)
+from lexsi_sdk.core.project import Project
+import pandas as pd
+
+from lexsi_sdk.core.wrapper import  monitor
+
+
+class AgentProject(Project):
+    """Project for Agent modality
+
+    :return: AgentProject
+    """
+
+    def sessions(self) -> pd.DataFrame:
+        """All sessions
+
+        :return: response
+        """
+        res = self.api_client.get(f"{SESSIONS_URI}?project_name={self.project_name}")
+        if not res["success"]:
+            raise Exception(res.get("details"))
+
+        return pd.DataFrame(res.get("details"))
+
+    def messages(self, session_id: str) -> pd.DataFrame:
+        """All messages for a session
+
+        :param session_id: id of the session
+        :return: response
+        """
+        res = self.api_client.get(
+            f"{MESSAGES_URI}?project_name={self.project_name}&session_id={session_id}"
+        )
+        if not res["success"]:
+            raise Exception(res.get("details"))
+
+        return pd.DataFrame(res.get("details"))
+
+    def traces(self, trace_id: str) -> pd.DataFrame:
+        """Traces generated for trace_id
+
+        :param trace_id: id of the trace
+        :return: response
+        """
+        res = self.api_client.get(
+            f"{TRACES_URI}?project_name={self.project_name}&trace_id={trace_id}"
+        )
+        if not res["success"]:
+            raise Exception(res.get("details"))
+
+        return pd.DataFrame(res.get("details"))

lexsi_sdk/core/alert.py

@@ -0,0 +1,56 @@
+from typing import List, Optional
+from pydantic import BaseModel
+import pandas as pd
+
+
+class Alert(BaseModel):
+    """Represents a monitoring alert and helper views."""
+    info: dict
+    detailed_report: Optional[List[dict] | dict] = None
+    not_used_features: Optional[List[dict]] = None
+
+    def __init__(self, **kwargs):
+        """Initialize base model without extra behavior."""
+        super().__init__(**kwargs)
+
+    def view_info(self) -> pd.DataFrame:
+        """view the alert info
+
+        :return: _description_
+        """
+        if not self.info:
+            return "There was an error while executing the alert."
+
+        return pd.DataFrame([self.info])
+
+    def view_detailed_report(self) -> pd.DataFrame:
+        """view the detailed report of alert
+
+        :return: _description_
+        """
+        if not self.detailed_report:
+            return "No detailed report found for the alert."
+
+        if isinstance(self.detailed_report, list):
+            detailed_report = [
+                {
+                    key: value
+                    for key, value in feature.items()
+                    if key != "current_small_hist" and key != "ref_small_hist"
+                }
+                for feature in self.detailed_report
+            ]
+        if isinstance(self.detailed_report, dict):
+            detailed_report = [self.detailed_report]
+
+        return pd.DataFrame(detailed_report)
+
+    def view_not_used_features(self) -> pd.DataFrame:
+        """view the not used features of alert
+
+        :return: _description_
+        """
+        if not self.not_used_features:
+            return "Not used features is empty."
+
+        return pd.DataFrame(self.not_used_features)