ibm-watsonx-orchestrate 1.6.3__py3-none-any.whl → 1.6.4__py3-none-any.whl

ibm_watsonx_orchestrate/client/utils.py

@@ -28,7 +28,6 @@ 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)
@@ -55,7 +54,7 @@ def is_local_dev(url: str | None = None) -> bool:
 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
@@ -79,17 +78,6 @@ def is_cpd_env(url: str | None = None) -> bool:
         return True
     return False
 
-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 get_cpd_instance_id_from_url(url: str | None = None) -> str:
     if url is None:
         url = get_current_env_url()
@@ -101,6 +89,20 @@ def get_cpd_instance_id_from_url(url: str | None = None) -> str:
     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
 
@@ -302,7 +302,7 @@ services:
       JWT_PRIVATE_CONFIGS_PATH: "/"
       VECTOR_STORE_PROVIDER: ${VECTOR_STORE_PROVIDER:-milvus}
       CELERY_RESULTS_TTL: "3600"
-      EVENT_BROKER_TTL: "-1"
+      EVENT_BROKER_TTL: "3600"
       TAVILY_API_KEY: ${TAVILY_API_KEY:-dummy_tavily_api_key}
       WATSONX_APIKEY: ${WATSONX_APIKEY}
       WATSONX_URL: ${WATSONX_URL}
@@ -404,7 +404,7 @@ services:
       WXAI_API_KEY: ${WXAI_API_KEY}
       VECTOR_STORE_PROVIDER: ${VECTOR_STORE_PROVIDER:-milvus}
       CELERY_RESULTS_TTL: "3600"
-      EVENT_BROKER_TTL: "-1"
+      EVENT_BROKER_TTL: "3600"
       TAVILY_API_KEY: ${TAVILY_API_KEY:-dummy_tavily_api_key}
       WATSONX_APIKEY: ${WATSONX_APIKEY}
       WATSONX_URL: ${WATSONX_URL}
@@ -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,19 +780,203 @@ 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}
       WO_AUTH_TYPE: ${WO_AUTH_TYPE}
     healthcheck:
       test: curl -k http://localhost:9044/readiness --fail
-      interval: 5s
+      interval: 30s
       timeout: 60s
       retries: 5
     ports:
       - 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
+# 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: "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
+      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:
@@ -817,6 +1001,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

@@ -42,7 +42,7 @@ LANGFUSE_PRIVATE_KEY=sk-lf-7bc4da63-7b2b-40c0-b5eb-1e0cf64f9af2
 
 CELERY_WORKER_CONCURRENCY=12
 CELERY_RESULTS_TTL="3600"
-EVENT_BROKER_TTL="-1"
+EVENT_BROKER_TTL="3600"
 
 # START -- IMAGE REGISTRIES AND TAGS
 # The registry URL to pull the private images from, including the name of the repository in the registry.
@@ -53,41 +53,41 @@ EVENT_BROKER_TTL="-1"
 REGISTRY_URL=
 
 
-SERVER_TAG=02-07-2025
+SERVER_TAG=22-07-2025
 SERVER_REGISTRY=
 
-WORKER_TAG=02-07-2025
+WORKER_TAG=22-07-2025
 WORKER_REGISTRY=
 
-AI_GATEWAY_TAG=01-07-2025
+AI_GATEWAY_TAG=21-07-2025
 AI_GATEWAY_REGISTRY=
 
-AGENT_GATEWAY_TAG=23-06-2025
+AGENT_GATEWAY_TAG=07-07-2025
 AGENT_GATEWAY_REGISTRY=
 
 DB_REGISTRY=
 # If you build multiarch set all three of these to the same, we have a pr against main
 # to not have this separation, but we can merge it later
-DBTAG=24-06-2025-v1
+DBTAG=22-07-2025
 AMDDBTAG=24-06-2025-v1
 ARM64DBTAG=24-06-2025-v1
 
 UI_REGISTRY=
-UITAG=27-06-2025
+UITAG=23-07-2025
 
 CM_REGISTRY=
-CM_TAG=27-06-2025
+CM_TAG=24-07-2025
 
-TRM_TAG=26-06-2025
+TRM_TAG=23-07-2025-3c60549f0bac275de3e5736265a3fd49cdd3a203
 TRM_REGISTRY=
 
-TR_TAG=26-06-2025
+TR_TAG=23-07-2025-3c60549f0bac275de3e5736265a3fd49cdd3a203
 TR_REGISTRY=
 
-BUILDER_TAG=02-07-2025
+BUILDER_TAG=22-07-2025-v1
 BUILDER_REGISTRY=
 
-FLOW_RUNTIME_TAG=23-06-2025
+FLOW_RUNTIME_TAG=15-07-2025
 FLOW_RUMTIME_REGISTRY=
 
 
@@ -100,6 +100,18 @@ 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=
+
+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 +164,14 @@ 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=
+CM_SUFFIXLIST=
 
 # Use your machine's local IP address for external async tool communication.
 CALLBACK_HOST_URL=
@@ -160,3 +180,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,6 +1,8 @@
 from .constants import START, END, RESERVED
-from ..types import FlowContext, TaskData, TaskEventType
-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,13 +16,16 @@ __all__ = [
     "FlowContext",
     "TaskData",
     "TaskEventType",
+    "File",
 
+    "DocProcNode",
     "UserNode",
     "AgentNode",
     "StartNode",
     "EndNode",
     "PromptNode",
     "ToolNode",
+    "DecisionsNode",
     "Assignment",
     "DataMap",
 
@@ -36,8 +41,8 @@ __all__ = [
     "Branch",
     "Foreach",
     "Loop",
+    "DecisionsCondition",
+    "DecisionsRule",
 
-    "user",
-    "flow_spec",
     "flow"
 ]

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}")