oracle-ads 2.12.10rc0__py3-none-any.whl → 2.13.0__py3-none-any.whl

ads/aqua/modeldeployment/deployment.py

@@ -1,8 +1,7 @@
 #!/usr/bin/env python
-# Copyright (c) 2024 Oracle and/or its affiliates.
+# Copyright (c) 2024, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
-import logging
 import shlex
 from typing import Dict, List, Optional, Union
 
@@ -271,7 +270,7 @@ class AquaDeploymentApp(AquaApp):
                     f"field. Either re-register the model with custom container URI, or set container_image_uri "
                     f"parameter when creating this deployment."
                 ) from err
-        logging.info(
+        logger.info(
             f"Aqua Image used for deploying {aqua_model.id} : {container_image_uri}"
         )
 
@@ -282,14 +281,14 @@ class AquaDeploymentApp(AquaApp):
             default_cmd_var = shlex.split(cmd_var_string)
             if default_cmd_var:
                 cmd_var = validate_cmd_var(default_cmd_var, cmd_var)
-            logging.info(f"CMD used for deploying {aqua_model.id} :{cmd_var}")
+            logger.info(f"CMD used for deploying {aqua_model.id} :{cmd_var}")
         except ValueError:
-            logging.debug(
+            logger.debug(
                 f"CMD will be ignored for this deployment as {AQUA_DEPLOYMENT_CONTAINER_CMD_VAR_METADATA_NAME} "
                 f"key is not available in the custom metadata field for this model."
             )
         except Exception as e:
-            logging.error(
+            logger.error(
                 f"There was an issue processing CMD arguments. Error: {str(e)}"
             )
 
@@ -385,7 +384,7 @@ class AquaDeploymentApp(AquaApp):
                     if key not in env_var:
                         env_var.update(env)
 
-        logging.info(f"Env vars used for deploying {aqua_model.id} :{env_var}")
+        logger.info(f"Env vars used for deploying {aqua_model.id} :{env_var}")
 
         # Start model deployment
         # configure model deployment infrastructure
@@ -440,10 +439,14 @@ class AquaDeploymentApp(AquaApp):
             .with_runtime(container_runtime)
         ).deploy(wait_for_completion=False)
 
+        deployment_id = deployment.dsc_model_deployment.id
+        logger.info(
+            f"Aqua model deployment {deployment_id} created for model {aqua_model.id}."
+        )
         model_type = (
             AQUA_MODEL_TYPE_CUSTOM if is_fine_tuned_model else AQUA_MODEL_TYPE_SERVICE
         )
-        deployment_id = deployment.dsc_model_deployment.id
+
         # we arbitrarily choose last 8 characters of OCID to identify MD in telemetry
         telemetry_kwargs = {"ocid": get_ocid_substring(deployment_id, key_len=8)}
 
@@ -539,6 +542,9 @@ class AquaDeploymentApp(AquaApp):
                         value=state,
                     )
 
+        logger.info(
+            f"Fetched {len(results)} model deployments from compartment_id={compartment_id}."
+        )
         # tracks number of times deployment listing was called
         self.telemetry.record_event_async(category="aqua/deployment", action="list")
 
@@ -546,18 +552,21 @@ class AquaDeploymentApp(AquaApp):
 
     @telemetry(entry_point="plugin=deployment&action=delete", name="aqua")
     def delete(self, model_deployment_id: str):
+        logger.info(f"Deleting model deployment {model_deployment_id}.")
         return self.ds_client.delete_model_deployment(
             model_deployment_id=model_deployment_id
         ).data
 
     @telemetry(entry_point="plugin=deployment&action=deactivate", name="aqua")
     def deactivate(self, model_deployment_id: str):
+        logger.info(f"Deactivating model deployment {model_deployment_id}.")
         return self.ds_client.deactivate_model_deployment(
             model_deployment_id=model_deployment_id
         ).data
 
     @telemetry(entry_point="plugin=deployment&action=activate", name="aqua")
     def activate(self, model_deployment_id: str):
+        logger.info(f"Activating model deployment {model_deployment_id}.")
         return self.ds_client.activate_model_deployment(
             model_deployment_id=model_deployment_id
         ).data
@@ -579,6 +588,8 @@ class AquaDeploymentApp(AquaApp):
         AquaDeploymentDetail:
             The instance of the Aqua model deployment details.
         """
+        logger.info(f"Fetching model deployment details for {model_deployment_id}.")
+
         model_deployment = self.ds_client.get_model_deployment(
             model_deployment_id=model_deployment_id, **kwargs
         ).data
@@ -594,7 +605,8 @@ class AquaDeploymentApp(AquaApp):
 
         if not oci_aqua:
             raise AquaRuntimeError(
-                f"Target deployment {model_deployment_id} is not Aqua deployment."
+                f"Target deployment {model_deployment_id} is not Aqua deployment as it does not contain "
+                f"{Tags.AQUA_TAG} tag."
             )
 
         log_id = ""
@@ -652,7 +664,7 @@ class AquaDeploymentApp(AquaApp):
         config = self.get_config(model_id, AQUA_MODEL_DEPLOYMENT_CONFIG)
         if not config:
             logger.debug(
-                f"Deployment config for custom model: {model_id} is not available."
+                f"Deployment config for custom model: {model_id} is not available. Use defaults."
             )
         return config
 

ads/aqua/modeldeployment/entities.py

@@ -41,6 +41,7 @@ class AquaDeployment(DataClassSerializable):
     id: str = None
     display_name: str = None
     aqua_service_model: bool = None
+    model_id: str = None
     aqua_model_name: str = None
     state: str = None
     description: str = None
@@ -97,7 +98,7 @@ class AquaDeployment(DataClassSerializable):
                 else None
             ),
         )
-
+        model_id = oci_model_deployment._model_deployment_configuration_details.model_configuration_details.model_id
         tags = {}
         tags.update(oci_model_deployment.freeform_tags or UNKNOWN_DICT)
         tags.update(oci_model_deployment.defined_tags or UNKNOWN_DICT)
@@ -110,6 +111,7 @@ class AquaDeployment(DataClassSerializable):
 
         return AquaDeployment(
             id=oci_model_deployment.id,
+            model_id=model_id,
             display_name=oci_model_deployment.display_name,
             aqua_service_model=aqua_service_model_tag is not None,
             aqua_model_name=aqua_model_name,

ads/cli.py

@@ -1,14 +1,15 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*--
-
-# Copyright (c) 2021, 2024 Oracle and/or its affiliates.
+# Copyright (c) 2021, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
+import json
+import logging
 import sys
 import traceback
-from dataclasses import is_dataclass
+import uuid
 
 import fire
+from pydantic import BaseModel
 
 from ads.common import logger
 
@@ -27,7 +28,7 @@ except Exception as ex:
     )
     logger.debug(ex)
     logger.debug(traceback.format_exc())
-    exit()
+    sys.exit()
 
 # https://packaging.python.org/en/latest/guides/single-sourcing-package-version/#single-sourcing-the-package-version
 if sys.version_info >= (3, 8):
@@ -84,7 +85,13 @@ def serialize(data):
         The string representation of each dataclass object.
     """
     if isinstance(data, list):
-        [print(str(item)) for item in data]
+        for item in data:
+            if isinstance(item, BaseModel):
+                print(json.dumps(item.dict(), indent=4))
+            else:
+                print(str(item))
+    elif isinstance(data, BaseModel):
+        print(json.dumps(data.dict(), indent=4))
     else:
         print(str(data))
 
@@ -122,8 +129,9 @@ def exit_program(ex: Exception, logger: "logging.Logger") -> None:
     ...     exit_program(e, logger)
     """
 
-    logger.debug(traceback.format_exc())
-    logger.error(str(ex))
+    request_id = str(uuid.uuid4())
+    logger.debug(f"Error Request ID: {request_id}\nError: {traceback.format_exc()}")
+    logger.error(f"Error Request ID: {request_id}\n" f"Error: {str(ex)}")
 
     exit_code = getattr(ex, "exit_code", 1)
     logger.error(f"Exit code: {exit_code}")

ads/common/auth.py

@@ -1,23 +1,25 @@
 #!/usr/bin/env python
-# -*- coding: utf-8; -*-
 
-# Copyright (c) 2021, 2023 Oracle and/or its affiliates.
+# Copyright (c) 2021, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
 import copy
-from datetime import datetime
 import os
-from dataclasses import dataclass
 import time
+from dataclasses import dataclass
+from datetime import datetime
 from typing import Any, Callable, Dict, Optional, Union
 
-import ads.telemetry
 import oci
+from oci.config import (
+    DEFAULT_LOCATION,  # "~/.oci/config"
+    DEFAULT_PROFILE,  # "DEFAULT"
+)
+
+import ads.telemetry
 from ads.common import logger
 from ads.common.decorator.deprecate import deprecated
-from ads.common.extended_enum import ExtendedEnumMeta
-from oci.config import DEFAULT_LOCATION  # "~/.oci/config"
-from oci.config import DEFAULT_PROFILE  # "DEFAULT"
+from ads.common.extended_enum import ExtendedEnum
 
 SECURITY_TOKEN_LEFT_TIME = 600
 
@@ -26,7 +28,7 @@ class SecurityTokenError(Exception):  # pragma: no cover
     pass
 
 
-class AuthType(str, metaclass=ExtendedEnumMeta):
+class AuthType(ExtendedEnum):
     API_KEY = "api_key"
     RESOURCE_PRINCIPAL = "resource_principal"
     INSTANCE_PRINCIPAL = "instance_principal"
@@ -73,7 +75,11 @@ class AuthState(metaclass=SingletonMeta):
         self.oci_key_profile = self.oci_key_profile or os.environ.get(
             "OCI_CONFIG_PROFILE", DEFAULT_PROFILE
         )
-        self.oci_config = self.oci_config or {"region": os.environ["OCI_RESOURCE_REGION"]} if os.environ.get("OCI_RESOURCE_REGION") else {}
+        self.oci_config = (
+            self.oci_config or {"region": os.environ["OCI_RESOURCE_REGION"]}
+            if os.environ.get("OCI_RESOURCE_REGION")
+            else {}
+        )
         self.oci_signer_kwargs = self.oci_signer_kwargs or {}
         self.oci_client_kwargs = self.oci_client_kwargs or {}
 
@@ -82,7 +88,9 @@ def set_auth(
     auth: Optional[str] = AuthType.API_KEY,
     oci_config_location: Optional[str] = DEFAULT_LOCATION,
     profile: Optional[str] = DEFAULT_PROFILE,
-    config: Optional[Dict] = {"region": os.environ["OCI_RESOURCE_REGION"]} if os.environ.get("OCI_RESOURCE_REGION") else {},
+    config: Optional[Dict] = {"region": os.environ["OCI_RESOURCE_REGION"]}
+    if os.environ.get("OCI_RESOURCE_REGION")
+    else {},
     signer: Optional[Any] = None,
     signer_callable: Optional[Callable] = None,
     signer_kwargs: Optional[Dict] = {},
@@ -202,8 +210,8 @@ def set_auth(
         oci_config_location != DEFAULT_LOCATION or profile != DEFAULT_PROFILE
     ):
         raise ValueError(
-            f"'config' and 'oci_config_location', 'profile' pair are mutually exclusive."
-            f"Please specify 'config' OR 'oci_config_location', 'profile' pair."
+            "'config' and 'oci_config_location', 'profile' pair are mutually exclusive."
+            "Please specify 'config' OR 'oci_config_location', 'profile' pair."
         )
 
     auth_state.oci_config = config
@@ -621,7 +629,7 @@ class APIKey(AuthSignerGenerator):
             )
 
         oci.config.validate_config(configuration)
-        logger.debug(f"Using 'api_key' authentication.")
+        logger.debug("Using 'api_key' authentication.")
         return {
             "config": configuration,
             "signer": oci.signer.Signer(
@@ -684,14 +692,19 @@ class ResourcePrincipal(AuthSignerGenerator):
             "signer": oci.auth.signers.get_resource_principals_signer(),
             "client_kwargs": self.client_kwargs,
         }
-        logger.debug(f"Using 'resource_principal' authentication.")
+        logger.debug("Using 'resource_principal' authentication.")
         return signer_dict
 
     @staticmethod
     def supported():
         return any(
             os.environ.get(var)
-            for var in ['JOB_RUN_OCID', 'NB_SESSION_OCID', 'DATAFLOW_RUN_ID', 'PIPELINE_RUN_OCID']
+            for var in [
+                "JOB_RUN_OCID",
+                "NB_SESSION_OCID",
+                "DATAFLOW_RUN_ID",
+                "PIPELINE_RUN_OCID",
+            ]
         )
 
 
@@ -747,7 +760,7 @@ class InstancePrincipal(AuthSignerGenerator):
             ),
             "client_kwargs": self.client_kwargs,
         }
-        logger.debug(f"Using 'instance_principal' authentication.")
+        logger.debug("Using 'instance_principal' authentication.")
         return signer_dict
 
 
@@ -814,7 +827,7 @@ class SecurityToken(AuthSignerGenerator):
                 oci.config.from_file(self.oci_config_location, self.oci_key_profile)
             )
 
-        logger.debug(f"Using 'security_token' authentication.")
+        logger.debug("Using 'security_token' authentication.")
 
         for parameter in self.SECURITY_TOKEN_REQUIRED:
             if parameter not in configuration:
@@ -903,7 +916,7 @@ class SecurityToken(AuthSignerGenerator):
             raise ValueError("Invalid `security_token_file`. Specify a valid path.")
         try:
             token = None
-            with open(expanded_path, "r") as f:
+            with open(expanded_path) as f:
                 token = f.read()
             return token
         except:
@@ -1023,7 +1036,7 @@ class OCIAuthContext:
             logger.debug(f"OCI profile set to {self.profile}")
         else:
             ads.set_auth(auth=AuthType.RESOURCE_PRINCIPAL)
-            logger.debug(f"OCI auth set to resource principal")
+            logger.debug("OCI auth set to resource principal")
         return self
 
     def __exit__(self, exc_type, exc_val, exc_tb):

ads/common/extended_enum.py

@@ -1,73 +1,81 @@
 #!/usr/bin/env python
-# -*- coding: utf-8; -*-
 
-# Copyright (c) 2022, 2024 Oracle and/or its affiliates.
+# Copyright (c) 2022, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
 
 from abc import ABCMeta
-from enum import Enum
 
 
 class ExtendedEnumMeta(ABCMeta):
-    """The helper metaclass to extend functionality of a generic Enum.
+    """
+    A helper metaclass to extend functionality of a generic "Enum-like" class.
 
     Methods
     -------
-    values(cls) -> list:
-        Gets the list of class attributes.
-
-    Examples
-    --------
-    >>> class TestEnum(str, metaclass=ExtendedEnumMeta):
-    ...    KEY1 = "value1"
-    ...    KEY2 = "value2"
-    >>> print(TestEnum.KEY1) # "value1"
+    __contains__(cls, item) -> bool:
+        Checks if `item` is among the attribute values of the class.
+        Case-insensitive if `item` is a string.
+    values(cls) -> tuple:
+        Returns the tuple of class attribute values.
+    keys(cls) -> tuple:
+        Returns the tuple of class attribute names.
     """
 
-    def __contains__(cls, value):
-        return value and value.lower() in tuple(value.lower() for value in cls.values())
-
-    def values(cls) -> list:
-        """Gets the list of class attributes values.
+    def __contains__(cls, item: object) -> bool:
+        """
+        Checks if `item` is a member of the class's values.
 
-        Returns
-        -------
-        list
-            The list of class values.
+        - If `item` is a string, does a case-insensitive match against any string
+          values stored in the class.
+        - Otherwise, does a direct membership test.
+        """
+        # Gather the attribute values
+        attr_values = cls.values()
+
+        # If item is a string, compare case-insensitively to any str-type values
+        if isinstance(item, str):
+            return any(
+                isinstance(val, str) and val.lower() == item.lower()
+                for val in attr_values
+            )
+        else:
+            # For non-string items (e.g., int), do a direct membership check
+            return item in attr_values
+
+    def __iter__(cls):
+        # Make the class iterable by returning an iterator over its values
+        return iter(cls.values())
+
+    def values(cls) -> tuple:
+        """
+        Gets the tuple of class attribute values, excluding private or special
+        attributes and any callables (methods, etc.).
         """
         return tuple(
-            value for key, value in cls.__dict__.items() if not key.startswith("_")
+            value
+            for key, value in cls.__dict__.items()
+            if not key.startswith("_") and not callable(value)
         )
 
-    def keys(cls) -> list:
-        """Gets the list of class attributes names.
-
-        Returns
-        -------
-        list
-            The list of class attributes names.
+    def keys(cls) -> tuple:
+        """
+        Gets the tuple of class attribute names, excluding private or special
+        attributes and any callables (methods, etc.).
         """
         return tuple(
-            key for key, value in cls.__dict__.items() if not key.startswith("_")
+            key
+            for key, value in cls.__dict__.items()
+            if not key.startswith("_") and not callable(value)
         )
 
 
-class ExtendedEnum(Enum):
+class ExtendedEnum(metaclass=ExtendedEnumMeta):
     """The base class to extend functionality of a generic Enum.
 
     Examples
     --------
-    >>> class TestEnum(ExtendedEnumMeta):
-    ...    KEY1 = "value1"
-    ...    KEY2 = "value2"
-    >>> print(TestEnum.KEY1.value) # "value1"
+    >>> class TestEnum(ExtendedEnum):
+    ...    KEY1 = "v1"
+    ...    KEY2 = "v2"
     """
-
-    @classmethod
-    def values(cls):
-        return sorted(map(lambda c: c.value, cls))
-
-    @classmethod
-    def keys(cls):
-        return sorted(map(lambda c: c.name, cls))

ads/llm/__init__.py

@@ -1,21 +1,24 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*--
 
-# Copyright (c) 2023 Oracle and/or its affiliates.
+# Copyright (c) 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
 try:
     import langchain
-    from ads.llm.langchain.plugins.llms.oci_data_science_model_deployment_endpoint import (
-        OCIModelDeploymentVLLM,
-        OCIModelDeploymentTGI,
-    )
+
+    from ads.llm.chat_template import ChatTemplates
     from ads.llm.langchain.plugins.chat_models.oci_data_science import (
         ChatOCIModelDeployment,
-        ChatOCIModelDeploymentVLLM,
         ChatOCIModelDeploymentTGI,
+        ChatOCIModelDeploymentVLLM,
+    )
+    from ads.llm.langchain.plugins.embeddings.oci_data_science_model_deployment_endpoint import (
+        OCIDataScienceEmbedding,
+    )
+    from ads.llm.langchain.plugins.llms.oci_data_science_model_deployment_endpoint import (
+        OCIModelDeploymentTGI,
+        OCIModelDeploymentVLLM,
     )
-    from ads.llm.chat_template import ChatTemplates
 except ImportError as ex:
     if ex.name == "langchain":
         raise ImportError(

ads/llm/langchain/plugins/embeddings/__init__.py

@@ -0,0 +1,4 @@
+#!/usr/bin/env python
+
+# Copyright (c) 2025 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/