ibm-watsonx-orchestrate 1.3.0__py3-none-any.whl → 1.5.0__py3-none-any.whl

ibm_watsonx_orchestrate/experimental/flow_builder/node.py

@@ -0,0 +1,116 @@
+import json
+from typing import Any, cast
+import uuid
+
+import yaml
+from pydantic import BaseModel, Field, SerializeAsAny
+
+from .types import EndNodeSpec, NodeSpec, AgentNodeSpec, PromptNodeSpec, StartNodeSpec, ToolNodeSpec, UserFieldKind, UserFieldOption, UserNodeSpec
+from .data_map import DataMap
+
+class Node(BaseModel):
+    spec: SerializeAsAny[NodeSpec]
+    input_map: DataMap | None = None
+
+    def __call__(self, **kwargs):
+        pass
+
+    def dump_spec(self, file: str) -> None:
+        dumped = self.spec.model_dump(mode='json',
+                                      exclude_unset=True, exclude_none=True, by_alias=True)
+        with open(file, 'w', encoding="utf-8") as f:
+            if file.endswith('.yaml') or file.endswith('.yml'):
+                yaml.dump(dumped, f)
+            elif file.endswith('.json'):
+                json.dump(dumped, f, indent=2)
+            else:
+                raise ValueError('file must end in .json, .yaml, or .yml')
+
+    def dumps_spec(self) -> str:
+        dumped = self.spec.model_dump(mode='json',
+                                      exclude_unset=True, exclude_none=True, by_alias=True)
+        return json.dumps(dumped, indent=2)
+
+    def __repr__(self):
+        return f"Node(name='{self.spec.name}', description='{self.spec.description}')"
+
+    def to_json(self) -> dict[str, Any]:
+        model_spec = {}
+        model_spec["spec"] = self.spec.to_json()
+        if self.input_map is not None:
+            model_spec['input_map'] = self.input_map.to_json()
+
+        return model_spec
+
+class StartNode(Node):
+    def __repr__(self):
+        return f"StartNode(name='{self.spec.name}', description='{self.spec.description}')"
+
+    def get_spec(self) -> StartNodeSpec:
+        return cast(StartNodeSpec, self.spec)
+
+class EndNode(Node):
+    def __repr__(self):
+        return f"EndNode(name='{self.spec.name}', description='{self.spec.description}')"
+
+    def get_spec(self) -> EndNodeSpec:
+        return cast(EndNodeSpec, self.spec)
+    
+class ToolNode(Node):
+    def __repr__(self):
+        return f"ToolNode(name='{self.spec.name}', description='{self.spec.description}')"
+
+    def get_spec(self) -> ToolNodeSpec:
+        return cast(ToolNodeSpec, self.spec)
+
+class UserNode(Node):
+    def __repr__(self):
+        return f"UserNode(name='{self.spec.name}', description='{self.spec.description}')"
+
+    def get_spec(self) -> UserNodeSpec:
+        return cast(UserNodeSpec, self.spec)
+    
+    def field(self, 
+              name: str,
+              kind: UserFieldKind = UserFieldKind.Text,
+              text: str | None = None,
+              display_name: str | None = None,
+              description: str | None = None,
+              default: Any | None = None,
+              option: UserFieldOption | None = None,
+              is_list: bool = False,
+              custom: dict[str, Any] | None = None,
+              widget: str | None = None):
+        self.get_spec().field(name=name,
+                              kind=kind,
+                              text=text,
+                              display_name=display_name,
+                              description=description,
+                              default=default,
+                              option=option,
+                              is_list=is_list,
+                              custom=custom,
+                              widget=widget)
+
+class AgentNode(Node):
+    def __repr__(self):
+        return f"AgentNode(name='{self.spec.name}', description='{self.spec.description}')"
+
+    def get_spec(self) -> AgentNodeSpec:
+        return cast(AgentNodeSpec, self.spec)
+
+class PromptNode(Node):
+    def __repr__(self):
+        return f"PromptNode(name='{self.spec.name}', description='{self.spec.description}')"
+
+    def get_spec(self) -> PromptNodeSpec:
+        return cast(PromptNodeSpec, self.spec)
+
+class NodeInstance(BaseModel):
+    node: Node
+    id: str # unique id of this task instance
+    flow: Any # the flow this task belongs to
+
+    def __init__(self, **kwargs): # type: ignore
+        super().__init__(**kwargs)
+        self.id = uuid.uuid4().hex

ibm_watsonx_orchestrate/experimental/flow_builder/resources/flow_status.openapi.yml

@@ -0,0 +1,66 @@
+openapi: 3.0.3
+info:
+  title: Flow status
+  version: '0.1'
+  description: This tool allows you to check the status of a flow.
+servers:
+  - url: http://wxo-tempus-runtime:9044
+components:
+  schemas:
+    APIError:
+      type: object
+      properties:
+        data:
+          type: object
+          properties:
+            message:
+              type: string
+          additionalProperties: true
+          required:
+            - message
+      required:
+        - data
+paths:
+  /v1/flows:
+    get:
+      description: Get the status of a flow instance.
+      operationId: get_flow_status
+      responses:
+        '200':
+          description: Return the status of a flow instance.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: object
+        '400':
+          description: Bad input
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/APIError'
+        '500':
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/APIError'
+      parameters:
+        - in: query
+          name: instance_id
+          description: Identifies the instance of the flow. This was provided when the flow tool was run.
+          required: false
+          schema:
+            type: string
+        - in: query
+          name: state
+          required: false
+          schema:
+            type: string
+            enum:
+              - completed
+              - in_progress
+              - interrupted
+              - failed
+