ibm-watsonx-orchestrate 1.6.2__py3-none-any.whl → 1.7.0__py3-none-any.whl

ibm_watsonx_orchestrate/cli/config.py

@@ -6,6 +6,7 @@ from copy import deepcopy
 from ibm_watsonx_orchestrate.cli.commands.tools.types import RegistryType
 from ibm_watsonx_orchestrate.utils.utils import yaml_safe_load
 from enum import Enum
+from ibm_watsonx_orchestrate.utils.exceptions import BadRequest
 
 # Section Headers
 AUTH_SECTION_HEADER = "auth"
@@ -82,7 +83,6 @@ def _check_if_default_config_file(folder, file):
 def _check_if_auth_config_file(folder, file):
     return folder == AUTH_CONFIG_FILE_FOLDER and file == AUTH_CONFIG_FILE
 
-
 def clear_protected_env_credentials_token():
     auth_cfg = Config(config_file_folder=AUTH_CONFIG_FILE_FOLDER, config_file=AUTH_CONFIG_FILE)
     auth_cfg.delete(AUTH_SECTION_HEADER, PROTECTED_ENV_NAME, AUTH_MCSP_TOKEN_OPT)
@@ -91,7 +91,7 @@ def clear_protected_env_credentials_token():
 class ConfigFileTypes(str, Enum):
     AUTH = 'auth'
     CONFIG = 'config'
-
+    DOCPROC_FEATURE_CONF= 'docproc_feature'
 
 class Config:
 
@@ -209,7 +209,7 @@ class Config:
         as keys to access deeper sections of the config and then deleting the last specified key.
         """
         if len(args) < 1:
-            raise ValueError("Config.delete() requires at least one positional argument")
+            raise BadRequest("Config.delete() requires at least one positional argument")
 
         config_data = {}
         try:

ibm_watsonx_orchestrate/cli/init_helper.py

@@ -4,6 +4,7 @@ from typing import Optional
 from rich import print as pprint
 from dotenv import dotenv_values
 import typer
+import sys
 
 from ibm_watsonx_orchestrate.cli.config import Config, PYTHON_REGISTRY_HEADER, \
     PYTHON_REGISTRY_TEST_PACKAGE_VERSION_OVERRIDE_OPT
@@ -29,7 +30,6 @@ def version_callback(checkVersion: bool=True):
 
         raise typer.Exit()
 
-    
 
 def init_callback(
     ctx: typer.Context,
@@ -38,6 +38,15 @@ def init_callback(
       "--version",
       help="Show the installed version of the ADK and Developer Edition Tags",
       callback=version_callback
+    ),
+    debug: Optional[bool] = typer.Option(
+        False,
+        "--debug",
+        help="Enable debug mode"
     )
 ):
+    if debug:
+        sys.tracebacklimit = 40
+    else:
+        sys.tracebacklimit = 0
     pass

ibm_watsonx_orchestrate/cli/main.py

@@ -1,4 +1,5 @@
 import typer
+import sys
 
 from ibm_watsonx_orchestrate.cli.commands.connections.connections_command import connections_app
 from ibm_watsonx_orchestrate.cli.commands.login.login_command import login_app
@@ -24,6 +25,7 @@ app = typer.Typer(
     pretty_exceptions_enable=False,
     callback=init_callback
 )
+
 app.add_typer(login_app)
 app.add_typer(environment_app, name="env", help='Add, remove, or select the activate env other commands will interact with (either your local server or a production instance)')
 app.add_typer(agents_app, name="agents", help='Interact with the agents in your active env')

ibm_watsonx_orchestrate/client/knowledge_bases/knowledge_base_client.py

@@ -1,4 +1,4 @@
-from ibm_watsonx_orchestrate.client.base_api_client import BaseAPIClient
+from ibm_watsonx_orchestrate.client.base_api_client import BaseAPIClient, ClientAPIException
 import json
 from typing_extensions import List
 from ibm_watsonx_orchestrate.client.utils import is_local_dev

ibm_watsonx_orchestrate/client/local_service_instance.py

@@ -2,6 +2,8 @@ from ibm_watsonx_orchestrate.client.base_service_instance import BaseServiceInst
 import logging
 import requests
 from ibm_watsonx_orchestrate.client.credentials import Credentials
+import json
+import base64
 
 logger = logging.getLogger(__name__)
 
@@ -11,7 +13,7 @@ DEFAULT_TENANT = {
     "tags": ["test"]
 }
 
-DEFAULT_USER = {"username": "wxo.archer@ibm.com", "password": "watsonx"}
+DEFAULT_USER = json.loads(base64.b64decode('eyJ1c2VybmFtZSI6ICJ3eG8uYXJjaGVyQGlibS5jb20iLCJwYXNzd29yZCI6ICJ3YXRzb254In0='))
 DEFAULT_LOCAL_SERVICE_URL = "http://localhost:4321"
 DEFAULT_LOCAL_AUTH_ENDPOINT = f"{DEFAULT_LOCAL_SERVICE_URL}/api/v1/auth/token"
 DEFAULT_LOCAL_TENANT_URL = f"{DEFAULT_LOCAL_SERVICE_URL}/api/v1/tenants"

ibm_watsonx_orchestrate/client/service_instance.py

@@ -6,6 +6,7 @@
 from __future__ import annotations
 
 from ibm_cloud_sdk_core.authenticators import MCSPAuthenticator 
+from ibm_cloud_sdk_core.authenticators import MCSPV2Authenticator
 from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
 from ibm_cloud_sdk_core.authenticators import CloudPakForDataAuthenticator
 
@@ -51,24 +52,47 @@ class ServiceInstance(BaseServiceInstance):
     def _create_token(self) -> str:
         if not self._credentials.auth_type:
             if ".cloud.ibm.com" in self._credentials.url:
-                logger.warning("Using IBM IAM Auth Type. If this is incorrect please use the '--type' flag to explicitly choose one of 'ibm_iam' or 'mcsp' or 'cpd")
+                logger.warning("Using IBM IAM Auth Type. If this is incorrect please use the '--type' flag to explicitly choose one of 'mcsp', 'mcsp_v1', 'mcsp_v2' or 'cpd' ")
                 return self._authenticate(EnvironmentAuthType.IBM_CLOUD_IAM)
             elif is_cpd_env(self._credentials.url):
-                logger.warning("Using CPD Auth Type. If this is incorrect please use the '--type' flag to explicitly choose one of 'ibm_iam' or 'mcsp' or 'cpd")
+                logger.warning("Using CPD Auth Type. If this is incorrect please use the '--type' flag to explicitly choose one of 'ibm_iam', 'mcsp', 'mcsp_v1' or 'mcsp_v2' ")
                 return self._authenticate(EnvironmentAuthType.CPD)
             else:
-                logger.warning("Using MCSP Auth Type. If this is incorrect please use the '--type' flag to explicitly choose one of 'ibm_iam' or 'mcsp' or 'cpd' ")
-                return self._authenticate(EnvironmentAuthType.MCSP)
+                logger.warning("Using MCSP Auth Type. If this is incorrect please use the '--type' flag to explicitly choose one of 'ibm_iam', 'mcsp_v1', 'mcsp_v2' or 'cpd' ")
+                try:
+                    return self._authenticate(EnvironmentAuthType.MCSP_V1)
+                except:
+                    return self._authenticate(EnvironmentAuthType.MCSP_V2)
+        auth_type = self._credentials.auth_type.lower()
+        if auth_type == "mcsp":
+            try:
+                return self._authenticate(EnvironmentAuthType.MCSP_V1)
+            except:
+                return self._authenticate(EnvironmentAuthType.MCSP_V2)
+        elif auth_type == "mcsp_v1":
+            return self._authenticate(EnvironmentAuthType.MCSP_V1)
+        elif auth_type == "mcsp_v2":
+            return self._authenticate(EnvironmentAuthType.MCSP_V2)
         else:
-            return self._authenticate(self._credentials.auth_type)
+            return self._authenticate(auth_type)
 
     def _authenticate(self, auth_type: str) -> str:
         """Handles authentication based on the auth_type."""
         try:
             match auth_type:
-                case EnvironmentAuthType.MCSP:
+                case EnvironmentAuthType.MCSP | EnvironmentAuthType.MCSP_V1:
                     url = self._credentials.iam_url if self._credentials.iam_url is not None else "https://iam.platform.saas.ibm.com"
                     authenticator = MCSPAuthenticator(apikey=self._credentials.api_key, url=url)
+                case EnvironmentAuthType.MCSP_V2:
+                    url = self._credentials.iam_url if self._credentials.iam_url is not None else "https://account-iam.platform.saas.ibm.com"
+                    wxo_url = self._credentials.url
+                    instance_id = wxo_url.split("instances/")[1]
+                    authenticator = MCSPV2Authenticator(
+                        apikey=self._credentials.api_key, 
+                        url=url, 
+                        scope_collection_type="services", 
+                        scope_id=instance_id
+                    )
                 case EnvironmentAuthType.IBM_CLOUD_IAM:
                     authenticator = IAMAuthenticator(apikey=self._credentials.api_key, url=self._credentials.iam_url)
                 case EnvironmentAuthType.CPD:
@@ -100,8 +124,10 @@ class ServiceInstance(BaseServiceInstance):
                     raise ClientError(f"Unsupported authentication type: {auth_type}")
 
             return authenticator.token_manager.get_token()
+
         except Exception as e:
-            raise ClientError(f"Error getting {auth_type.upper()} Token", e)
+            raise ClientError(f"Error getting {auth_type.upper()} Token", logg_messages=False)
+
 
     
     def _is_token_refresh_possible(self) -> bool:

ibm_watsonx_orchestrate/docker/compose-lite.yml

@@ -751,8 +751,8 @@ services:
       SERVER_HTTP_PORT: "9044"
       SERVER_CONTEXT_PATH:
       SERVER_JWK_URL: https://wo-ibm-dev.verify.ibm.com/v1.0/endpoint/default/jwks
-      SERVER_STANDALONE_TASK_CALLBACK_URL: http://localhost:9044/task/callback/{thread_id}/{requestId}
-      SERVER_FLOW_CALLBACK_URL: http://localhost:9044/v1/flows/{flow_instance_id}/{task_instance_id}/resume/async
+      SERVER_STANDALONE_TASK_CALLBACK_URL: http://wxo-tempus-runtime:9044/task/callback/{thread_id}/{requestId}
+      SERVER_FLOW_CALLBACK_URL: http://wxo-tempus-runtime:9044/v1/flows/{flow_instance_id}/{task_instance_id}/resume/async
       JWT_SECRET: ${JWT_SECRET}
       SERVER_INTERNAL_PROTOCOL: http
       SERVER_INTERNAL_HOSTNAME: wxo-tempus-runtime
@@ -780,6 +780,9 @@ services:
       LANGFUSE_PUBLIC_KEY: ${LANGFUSE_PUBLIC_KEY:-pk-lf-7417757e-d6df-421b-957e-683b76acb5df}
       LANGFUSE_SECRET_KEY: ${LANGFUSE_PRIVATE_KEY:-sk-lf-7bc4da63-7b2b-40c0-b5eb-1e0cf64f9af2}
       LOG_LEVEL: info
+      DISABLE_FLOW_BINDING: true
+      DOCPROC_ENABLED: ${DOCPROC_ENABLED:-false}
+      DOCPROC_BASE_URL: http://wxo-doc-processing-infra-standalone:9080
       WO_API_KEY: ${WO_API_KEY}
       WO_INSTANCE: ${WO_INSTANCE}
       AUTHORIZATION_URL: ${AUTHORIZATION_URL}
@@ -794,6 +797,170 @@ services:
     depends_on:
       - wxo-server-db
 
+########################
+# DOCPROC dependencies
+# DPS - 18081
+# DPI - 19080 / 19443
+# WDU - 18082
+# WDU (Prometheus) - 18086
+# DPS Cache - 18083
+# LLM Service - 18084
+######################## 
+
+  wxo-doc-processing-service:
+    image: ${DOCPROC_REGISTRY:-us.icr.io/watson-orchestrate-private}/document-processing/wo_doc_processing_service:${DOCPROC_DPS_TAG:-20250606-172035-246-4191121}
+    platform: linux/amd64
+    restart: unless-stopped
+    environment:
+      SERVICE_NAME: wxo-doc-processing-service
+      LOG_LEVEL: info
+      VERIFY_CLIENT_CERT: 0
+      SERVICE_URL: ${SERVICE_URL:-https://wxo-doc-processing-cache:8080}
+      RATE_LIMITING_ENABLED: "false"
+      SHOULD_CACHE_IMAGES: "false"
+      HANDWRITING_ENABLED: "true"
+      WDU_RUNTIME_URL: wdu-runtime:8080
+      WDU_TIMEOUT_SECS: "180"
+      IBM_DPS_CACHE_SERVICE: https://wxo-doc-processing-cache:8080
+    profiles:
+      - docproc
+    # depends_on:
+      # wxo-doc-processing-cache:
+        # condition: service_healthy
+    ports:
+      - "18081:8080"
+    healthcheck:
+      test: ["CMD-SHELL", "curl -fk https://localhost:8080/ping"]
+      interval: 30s
+      timeout: 30s
+      retries: 10
+
+  wdu-runtime:
+    image: ${WDU_REGISTRY:-us.icr.io/watson-orchestrate-private}/document-processing/wdu-runtime:${WDU_TAG:-2.4.0}
+    platform: linux/amd64
+    restart: unless-stopped
+    environment:
+      MEMORY_MINIMAL: "true"
+      PREFLIGHT_MAX_SIZE: 10Mb
+      PREFLIGHT_MAX_PAGES: 600
+      RUNTIME_LIBRARY: "watson_doc_understanding"
+    profiles:
+      - docproc
+    ports:
+      - "18082:8080"
+      - "18086:8086"
+    volumes:
+      - "wdu-models:/models"
+      - "wdu-prometheus-files:/prometheus/"
+    tmpfs:
+      - "/dev/shm"
+    healthcheck:
+      test: ["CMD-SHELL", "/app/check_heartbeat.sh /tmp/heartbeat.txt 120"]
+      interval: 30s
+      timeout: 30s
+      retries: 10
+    depends_on:
+      wdu-model-copy:
+        condition: service_completed_successfully
+
+  wdu-model-copy:
+    image: ${WDU_REGISTRY:-us.icr.io/watson-orchestrate-private}/document-processing/wdu-models:${WDU_TAG:-2.4.0}
+    platform: linux/amd64
+    user: root
+    profiles:
+      - docproc
+    environment:
+      DEST_FOLDER: "/app/models"
+    volumes:
+      - "wdu-models:/app/models"
+      - "wdu-prometheus-files:/prometheus/"
+    tmpfs:
+      - "/dev/shm"
+
+  wxo-doc-processing-infra-standalone:
+    image: ${DOCPROC_REGISTRY:-us.icr.io/watson-orchestrate-private}/document-processing/wo-doc-processing-infra-standalone:${DOCPROC_DPI_TAG:-2025-06-13-dev-1}
+    platform: linux/amd64
+    profiles:
+      - docproc
+    environment:
+      PGHOST: wxo-server-db
+      PGPORT: "5432"
+      PGUSER: ${POSTGRES_USER:-postgres}
+      PGPASSWORD: ${POSTGRES_PASSWORD:-postgres}
+      PGDATABASE: wxo-document-processing-dpi
+      PGURL: "jdbc:postgresql://localhost:5432/wxo-document-processing-dpi?user=${POSTGRES_USER:-postgres}&password=${POSTGRES_PASSWORD:-postgres}"
+      USE_PGBOUNCER: "false"
+      S3_ACCESS_KEY: ${MINIO_ROOT_USER:-minioadmin}
+      S3_SECRET_KEY: ${MINIO_ROOT_PASSWORD:-watsonxorchestrate}
+      S3_ENDPOINT_URL: http://wxo-server-minio:9000
+      BUCKET_NAME_DEFAULT: wxo-document-processing-dpi-common
+      S3_FILERESOURCE_BUCKET: ${BUCKET_NAME_DEFAULT:-wxo-document-processing-dpi}
+      # S3_TLS_ENABLED: "true"
+      ENRICHMENT_BATCH_SIZE: "1000"
+      CIPHER_AES_REALM_KEY: "dGVzdHRlc3R0ZXN0dGVzdA=="
+      SIDECAR_METERED_ENABLED: "false"
+      DPI_DEBUG: true
+      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
+      STANDALONE_DPI: "true"
+    depends_on:
+      wxo-doc-processing-dpi-minio-init:
+        condition: service_completed_successfully
+      wxo-doc-processing-infra-pg-init:
+        condition: service_completed_successfully
+      wxo-doc-processing-service:
+        condition: service_healthy
+      # wxo-doc-processing-llm-service:
+      #   condition: service_healthy
+    ports:
+      - 19080:9080
+      - 19443:9443
+    healthcheck:
+      test: ["CMD-SHELL", "HEALTHCHECK_URL=http://localhost:9080/dps/v1/health /healthcheck-all.sh all"]
+      interval: 30s
+      timeout: 30s
+      retries: 10
+
+  wxo-doc-processing-infra-pg-init:
+    image: ${DOCPROC_REGISTRY:-us.icr.io/watson-orchestrate-private}/document-processing/wo-doc-processing-infra-pg-init:${DOCPROC_DPI_TAG:-2025-06-13-dev-1}
+    platform: linux/amd64
+    environment: 
+      PGHOST: wxo-server-db
+      PGPORT: "5432"
+      PGUSER: ${POSTGRES_USER:-postgres}
+      PGPASSWORD: ${POSTGRES_PASSWORD:-postgres}
+      PGDATABASE: wxo-document-processing-dpi
+      PGURL: "jdbc:postgresql://localhost:5432/wxo-document-processing-dpi?user=${POSTGRES_USER:-postgres}&password=${POSTGRES_PASSWORD:-postgres}"
+      USE_PGBOUNCER: "false"
+    entrypoint: /liquibase-init.sh
+      - pgbouncer
+    profiles:
+      - docproc
+    depends_on:
+      wxo-server-db:
+        condition: service_started
+    healthcheck:
+      test: ["CMD-SHELL", "psql -h localhost -U ${POSTGRES_USER:-postgres} -d ${POSTGRES_PASSWORD:-postgres}"]
+      interval: 1s
+      timeout: 5s
+      retries: 50
+
+  wxo-doc-processing-dpi-minio-init:
+    image: ${OPENSOURCE_REGISTRY_PROXY:-docker.io}/minio/mc:latest
+    platform: linux/amd64
+    profiles:
+      - docproc
+    depends_on:
+      wxo-server-minio:
+        condition: service_healthy
+    entrypoint: >
+      /bin/sh -c "
+      /usr/bin/mc alias set wxo-server-minio http://wxo-server-minio:9000 ${MINIO_ROOT_USER:-minioadmin} ${MINIO_ROOT_PASSWORD:-watsonxorchestrate};
+      /usr/bin/mc mb wxo-server-minio/wxo-document-processing-dpi;
+      exit 0;
+      "
+
 volumes:
   tools:
     driver: local
@@ -817,6 +984,14 @@ volumes:
     driver: local
   langfuse_clickhouse_logs:
     driver: local
+  wdu-prometheus-files:
+    driver: local
+    driver_opts:
+      type: tmpfs
+      device: tmpfs
+      o: "uid=1000,gid=1000,mode=1777"
+  wdu-models:
+    driver: local
   es_data:
 
 networks:

ibm_watsonx_orchestrate/docker/default.env

@@ -62,7 +62,7 @@ WORKER_REGISTRY=
 AI_GATEWAY_TAG=01-07-2025
 AI_GATEWAY_REGISTRY=
 
-AGENT_GATEWAY_TAG=23-06-2025
+AGENT_GATEWAY_TAG=07-07-2025
 AGENT_GATEWAY_REGISTRY=
 
 DB_REGISTRY=
@@ -87,7 +87,7 @@ TR_REGISTRY=
 BUILDER_TAG=02-07-2025
 BUILDER_REGISTRY=
 
-FLOW_RUNTIME_TAG=23-06-2025
+FLOW_RUNTIME_TAG=04-07-2025
 FLOW_RUMTIME_REGISTRY=
 
 
@@ -100,6 +100,15 @@ JAEGER_PROXY_REGISTRY=
 SOCKET_HANDLER_TAG=29-05-2025
 SOCKET_HANDLER_REGISTRY=
 
+# IBM Document Processing
+WDU_TAG=2.5.0
+WDU_REGISTRY=
+
+DOCPROC_DPS_TAG=20250610-183301-248-865fbc1
+DOCPROC_LLMSERVICE_TAG=20250604-192056-107-e1d4d66
+DOCPROC_CACHE_TAG=20250610-214940-68-f3258f4
+DOCPROC_DPI_TAG=20250702-000808-237-7b1e424d
+DOCPROC_REGISTRY=
 
 # END -- IMAGE REGISTRIES AND TAGS
 
@@ -152,6 +161,13 @@ DB_CONN_LIFE=
 DB_MAX_IDLE_CONN=
 DB_MAX_CONN=
 SERVER_HOST=
+WO_API_KEY=
+WO_PASSWORD=
+WO_USERNAME=
+WO_INSTANCE=
+AUTHORIZATION_URL=
+WO_AUTH_TYPE=
+PYTHONPATH=
 
 # Use your machine's local IP address for external async tool communication.
 CALLBACK_HOST_URL=
@@ -160,3 +176,7 @@ AGENTOPS_API_KEY_AUTH_ENABLED=true
 AGENTOPS_API_KEY=qwertyuiop
 
 RUNTIME_MANAGER_API_KEY=example
+
+
+# IBM Document Processing
+SERVICE_URL=https://wxo-doc-processing-cache:8080

ibm_watsonx_orchestrate/flow_builder/flows/__init__.py

@@ -1,5 +1,5 @@
 from .constants import START, END, RESERVED
-from ..types import FlowContext, TaskData, TaskEventType
+from ..types import FlowContext, TaskData, TaskEventType, DocumentContent
 from ..node import UserNode, AgentNode, StartNode, EndNode, PromptNode, ToolNode
 from .flow import Flow, CompiledFlow, FlowRun, FlowEvent, FlowEventType, FlowFactory, MatchPolicy, WaitPolicy, ForeachPolicy, Branch, Foreach, Loop
 from .decorators import flow
@@ -14,7 +14,9 @@ __all__ = [
     "FlowContext",
     "TaskData",
     "TaskEventType",
+    "DocumentContent",
 
+    "DocProcNode",
     "UserNode",
     "AgentNode",
     "StartNode",

ibm_watsonx_orchestrate/flow_builder/flows/decorators.py

@@ -33,7 +33,8 @@ def flow(*args,
          description: str|None=None,
          input_schema: type[BaseModel] | None = None,
          output_schema: type[BaseModel] | None = None,
-         initiators: Sequence[str] = ()):
+         initiators: Sequence[str] = (),
+         schedulable: bool = False):
     """Decorator to mark a function as a flow model builder."""
 
     def decorator(func: Callable):
@@ -58,7 +59,8 @@ def flow(*args,
                              description = node_spec.description,
                              input_schema = input_schema,
                              output_schema = output_schema,
-                             initiators = initiators)
+                             initiators = initiators,
+                             schedulable = schedulable)
 
         # logger.info("Creating flow model: %s", a_model.spec.name)
 

ibm_watsonx_orchestrate/flow_builder/flows/events.py

@@ -5,9 +5,11 @@ from dotenv import load_dotenv
 import os
 
 from typing import (
-    AsyncIterator, Union
+    AsyncIterator, TypeVar, Union
 )
 
+from enum import Enum
+
 from ..types import (
     FlowEventType, TaskEventType, FlowEvent, FlowContext
 )
@@ -66,12 +68,11 @@ def deserialize_flow_event(byte_data: bytes) -> FlowEvent:
     
     return flow_event
 
+def is_valid_enum_value(value: str, enum_type: type[Enum]) -> bool:
+    return value in (item.value for item in enum_type)
+
 def get_event_type(selected_event_type: str) -> Union[FlowEventType, TaskEventType]:
-    """Selects the right event type from the corresponding enumerator"""
-    eventKind = selected_event_type.upper()
-    if eventKind in FlowEventType.__members__:
-        return FlowEventType(selected_event_type)
-    elif eventKind in TaskEventType.__members__:
-        return TaskEventType(selected_event_type)
-    else:
-        raise ValueError(f"Invalid event type: {eventKind}")
+    for enum_type in [FlowEventType, TaskEventType]:
+        if is_valid_enum_value(selected_event_type, enum_type):
+            return enum_type(selected_event_type)
+    raise ValueError(f"Invalid event type: {selected_event_type}")