ibm-watsonx-orchestrate 1.6.2__tar.gz → 1.6.3__tar.gz

{ibm_watsonx_orchestrate-1.6.2 → ibm_watsonx_orchestrate-1.6.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ibm-watsonx-orchestrate
-Version: 1.6.2
+Version: 1.6.3
 Summary: IBM watsonx.orchestrate SDK
 Author-email: IBM <support@ibm.com>
 License: MIT License

{ibm_watsonx_orchestrate-1.6.2 → ibm_watsonx_orchestrate-1.6.3}/src/ibm_watsonx_orchestrate/__init__.py

@@ -5,7 +5,7 @@
 
 pkg_name = "ibm-watsonx-orchestrate"
 
-__version__ = "1.6.2"
+__version__ = "1.6.3"
 
 
 

ibm_watsonx_orchestrate-1.6.3/src/ibm_watsonx_orchestrate/cli/commands/channels/types.py

@@ -0,0 +1,27 @@
+from enum import Enum
+
+class EnvironmentType(str, Enum):
+    DRAFT ='draft'
+    LIVE = 'live'
+
+    def __str__(self):
+        return self.value
+    
+
+class ChannelType(str, Enum):
+    WEBCHAT ='webchat'
+
+    def __str__(self):
+        return self.value
+    
+class RuntimeEnvironmentType(str, Enum):
+    LOCAL = 'local'
+    CPD = 'cpd'
+    IBM_CLOUD = 'ibmcloud'
+    AWS = 'aws'
+
+    def __str__(self):
+        return self.value
+    
+    def __repr__(self):
+        return self.value

{ibm_watsonx_orchestrate-1.6.2 → ibm_watsonx_orchestrate-1.6.3}/src/ibm_watsonx_orchestrate/cli/commands/channels/webchat/channels_webchat_controller.py

@@ -4,12 +4,15 @@ import jwt
 import sys
 
 from ibm_watsonx_orchestrate.cli.config import Config, ENV_WXO_URL_OPT, ENVIRONMENTS_SECTION_HEADER, CONTEXT_SECTION_HEADER, CONTEXT_ACTIVE_ENV_OPT, CHAT_UI_PORT
-from ibm_watsonx_orchestrate.client.utils import is_local_dev, is_ibm_cloud, AUTH_CONFIG_FILE_FOLDER, AUTH_SECTION_HEADER, AUTH_MCSP_TOKEN_OPT, AUTH_CONFIG_FILE
+from ibm_watsonx_orchestrate.cli.commands.channels.types import RuntimeEnvironmentType
+
+from ibm_watsonx_orchestrate.client.utils import is_local_dev, is_ibm_cloud_platform, get_environment, get_cpd_instance_id_from_url, is_saas_env, AUTH_CONFIG_FILE_FOLDER, AUTH_SECTION_HEADER, AUTH_MCSP_TOKEN_OPT, AUTH_CONFIG_FILE
 
 from ibm_watsonx_orchestrate.client.agents.agent_client import AgentClient
 
 from ibm_watsonx_orchestrate.client.utils import instantiate_client
 
+
 logger = logging.getLogger(__name__)
 
 class ChannelsWebchatController:
@@ -22,7 +25,7 @@ class ChannelsWebchatController:
         return self.native_client
     
     def extract_tenant_id_from_crn(self, crn: str) -> str:
-        is_ibm_cloud_env = is_ibm_cloud()
+        is_ibm_cloud_env = is_ibm_cloud_platform()
         if is_ibm_cloud_env:
             try:
                 parts = crn.split("a/")[1].split(":")
@@ -77,6 +80,7 @@ class ChannelsWebchatController:
         agent_environments = agent.get("environments", [])        
 
         is_local = is_local_dev()
+        is_saas = is_saas_env()
         target_env = env or 'draft'
 
         if is_local:
@@ -91,15 +95,13 @@ class ChannelsWebchatController:
                 logger.error(f'This agent does not exist in the {env} environment. You need to deploy it to {env} before you can embed the agent')
             exit(1)
 
-        if target_env == 'draft' and is_local == False:
+        if target_env == 'draft' and is_saas == True:
             logger.error(f'For SAAS, please ensure this agent exists in a Live Environment')
             exit(1)
              
-
-
         return filtered_environments[0].get("id")
 
-    def get_tennent_id(self):
+    def get_tenant_id(self):
         auth_cfg = Config(AUTH_CONFIG_FILE_FOLDER, AUTH_CONFIG_FILE)
 
         cfg = Config()
@@ -154,30 +156,40 @@ class ChannelsWebchatController:
             
     def create_webchat_embed_code(self):
         crn = None
-        is_ibm_cloud_env = is_ibm_cloud()
-        is_local = is_local_dev()
-        if is_ibm_cloud_env is True:
-            crn = input("Please enter your CRN which can be gotten from the IBM Cloud UI: ")
-            if crn == "":
-                logger.error("You must enter your CRN for IBM Cloud instances")
+        environment = get_environment()
+
+        match (environment):
+            case RuntimeEnvironmentType.LOCAL:
+                tenant_id = self.get_tenant_id_local()
+
+            case RuntimeEnvironmentType.CPD:
+                tenant_id = get_cpd_instance_id_from_url()
+
+            case RuntimeEnvironmentType.IBM_CLOUD:
+                crn = input("Please enter your CRN which can be retrieved from the IBM Cloud UI: ")
+                if crn == "":
+                    logger.error("You must enter your CRN for IBM Cloud instances")
+                    sys.exit(1)
+                is_crn_correct = self.check_crn_is_correct(crn)
+                if is_crn_correct == False:
+                    logger.error("Invalid CRN format provided.")
+                    sys.exit(1)
+                tenant_id = self.extract_tenant_id_from_crn(crn)
+
+            case RuntimeEnvironmentType.AWS:
+                tenant_id = self.get_tenant_id()
+
+            case _:
+                logger.error("Environment not recognized")
                 sys.exit(1)
-            is_crn_correct = self.check_crn_is_correct(crn)
-            if is_crn_correct == False:
-                logger.error("Invalid CRN format provided.")
-
-        if is_ibm_cloud_env and crn is not None:
-            tenant_id = self.extract_tenant_id_from_crn(crn)
-        elif is_ibm_cloud_env is False and is_local is False:
-            tenant_id = self.get_tennent_id()
-        elif is_local:
-            tenant_id = self.get_tenant_id_local()
+
         host_url = self.get_host_url()
         agent_id = self.get_agent_id(self.agent_name)
         agent_env_id = self.get_environment_id(self.agent_name, self.env)
 
         script_path = (
             "/wxoLoader.js?embed=true"
-            if is_local
+            if environment == "local"
             else "/wxochat/wxoLoader.js?embed=true"
         )
 
@@ -189,9 +201,8 @@ class ChannelsWebchatController:
         ]
 
         # Conditional fields for IBM Cloud
-        if is_ibm_cloud_env:
+        if environment == "ibmcloud":
             config_lines.append(f'crn: "{crn}"')
-        if is_ibm_cloud_env:
             config_lines.append(f'deploymentPlatform: "ibmcloud"')
 
         config_lines.append(f"""chatOptions: {{

{ibm_watsonx_orchestrate-1.6.2 → ibm_watsonx_orchestrate-1.6.3}/src/ibm_watsonx_orchestrate/cli/commands/environment/types.py

@@ -7,4 +7,4 @@ class EnvironmentAuthType(str, Enum):
     CPD = 'cpd'
 
     def __str__(self):
-        return self.value
+        return self.value

{ibm_watsonx_orchestrate-1.6.2 → ibm_watsonx_orchestrate-1.6.3}/src/ibm_watsonx_orchestrate/cli/commands/models/models_controller.py

@@ -167,15 +167,12 @@ class ModelsController:
             logger.error("Error: WATSONX_URL is required in the environment.")
             sys.exit(1)
 
-        if is_cpd_env(models_client.base_url):
-            virtual_models = []
-            virtual_model_policies = []
-        else:
-            logger.info("Retrieving virtual-model models list...")
-            virtual_models = models_client.list()
+    
+        logger.info("Retrieving virtual-model models list...")
+        virtual_models = models_client.list()
 
-            logger.info("Retrieving virtual-policies models list...")
-            virtual_model_policies = model_policies_client.list()
+        logger.info("Retrieving virtual-policies models list...")
+        virtual_model_policies = model_policies_client.list()
 
         logger.info("Retrieving watsonx.ai models list...")
         found_models = _get_wxai_foundational_models()

{ibm_watsonx_orchestrate-1.6.2 → ibm_watsonx_orchestrate-1.6.3}/src/ibm_watsonx_orchestrate/client/connections/connections_client.py

@@ -63,12 +63,7 @@ class ConnectionsClient(BaseAPIClient):
     # GET /api/v1/connections/applications/{app_id}
     def get(self, app_id: str) -> GetConnectionResponse | None:
         try:
-            path = (
-                f"/connections/applications/{app_id}"
-                if is_cpd_env(self.base_url)
-                else f"/connections/applications?app_id={app_id}"
-            )
-            return GetConnectionResponse.model_validate(self._get(path))
+            return GetConnectionResponse.model_validate(self._get(f"/connections/applications?app_id={app_id}"))
         except ClientAPIException as e:
             if e.response.status_code == 404:
                 return None
@@ -78,12 +73,7 @@ class ConnectionsClient(BaseAPIClient):
     # GET api/v1/connections/applications
     def list(self) -> List[ListConfigsResponse]:
         try:
-            path = (
-                f"/connections/applications"
-                if is_cpd_env(self.base_url)
-                else f"/connections/applications?include_details=true"
-            )
-            res = self._get(path)
+            res = self._get(f"/connections/applications?include_details=true")
             import json
             json.dumps(res)
             return [ListConfigsResponse.model_validate(conn) for conn in res.get("applications", [])]
@@ -135,19 +125,9 @@ class ConnectionsClient(BaseAPIClient):
     def get_credentials(self, app_id: str, env: ConnectionEnvironment, use_app_credentials: bool) -> dict:
         try:
             if use_app_credentials:
-                path = (
-                    f"/connections/applications/{app_id}/credentials?env={env}"
-                    if is_cpd_env(self.base_url)
-                    else f"/connections/applications/{app_id}/credentials/{env}"
-                )
-                return self._get(path)
+                return self._get(f"/connections/applications/{app_id}/credentials/{env}")
             else:
-                path = (
-                    f"/connections/applications/{app_id}/configs/runtime_credentials?env={env}"
-                    if is_cpd_env(self.base_url)
-                    else f"/connections/applications/runtime_credentials?app_id={app_id}&env={env}"
-                )
-                return self._get(path)
+                return self._get(f"/connections/applications/runtime_credentials?app_id={app_id}&env={env}")
         except ClientAPIException as e:
             if e.response.status_code == 404:
                 return None
@@ -177,12 +157,7 @@ class ConnectionsClient(BaseAPIClient):
         if conn_id is None:
             return ""
         try:
-            path = (
-                f"/connections/applications/id/{conn_id}"
-                if is_cpd_env(self.base_url)
-                else f"/connections/applications?connection_id={conn_id}"
-            )
-            app_details = self._get(path)
+            app_details = self._get(f"/connections/applications?connection_id={conn_id}")
             return app_details.get("app_id")
         except ClientAPIException as e:
             if e.response.status_code == 404:

{ibm_watsonx_orchestrate-1.6.2 → ibm_watsonx_orchestrate-1.6.3}/src/ibm_watsonx_orchestrate/client/utils.py

@@ -16,22 +16,27 @@ from ibm_watsonx_orchestrate.cli.config import (
 from threading import Lock
 from ibm_watsonx_orchestrate.client.base_api_client import BaseAPIClient
 from ibm_watsonx_orchestrate.utils.utils import yaml_safe_load
+from ibm_watsonx_orchestrate.cli.commands.channels.types import RuntimeEnvironmentType
 import logging
 from typing import TypeVar
 import os
 import jwt
 import time
+import sys
 
 logger = logging.getLogger(__name__)
 LOCK = Lock()
 T = TypeVar("T", bound=BaseAPIClient)
 
 
+def get_current_env_url() -> str:
+    cfg = Config()
+    active_env = cfg.read(CONTEXT_SECTION_HEADER, CONTEXT_ACTIVE_ENV_OPT)
+    return cfg.get(ENVIRONMENTS_SECTION_HEADER, active_env, ENV_WXO_URL_OPT)
+
 def is_local_dev(url: str | None = None) -> bool:
     if url is None:
-        cfg = Config()
-        active_env = cfg.read(CONTEXT_SECTION_HEADER, CONTEXT_ACTIVE_ENV_OPT)
-        url = cfg.get(ENVIRONMENTS_SECTION_HEADER, active_env, ENV_WXO_URL_OPT)
+        url = get_current_env_url()
 
     if url.startswith("http://localhost"):
         return True
@@ -47,21 +52,55 @@ def is_local_dev(url: str | None = None) -> bool:
 
     return False
 
-def is_ibm_cloud():
-    cfg = Config()
-    active_env = cfg.read(CONTEXT_SECTION_HEADER, CONTEXT_ACTIVE_ENV_OPT)
-    url = cfg.get(ENVIRONMENTS_SECTION_HEADER, active_env, ENV_WXO_URL_OPT)
+def is_ga_platform(url: str | None = None) -> bool:
+    if url is None:
+        url = get_current_env_url()
+        
+    if url.__contains__("orchestrate.ibm.com"):
+        return True
+    return False
+
+def is_saas_env():
+    return is_ga_platform() or is_ibm_cloud_platform()
+
+def is_ibm_cloud_platform(url:str | None = None) -> bool:
+    if url is None:
+        url = get_current_env_url()
 
     if url.__contains__("cloud.ibm.com"):
         return True
     return False
 
+def is_cpd_env(url: str | None = None) -> bool:
+    if url is None:
+        url = get_current_env_url()
 
-def is_cpd_env(url: str) -> bool:
     if url.lower().startswith("https://cpd"):
         return True
     return False
 
+def get_environment() -> str:
+    if is_local_dev():
+        return RuntimeEnvironmentType.LOCAL
+    if is_cpd_env():
+        return RuntimeEnvironmentType.CPD
+    if is_ibm_cloud_platform():
+        return RuntimeEnvironmentType.IBM_CLOUD
+    if is_ga_platform():
+        return RuntimeEnvironmentType.AWS
+    return None
+
+def get_cpd_instance_id_from_url(url: str | None = None) -> str:
+    if url is None:
+        url = get_current_env_url()
+
+    if not is_cpd_env(url):
+        logger.error(f"The host {url} is not a CPD instance")
+        sys.exit(1)
+
+    url_fragments = url.split('/')
+    return url_fragments[-1] if url_fragments[-1] else url_fragments[-2]
+
 def check_token_validity(token: str) -> bool:
     try:
         token_claimset = jwt.decode(token, options={"verify_signature": False})

ibm_watsonx_orchestrate-1.6.2/src/ibm_watsonx_orchestrate/cli/commands/channels/types.py

@@ -1,15 +0,0 @@
-from enum import Enum
-
-class  EnvironmentType(str, Enum):
-    DRAFT ='draft'
-    LIVE = 'live'
-
-    def __str__(self):
-        return self.value
-    
-
-class  ChannelType(str, Enum):
-    WEBCHAT ='webchat'
-
-    def __str__(self):
-        return self.value