ibm-watsonx-orchestrate 1.5.1__py3-none-any.whl → 1.7.0a0__py3-none-any.whl

ibm_watsonx_orchestrate/cli/commands/agents/agents_controller.py

@@ -25,7 +25,7 @@ from ibm_watsonx_orchestrate.agent_builder.agents import (
     AgentKind,
     SpecVersion
 )
-from ibm_watsonx_orchestrate.client.agents.agent_client import AgentClient
+from ibm_watsonx_orchestrate.client.agents.agent_client import AgentClient, AgentUpsertResponse
 from ibm_watsonx_orchestrate.client.agents.external_agent_client import ExternalAgentClient
 from ibm_watsonx_orchestrate.client.agents.assistant_agent_client import AssistantAgentClient
 from ibm_watsonx_orchestrate.client.tools.tool_client import ToolClient
@@ -99,6 +99,7 @@ def parse_create_native_args(name: str, kind: AgentKind, description: str | None
         "style": args.get("style"),
         "custom_join_tool": args.get("custom_join_tool"),
         "structured_output": args.get("structured_output"),
+        "context_access_enabled": args.get("context_access_enabled", True),
     }
 
     collaborators = args.get("collaborators", [])
@@ -116,6 +117,23 @@ def parse_create_native_args(name: str, kind: AgentKind, description: str | None
     knowledge_base = [x.strip() for x in knowledge_base if x.strip() != ""]
     agent_details["knowledge_base"] = knowledge_base
 
+    context_variables = args.get("context_variables", [])
+    context_variables = context_variables if context_variables else []
+    context_variables = [x.strip() for x in context_variables if x.strip() != ""]
+    agent_details["context_variables"] = context_variables
+
+    # hidden = args.get("hidden")
+    # if hidden:
+    #     agent_details["hidden"] = hidden 
+
+    # starter_prompts = args.get("starter_prompts")
+    # if starter_prompts:
+    #     agent_details["starter_prompts"] = starter_prompts 
+
+    # welcome_content = args.get("welcome_content")
+    # if welcome_content:
+    #     agent_details["welcome_content"] = welcome_content 
+
     return agent_details
 
 def parse_create_external_args(name: str, kind: AgentKind, description: str | None, **args) -> dict:
@@ -133,8 +151,14 @@ def parse_create_external_args(name: str, kind: AgentKind, description: str | No
         "config": args.get("config", {}),
         "nickname": args.get("nickname"),
         "app_id": args.get("app_id"),
+        "context_access_enabled": args.get("context_access_enabled", True),
     }
 
+    context_variables = args.get("context_variables", [])
+    context_variables = context_variables if context_variables else []
+    context_variables = [x.strip() for x in context_variables if x.strip() != ""]
+    agent_details["context_variables"] = context_variables
+
     return agent_details
 
 def parse_create_assistant_args(name: str, kind: AgentKind, description: str | None, **args) -> dict:
@@ -146,8 +170,14 @@ def parse_create_assistant_args(name: str, kind: AgentKind, description: str | N
         "tags": args.get("tags", []),
         "config": args.get("config", {}),
         "nickname": args.get("nickname"),
+        "context_access_enabled": args.get("context_access_enabled", True),
     }
 
+    context_variables = args.get("context_variables", [])
+    context_variables = context_variables if context_variables else []
+    context_variables = [x.strip() for x in context_variables if x.strip() != ""]
+    agent_details["context_variables"] = context_variables
+
     return agent_details
 
 def get_conn_id_from_app_id(app_id: str) -> str:
@@ -177,6 +207,10 @@ def get_agent_details(name: str, client: AgentClient | ExternalAgentClient | Ass
 
     return agent_specs[0]
 
+def _raise_guidelines_warning(response: AgentUpsertResponse) -> None:
+    if response.warning:
+        logger.warning(f"Agent Configuration Issue: {response.warning}")
+
 class AgentsController:
     def __init__(self):
         self.native_client = None
@@ -420,6 +454,72 @@ class AgentsController:
         ref_agent.knowledge_base = ref_knowledge_bases
         return ref_agent
     
+    def dereference_guidelines(self, agent: Agent) -> Agent:
+        tool_client = self.get_tool_client()
+        
+        guideline_tool_names = set()
+
+        for guideline in agent.guidelines:
+            if guideline.tool:
+                guideline_tool_names.add(guideline.tool)
+        
+        if len(guideline_tool_names) == 0:
+            return agent
+
+        deref_agent = deepcopy(agent)
+
+        matching_tools = tool_client.get_drafts_by_names(list(guideline_tool_names))
+
+        name_id_lookup = {}
+        for tool in matching_tools:
+            if tool.get("name") in name_id_lookup:
+                logger.error(f"Duplicate draft entries for tool '{tool.get('name')}'")
+                sys.exit(1)
+            name_id_lookup[tool.get("name")] = tool.get("id")
+        
+        for guideline in deref_agent.guidelines:
+            if guideline.tool:
+                id = name_id_lookup.get(guideline.tool)
+                if not id:
+                    logger.error(f"Failed to find guideline tool. No tools found with the name '{guideline.tool}'")
+                    sys.exit(1)
+                guideline.tool = id
+
+        return deref_agent
+    
+    def reference_guidelines(self, agent: Agent) -> Agent:
+        tool_client = self.get_tool_client()
+        
+        guideline_tool_ids = set()
+
+        for guideline in agent.guidelines:
+            if guideline.tool:
+                guideline_tool_ids.add(guideline.tool)
+        
+        if len(guideline_tool_ids) == 0:
+            return agent
+
+        ref_agent = deepcopy(agent)
+
+        matching_tools = tool_client.get_drafts_by_ids(list(guideline_tool_ids))
+
+        id_name_lookup = {}
+        for tool in matching_tools:
+            if tool.get("id") in id_name_lookup:
+                logger.error(f"Duplicate draft entries for tool '{tool.get('id')}'")
+                sys.exit(1)
+            id_name_lookup[tool.get("id")] = tool.get("name")
+        
+        for guideline in ref_agent.guidelines:
+            if guideline.tool:
+                name = id_name_lookup.get(guideline.tool)
+                if not name:
+                    logger.error(f"Failed to find guideline tool. No tools found with the id '{guideline.tool}'")
+                    sys.exit(1)
+                guideline.tool = name
+
+        return ref_agent
+
     @staticmethod
     def dereference_app_id(agent: ExternalAgent | AssistantAgent) -> ExternalAgent | AssistantAgent:
         if agent.kind == AgentKind.EXTERNAL:
@@ -448,6 +548,8 @@ class AgentsController:
             agent = self.dereference_tools(agent)
         if agent.knowledge_base and len(agent.knowledge_base):
             agent = self.dereference_knowledge_bases(agent)
+        if agent.guidelines and len(agent.guidelines):
+            agent = self.dereference_guidelines(agent)
 
         return agent
     
@@ -458,10 +560,12 @@ class AgentsController:
             agent = self.reference_tools(agent)
         if agent.knowledge_base and len(agent.knowledge_base):
             agent = self.reference_knowledge_bases(agent)
+        if agent.guidelines and len(agent.guidelines):
+            agent = self.reference_guidelines(agent)
 
         return agent
     
-    def dereference_external_or_assistant_agent_dependencies(self, agent: ExternalAgent | AssistantAgent) -> ExternalAgent | AssistantAgent: 
+    def dereference_external_or_assistant_agent_dependencies(self, agent: ExternalAgent | AssistantAgent) -> ExternalAgent | AssistantAgent:
         agent_dict = agent.model_dump()
 
         if agent_dict.get("app_id") or agent.config.model_dump().get("app_id"):
@@ -469,7 +573,7 @@ class AgentsController:
 
         return agent
 
-    def reference_external_or_assistant_agent_dependencies(self, agent: ExternalAgent | AssistantAgent) -> ExternalAgent | AssistantAgent: 
+    def reference_external_or_assistant_agent_dependencies(self, agent: ExternalAgent | AssistantAgent) -> ExternalAgent | AssistantAgent:
         agent_dict = agent.model_dump()
 
         if agent_dict.get("connection_id") or agent.config.model_dump().get("connection_id"):
@@ -543,7 +647,8 @@ class AgentsController:
 
     def publish_agent(self, agent: Agent, **kwargs) -> None:
         if isinstance(agent, Agent):
-            self.get_native_client().create(agent.model_dump(exclude_none=True))
+            response = self.get_native_client().create(agent.model_dump(exclude_none=True))
+            _raise_guidelines_warning(response)
             logger.info(f"Agent '{agent.name}' imported successfully")
         if isinstance(agent, ExternalAgent):
             self.get_external_client().create(agent.model_dump(exclude_none=True))
@@ -557,7 +662,8 @@ class AgentsController:
     ) -> None:
         if isinstance(agent, Agent):
             logger.info(f"Existing Agent '{agent.name}' found. Updating...")
-            self.get_native_client().update(agent_id, agent.model_dump(exclude_none=True))
+            response = self.get_native_client().update(agent_id, agent.model_dump(exclude_none=True))
+            _raise_guidelines_warning(response)
             logger.info(f"Agent '{agent.name}' updated successfully")
         if isinstance(agent, ExternalAgent):
             logger.info(f"Existing External Agent '{agent.name}' found. Updating...")
@@ -660,14 +766,14 @@ class AgentsController:
                     show_lines=True
                 )
                 column_args = {
-                    "Name": {},
+                    "Name": {"overflow": "fold"},
                     "Description": {},
                     "LLM": {"overflow": "fold"},
                     "Style": {},
                     "Collaborators": {},
                     "Tools": {},
                     "Knowledge Base": {},
-                    "ID": {},
+                    "ID": {"overflow": "fold"},
                 }
                 for column in column_args:
                     native_table.add_column(column, **column_args[column])
@@ -717,7 +823,7 @@ class AgentsController:
                     show_lines=True
                 )
                 column_args = {
-                    "Name": {},
+                    "Name": {"overflow": "fold"},
                     "Title": {},
                     "Description": {},
                     "Tags": {},
@@ -725,9 +831,9 @@ class AgentsController:
                     "Chat Params": {},
                     "Config": {},
                     "Nickname": {},
-                    "App ID": {},
-                    "ID": {}
-                    }
+                    "App ID": {"overflow": "fold"},
+                    "ID": {"overflow": "fold"}
+                }
                 
                 for column in column_args:
                     external_table.add_column(column, **column_args[column])
@@ -778,17 +884,17 @@ class AgentsController:
                     title="Assistant Agents",
                     show_lines=True)
                 column_args = {
-                    "Name": {},
+                    "Name": {"overflow": "fold"},
                     "Title": {},
                     "Description": {},
                     "Tags": {},
                     "Nickname": {},
                     "CRN": {},
                     "Instance URL": {},
-                    "Assistant ID": {},
-                    "Environment ID": {},
-                    "ID": {}
-                    }
+                    "Assistant ID": {"overflow": "fold"},
+                    "Environment ID": {"overflow": "fold"},
+                    "ID": {"overflow": "fold"}
+                }
                 
                 for column in column_args:
                     assistants_table.add_column(column, **column_args[column])
@@ -875,7 +981,6 @@ class AgentsController:
         
 
     def export_agent(self, name: str, kind: AgentKind, output_path: str, agent_only_flag: bool=False, zip_file_out: zipfile.ZipFile | None = None) -> None:
-    
         output_file = Path(output_path)
         output_file_extension = output_file.suffix
         output_file_name = output_file.stem

ibm_watsonx_orchestrate/cli/commands/channels/webchat/channels_webchat_controller.py

@@ -1,10 +1,10 @@
 import logging
-import logging
 import rich
 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, AUTH_CONFIG_FILE_FOLDER, AUTH_SECTION_HEADER, AUTH_MCSP_TOKEN_OPT, AUTH_CONFIG_FILE
+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.client.agents.agent_client import AgentClient
 
@@ -20,7 +20,41 @@ class ChannelsWebchatController:
     def get_native_client(self):
         self.native_client = instantiate_client(AgentClient)
         return self.native_client
-
+    
+    def extract_tenant_id_from_crn(self, crn: str) -> str:
+        is_ibm_cloud_env = is_ibm_cloud()
+        if is_ibm_cloud_env:
+            try:
+                parts = crn.split("a/")[1].split(":")
+                account_part = parts[0]
+                instance_part = parts[1]
+                tenant_id = f"{account_part}_{instance_part}"
+                return tenant_id
+            except (IndexError, AttributeError):
+                raise ValueError(f"Invalid CRN format: {crn}")
+        else:
+            try:
+                parts = crn.split("sub/")[1].split(":")
+                account_part = parts[0]
+                instance_part = parts[1]
+                tenant_id = f"{account_part}_{instance_part}"
+                return tenant_id
+            except (IndexError, AttributeError):
+                raise ValueError(f"Invalid CRN format: {crn}")
+
+        
+            
+    def check_crn_is_correct(self, crn: str):
+        parts = crn.split("a/")[1].split(":")
+        instance_part_crn = parts[1]
+        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)
+        instance_part_url = url.rstrip("/").split("/")[-1]
+        if instance_part_crn == instance_part_url:
+            return True
+        else:
+            return False
 
     def get_agent_id(self, agent_name: str):
         native_client = self.get_native_client()
@@ -40,7 +74,7 @@ class ChannelsWebchatController:
             raise ValueError(f"No agent found with the name '{agent_name}'")
 
         agent = existing_native_agents[0]
-        agent_environments = agent.get("environments", [])
+        agent_environments = agent.get("environments", [])        
 
         is_local = is_local_dev()
         target_env = env or 'draft'
@@ -57,15 +91,37 @@ 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)
 
-        return filtered_environments[0].get("id")
+        if target_env == 'draft' and is_local == False:
+            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):
         auth_cfg = Config(AUTH_CONFIG_FILE_FOLDER, AUTH_CONFIG_FILE)
 
         cfg = Config()
         active_env = cfg.read(CONTEXT_SECTION_HEADER, CONTEXT_ACTIVE_ENV_OPT)
-        is_local = is_local_dev()
+
+        existing_auth_config = auth_cfg.get(AUTH_SECTION_HEADER).get(active_env, {})
+
+        existing_token = existing_auth_config.get(AUTH_MCSP_TOKEN_OPT) if existing_auth_config else None
+        token = jwt.decode(existing_token, options={"verify_signature": False})
+        crn = ""
+        crn = token.get('aud', None)
+
+        tenant_id = self.extract_tenant_id_from_crn(crn)
+        return tenant_id
+
+
+
+    def get_tenant_id_local(self):
+        auth_cfg = Config(AUTH_CONFIG_FILE_FOLDER, AUTH_CONFIG_FILE)
+
+        cfg = Config()
+        active_env = cfg.read(CONTEXT_SECTION_HEADER, CONTEXT_ACTIVE_ENV_OPT)
 
         existing_auth_config = auth_cfg.get(AUTH_SECTION_HEADER).get(active_env, {})
 
@@ -73,10 +129,7 @@ class ChannelsWebchatController:
 
         token = jwt.decode(existing_token, options={"verify_signature": False})
         tenant_id = ""
-        if is_local:
-            tenant_id = token.get('woTenantId', None)
-        else:
-            tenant_id = token.get('tenantId', None)
+        tenant_id = token.get('woTenantId', None)
 
         return tenant_id
 
@@ -100,41 +153,70 @@ class ChannelsWebchatController:
 
             
     def create_webchat_embed_code(self):
-        tenant_id = self.get_tennent_id()
+        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")
+                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)
 
-        is_local = is_local_dev()
         script_path = (
             "/wxoLoader.js?embed=true"
             if is_local
             else "/wxochat/wxoLoader.js?embed=true"
         )
 
+        config_lines = [
+            f'orchestrationID: "{tenant_id}"',
+            f'hostURL: "{host_url}"',
+            'rootElementID: "root"',
+            'showLauncher: true',
+        ]
+
+        # Conditional fields for IBM Cloud
+        if is_ibm_cloud_env:
+            config_lines.append(f'crn: "{crn}"')
+        if is_ibm_cloud_env:
+            config_lines.append(f'deploymentPlatform: "ibmcloud"')
+
+        config_lines.append(f"""chatOptions: {{
+            agentId: "{agent_id}",
+            agentEnvironmentId: "{agent_env_id}"
+        }}""")
+
+        config_body = ",\n                    ".join(config_lines)
+
         script = f"""
             <script>
                 window.wxOConfiguration = {{
-                    orchestrationID: "{tenant_id}",
-                    hostURL: "{host_url}",
-                    rootElementID: "root",
-                    showLauncher: true,
-                    chatOptions: {{
-                        agentId: "{agent_id}",
-                        agentEnvironmentId: "{agent_env_id}"
-                    }},
+                    {config_body}
                 }};
 
                 setTimeout(function () {{
                     const script = document.createElement('script');
                     script.src = `${{window.wxOConfiguration.hostURL}}{script_path}`;
                     script.addEventListener('load', function () {{
-                    wxoLoader.init();
+                        wxoLoader.init();
                     }});
                     document.head.appendChild(script);
                 }}, 0);
             </script>
-        """ 
+            """
 
         rich.print(script)
         return script

ibm_watsonx_orchestrate/cli/commands/connections/connections_command.py

@@ -191,31 +191,31 @@ def set_credentials_connection_command(
         typer.Option(
             '--client-id',
             # help='For oauth_auth_on_behalf_of_flow, oauth_auth_code_flow, oauth_auth_implicit_flow, oauth_auth_password_flow and oauth_auth_client_credentials_flow, the client_id to authenticate against the application token server'
-            help='For oauth_auth_on_behalf_of_flow, the client_id to authenticate against the application token server'
+            help='For oauth_auth_on_behalf_of_flow and oauth_auth_client_credentials_flow, the client_id to authenticate against the application token server'
+        )
+    ] = None,
+    client_secret: Annotated[
+        str,
+        typer.Option(
+            '--client-secret',
+            help='For oauth_auth_client_credentials_flow, the client_secret to authenticate with'
         )
     ] = None,
-    # client_secret: Annotated[
-    #     str,
-    #     typer.Option(
-    #         '--client-secret',
-    #         help='For oauth_auth_code_flow, oauth_auth_password_flow and oauth_auth_client_credentials_flow, the client_secret to authenticate with'
-    #     )
-    # ] = None,
     token_url: Annotated[
         str,
         typer.Option(
             '--token-url',
             # help='For oauth_auth_on_behalf_of_flow, oauth_auth_code_flow, oauth_auth_password_flow and oauth_auth_client_credentials_flow, the url of the application token server'
-            help='For oauth_auth_on_behalf_of_flow, the url of the application token server'
+            help='For oauth_auth_on_behalf_of_flow and oauth_auth_client_credentials_flow, the url of the application token server'
+        )
+    ] = None,
+    auth_url: Annotated[
+        str,
+        typer.Option(
+            '--auth-url',
+            help='For oauth_auth_code_flow, the url of the application token server'
         )
     ] = None,
-    # auth_url: Annotated[
-    #     str,
-    #     typer.Option(
-    #         '--auth-url',
-    #         help='For oauth_auth_code_flow, oauth_auth_implicit_flow and oauth_auth_password_flow, the url of the application token server'
-    #     )
-    # ] = None,
     grant_type: Annotated[
         str,
         typer.Option(
@@ -223,6 +223,13 @@ def set_credentials_connection_command(
             help='For oauth_auth_on_behalf_of_flow, the grant type used by the application token server'
         )
     ] = None,
+    scopes: Annotated[
+        List[str],
+        typer.Option(
+            '--scopes',
+            help='For oauth_auth_code_flow and oauth_auth_client_credentials_flow, the optional scopes used by the application token server'
+        )
+    ] = None,
     entries: Annotated[
         List[str],
         typer.Option(
@@ -239,10 +246,11 @@ def set_credentials_connection_command(
         token=token,
         api_key=api_key,
         client_id=client_id,
-        # client_secret=client_secret,
+        client_secret=client_secret,
         token_url=token_url,
-        # auth_url=auth_url,
+        auth_url=auth_url,
         grant_type=grant_type,
+        scopes=scopes,
         entries=entries
     )