ibm-watsonx-orchestrate 1.2.0__tar.gz → 1.4.2__tar.gz

{ibm_watsonx_orchestrate-1.2.0 → ibm_watsonx_orchestrate-1.4.2}/PKG-INFO

@@ -1,25 +1,29 @@
 Metadata-Version: 2.4
 Name: ibm-watsonx-orchestrate
-Version: 1.2.0
+Version: 1.4.2
 Summary: IBM watsonx.orchestrate SDK
 Author-email: IBM <support@ibm.com>
 License: MIT License
 License-File: LICENSE
 Requires-Python: <3.14,>=3.11
 Requires-Dist: certifi>=2024.8.30
+Requires-Dist: click<8.2.0,>=8.0.0
 Requires-Dist: docstring-parser<1.0,>=0.16
 Requires-Dist: httpx<1.0.0,>=0.28.1
 Requires-Dist: ibm-cloud-sdk-core>=3.22.0
 Requires-Dist: jsonref==1.1.0
 Requires-Dist: jsonschema<5.0.0,>=4.23.0
 Requires-Dist: langchain-community<1.0.0,>=0.3.12
+Requires-Dist: munch>=4.0.0
 Requires-Dist: numpy>=1.26.0
 Requires-Dist: packaging>=24.2
 Requires-Dist: pydantic<3.0.0,>=2.10.3
 Requires-Dist: pyjwt<3.0.0,>=2.10.1
 Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pytz>=2025.2
 Requires-Dist: pyyaml<7.0.0,>=6.0.2
-Requires-Dist: requests>=2.32.3
+Requires-Dist: redis>=6.0.0
+Requires-Dist: requests>=2.32.0
 Requires-Dist: rich<14.0.0,>=13.9.4
 Requires-Dist: typer<1.0.0,>=0.15.1
 Requires-Dist: urllib3>=2.2.3

{ibm_watsonx_orchestrate-1.2.0 → ibm_watsonx_orchestrate-1.4.2}/pyproject.toml

@@ -17,6 +17,7 @@ requires-python = ">=3.11, <3.14"
 classifiers = []
 dependencies = [
     "certifi>=2024.8.30",
+    "click>=8.0.0,<8.2.0",
     "docstring-parser>=0.16,<1.0",
     "httpx>=0.28.1,<1.0.0",
     "ibm-cloud-sdk-core>=3.22.0",
@@ -29,10 +30,13 @@ dependencies = [
     "pyjwt>=2.10.1,<3.0.0",
     "python-dotenv>=1.0.0",
     "pyyaml>=6.0.2,<7.0.0",
-    "requests>=2.32.3",
+    "requests>=2.32.0",
     "rich>=13.9.4,<14.0.0",
     "typer>=0.15.1,<1.0.0",
-    "urllib3>=2.2.3"
+    "urllib3>=2.2.3",
+    "munch>=4.0.0",
+    "pytz>=2025.2",
+    "redis>=6.0.0"
 ]
 
 [project.optional-dependencies]

{ibm_watsonx_orchestrate-1.2.0 → ibm_watsonx_orchestrate-1.4.2}/src/ibm_watsonx_orchestrate/__init__.py

@@ -5,7 +5,7 @@
 
 pkg_name = "ibm-watsonx-orchestrate"
 
-__version__ = "1.2.0"
+__version__ = "1.4.2"
 
 
 

{ibm_watsonx_orchestrate-1.2.0 → ibm_watsonx_orchestrate-1.4.2}/src/ibm_watsonx_orchestrate/agent_builder/agents/types.py

@@ -5,6 +5,7 @@ from typing import List, Optional, Dict
 from pydantic import BaseModel, model_validator, ConfigDict
 from ibm_watsonx_orchestrate.agent_builder.tools import BaseTool
 from ibm_watsonx_orchestrate.agent_builder.knowledge_bases.types import KnowledgeBaseSpec
+from ibm_watsonx_orchestrate.agent_builder.knowledge_bases.knowledge_base import KnowledgeBase
 from pydantic import Field, AliasChoices
 from typing import Annotated
 
@@ -45,6 +46,7 @@ class BaseAgentSpec(BaseModel):
     kind: AgentKind
     id: Optional[Annotated[str, Field(json_schema_extra={"min_length_str": 1})]] = None
     name: Annotated[str, Field(json_schema_extra={"min_length_str":1})]
+    display_name: Annotated[Optional[str], Field(json_schema_extra={"min_length_str":1})] = None
     description: Annotated[str, Field(json_schema_extra={"min_length_str":1})]
 
     def dump_spec(self, file: str) -> None:
@@ -68,6 +70,7 @@ class BaseAgentSpec(BaseModel):
 class AgentStyle(str, Enum):
     DEFAULT = "default"
     REACT = "react"
+    PLANNER = "planner"
 
 class AgentSpec(BaseAgentSpec):
     model_config = ConfigDict(arbitrary_types_allowed=True)
@@ -85,6 +88,8 @@ class AgentSpec(BaseAgentSpec):
     def __init__(self, *args, **kwargs):
         if "tools" in kwargs and kwargs["tools"]:
             kwargs["tools"] = [x.__tool_spec__.name if isinstance(x, BaseTool) else x for x in kwargs["tools"]]
+        if "knowledge_base" in kwargs and kwargs["knowledge_base"]:
+            kwargs["knowledge_base"] = [x.name if isinstance(x, KnowledgeBase) else x for x in kwargs["knowledge_base"]]
         if "collaborators" in kwargs and kwargs["collaborators"]:
             kwargs["collaborators"] = [x.name if isinstance(x, BaseAgentSpec) else x for x in kwargs["collaborators"]]
         super().__init__(*args, **kwargs)
@@ -101,7 +106,7 @@ class AgentSpec(BaseAgentSpec):
 
 def validate_agent_fields(values: dict) -> dict:
     # Check for empty strings or whitespace
-    for field in ["id", "name", "kind", "description", "collaborators", "tools"]:
+    for field in ["id", "name", "kind", "description", "collaborators", "tools", "knowledge_base"]:
         value = values.get(field)
         if value and not str(value).strip():
             raise ValueError(f"{field} cannot be empty or just whitespace")

{ibm_watsonx_orchestrate-1.2.0 → ibm_watsonx_orchestrate-1.4.2}/src/ibm_watsonx_orchestrate/agent_builder/knowledge_bases/knowledge_base.py

@@ -1,7 +1,7 @@
 import json
 from ibm_watsonx_orchestrate.utils.utils import yaml_safe_load
-from .types import KnowledgeBaseSpec
-
+from .types import KnowledgeBaseSpec, KnowledgeBaseKind
+from pydantic import model_validator
 
 class KnowledgeBase(KnowledgeBaseSpec):
 
@@ -24,4 +24,17 @@ class KnowledgeBase(KnowledgeBaseSpec):
         return f"KnowledgeBase(id='{self.id}', name='{self.name}', description='{self.description}')"
 
     def __str__(self):
-        return self.__repr__()
+        return self.__repr__()
+    
+    # Not a model validator since we only want to validate this on import
+    def validate_documents_or_index_exists(self):
+        if self.documents and self.conversational_search_tool and self.conversational_search_tool.index_config or \
+            (not self.documents and (not self.conversational_search_tool or not self.conversational_search_tool.index_config)):
+            raise ValueError("Must provide either \"documents\" or \"conversational_search_tool.index_config\", but not both")
+        return self
+    
+    @model_validator(mode="after")
+    def validate_kind(self):
+        if self.kind != KnowledgeBaseKind.KNOWLEDGE_BASE:
+            raise ValueError(f"The specified kind '{self.kind}' cannot be used to create a knowledge base")
+        return self

{ibm_watsonx_orchestrate-1.2.0 → ibm_watsonx_orchestrate-1.4.2}/src/ibm_watsonx_orchestrate/agent_builder/knowledge_bases/knowledge_base_requests.py

@@ -1,12 +1,12 @@
 import json
 from ibm_watsonx_orchestrate.utils.utils import yaml_safe_load
-from .types import CreateKnowledgeBase, PatchKnowledgeBase, KnowledgeBaseKind
+from .types import KnowledgeBaseSpec, PatchKnowledgeBase, KnowledgeBaseKind
 
 
-class KnowledgeBaseCreateRequest(CreateKnowledgeBase):
+class KnowledgeBaseCreateRequest(KnowledgeBaseSpec):
 
     @staticmethod
-    def from_spec(file: str) -> 'CreateKnowledgeBase':
+    def from_spec(file: str) -> 'KnowledgeBaseSpec':
         with open(file, 'r') as f:
             if file.endswith('.yaml') or file.endswith('.yml'):
                 content = yaml_safe_load(f)
@@ -15,20 +15,10 @@ class KnowledgeBaseCreateRequest(CreateKnowledgeBase):
             else:
                 raise ValueError('file must end in .json, .yaml, or .yml')
             
-            if (content.get('documents') and content.get("conversational_search_tool", {}).get("index_config")) or \
-                  (not content.get('documents') and not content.get("conversational_search_tool", {}).get("index_config")):
-                raise ValueError("Must provide either \"documents\" or \"conversational_search_tool.index_config\", but not both")
-            
             if not content.get("spec_version"):
                 raise ValueError(f"Field 'spec_version' not provided. Please ensure provided spec conforms to a valid spec format")
             
-            if not content.get("kind"):
-                raise ValueError(f"Field 'kind' not provided. Should be 'knowledge_base'")
-
-            if content.get("kind") != KnowledgeBaseKind.KNOWLEDGE_BASE:
-                raise ValueError(f"Field 'kind' should be 'knowledge_base', but is set to '{content.get('kind')}'")
-            
-            knowledge_base = CreateKnowledgeBase.model_validate(content)
+            knowledge_base = KnowledgeBaseSpec.model_validate(content)
 
         return knowledge_base
     
@@ -48,12 +38,6 @@ class KnowledgeBaseUpdateRequest(PatchKnowledgeBase):
             if not content.get("spec_version"):
                 raise ValueError(f"Field 'spec_version' not provided. Please ensure provided spec conforms to a valid spec format")
             
-            if not content.get("kind"):
-                raise ValueError(f"Field 'kind' not provided. Should be 'knowledge_base'")
-
-            if content.get("kind") != KnowledgeBaseKind.KNOWLEDGE_BASE:
-                raise ValueError(f"Field 'kind' should be 'knowledge_base', but is set to '{content.get('kind')}'")
-            
             patch = PatchKnowledgeBase.model_validate(content)
 
         return patch

{ibm_watsonx_orchestrate-1.2.0 → ibm_watsonx_orchestrate-1.4.2}/src/ibm_watsonx_orchestrate/agent_builder/knowledge_bases/types.py

@@ -3,8 +3,7 @@ from datetime import datetime
 from uuid import UUID
 from enum import Enum
 
-from pydantic import BaseModel, Field
-
+from pydantic import BaseModel, model_validator
 
 class SpecVersion(str, Enum):
     V1 = "v1"
@@ -206,16 +205,6 @@ class KnowledgeBaseBuiltInVectorIndexConfig(BaseModel):
     chunk_overlap: Optional[int] = None
     limit: Optional[int] = None
     
-class CreateKnowledgeBase(BaseModel):
-    """request payload schema"""
-    name: Optional[str] = None
-    description: Optional[str] = None
-    documents: list[str] = None
-    vector_index: Optional[KnowledgeBaseBuiltInVectorIndexConfig] = None
-    conversational_search_tool: Optional[ConversationalSearchConfig] = None
-    prioritize_built_in_index: Optional[bool] = None
-    
-    
 class PatchKnowledgeBase(BaseModel):
     """request payload schema"""
     description: Optional[str] = None
@@ -223,7 +212,14 @@ class PatchKnowledgeBase(BaseModel):
     conversational_search_tool: Optional[ConversationalSearchConfig] = None  
     prioritize_built_in_index: Optional[bool] = None
     representation: Optional[KnowledgeBaseRepresentation] = None
-    
+
+    @model_validator(mode="after")
+    def validate_fields(self):
+        if self.documents and self.conversational_search_tool and self.conversational_search_tool.index_config:
+            raise ValueError("Must not provide both \"documents\" or \"conversational_search_tool.index_config\"")
+        if self.conversational_search_tool and self.conversational_search_tool.index_config and len(self.conversational_search_tool.index_config) != 1:
+            raise ValueError(f"Must provide exactly one conversational_search_tool.index_config. Provided {len(self.conversational_search_tool.index_config)}.")
+        return self
     
 class KnowledgeBaseSpec(BaseModel):
     """Schema for a complete knowledge-base."""
@@ -231,13 +227,15 @@ class KnowledgeBaseSpec(BaseModel):
     kind: KnowledgeBaseKind = KnowledgeBaseKind.KNOWLEDGE_BASE
     id: Optional[UUID] = None 
     tenant_id: Optional[str] = None
-    name: Optional[str] = None
+    name: str
     description: Optional[str] = None
     vector_index: Optional[KnowledgeBaseBuiltInVectorIndexConfig] = None
     conversational_search_tool: Optional[ConversationalSearchConfig] | Optional[UUID] = None
     prioritize_built_in_index: Optional[bool] = None
+    representation: Optional[KnowledgeBaseRepresentation] = None
     vector_index_id: Optional[UUID] = None 
     created_by: Optional[str] = None
     created_on: Optional[datetime] = None 
     updated_at: Optional[datetime] = None
-
+    # For import/update
+    documents: list[str] = None

ibm_watsonx_orchestrate-1.4.2/src/ibm_watsonx_orchestrate/agent_builder/toolkits/base_toolkit.py

@@ -0,0 +1,32 @@
+import json
+
+import yaml
+
+from .types import ToolkitSpec
+
+
+class BaseToolkit:
+    __toolkit_spec__: ToolkitSpec
+
+    def __init__(self, spec: ToolkitSpec):
+        self.__toolkit_spec__ = spec
+
+    def __call__(self, **kwargs):
+        pass
+
+    def dump_spec(self, file: str) -> None:
+        dumped = self.__toolkit_spec__.model_dump(mode='json', exclude_unset=True, exclude_none=True, by_alias=True)
+        with open(file, 'w') 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.__toolkit_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"Toolkit(name='{self.__toolkit_spec__.name}', description='{self.__toolkit_spec__.description}')"

ibm_watsonx_orchestrate-1.4.2/src/ibm_watsonx_orchestrate/agent_builder/toolkits/types.py

@@ -0,0 +1,42 @@
+from typing import List, Dict, Optional
+from enum import Enum
+from pydantic import BaseModel, model_validator
+
+class ToolkitKind(str, Enum):
+    MCP = "mcp"
+
+class Language(str, Enum):
+    NODE = "node"
+    PYTHON ="python"
+
+class ToolkitSource(str, Enum):
+    FILES = "files"
+    PUBLIC_REGISTRY = "public-registry"
+
+
+
+class McpModel(BaseModel):
+    source: str
+    command: str
+    args: List[str]
+    tools: List[str]
+    connections: Dict[str, str]
+
+
+class ToolkitSpec(BaseModel):
+    id: str
+    tenant_id: str
+    name: str
+    description: Optional[str]
+    created_on: str
+    updated_at: str
+    created_by: str
+    created_by_username: str
+    tools: List[str] | None
+    mcp: McpModel
+
+    @model_validator(mode='after')
+    def validate_tools_and_mcp(self) -> 'ToolkitSpec':
+        if self.mcp.source not in {"files", "public-registry"}:
+            raise ValueError("MCP source must be either 'files' or 'public-registry'.")
+        return self

{ibm_watsonx_orchestrate-1.2.0 → ibm_watsonx_orchestrate-1.4.2}/src/ibm_watsonx_orchestrate/agent_builder/tools/openapi_tool.py

@@ -115,17 +115,9 @@ def create_openapi_json_tool(
         raise ValueError(
             f"Path {http_path} did not have an http_method {http_method}. Available methods are {list(route.keys())}")
 
-    operation_id = (
-        re.sub(
-            '_+',
-            '_',
-            re.sub(
-                r'[^a-zA-Z_]',
-                '_',
-                route_spec.get('operationId', None)
-            )
-        )
-    ) if route_spec.get('operationId', None) is not None else None
+    operation_id = re.sub( r'(\W|_)+', '_', route_spec.get('operationId') ) \
+                     if route_spec.get('operationId', None) else None
+
     spec_name = name or operation_id
     spec_permission = permission or _action_to_perm(route_spec.get('x-ibm-operation', {}).get('action'))
     if spec_name is None:
@@ -142,7 +134,7 @@ def create_openapi_json_tool(
         description=spec_description,
         permission=spec_permission
     )
-    
+
     spec.input_schema = input_schema or ToolRequestBody(
         type='object',
         properties={},
@@ -301,7 +293,7 @@ async def create_openapi_json_tool_from_uri(
         description=description,
         input_schema=input_schema,
         output_schema=output_schema,
-        app_id=app_id
+        connection_id=app_id
     )
 
 
@@ -310,6 +302,15 @@ async def create_openapi_json_tools_from_uri(
         connection_id: str = None
 ) -> List[OpenAPITool]:
     openapi_contents = await _get_openapi_spec_from_uri(openapi_uri)
+    tools: List[OpenAPITool] = await create_openapi_json_tools_from_content(openapi_contents, connection_id)
+
+    return tools
+
+async def create_openapi_json_tools_from_content(
+        openapi_contents: dict,
+        connection_id: str = None
+) -> List[OpenAPITool]:
+   
     tools: List[OpenAPITool] = []
 
     for path, methods in openapi_contents.get('paths', {}).items():

{ibm_watsonx_orchestrate-1.2.0 → ibm_watsonx_orchestrate-1.4.2}/src/ibm_watsonx_orchestrate/agent_builder/tools/python_tool.py

@@ -47,7 +47,7 @@ class PythonTool(BaseTool):
         return PythonTool(fn=fn, spec=spec)
 
     def __repr__(self):
-        return f"PythonTool(fn={self.__tool_spec__.binding.python.function}, name='{self.__tool_spec__.name}', description='{self.__tool_spec__.description}')"
+        return f"PythonTool(fn={self.__tool_spec__.binding.python.function}, name='{self.__tool_spec__.name}', display_name='{self.__tool_spec__.display_name or ''}', description='{self.__tool_spec__.description}')"
 
     def __str__(self):
         return self.__repr__()
@@ -99,7 +99,8 @@ def tool(
     input_schema: ToolRequestBody = None,
     output_schema: ToolResponseBody = None,
     permission: ToolPermission = ToolPermission.READ_ONLY,
-    expected_credentials: List[ExpectedCredentials] = None
+    expected_credentials: List[ExpectedCredentials] = None,
+    display_name: str = None
 ) -> Callable[[{__name__, __doc__}], PythonTool]:
     """
     Decorator to convert a python function into a callable tool.
@@ -125,6 +126,7 @@ def tool(
         
         spec = ToolSpec(
             name=name or fn.__name__,
+            display_name=display_name,
             description=_desc,
             permission=permission
         )

{ibm_watsonx_orchestrate-1.2.0 → ibm_watsonx_orchestrate-1.4.2}/src/ibm_watsonx_orchestrate/agent_builder/tools/types.py

@@ -137,7 +137,7 @@ class ClientSideToolBinding(BaseModel):
 class McpToolBinding(BaseModel):
     server_url: Optional[str] = None
     source: str
-    connections: Dict[str, str]
+    connections: Dict[str, str] | None
 
 class ToolBinding(BaseModel):
     openapi: OpenApiToolBinding = None
@@ -166,6 +166,7 @@ class ToolBinding(BaseModel):
 
 class ToolSpec(BaseModel):
     name: str
+    display_name: str | None = None
     description: str
     permission: ToolPermission
     input_schema: ToolRequestBody = None

{ibm_watsonx_orchestrate-1.2.0 → ibm_watsonx_orchestrate-1.4.2}/src/ibm_watsonx_orchestrate/cli/commands/agents/agents_command.py

@@ -190,3 +190,32 @@ def remove_agent(
 ):  
     agents_controller = AgentsController()
     agents_controller.remove_agent(name=name, kind=kind)
+
+@agents_app.command(name="export", help='Export an agent and its dependencies to a zip file or yaml')
+def export_agent(
+    name: Annotated[
+        str,
+        typer.Option("--name", "-n", help="Name of the agent you wish to export"),
+    ],
+    kind: Annotated[
+        AgentKind,
+        typer.Option("--kind", "-k", help="The kind of agent you wish to export"),
+    ],
+    output_file: Annotated[
+        str,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Path to a where the file containing the exported data should be saved",
+        ),
+    ],
+    agent_only_flag: Annotated[
+        bool,
+        typer.Option(
+            "--agent-only",
+            help="Export only the yaml to the specified agent, excluding its dependencies",
+        ),
+    ]=False
+):  
+    agents_controller = AgentsController()
+    agents_controller.export_agent(name=name, kind=kind, output_path=output_file, agent_only_flag=agent_only_flag)