ibm-watsonx-orchestrate 1.7.0b1__py3-none-any.whl → 1.8.0b1__py3-none-any.whl

ibm_watsonx_orchestrate/__init__.py

@@ -5,8 +5,7 @@
 
 pkg_name = "ibm-watsonx-orchestrate"
 
-__version__ = "1.7.0b1"
-
+__version__ = "1.8.0b1"
 
 
 

ibm_watsonx_orchestrate/agent_builder/agents/types.py

@@ -14,17 +14,39 @@ from ibm_watsonx_orchestrate.utils.exceptions import BadRequest
 from ibm_watsonx_orchestrate.agent_builder.tools.types import JsonSchemaObject
 
 # TO-DO: this is just a placeholder. Will update this later to align with backend
-DEFAULT_LLM = "watsonx/meta-llama/llama-3-1-70b-instruct"
+DEFAULT_LLM = "watsonx/meta-llama/llama-3-2-90b-vision-instruct"
+
+# Handles yaml formatting for multiline strings to improve readability
+def str_presenter(dumper, data):
+    if len(data.splitlines()) > 1:  # check for multiline string
+        data = "\n".join([line.rstrip() for line in data.splitlines()])
+        return dumper.represent_scalar('tag:yaml.org,2002:str', data, style='|')
+    return dumper.represent_scalar('tag:yaml.org,2002:str', data)
+
+yaml.add_representer(str, str_presenter)
+yaml.representer.SafeRepresenter.add_representer(str, str_presenter) # to use with safe_dum
 
 class SpecVersion(str, Enum):
     V1 = "v1"
 
+    def __str__(self):
+        return self.value 
+
+    def __repr__(self):
+        return repr(self.value)
+
 
 class AgentKind(str, Enum):
     NATIVE = "native"
     EXTERNAL = "external"
     ASSISTANT = "assistant"
 
+    def __str__(self):
+        return self.value 
+
+    def __repr__(self):
+        return repr(self.value)
+
 class ExternalAgentAuthScheme(str, Enum):
     BEARER_TOKEN = 'BEARER_TOKEN'
     API_KEY = "API_KEY"
@@ -88,6 +110,12 @@ class AgentStyle(str, Enum):
     REACT = "react"
     PLANNER = "planner"
 
+    def __str__(self):
+        return self.value 
+
+    def __repr__(self):
+        return repr(self.value)
+
 class AgentGuideline(BaseModel):
     model_config = ConfigDict(arbitrary_types_allowed=True)
 

ibm_watsonx_orchestrate/agent_builder/connections/types.py

@@ -75,6 +75,16 @@ class ConnectionType(str, Enum):
 
     def __repr__(self):
         return repr(self.value)
+    
+class ConnectionSendVia(str,Enum):
+    HEADER = 'header'
+    BODY = 'body'
+
+    def __str__(self):
+        return self.value
+    
+    def __repr__(self):
+        return repr(self.value)
 
 OAUTH_CONNECTION_TYPES = {
     ConnectionType.OAUTH2_AUTH_CODE,
@@ -177,7 +187,7 @@ class OAuth2AuthCodeCredentials(BaseModel):
     client_secret: str
     token_url: str
     authorization_url: str
-    scopes : Optional[List[str]] = None
+    scope : Optional[str] = None
 
 # class OAuth2ImplicitCredentials(BaseModel):
 #     client_id: str
@@ -193,7 +203,9 @@ class OAuth2ClientCredentials(BaseModel):
     client_id: str
     client_secret: str
     token_url: str
-    scopes : Optional[List[str]] = None
+    scope : Optional[str] = None
+    send_via: ConnectionSendVia = ConnectionSendVia.HEADER
+    grant_type: str = "client_credentials"
 
 class OAuthOnBehalfOfCredentials(BaseModel):
     client_id: str

ibm_watsonx_orchestrate/cli/commands/channels/types.py

@@ -1,6 +1,6 @@
 from enum import Enum
 
-class  EnvironmentType(str, Enum):
+class EnvironmentType(str, Enum):
     DRAFT ='draft'
     LIVE = 'live'
 
@@ -8,8 +8,21 @@ class  EnvironmentType(str, Enum):
         return self.value
     
 
-class  ChannelType(str, Enum):
+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/cli/commands/channels/webchat/channels_webchat_controller.py

@@ -4,7 +4,8 @@ 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
 
@@ -22,7 +23,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 +78,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,7 +93,7 @@ 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)
              
@@ -99,7 +101,7 @@ class ChannelsWebchatController:
 
         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/cli/commands/connections/connections_command.py

@@ -201,6 +201,13 @@ def set_credentials_connection_command(
             help='For oauth_auth_client_credentials_flow, the client_secret to authenticate with'
         )
     ] = None,
+    send_via: Annotated[
+        str,
+        typer.Option(
+            '--send-via',
+            help='For oauth_auth_client_credentials_flow, how the token will be sent to the server. Defaults to using `header`'
+        )
+    ] = None,
     token_url: Annotated[
         str,
         typer.Option(
@@ -220,14 +227,14 @@ def set_credentials_connection_command(
         str,
         typer.Option(
             '--grant-type',
-            help='For oauth_auth_on_behalf_of_flow, the grant type used by the application token server'
+            help='For oauth_auth_on_behalf_of_flow and oauth_auth_client_credentials_flow, the grant type used by the application token server'
         )
     ] = None,
-    scopes: Annotated[
-        List[str],
+    scope: Annotated[
+        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'
+            '--scope',
+            help='For oauth_auth_code_flow and oauth_auth_client_credentials_flow, the optional scopes used by the application token server. Should be in the form of a space seperated string.'
         )
     ] = None,
     entries: Annotated[
@@ -247,10 +254,11 @@ def set_credentials_connection_command(
         api_key=api_key,
         client_id=client_id,
         client_secret=client_secret,
+        send_via=send_via,
         token_url=token_url,
         auth_url=auth_url,
         grant_type=grant_type,
-        scopes=scopes,
+        scope=scope,
         entries=entries
     )
 

ibm_watsonx_orchestrate/cli/commands/connections/connections_controller.py

@@ -160,13 +160,13 @@ def _validate_connection_params(type: ConnectionType, **args) -> None:
             f"Missing flags --token-url is required for type {type}"
         )
 
-
     if type == ConnectionType.OAUTH_ON_BEHALF_OF_FLOW and (
             args.get('grant_type') is None
     ):
         raise typer.BadParameter(
             f"Missing flags --grant-type is required for type {type}"
         )
+    
 
 def _parse_entry(entry: str) -> dict[str,str]:
     split_entry = entry.split('=')
@@ -197,15 +197,13 @@ def _get_credentials(type: ConnectionType, **kwargs):
                 client_id=kwargs.get("client_id"),
                 client_secret=kwargs.get("client_secret"),
                 token_url=kwargs.get("token_url"),
-                scopes=kwargs.get("scopes")
+                scope=kwargs.get("scope")
             )
         case ConnectionType.OAUTH2_CLIENT_CREDS:
-            return OAuth2ClientCredentials(
-                client_id=kwargs.get("client_id"),
-                client_secret=kwargs.get("client_secret"),
-                token_url=kwargs.get("token_url"),
-                scopes=kwargs.get("scopes")
-            )
+            # using filtered args as default values will not be set if 'None' is passed, causing validation errors
+            keys = ["client_id","client_secret","token_url","grant_type","send_via", "scope"]
+            filtered_args = { key_name: kwargs[key_name] for key_name in keys if kwargs.get(key_name) }
+            return OAuth2ClientCredentials(**filtered_args)
         # case ConnectionType.OAUTH2_IMPLICIT:
         #     return OAuth2ImplicitCredentials(
         #         authorization_url=kwargs.get("auth_url"),

ibm_watsonx_orchestrate/cli/commands/copilot/copilot_command.py

@@ -0,0 +1,65 @@
+import typer
+from typing_extensions import Annotated
+from pathlib import Path
+from ibm_watsonx_orchestrate.cli.commands.copilot.copilot_controller import prompt_tune, create_agent
+from ibm_watsonx_orchestrate.cli.commands.copilot.copilot_server_controller import start_server, stop_server
+
+copilot_app = typer.Typer(no_args_is_help=True)
+
+# Server Commands
+@copilot_app.command(name="start", help='Start the copilot server')
+def start_server_command(
+    user_env_file: str = typer.Option(
+        None,
+        "--env-file", "-e",
+        help="Path to a .env file that overrides default.env. Then environment variables override both."
+    )
+):
+    user_env_file_path = Path(user_env_file) if user_env_file else None
+
+    start_server(user_env_file_path=user_env_file_path)
+
+@copilot_app.command(name="stop", help='Stop the copilot server')
+def stop_server_command():
+    stop_server()
+
+# Functional Commands
+@copilot_app.command(name="prompt-tune", help='Tune the instructions of an Agent using IBM Conversational Prompt Engineering (CPE) to improve agent performance')
+def prompt_tume_command(
+    file: Annotated[
+        str,
+        typer.Option("--file", "-f", help="Path to agent spec file"),
+    ] = None,
+    output_file: Annotated[
+        str,
+        typer.Option("--output-file", "-o", help="Optional output file to avoid overwriting existing agent spec"),
+    ] = None,
+    dry_run_flag: Annotated[
+        bool,
+        typer.Option("--dry-run", help="Dry run will prevent the tuned content being saved and output the results to console"),
+    ] = False,
+    llm: Annotated[
+        str,
+        typer.Option("--llm", help="Select the agent LLM"),
+    ] = None,
+    samples: Annotated[
+        str,
+        typer.Option("--samples", "-s", help="Path to utterances sample file (txt file where each line is a utterance, or csv file with a single \"input\" column)"),
+    ] = None
+):
+    if file is None:
+        # create agent yaml from scratch
+        create_agent(
+            llm=llm,
+            output_file=output_file,
+            samples_file=samples,
+            dry_run_flag=dry_run_flag
+        )
+    else:
+        # improve existing agent instruction
+        prompt_tune(
+            agent_spec=file,
+            samples_file=samples,
+            output_file=output_file,
+            dry_run_flag=dry_run_flag,
+        )