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

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/cli/commands/server/server_command.py

@@ -46,15 +46,7 @@ _ALWAYS_UNSET: set[str] = {
   
 def define_saas_wdu_runtime(value: str = "none") -> None:
     cfg = Config()
-
-    current_config_file_values = cfg.get(USER_ENV_CACHE_HEADER)
-    current_config_file_values["SAAS_WDU_RUNTIME"] = value
-
-    cfg.save(
-        {
-            USER_ENV_CACHE_HEADER: current_config_file_values
-        }
-    )
+    cfg.write(USER_ENV_CACHE_HEADER,"SAAS_WDU_RUNTIME",value)
 
 def ensure_docker_installed() -> None:
     try:
@@ -390,6 +382,8 @@ def run_compose_lite(final_env_file: Path, experimental_with_langfuse=False, exp
         "up",
         "--scale",
         "ui=0",
+        "--scale",
+        "cpe=0",
         "-d",
         "--remove-orphans",
     ]
@@ -883,7 +877,7 @@ def server_start(
     if experimental_with_langfuse:
         logger.info(f"You can access the observability platform Langfuse at http://localhost:3010, username: orchestrate@ibm.com, password: orchestrate")
     if with_doc_processing:
-        logger.info(f"Document processing capabilities are now available for use in Flows (both ADK and runtime). Note: This option is currently available only in the Developer edition.")
+        logger.info(f"Document processing in Flows (Public Preview) has been enabled.")
 
 @server_app.command(name="stop")
 def server_stop(

ibm_watsonx_orchestrate/cli/main.py

@@ -1,3 +1,4 @@
+
 import typer
 import sys
 
@@ -14,6 +15,7 @@ from ibm_watsonx_orchestrate.cli.commands.channels.channels_command import chann
 from ibm_watsonx_orchestrate.cli.commands.knowledge_bases.knowledge_bases_command import knowledge_bases_app
 from ibm_watsonx_orchestrate.cli.commands.toolkit.toolkit_command import toolkits_app
 from ibm_watsonx_orchestrate.cli.commands.evaluations.evaluations_command import evaluation_app
+from ibm_watsonx_orchestrate.cli.commands.copilot.copilot_command import copilot_app
 from ibm_watsonx_orchestrate.cli.init_helper import init_callback
 
 import urllib3
@@ -38,6 +40,7 @@ app.add_typer(chat_app, name="chat", help='Launch the chat ui for your local Dev
 app.add_typer(models_app, name="models", help='List the available large language models (llms) that can be used in your agent definitions')
 app.add_typer(channel_app, name="channels", help="Configure channels where your agent can exist on (such as embedded webchat)")
 app.add_typer(evaluation_app, name="evaluations", help='Evaluate the performance of your agents in your active env')
+app.add_typer(copilot_app, name="copilot", help='Access AI powered assistance to help refine your agents')
 app.add_typer(settings_app, name="settings", help='Configure the settings for your active env')
 
 if __name__ == "__main__":

ibm_watsonx_orchestrate/client/base_api_client.py

@@ -3,6 +3,7 @@ import json
 import requests
 from abc import ABC, abstractmethod
 from ibm_cloud_sdk_core.authenticators import MCSPAuthenticator
+from typing_extensions import List
 
 
 class ClientAPIException(requests.HTTPError):
@@ -62,6 +63,17 @@ class BaseAPIClient:
         self._check_response(response)
         return response.json() if response.text else {}
     
+    def _post_nd_json(self, path: str, data: dict = None, files: dict = None) -> List[dict]:
+        url = f"{self.base_url}{path}"
+        response = requests.post(url, headers=self._get_headers(), json=data, files=files)
+        self._check_response(response)
+
+        res = []
+        if response.text:
+            for line in response.text.splitlines():
+                res.append(json.loads(line))
+        return res
+    
     def _post_form_data(self, path: str, data: dict = None, files: dict = None) -> dict:
         url = f"{self.base_url}{path}"
         # Use data argument instead of json so data is encoded as application/x-www-form-urlencoded

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/client/copilot/cpe/copilot_cpe_client.py

@@ -0,0 +1,67 @@
+from typing import Dict, Any
+from uuid import uuid4
+
+from ibm_watsonx_orchestrate.client.base_api_client import BaseAPIClient
+
+
+class CPEClient(BaseAPIClient):
+    """
+    Client to handle CRUD operations for Conversational Prompt Engineering Service
+    """
+
+    def __init__(self, *args, **kwargs):
+        self.chat_id = str(uuid4())
+        super().__init__(*args, **kwargs)
+        self.base_url = kwargs.get("base_url", self.base_url)
+        self.chat_model_name = 'llama-3-3-70b-instruct'
+
+    def _get_headers(self) -> dict:
+        return {
+            "chat_id": self.chat_id
+        }
+
+
+    def submit_pre_cpe_chat(self, user_message: str | None =None, tools: Dict[str, Any] = None, agents: Dict[str, Any] = None) -> dict:
+        payload = {
+            "message": user_message,
+            "tools": tools,
+            "agents": agents,
+            "chat_id": self.chat_id,
+            "chat_model_name": self.chat_model_name
+        }
+
+        response = self._post_nd_json("/wxo-cpe/create-agent", data=payload)
+
+        if response:
+            return response[-1]
+
+
+    def init_with_context(self, model: str | None = None, context_data: Dict[str, Any] = None) -> dict:
+        payload = {
+            "context_data": context_data,
+            "chat_id": self.chat_id
+        }
+
+        if model:
+            payload["target_model_name"] = model
+
+        response = self._post_nd_json("/wxo-cpe/init_cpe_from_wxo", data=payload)
+
+        if response:
+            return response[-1]
+
+
+    def invoke(self, prompt: str, model: str | None = None, context_data: Dict[str, Any] = None) -> dict:
+        payload = {
+            "prompt": prompt,
+            "context_data": context_data,
+            "chat_id": self.chat_id
+        }
+
+        if model:
+            payload["target_model_name"] = model
+
+        response = self._post_nd_json("/wxo-cpe/invoke", data=payload)
+
+        if response:
+            return response[-1]

ibm_watsonx_orchestrate/client/utils.py

@@ -16,22 +16,26 @@ 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 +51,58 @@ 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_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 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 check_token_validity(token: str) -> bool:
     try:
         token_claimset = jwt.decode(token, options={"verify_signature": False})

ibm_watsonx_orchestrate/docker/compose-lite.yml

@@ -46,7 +46,7 @@ services:
       WXO_SERVER_URL: http://wxo-server:4321
       MAX_POOL: 60
       DEPLOYMENT_MODE: laptop
-      SUFFIXLIST: '["global_05d7ba72", "ibm_184bdbd3"]'
+      SUFFIXLIST: ${CM_SUFFIXLIST:-[]}
     ports:
       - 3001:3001
 
@@ -796,6 +796,23 @@ services:
       - 9044:9044
     depends_on:
       - wxo-server-db
+  
+  cpe:
+    image: ${CPE_REGISTRY:-us.icr.io/watson-orchestrate-private}/wxo-prompt-optimizer:${CPE_TAG:-latest}
+    platform: linux/amd64
+    restart: unless-stopped
+    environment:
+      WATSONX_APIKEY: ${WATSONX_APIKEY}
+      WATSONX_SPACE_ID: ${WATSONX_SPACE_ID}
+      WO_API_KEY: ${WO_API_KEY}
+      WO_USERNAME: ${WO_USERNAME}
+      WO_PASSWORD: ${WO_PASSWORD}
+      WO_INSTANCE: ${WO_INSTANCE}
+      USE_SAAS_ML_TOOLS_RUNTIME: ${USE_SAAS_ML_TOOLS_RUNTIME}
+      WO_AUTH_TYPE: ${WO_AUTH_TYPE}
+      AUTHORIZATION_URL: ${AUTHORIZATION_URL}
+    ports:
+      - 8081:8080
 
 ########################
 # DOCPROC dependencies
@@ -899,7 +916,7 @@ services:
       ENRICHMENT_BATCH_SIZE: "1000"
       CIPHER_AES_REALM_KEY: "dGVzdHRlc3R0ZXN0dGVzdA=="
       SIDECAR_METERED_ENABLED: "false"
-      DPI_DEBUG: true
+      DPI_DEBUG: "false"
       DPI_WO_WDU_SERVER_ENDPOINT: https://wxo-doc-processing-service:8080
       # DPI_RAG_SERVER_ENDPOINT: https://wxo-doc-processing-llm-service:8083
       DISABLE_TLS: true

ibm_watsonx_orchestrate/docker/default.env

@@ -53,10 +53,10 @@ EVENT_BROKER_TTL="-1"
 REGISTRY_URL=
 
 
-SERVER_TAG=02-07-2025
+SERVER_TAG=10-07-2025-beb40a3a
 SERVER_REGISTRY=
 
-WORKER_TAG=02-07-2025
+WORKER_TAG=10-07-2025-beb40a3a
 WORKER_REGISTRY=
 
 AI_GATEWAY_TAG=01-07-2025
@@ -73,21 +73,21 @@ AMDDBTAG=24-06-2025-v1
 ARM64DBTAG=24-06-2025-v1
 
 UI_REGISTRY=
-UITAG=27-06-2025
+UITAG=21-07-2025
 
 CM_REGISTRY=
 CM_TAG=27-06-2025
 
-TRM_TAG=26-06-2025
+TRM_TAG=08-07-2025
 TRM_REGISTRY=
 
-TR_TAG=26-06-2025
+TR_TAG=08-07-2025
 TR_REGISTRY=
 
-BUILDER_TAG=02-07-2025
+BUILDER_TAG=22-07-2025-v1
 BUILDER_REGISTRY=
 
-FLOW_RUNTIME_TAG=04-07-2025
+FLOW_RUNTIME_TAG=15-07-2025
 FLOW_RUMTIME_REGISTRY=
 
 
@@ -100,6 +100,9 @@ JAEGER_PROXY_REGISTRY=
 SOCKET_HANDLER_TAG=29-05-2025
 SOCKET_HANDLER_REGISTRY=
 
+CPE_TAG=17-07-2025
+CPE_REGISTRY=
+
 # IBM Document Processing
 WDU_TAG=2.5.0
 WDU_REGISTRY=
@@ -168,6 +171,7 @@ WO_INSTANCE=
 AUTHORIZATION_URL=
 WO_AUTH_TYPE=
 PYTHONPATH=
+CM_SUFFIXLIST=
 
 # Use your machine's local IP address for external async tool communication.
 CALLBACK_HOST_URL=

ibm_watsonx_orchestrate/flow_builder/flows/__init__.py

@@ -1,6 +1,8 @@
 from .constants import START, END, RESERVED
-from ..types import FlowContext, TaskData, TaskEventType, DocumentContent
-from ..node import UserNode, AgentNode, StartNode, EndNode, PromptNode, ToolNode
+
+from ..types import FlowContext, TaskData, TaskEventType, File, DecisionsCondition, DecisionsRule
+from ..node import UserNode, AgentNode, StartNode, EndNode, PromptNode, ToolNode, DecisionsNode
+
 from .flow import Flow, CompiledFlow, FlowRun, FlowEvent, FlowEventType, FlowFactory, MatchPolicy, WaitPolicy, ForeachPolicy, Branch, Foreach, Loop
 from .decorators import flow
 from ..data_map import Assignment, DataMap
@@ -14,7 +16,7 @@ __all__ = [
     "FlowContext",
     "TaskData",
     "TaskEventType",
-    "DocumentContent",
+    "File",
 
     "DocProcNode",
     "UserNode",
@@ -23,6 +25,7 @@ __all__ = [
     "EndNode",
     "PromptNode",
     "ToolNode",
+    "DecisionsNode",
     "Assignment",
     "DataMap",
 
@@ -38,8 +41,8 @@ __all__ = [
     "Branch",
     "Foreach",
     "Loop",
+    "DecisionsCondition",
+    "DecisionsRule",
 
-    "user",
-    "flow_spec",
     "flow"
 ]

ibm_watsonx_orchestrate/flow_builder/flows/flow.py

@@ -27,12 +27,11 @@ from ibm_watsonx_orchestrate.client.utils import instantiate_client
 from ..types import (
     EndNodeSpec, Expression, ForeachPolicy, ForeachSpec, LoopSpec, BranchNodeSpec, MatchPolicy, PromptLLMParameters, PromptNodeSpec, 
     StartNodeSpec, ToolSpec, JsonSchemaObject, ToolRequestBody, ToolResponseBody, UserFieldKind, UserFieldOption, UserFlowSpec, UserNodeSpec, WaitPolicy,
-    DocProcSpec, TextExtractionResponse, KVPInvoicesExtractionResponse, KVPUtilityBillsExtractionResponse,
-    DocumentContent
+    DocProcSpec, TextExtractionResponse, File, DecisionsNodeSpec, DecisionsRule
 )
 from .constants import CURRENT_USER, START, END, ANY_USER
 from ..node import (
-    EndNode, Node, PromptNode, StartNode, UserNode, AgentNode, DataMap, ToolNode, DocProcNode
+    EndNode, Node, PromptNode, StartNode, UserNode, AgentNode, DataMap, ToolNode, DocProcNode, DecisionsNode
 )
 from ..types import (
     AgentNodeSpec, extract_node_spec, FlowContext, FlowEventType, FlowEvent, FlowSpec,
@@ -434,6 +433,49 @@ class Flow(Node):
         node = self._add_node(node)
         return cast(PromptNode, node)
     
+    def decisions(self, 
+            name: str, 
+            display_name: str|None=None,
+            rules: list[DecisionsRule] | None = None,
+            default_actions: dict[str, Any] = None,
+            locale: str | None = None,
+            description: str | None = None,
+            input_schema: type[BaseModel]|None = None, 
+            output_schema: type[BaseModel]|None=None,
+            input_map: DataMap = None) -> PromptNode:
+
+        if name is None:
+            raise ValueError("name must be provided.")
+        
+        if rules is None:
+            raise ValueError("rules must be specified.")
+
+         # create input spec
+        input_schema_obj = _get_json_schema_obj(parameter_name = "input", type_def = input_schema)
+        output_schema_obj = _get_json_schema_obj("output", output_schema)
+
+        # Create the tool spec
+        task_spec = DecisionsNodeSpec(
+            name=name,
+            display_name=display_name if display_name is not None else name,
+            description=description,
+            rules=rules,
+            default_actions=default_actions,
+            locale=locale,
+            input_schema=_get_tool_request_body(input_schema_obj),
+            output_schema=_get_tool_response_body(output_schema_obj),
+            output_schema_object = output_schema_obj
+        )
+
+        node = DecisionsNode(spec=task_spec)
+        # setup input map
+        if input_map:
+            node.input_map = self._get_data_map(input_map)
+        
+        # add the node to the list of node
+        node = self._add_node(node)
+        return cast(DecisionsNode, node)
+    
     def docproc(self, 
             name: str, 
             task: str,
@@ -448,12 +490,10 @@ class Flow(Node):
             raise ValueError("task must be provided.")
         
         output_schema_dict = { 
-            "text_extraction" : TextExtractionResponse,
-            "kvp_invoices_extraction" : KVPInvoicesExtractionResponse,
-            "kvp_utility_bills_extraction" : KVPUtilityBillsExtractionResponse
+            "text_extraction" : TextExtractionResponse
         }
          # create input spec
-        input_schema_obj = _get_json_schema_obj(parameter_name = "input", type_def = DocumentContent)
+        input_schema_obj = _get_json_schema_obj(parameter_name = "input", type_def = File)
         output_schema_obj = _get_json_schema_obj("output", output_schema_dict[task])
         if "$defs" in output_schema_obj.model_extra:
             output_schema_obj.model_extra.pop("$defs")

ibm_watsonx_orchestrate/flow_builder/node.py

@@ -5,7 +5,7 @@ import uuid
 import yaml
 from pydantic import BaseModel, Field, SerializeAsAny
 
-from .types import EndNodeSpec, NodeSpec, AgentNodeSpec, PromptNodeSpec, StartNodeSpec, ToolNodeSpec, UserFieldKind, UserFieldOption, UserNodeSpec, DocProcSpec
+from .types import EndNodeSpec, NodeSpec, AgentNodeSpec, PromptNodeSpec, StartNodeSpec, ToolNodeSpec, UserFieldKind, UserFieldOption, UserNodeSpec, DocProcSpec, DecisionsNodeSpec
 from .data_map import DataMap
 
 class Node(BaseModel):
@@ -116,7 +116,13 @@ class DocProcNode(Node):
 
     def get_spec(self) -> DocProcSpec:
         return cast(DocProcSpec, self.spec)
+class DecisionsNode(Node):
+    def __repr__(self):
+        return f"DecisionsNode(name='{self.spec.name}', description='{self.spec.description}')"
 
+    def get_spec(self) -> DecisionsNodeSpec:
+        return cast(DecisionsNodeSpec, self.spec)
+    
 class NodeInstance(BaseModel):
     node: Node
     id: str # unique id of this task instance