ibm-watsonx-orchestrate 1.7.0a0__py3-none-any.whl → 1.8.0b0__py3-none-any.whl

ibm_watsonx_orchestrate/docker/default.env

@@ -53,16 +53,16 @@ EVENT_BROKER_TTL="-1"
 REGISTRY_URL=
 
 
-SERVER_TAG=26-06-2025
+SERVER_TAG=02-07-2025
 SERVER_REGISTRY=
 
-WORKER_TAG=26-06-2025
+WORKER_TAG=02-07-2025
 WORKER_REGISTRY=
 
-AI_GATEWAY_TAG=23-06-2025
+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=
@@ -73,41 +73,44 @@ AMDDBTAG=24-06-2025-v1
 ARM64DBTAG=24-06-2025-v1
 
 UI_REGISTRY=
-UITAG=26-06-2025
+UITAG=27-06-2025
 
 CM_REGISTRY=
-CM_TAG=18-06-2025
+CM_TAG=27-06-2025
 
-TRM_TAG=25-06-2025
+TRM_TAG=08-07-2025
 TRM_REGISTRY=
 
-TR_TAG=25-06-2025
+TR_TAG=08-07-2025
 TR_REGISTRY=
 
-BUILDER_TAG=26-06-2025-a
+BUILDER_TAG=02-07-2025
 BUILDER_REGISTRY=
 
-FLOW_RUNTIME_TAG=23-06-2025
+FLOW_RUNTIME_TAG=10-07-2025
 FLOW_RUMTIME_REGISTRY=
 
 
-AGENT_ANALYTICS_TAG=24-06-2025
+AGENT_ANALYTICS_TAG=02-07-2025-v1
 AGENT_ANALYTICS_REGISTRY=
 
-JAEGER_PROXY_TAG=24-06-2025
+JAEGER_PROXY_TAG=01-07-2025
 JAEGER_PROXY_REGISTRY=
 
 SOCKET_HANDLER_TAG=29-05-2025
 SOCKET_HANDLER_REGISTRY=
 
+CPE_TAG=08-07-2025
+CPE_REGISTRY=
+
 # IBM Document Processing
-WDU_TAG=2.5.0-rc.2
+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=20250624-155521-230-48b7f28b
+DOCPROC_DPI_TAG=20250702-000808-237-7b1e424d
 DOCPROC_REGISTRY=
 
 # END -- IMAGE REGISTRIES AND TAGS
@@ -161,6 +164,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=
@@ -172,4 +182,4 @@ RUNTIME_MANAGER_API_KEY=example
 
 
 # IBM Document Processing
-SERVICE_URL=https://wxo-doc-processing-cache:8080
+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}")

ibm_watsonx_orchestrate/flow_builder/flows/flow.py

@@ -15,6 +15,7 @@ import logging
 import copy
 import uuid
 import pytz
+import os
 
 from typing_extensions import Self
 from pydantic import BaseModel, Field, SerializeAsAny
@@ -25,11 +26,13 @@ from ibm_watsonx_orchestrate.client.tools.tempus_client import TempusClient
 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
+    StartNodeSpec, ToolSpec, JsonSchemaObject, ToolRequestBody, ToolResponseBody, UserFieldKind, UserFieldOption, UserFlowSpec, UserNodeSpec, WaitPolicy,
+    DocProcSpec, TextExtractionResponse, KVPInvoicesExtractionResponse, KVPUtilityBillsExtractionResponse,
+    DocumentContent
 )
 from .constants import CURRENT_USER, START, END, ANY_USER
 from ..node import (
-    EndNode, Node, PromptNode, StartNode, UserNode, AgentNode, DataMap, ToolNode
+    EndNode, Node, PromptNode, StartNode, UserNode, AgentNode, DataMap, ToolNode, DocProcNode
 )
 from ..types import (
     AgentNodeSpec, extract_node_spec, FlowContext, FlowEventType, FlowEvent, FlowSpec,
@@ -114,7 +117,7 @@ class Flow(Node):
                 # pydantic suppport nested comparison by default
 
                 schema.title = title
-                
+
                 if schema == existing_schema:
                     return existing_schema
                 # we need to do a deep compare
@@ -354,6 +357,7 @@ class Flow(Node):
               name: str, 
               agent: str, 
               display_name: str|None=None,
+              title: str | None = None,
               message: str | None = "Follow the agent instructions.",
               description: str | None = None,
               input_schema: type[BaseModel]|None = None, 
@@ -371,6 +375,7 @@ class Flow(Node):
             display_name=display_name,
             description=description,
             agent=agent,
+            title=title,
             message=message,
             guidelines=guidelines,
             input_schema=_get_tool_request_body(input_schema_obj),
@@ -428,6 +433,50 @@ class Flow(Node):
         # add the node to the list of node
         node = self._add_node(node)
         return cast(PromptNode, node)
+    
+    def docproc(self, 
+            name: str, 
+            task: str,
+            display_name: str|None=None,
+            description: str | None = None,
+            input_map: DataMap = None) -> DocProcNode:
+
+        if name is None :
+            raise ValueError("name must be provided.")
+        
+        if task is None:
+            raise ValueError("task must be provided.")
+        
+        output_schema_dict = { 
+            "text_extraction" : TextExtractionResponse,
+            "kvp_invoices_extraction" : KVPInvoicesExtractionResponse,
+            "kvp_utility_bills_extraction" : KVPUtilityBillsExtractionResponse
+        }
+         # create input spec
+        input_schema_obj = _get_json_schema_obj(parameter_name = "input", type_def = DocumentContent)
+        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")
+        # Create the docproc spec
+        task_spec = DocProcSpec(
+            name=name,
+            display_name=display_name if display_name is not None else name,
+            description=description,
+            input_schema=_get_tool_request_body(input_schema_obj),
+            output_schema=_get_tool_response_body(output_schema_obj),
+            output_schema_object = output_schema_obj,
+            task=task
+        )
+
+        node = DocProcNode(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(DocProcNode, node)
+    
 
     def node_exists(self, node: Union[str, Node]):
      
@@ -921,7 +970,8 @@ class FlowFactory(BaseModel):
                     description: str|None=None,
                     initiators: Sequence[str]|None=None,
                     input_schema: type[BaseModel]|None=None,
-                    output_schema: type[BaseModel]|None=None) -> Flow:
+                    output_schema: type[BaseModel]|None=None,
+                    schedulable: bool=False) -> Flow:
         if isinstance(name, Callable):
             flow_spec = getattr(name, "__flow_spec__", None)
             if not flow_spec:
@@ -942,7 +992,8 @@ class FlowFactory(BaseModel):
             initiators=initiators,
             input_schema=_get_tool_request_body(input_schema_obj),
             output_schema=_get_tool_response_body(output_schema_obj),
-            output_schema_object = output_schema_obj
+            output_schema_object = output_schema_obj,
+            schedulable=schedulable,
         )
 
         return Flow(spec = flow_spec)
@@ -1228,10 +1279,12 @@ class UserFlow(Flow):
               kind: UserFieldKind = UserFieldKind.Text,
               display_name: str | None = None,
               description: str | None = None,
-              owners: list[str] = [],
               default: Any | None = None,
-              text: str = None,
+              text: str = None, # The text used to ask question to the user, e.g. 'what is your name?'
               option: UserFieldOption | None = None,
+              is_list: bool = False,
+              min: Any | None = None,
+              max: Any | None = None,
               input_map: DataMap = None,
               custom: dict[str, Any] = {}) -> UserNode:
         '''create a node in the flow'''
@@ -1246,20 +1299,42 @@ class UserFlow(Flow):
         schema_obj.properties = {}
         schema_obj.properties[name] = UserFieldKind.convert_kind_to_schema_property(kind, name, description, default, option, custom)
 
-        return self.user(name, 
-                         display_name=display_name,
-                         description=description,
-                         owners=owners,
-                         text=text,
-                         output_schema=schema_obj,
-                         input_map=input_map)
+        task_spec = UserNodeSpec(
+            name=name,
+            display_name=display_name,
+            description=description,
+            owners=[CURRENT_USER],
+            input_schema=_get_tool_request_body(schema_obj),
+            output_schema=_get_tool_response_body(schema_obj),
+            text=text,
+            output_schema_object = schema_obj
+        )
+
+        node = UserNode(spec = task_spec)
+        node.field(name = name,
+                   kind = kind,
+                   display_name = display_name,
+                   description = description,
+                   default = default,
+                   text = text,
+                   option = option,
+                   is_list = is_list,
+                   min = min,
+                   max = max,
+                   custom = custom)
+
+        # setup input map
+        if input_map:
+            node.input_map = self._get_data_map(input_map)
+
+        node = self._add_node(node)
+        return cast(UserNode, node)
 
     def user(
         self,
         name: str | None = None,
         display_name: str | None = None,
         description: str | None = None,
-        owners: list[str] = [],
         text: str | None = None,
         output_schema: type[BaseModel] | JsonSchemaObject| None = None,
         input_map: DataMap = None,
@@ -1273,16 +1348,12 @@ class UserFlow(Flow):
         # input and output is always the same in an user node
         output_schema_obj = output_schema_obj
 
-        # identify owner
-        if not owners:
-            owners = [ANY_USER]
-
         # Create the tool spec
         task_spec = UserNodeSpec(
             name=name,
             display_name=display_name,
             description=description,
-            owners=owners,
+            owners=[CURRENT_USER],
             input_schema=_get_tool_request_body(output_schema_obj),
             output_schema=_get_tool_response_body(output_schema_obj),
             text=text,

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
+from .types import EndNodeSpec, NodeSpec, AgentNodeSpec, PromptNodeSpec, StartNodeSpec, ToolNodeSpec, UserFieldKind, UserFieldOption, UserNodeSpec, DocProcSpec
 from .data_map import DataMap
 
 class Node(BaseModel):
@@ -78,6 +78,8 @@ class UserNode(Node):
               description: str | None = None,
               default: Any | None = None,
               option: UserFieldOption | None = None,
+              min: Any | None = None,
+              max: Any | None = None,
               is_list: bool = False,
               custom: dict[str, Any] | None = None,
               widget: str | None = None):
@@ -88,6 +90,8 @@ class UserNode(Node):
                               description=description,
                               default=default,
                               option=option,
+                              min=min,
+                              max=max,
                               is_list=is_list,
                               custom=custom,
                               widget=widget)
@@ -105,6 +109,13 @@ class PromptNode(Node):
 
     def get_spec(self) -> PromptNodeSpec:
         return cast(PromptNodeSpec, self.spec)
+    
+class DocProcNode(Node):
+    def __repr__(self):
+        return f"DocProcNode(name='{self.spec.name}', description='{self.spec.description}')"
+
+    def get_spec(self) -> DocProcSpec:
+        return cast(DocProcSpec, self.spec)
 
 class NodeInstance(BaseModel):
     node: Node