ibm-watsonx-orchestrate 1.9.0b1__py3-none-any.whl → 1.10.0b0__py3-none-any.whl

ibm_watsonx_orchestrate/__init__.py

@@ -5,7 +5,8 @@
 
 pkg_name = "ibm-watsonx-orchestrate"
 
-__version__ = "1.9.0b1"
+__version__ = "1.10.0b0"
+
 
 
 

ibm_watsonx_orchestrate/agent_builder/agents/types.py

@@ -77,6 +77,8 @@ class BaseAgentSpec(BaseModel):
     description: Annotated[str, Field(json_schema_extra={"min_length_str":1})]
     context_access_enabled: bool = True
     context_variables: Optional[List[str]] = []
+    voice_configuration_id: Optional[str] = None
+    voice_configuration: Optional[str] = None
 
     def dump_spec(self, file: str) -> None:
         dumped = self.model_dump(mode='json', exclude_unset=True, exclude_none=True)

ibm_watsonx_orchestrate/agent_builder/knowledge_bases/types.py

@@ -86,11 +86,10 @@ class GenerationConfiguration(BaseModel):
     {
         "model_id": "meta-llama/llama-3-1-70b-instruct",
         "prompt_instruction": "When the documents are in different languages, you should respond in english.",
-        "retrieval_confidence_threshold": "Lowest",
         "generated_response_length": "Moderate",
-        "response_confidence_threshold": "Low",
         "display_text_no_results_found": "no docs found",
         "display_text_connectivity_issue": "conn failed",
+        "idk_message": "I dont know",
     }
     """
 
@@ -99,6 +98,7 @@ class GenerationConfiguration(BaseModel):
     generated_response_length: Optional[GeneratedResponseLength] = None
     display_text_no_results_found: Optional[str] = None
     display_text_connectivity_issue: Optional[str] = None
+    idk_message: Optional[str] = None
 
 class FieldMapping(BaseModel):
     """

ibm_watsonx_orchestrate/agent_builder/models/types.py

@@ -87,6 +87,11 @@ class ProviderConfig(BaseModel):
     azure_entra_tenant_id: Optional[str] = Field(None, alias="azureEntraTenantId")
     azure_ad_token: Optional[str] = Field(None, alias="azureAdToken")
     azure_model_name: Optional[str] = Field(None, alias="azureModelName")
+    azure_inference_deployment_name: Optional[str] = Field(None, alias="azureDeploymentName")
+    azure_inference_api_version: Optional[str] = Field(None, alias="azureApiVersion")
+    azure_inference_extra_params: Optional[str] = Field(None, alias="azureExtraParams")
+    azure_inference_foundry_url: Optional[str] = Field(None, alias="azureFoundryUrl")
+
 
     # Workers AI specific
     workers_ai_account_id: Optional[str] = Field(None, alias="workersAiAccountId")

ibm_watsonx_orchestrate/agent_builder/tools/python_tool.py

@@ -187,15 +187,27 @@ def _fix_optional(schema):
     replacements = {}
     if schema.required is None:
         schema.required = []
-
     for k, v in schema.properties.items():
+        # Simple null type & required -> not required
         if v.type == 'null' and k in schema.required:
             not_required.append(k)
-        if v.anyOf is not None and next(filter(lambda x: x.type == 'null', v.anyOf)) and k in schema.required:
-            v.anyOf = list(filter(lambda x: x.type != 'null', v.anyOf))
-            if len(v.anyOf) == 1:
-                replacements[k] = v.anyOf[0]
-            not_required.append(k)
+        # Optional with null & required
+        if v.anyOf is not None and [x for x in v.anyOf if x.type == 'null']:
+            if k in schema.required:
+            # required with default -> not required 
+            # required without default -> required & remove null from union
+                if v.default:
+                    not_required.append(k)
+                else:
+                    v.anyOf = list(filter(lambda x: x.type != 'null', v.anyOf))
+                if len(v.anyOf) == 1:
+                    replacements[k] = v.anyOf[0]
+            else:
+            # not required with default -> no change
+            # not required without default -> means default input is 'None'
+                v.default = v.default if v.default else 'null'
+
+
     schema.required = list(filter(lambda x: x not in not_required, schema.required if schema.required is not None else []))
     for k, v in replacements.items():
         combined = {
@@ -204,7 +216,7 @@ def _fix_optional(schema):
         }
         schema.properties[k] = JsonSchemaObject(**combined)
         schema.properties[k].anyOf = None
-
+        
     for k in schema.properties.keys():
         if schema.properties[k].type == 'object':
             schema.properties[k] = _fix_optional(schema.properties[k])

ibm_watsonx_orchestrate/agent_builder/tools/types.py

@@ -36,6 +36,7 @@ class JsonSchemaObject(BaseModel):
     anyOf: Optional[List['JsonSchemaObject']] = None
     in_field: Optional[Literal['query', 'header', 'path', 'body']] = Field(None, alias='in')
     aliasName: str | None = None
+    wrap_data: Optional[bool] = True
     "Runtime feature where the sdk can provide the original name of a field before prefixing"
 
     @model_validator(mode='after')
@@ -48,9 +49,9 @@ class JsonSchemaObject(BaseModel):
 class ToolRequestBody(BaseModel):
     model_config = ConfigDict(extra='allow')
 
-    type: Literal['object']
-    properties: Dict[str, JsonSchemaObject]
-    required: Optional[List[str]] = None
+    type: Literal['object', 'string']
+    properties: Optional[Dict[str, JsonSchemaObject]] = {}
+    required: Optional[List[str]] = []
 
 
 class ToolResponseBody(BaseModel):
@@ -186,6 +187,7 @@ class ToolBinding(BaseModel):
 
 class ToolSpec(BaseModel):
     name: str
+    id: str | None = None
     display_name: str | None = None
     description: str
     permission: ToolPermission

ibm_watsonx_orchestrate/agent_builder/voice_configurations/__init__.py

@@ -0,0 +1 @@
+from .types import VoiceConfiguration

ibm_watsonx_orchestrate/agent_builder/voice_configurations/types.py

@@ -0,0 +1,98 @@
+import json
+from typing import Annotated, Optional, List, Dict
+from pydantic import BaseModel, Field, model_validator
+
+def _validate_exactly_one_of_fields(object: BaseModel, object_name: str, fields: list[str]):
+  present_fields = [getattr(object,field) for field in fields if getattr(object,field) is not None]
+
+  if len(present_fields) != 1:
+    raise ValueError(f"{object_name} requires exactly one of {','.join(fields)}")
+
+
+def _validate_language_uniqueness(config: BaseModel):
+  if hasattr(config,'language') and hasattr(config,'additional_languages'):
+    if config.language and config.additional_languages and config.language in config.additional_languages:
+      raise ValueError(f"Language '{config.language}' cannot be in both the default language and additional_languages")
+
+
+class WatsonSTTConfig(BaseModel):
+  api_url: Annotated[str, Field(min_length=1,max_length=2048)]
+  api_key: Optional[Annotated[str, Field(min_length=1,max_length=2048)]] = None
+  bearer_token: Optional[Annotated[str, Field(min_length=1,max_length=2048)]] = None
+  model: Annotated[str, Field(min_length=1,max_length=256)]
+
+class EmotechSTTConfig(BaseModel):
+  api_key: Annotated[str,Field(min_length=1,max_length=2048)]
+  api_url: Annotated[str,Field(min_length=1,max_length=2048)]
+
+
+class SpeechToTextConfig(BaseModel):
+  provider: Annotated[str, Field(min_length=1,max_length=128)]
+  watson_stt_config: Optional[WatsonSTTConfig] = None
+  emotech_stt_config: Optional[EmotechSTTConfig] = None
+
+  @model_validator(mode='after')
+  def validate_providers(self):
+    _validate_exactly_one_of_fields(self,'SpeechToTextConfig',['watson_stt_config','emotech_stt_config'])
+    return self
+
+class WatsonTTSConfig(BaseModel):
+  api_url: Annotated[str, Field(min_length=1,max_length=2048)]
+  api_key: Optional[Annotated[str, Field(min_length=1,max_length=2048)]] = None
+  bearer_token: Optional[Annotated[str, Field(min_length=1,max_length=2048)]] = None
+  voice: Annotated[str, Field(min_length=1,max_length=128)]
+  rate_percentage: Optional[int] = None
+  pitch_percentage: Optional[int] = None
+  language: Optional[str] = None
+
+class EmotechTTSConfig(BaseModel):
+  api_url: Annotated[str, Field(min_length=1,max_length=2048)]
+  api_key: Annotated[str, Field(min_length=1,max_length=2048)]
+  voice: Optional[Annotated[str, Field(min_length=1,max_length=128)]]
+
+class TextToSpeechConfig(BaseModel):
+  provider: Annotated[str, Field(min_length=1,max_length=128)]
+  watson_tts_config: Optional[WatsonTTSConfig] = None
+  emotech_tts_config: Optional[EmotechTTSConfig] = None
+
+  @model_validator(mode='after')
+  def validate_providers(self):
+    _validate_exactly_one_of_fields(self,'TextToSpeechConfig',['watson_tts_config','emotech_tts_config'])
+    return self
+
+class AdditionalProperties(BaseModel):
+  speech_to_text: Optional[SpeechToTextConfig] = None
+  text_to_speech: Optional[TextToSpeechConfig] = None
+
+class DTMFInput(BaseModel):
+  inter_digit_timeout_ms: Optional[int] = None
+  termination_key: Optional[str] = None
+  maximum_count: Optional[int] = None
+  ignore_speech: Optional[bool] = None
+
+class AttachedAgent(BaseModel):
+  id: str
+  name: Optional[str] = None
+  display_name: Optional[str] = None
+
+class VoiceConfiguration(BaseModel):
+  name: Annotated[str, Field(min_length=1,max_length=128)]
+  speech_to_text: SpeechToTextConfig
+  text_to_speech: TextToSpeechConfig
+  language: Optional[Annotated[str,Field(min_length=2,max_length=16)]] = None
+  additional_languages: Optional[dict[str,AdditionalProperties]] = None
+  dtmf_input: Optional[DTMFInput] = None
+  voice_configuration_id: Optional[str] = None
+  tenant_id: Optional[Annotated[str, Field(min_length=1,max_length=128)]] = None
+  attached_agents: Optional[list[AttachedAgent]] = None
+
+  @model_validator(mode='after')
+  def validate_language(self):
+    _validate_language_uniqueness(self)
+    return self
+
+  def dumps_spec(self) -> str:
+    dumped = self.model_dump(mode='json', exclude_none=True)
+    return json.dumps(dumped, indent=2)
+
+

ibm_watsonx_orchestrate/cli/commands/agents/agents_command.py

@@ -253,3 +253,23 @@ def export_agent(
 ):  
     agents_controller = AgentsController()
     agents_controller.export_agent(name=name, kind=kind, output_path=output_file, agent_only_flag=agent_only_flag)
+
+@agents_app.command(name="deploy", help="Deploy Agent")
+def deploy_agent(
+    name: Annotated[
+        str,
+        typer.Option("--name", "-n", help="Name of the agent you wish to deploy"),
+    ]
+):
+    agents_controller = AgentsController()
+    agents_controller.deploy_agent(name=name)
+
+@agents_app.command(name="undeploy", help="Undeploy Agent")
+def undeploy_agent(
+    name: Annotated[
+        str,
+        typer.Option("--name", "-n", help="Name of the agent you wish to undeploy"),
+    ]
+):
+    agents_controller = AgentsController()
+    agents_controller.undeploy_agent(name=name)

ibm_watsonx_orchestrate/cli/commands/agents/agents_controller.py

@@ -29,13 +29,17 @@ from ibm_watsonx_orchestrate.client.agents.agent_client import AgentClient, Agen
 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
+from ibm_watsonx_orchestrate.client.voice_configurations.voice_configurations_client import VoiceConfigurationsClient
 from ibm_watsonx_orchestrate.utils.exceptions import BadRequest
 from ibm_watsonx_orchestrate.client.connections import get_connections_client
 from ibm_watsonx_orchestrate.client.knowledge_bases.knowledge_base_client import KnowledgeBaseClient
 
-from ibm_watsonx_orchestrate.client.utils import instantiate_client
+from ibm_watsonx_orchestrate.client.utils import instantiate_client, is_local_dev
 from ibm_watsonx_orchestrate.utils.utils import check_file_in_zip
 
+from rich.console import Console
+from rich.progress import Progress, SpinnerColumn, TextColumn
+
 logger = logging.getLogger(__name__)
 
 # Helper generic type for any agent
@@ -197,6 +201,7 @@ def get_app_id_from_conn_id(conn_id: str) -> str:
         exit(1)
     return app_id
 
+
 def get_agent_details(name: str, client: AgentClient | ExternalAgentClient | AssistantAgentClient) -> dict:
     agent_specs = client.get_draft_by_name(name)
     if len(agent_specs) > 1:
@@ -219,6 +224,7 @@ class AgentsController:
         self.assistant_client = None
         self.tool_client = None
         self.knowledge_base_client = None
+        self.voice_configuration_client = None
 
     def get_native_client(self):
         if not self.native_client:
@@ -245,6 +251,11 @@ class AgentsController:
             self.knowledge_base_client = instantiate_client(KnowledgeBaseClient)
         return self.knowledge_base_client
     
+    def get_voice_configuration_client(self):
+        if not self.voice_configuration_client:
+            self.voice_configuration_client = instantiate_client(VoiceConfigurationsClient)
+        return self.voice_configuration_client
+    
     @staticmethod
     def import_agent(file: str, app_id: str) -> List[Agent | ExternalAgent | AssistantAgent]:
         agents = parse_file(file)
@@ -520,6 +531,38 @@ class AgentsController:
                 guideline.tool = name
 
         return ref_agent
+    
+    def get_voice_config_name_from_id(self, voice_config_id: str) -> str | None:
+        client = self.get_voice_configuration_client()
+        config = client.get_by_id(voice_config_id)
+        return config.name if config else None
+
+    def get_voice_config_id_from_name(self, voice_config_name: str) -> str | None:
+        client = self.get_voice_configuration_client()
+        configs = client.get_by_name(voice_config_name)
+
+        if len(configs) == 0:
+            logger.error(f"No voice_configs with the name '{voice_config_name}' found. Failed to get config")
+            sys.exit(1)
+        
+        if len(configs) > 1:
+            logger.error(f"Multiple voice_configs with the name '{voice_config_name}' found. Failed to get config")
+            sys.exit(1)
+        
+        return configs[0].voice_configuration_id
+
+
+    def reference_voice_config(self,agent: Agent):
+        deref_agent = deepcopy(agent)
+        deref_agent.voice_configuration = self.get_voice_config_name_from_id(agent.voice_configuration_id)
+        del deref_agent.voice_configuration_id
+        return deref_agent
+
+    def dereference_voice_config(self,agent: Agent):
+        ref_agent = deepcopy(agent)
+        ref_agent.voice_configuration_id = self.get_voice_config_id_from_name(agent.voice_configuration)
+        del ref_agent.voice_configuration
+        return ref_agent
 
     @staticmethod
     def dereference_app_id(agent: ExternalAgent | AssistantAgent) -> ExternalAgent | AssistantAgent:
@@ -540,7 +583,18 @@ class AgentsController:
             agent.config.connection_id = None
 
         return agent
+    
+    def dereference_common_agent_dependencies(self, agent: AnyAgentT) -> AnyAgentT:
+        if agent.voice_configuration:
+            agent = self.dereference_voice_config(agent)
+
+        return agent  
+
+    def reference_common_agent_dependencies(self, agent: AnyAgentT) -> AnyAgentT:
+        if agent.voice_configuration_id:
+            agent = self.reference_voice_config(agent)
 
+        return agent
 
     def dereference_native_agent_dependencies(self, agent: Agent) -> Agent:
         if agent.collaborators and len(agent.collaborators):
@@ -584,6 +638,8 @@ class AgentsController:
     
     # Convert all names used in an agent to the corresponding ids
     def dereference_agent_dependencies(self, agent: AnyAgentT) -> AnyAgentT:
+
+        agent = self.dereference_common_agent_dependencies(agent)
         if isinstance(agent, Agent):
             return self.dereference_native_agent_dependencies(agent)
         if isinstance(agent, ExternalAgent) or isinstance(agent, AssistantAgent):
@@ -591,6 +647,8 @@ class AgentsController:
 
     # Convert all ids used in an agent to the corresponding names
     def reference_agent_dependencies(self, agent: AnyAgentT) -> AnyAgentT:
+
+        agent = self.reference_common_agent_dependencies(agent)
         if isinstance(agent, Agent):
             return self.reference_native_agent_dependencies(agent)
         if isinstance(agent, ExternalAgent) or isinstance(agent, AssistantAgent):
@@ -1111,3 +1169,114 @@ class AgentsController:
             logger.info(f"Successfully wrote agents and tools to '{output_path}'")
             zip_file_out.close()
 
+
+    def deploy_agent(self, name: str):
+        if is_local_dev():
+            logger.error("Agents cannot be deployed in Developer Edition")
+            sys.exit(1)
+        native_client = self.get_native_client()
+        external_client = self.get_external_client()
+        assistant_client = self.get_assistant_client()
+
+        existing_native_agents = native_client.get_draft_by_name(name)
+        existing_external_agents = external_client.get_draft_by_name(name)
+        existing_assistant_agents = assistant_client.get_draft_by_name(name)
+
+        if len(existing_native_agents) == 0 and (len(existing_external_agents) >= 1 or len(existing_assistant_agents) >= 1):
+            logger.error(f"No native agent found with name '{name}'. Only Native Agents can be deployed to a Live Environment")
+            sys.exit(1)
+        if len(existing_native_agents) > 1:
+            logger.error(f"Multiple native agents with the name '{name}' found. Failed to get agent")
+            sys.exit(1)
+        if len(existing_native_agents) == 0:
+            logger.error(f"No native agents with the name '{name}' found. Failed to get agent")
+            sys.exit(1)
+            
+
+        agent_details = existing_native_agents[0]
+        agent_id = agent_details.get("id")
+
+        environments = native_client.get_environments_for_agent(agent_id)
+
+        live_environment = [env for env in environments if env.get("name") == "live"]
+        if live_environment is None:
+            logger.error("No live environment found for this tenant")
+            sys.exit(1)
+
+        live_env_id = live_environment[0].get("id")
+
+        console = Console()
+        with Progress(
+            SpinnerColumn(spinner_name="dots"),
+            TextColumn("[progress.description]{task.description}"),
+            transient=True,
+            console=console,
+                ) as progress:
+                    progress.add_task(description="Deploying agent to Live envrionment", total=None)
+
+                    status = native_client.deploy(agent_id, live_env_id)
+
+        if status:
+            logger.info(f"Successfully deployed agent {name}")
+        else:
+            logger.error(f"Error deploying agent {name}")
+
+    def undeploy_agent(self, name: str):
+        if is_local_dev():
+            logger.error("Agents cannot be undeployed in Developer Edition")
+            sys.exit(1)
+        
+        native_client = self.get_native_client()
+        external_client = self.get_external_client()
+        assistant_client = self.get_assistant_client()
+
+        existing_native_agents = native_client.get_draft_by_name(name)
+        existing_external_agents = external_client.get_draft_by_name(name)
+        existing_assistant_agents = assistant_client.get_draft_by_name(name)
+
+        if len(existing_native_agents) == 0 and (len(existing_external_agents) >= 1 or len(existing_assistant_agents) >= 1):
+            logger.error(f"No native agent found with name '{name}'. Only Native Agents can be undeployed from a Live Environment")
+            sys.exit(1)
+        if len(existing_native_agents) > 1:
+            logger.error(f"Multiple native agents with the name '{name}' found. Failed to get agent")
+            sys.exit(1)
+        if len(existing_native_agents) == 0:
+            logger.error(f"No native agents with the name '{name}' found. Failed to get agent")
+            sys.exit(1)
+
+        agent_details = existing_native_agents[0]
+        agent_id = agent_details.get("id")
+
+        environments = native_client.get_environments_for_agent(agent_id)
+        live_environment = [env for env in environments if env.get("name") == "live"]
+        if live_environment is None:
+            logger.error("No live environment found for this tenant")
+            sys.exit(1)
+        version_id = live_environment[0].get("current_version")
+
+        if version_id is None:
+            agent_name = agent_details.get("name")
+            logger.error(f"Agent {agent_name} does not exist in a Live environment")
+            sys.exit(1)
+
+        draft_environment = [env for env in environments if env.get("name") == "draft"]
+        if draft_environment is None:
+            logger.error("No draft environment found for this tenant")
+            sys.exit(1)
+        draft_env_id = draft_environment[0].get("id")
+
+        console = Console()
+        with Progress(
+            SpinnerColumn(spinner_name="dots"),
+            TextColumn("[progress.description]{task.description}"),
+            transient=True,
+            console=console,
+                ) as progress:
+                    progress.add_task(description="Undeploying agent to Draft envrionment", total=None)
+
+                    status = native_client.undeploy(agent_id, version_id, draft_env_id)
+        if status:
+            logger.info(f"Successfully undeployed agent {name}")
+        else:
+            logger.error(f"Error undeploying agent {name}")
+

ibm_watsonx_orchestrate/cli/commands/connections/connections_controller.py

@@ -404,8 +404,11 @@ def list_connections(environment: ConnectionEnvironment | None, verbose: bool =
                     "❌"
                 )
                 continue
-
-            connection_type = get_connection_type(security_scheme=conn.security_scheme, auth_type=conn.auth_type)
+            
+            try:
+                connection_type = get_connection_type(security_scheme=conn.security_scheme, auth_type=conn.auth_type)
+            except:
+                connection_type = conn.auth_type
 
             if conn.environment == ConnectionEnvironment.DRAFT:
                 draft_table.add_row(