ibm-watsonx-orchestrate 1.11.0b0__tar.gz → 1.12.0b0__tar.gz

{ibm_watsonx_orchestrate-1.11.0b0 → ibm_watsonx_orchestrate-1.12.0b0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ibm-watsonx-orchestrate
-Version: 1.11.0b0
+Version: 1.12.0b0
 Summary: IBM watsonx.orchestrate SDK
 Author-email: IBM <support@ibm.com>
 License: MIT License
@@ -11,7 +11,7 @@ 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.24.2
-Requires-Dist: ibm-watsonx-orchestrate-evaluation-framework==1.0.8
+Requires-Dist: ibm-watsonx-orchestrate-evaluation-framework==1.1.2
 Requires-Dist: jsonref==1.1.0
 Requires-Dist: langchain-core<=0.3.63
 Requires-Dist: langsmith<=0.3.45

{ibm_watsonx_orchestrate-1.11.0b0 → ibm_watsonx_orchestrate-1.12.0b0}/pyproject.toml

@@ -35,7 +35,7 @@ dependencies = [
     "urllib3>=2.2.3",
     "pytz>=2025.2",
     "redis>=6.0.0",
-    "ibm_watsonx_orchestrate_evaluation_framework==1.0.8"
+    "ibm_watsonx_orchestrate_evaluation_framework==1.1.2"
 ]
 
 [project.optional-dependencies]

{ibm_watsonx_orchestrate-1.11.0b0 → ibm_watsonx_orchestrate-1.12.0b0}/src/ibm_watsonx_orchestrate/__init__.py

@@ -5,7 +5,7 @@
 
 pkg_name = "ibm-watsonx-orchestrate"
 
-__version__ = "1.11.0b0"
+__version__ = "1.12.0b0"
 
 
 from ibm_watsonx_orchestrate.utils.logging.logger import setup_logging

{ibm_watsonx_orchestrate-1.11.0b0 → ibm_watsonx_orchestrate-1.12.0b0}/src/ibm_watsonx_orchestrate/agent_builder/agents/types.py

@@ -1,5 +1,6 @@
 import json
 import yaml
+import logging
 from enum import Enum
 from typing import List, Optional, Dict
 from pydantic import BaseModel, model_validator, ConfigDict
@@ -9,6 +10,7 @@ from ibm_watsonx_orchestrate.agent_builder.knowledge_bases.knowledge_base import
 from ibm_watsonx_orchestrate.agent_builder.agents.webchat_customizations import StarterPrompts, WelcomeContent
 from pydantic import Field, AliasChoices
 from typing import Annotated
+from ibm_watsonx_orchestrate.cli.commands.partners.offering.types import CATALOG_ONLY_FIELDS
 from ibm_watsonx_orchestrate.utils.exceptions import BadRequest
 
 from ibm_watsonx_orchestrate.agent_builder.tools.types import JsonSchemaObject
@@ -16,6 +18,8 @@ from ibm_watsonx_orchestrate.agent_builder.tools.types import JsonSchemaObject
 # TO-DO: this is just a placeholder. Will update this later to align with backend
 DEFAULT_LLM = "watsonx/meta-llama/llama-3-2-90b-vision-instruct"
 
+logger = logging.getLogger(__name__)
+
 # Handles yaml formatting for multiline strings to improve readability
 def str_presenter(dumper, data):
     if len(data.splitlines()) > 1:  # check for multiline string
@@ -93,6 +97,19 @@ class BaseAgentSpec(BaseModel):
     def dumps_spec(self) -> str:
         dumped = self.model_dump(mode='json', exclude_none=True)
         return json.dumps(dumped, indent=2)
+    
+    @model_validator(mode="before")
+    def validate_agent_fields(cls,values):
+        return drop_catalog_fields(values)
+
+
+def drop_catalog_fields(values: dict):
+    for field in CATALOG_ONLY_FIELDS:
+        if values.get(field):
+            logger.warning(f"Field '{field}' is only used when publishing to the catalog, dropping this field for import")
+            del values[field]
+    return values
+
 
 # ===============================
 #      NATIVE AGENT TYPES
@@ -223,6 +240,11 @@ class ExternalAgentSpec(BaseAgentSpec):
 
     @model_validator(mode="before")
     def validate_fields_for_external(cls, values):
+        # The get api responds with a flat object with no config
+        if values.get("config") is None:
+            values["config"] = {}
+            values["config"]["enable_cot"] = values.get("enable_cot", None)
+            values["config"]["hidden"] = values.get("hidden", None)
         return validate_external_agent_fields(values)
 
     @model_validator(mode="after")
@@ -276,6 +298,14 @@ class AssistantAgentSpec(BaseAgentSpec):
 
     @model_validator(mode="before")
     def validate_fields_for_external(cls, values):
+        if values.get("config") is None:
+            values["config"] = {}
+            values["config"]["api_version"] = values.get("api_version", None)
+            values["config"]["assistant_id"] = values.get("assistant_id", None)
+            values["config"]["crn"] = values.get("crn", None)
+            values["config"]["service_instance_url"] = values.get("service_instance_url", None)
+            values["config"]["environment_id"] = values.get("environment_id", None)
+            values["config"]["authorization_url"] = values.get("authorization_url", None)
         return validate_assistant_agent_fields(values)
 
     @model_validator(mode="after")

{ibm_watsonx_orchestrate-1.11.0b0 → ibm_watsonx_orchestrate-1.12.0b0}/src/ibm_watsonx_orchestrate/agent_builder/connections/connections.py

@@ -1,5 +1,6 @@
 import os
 import logging
+from copy import deepcopy
 from typing import List
 from ibm_watsonx_orchestrate.agent_builder.connections.types import (
     BasicAuthCredentials,
@@ -13,7 +14,7 @@ from ibm_watsonx_orchestrate.agent_builder.connections.types import (
     CONNECTION_TYPE_CREDENTIAL_MAPPING
 )
 
-from ibm_watsonx_orchestrate.utils.utils import sanatize_app_id
+from ibm_watsonx_orchestrate.utils.utils import sanitize_app_id
 from ibm_watsonx_orchestrate.utils.exceptions import BadRequest
 
 logger = logging.getLogger(__name__)
@@ -67,7 +68,8 @@ def _clean_env_vars(vars: dict[str:str], requirements: List[str], app_id: str) -
     return required_env_vars
 
 def _build_credentials_model(credentials_type: type[CREDENTIALS], vars: dict[str,str], base_prefix: str) -> type[CREDENTIALS]:
-    requirements = connection_type_requirements_mapping[credentials_type]
+    requirements_lut = deepcopy(connection_type_requirements_mapping)
+    requirements = requirements_lut[credentials_type]
 
     if requirements:
         requirements.append("url")
@@ -101,14 +103,15 @@ def _get_credentials_model(connection_type: ConnectionSecurityScheme, app_id: st
     
     credentials_type = CONNECTION_TYPE_CREDENTIAL_MAPPING[connection_type]
 
-    requirements = connection_type_requirements_mapping.get(credentials_type)
+    requirements_lut = deepcopy(connection_type_requirements_mapping)
+    requirements = requirements_lut.get(credentials_type)
     if requirements:
         variables = _clean_env_vars(vars=variables, requirements=requirements, app_id=app_id)
 
     return _build_credentials_model(credentials_type=credentials_type, vars=variables, base_prefix=base_prefix)
 
 def get_connection_type(app_id: str) -> ConnectionSecurityScheme:
-    sanitized_app_id = sanatize_app_id(app_id=app_id)
+    sanitized_app_id = sanitize_app_id(app_id=app_id)
     expected_schema_key = f"WXO_SECURITY_SCHEMA_{sanitized_app_id}"
     expected_schema = os.environ.get(expected_schema_key)
 
@@ -126,7 +129,7 @@ def get_connection_type(app_id: str) -> ConnectionSecurityScheme:
     return expected_schema
 
 def get_application_connection_credentials(type: ConnectionType, app_id: str) -> CREDENTIALS:
-    sanitized_app_id = sanatize_app_id(app_id=app_id)
+    sanitized_app_id = sanitize_app_id(app_id=app_id)
     expected_schema = get_connection_type(app_id=app_id)
     requested_schema = connection_type_security_schema_map.get(type)
 

{ibm_watsonx_orchestrate-1.11.0b0 → ibm_watsonx_orchestrate-1.12.0b0}/src/ibm_watsonx_orchestrate/agent_builder/connections/types.py

@@ -1,7 +1,11 @@
+import logging
 from pydantic import BaseModel, Field, AliasChoices, model_validator
 from typing import Optional, Union, TypeVar, List
 from enum import Enum
 
+
+logger = logging.getLogger(__name__)
+
 class ConnectionKind(str, Enum):
     basic = 'basic'
     bearer = 'bearer'
@@ -145,6 +149,16 @@ class ConnectionConfiguration(BaseModel):
         
         super().__init__(*args, **kwargs)
 
+    @model_validator(mode="before")
+    def validate_auth_scheme(self):
+        if self.get('auth_type'):
+            try:
+                self['auth_type'] = ConnectionAuthType(self.get('auth_type'))
+            except:
+                logger.warning(f"Unsupported auth type '{self.get('auth_type')}', this will be removed from the configuration data")
+                self['auth_type'] = None
+        return self
+
     @model_validator(mode="after")
     def validate_config(self):
         conn_type = None

{ibm_watsonx_orchestrate-1.11.0b0 → ibm_watsonx_orchestrate-1.12.0b0}/src/ibm_watsonx_orchestrate/agent_builder/knowledge_bases/types.py

@@ -3,7 +3,8 @@ from datetime import datetime
 from uuid import UUID
 from enum import Enum
 
-from pydantic import BaseModel
+from pydantic import BaseModel, model_validator
+
 
 class SpecVersion(str, Enum):
     V1 = "v1"
@@ -104,6 +105,7 @@ class GenerationConfiguration(BaseModel):
     display_text_no_results_found: Optional[str] = None
     display_text_connectivity_issue: Optional[str] = None
     idk_message: Optional[str] = None
+    enabled: bool = True
 
 class FieldMapping(BaseModel):
     """
@@ -224,15 +226,14 @@ class AstraDBConnection(BaseModel):
     api_endpoint: str
     port: Optional[str] = None
     server_cert: Optional[str] = None
-    keyspace: Optional[str]
+    keyspace: Optional[str] = None
     data_type: str
-    collection: Optional[str]
-    table: Optional[str]
-    index_column: Optional[str]
-    embedding_mode: str
-    embedding_model_id: Optional[str]
-    credentials: dict
-    search_mode: str
+    collection: Optional[str] = None
+    table: Optional[str] = None
+    index_column: Optional[str] = None
+    embedding_mode: Optional[str] = None
+    embedding_model_id: Optional[str] = None
+    search_mode: Optional[str] = None
     limit: Optional[int] = 5
     filter: Optional[str] = None
     field_mapping: Optional[FieldMapping] = None
@@ -243,7 +244,13 @@ class IndexConnection(BaseModel):
     elastic_search: Optional[ElasticSearchConnection] = None
     custom_search: Optional[CustomSearchConnection] = None
     astradb: Optional[AstraDBConnection] = None
-    
+
+
+class QuerySource(str, Enum):
+    SessionHistory = "SessionHistory"
+    Agent = "Agent"
+
+
 class ConversationalSearchConfig(BaseModel):
     language: Optional[str] = None
     index_config: list[IndexConnection] = None
@@ -252,6 +259,14 @@ class ConversationalSearchConfig(BaseModel):
     citations: Optional[CitationsConfig] = None
     hap_filtering: Optional[HAPFiltering] = None
     confidence_thresholds: Optional[ConfidenceThresholds] = None
+    query_source: QuerySource = QuerySource.SessionHistory
+    agent_query_description: str = "The query to search for in the knowledge base"
+
+    @model_validator(mode="after")
+    def validate_agent_query_description(self) -> 'ConversationalSearchConfig':
+        if self.query_source == QuerySource.Agent and len(self.agent_query_description) == 0:
+            raise ValueError("Provide a non-empty agent_query_description when query source is `Agent`")
+        return self
 
 class KnowledgeBaseBuiltInVectorIndexConfig(BaseModel):
     embeddings_model_name: Optional[str] = None

{ibm_watsonx_orchestrate-1.11.0b0 → ibm_watsonx_orchestrate-1.12.0b0}/src/ibm_watsonx_orchestrate/agent_builder/tools/__init__.py

@@ -1,4 +1,5 @@
 from .base_tool import BaseTool
 from .python_tool import tool, PythonTool, get_all_python_tools
 from .openapi_tool import create_openapi_json_tool, create_openapi_json_tool_from_uri, create_openapi_json_tools_from_uri, OpenAPITool, HTTPException
+from .langflow_tool import LangflowTool
 from .types import ToolPermission, JsonSchemaObject, ToolRequestBody, ToolResponseBody, OpenApiSecurityScheme, OpenApiToolBinding, PythonToolBinding, WxFlowsToolBinding, SkillToolBinding, ClientSideToolBinding, ToolBinding, ToolSpec

ibm_watsonx_orchestrate-1.12.0b0/src/ibm_watsonx_orchestrate/agent_builder/tools/langflow_tool.py

@@ -0,0 +1,124 @@
+import json
+import re
+
+from pydantic import BaseModel
+
+from ibm_watsonx_orchestrate.agent_builder.connections.types import ConnectionSecurityScheme
+from .base_tool import BaseTool
+from .types import LangflowToolBinding, ToolBinding, ToolPermission, ToolRequestBody, ToolResponseBody, ToolSpec
+from ibm_watsonx_orchestrate.utils.exceptions import BadRequest
+
+MIN_LANGFLOW_VERSION = [1,5,0]
+LANGFLOW_CHAT_INPUT_LABEL = "ChatInput"
+LANGFLOW_CHAT_OUTPUT_LABEL = "ChatOutput"
+VALID_NAME_PATTERN = re.compile("^[a-zA-Z](\\w|_)+$")
+
+class LangflowTool(BaseTool):
+  def __init__(self,spec: ToolSpec):
+    BaseTool.__init__(self,spec=spec)
+
+    if self.__tool_spec__.binding.langflow is None:
+      raise BadRequest('Missing langflow binding')
+    
+  
+  def __repr__(self):
+    return f"LangflowTool(name='{self.__tool_spec__.name}', description='{self.__tool_spec__.description}')"
+
+  
+  def __str__(self):
+    return self.__repr__()
+  
+def validate_langflow_version(version_string: str) -> bool:
+  version_nums = map(int, re.findall(r"\d+",version_string))
+  for i,n in enumerate(version_nums):
+    if i >= len(MIN_LANGFLOW_VERSION) or MIN_LANGFLOW_VERSION[i] < n:
+      break
+    if MIN_LANGFLOW_VERSION[i] > n:
+      return False
+  return True
+
+
+def extract_langflow_nodes(tool_definition: dict, node_type: str) -> dict:
+  return [n for n in tool_definition.get('data',{}).get('nodes',{}) if n.get('data',{}).get('type') == node_type]
+
+def langflow_input_schema(tool_definition: dict = None) -> ToolRequestBody:
+  
+  chat_input_nodes = extract_langflow_nodes(tool_definition=tool_definition,node_type=LANGFLOW_CHAT_INPUT_LABEL)
+
+  if len(chat_input_nodes) < 1:
+    raise ValueError(f"No '{LANGFLOW_CHAT_INPUT_LABEL}' node found in langflow tool")
+  if len(chat_input_nodes) > 1:
+    raise ValueError(f"Too many '{LANGFLOW_CHAT_INPUT_LABEL}' nodes found in langlow tool")
+
+  input_description = chat_input_nodes[0].get("data",{}).get("node",{}).get("description","")
+
+  return ToolRequestBody(
+    type= "object",
+    properties= {
+      "input": {
+        "description": input_description,
+        "type": "string"
+      }
+    },
+    required= ["input"]
+  )
+
+def langflow_output_schema(tool_definition: dict = None):
+
+  chat_output_nodes = extract_langflow_nodes(tool_definition=tool_definition,node_type=LANGFLOW_CHAT_OUTPUT_LABEL)
+
+  if len(chat_output_nodes) < 1:
+    raise ValueError(f"No '{LANGFLOW_CHAT_OUTPUT_LABEL}' node found in langflow tool")
+  if len(chat_output_nodes) > 1:
+    output_description = ""
+  else:
+    output_description = chat_output_nodes[0].get("data",{}).get("node",{}).get("description","")
+
+  return ToolResponseBody(
+    description=output_description,
+    type= "string"
+  )
+  
+def create_langflow_tool(
+    tool_definition: dict,
+    connections: dict = None,
+    ) -> LangflowTool:
+
+  name = tool_definition.get('name')
+  if not name:
+    raise ValueError('Provided tool definition does not have a name')
+  
+  if VALID_NAME_PATTERN.match(name) is None:
+    raise ValueError(f"Langflow tool name contains unsupported characters. Only alphanumeric characters and underscores are allowed, and must not start with a number or underscore.")
+  
+  description = tool_definition.get('description')
+  if not description:
+    raise ValueError('Provided tool definition does not have a description')
+  
+  langflow_id = tool_definition.get('id')
+
+  langflow_version = tool_definition.get('last_tested_version')
+  if not langflow_version:
+    raise ValueError('No langflow version detected in tool definition')
+  if not validate_langflow_version(langflow_version):
+    raise ValueError(f"Langflow version is below minimum requirements, found '{langflow_version}', miniumum required version '{'.'.join(map(str,MIN_LANGFLOW_VERSION))}'")
+  
+  spec = ToolSpec(
+    name=name,
+    description=description,
+    permission=ToolPermission('read_only')
+  )
+
+  spec.input_schema = langflow_input_schema(tool_definition=tool_definition)
+
+  spec.output_schema = langflow_output_schema(tool_definition=tool_definition)
+
+  spec.binding = ToolBinding(
+    langflow=LangflowToolBinding(
+      langflow_id=langflow_id,
+      langflow_version=langflow_version,
+      connections=connections
+    )
+  )
+
+  return LangflowTool(spec)

{ibm_watsonx_orchestrate-1.11.0b0 → ibm_watsonx_orchestrate-1.12.0b0}/src/ibm_watsonx_orchestrate/agent_builder/tools/openapi_tool.py

@@ -56,9 +56,9 @@ class OpenAPITool(BaseTool):
                 spec = ToolSpec.model_validate(json.load(f))
             else:
                 raise BadRequest('file must end in .json, .yaml, or .yml')
-
-        if spec.binding.openapi is None or spec.binding.openapi is None:
-            raise BadRequest('failed to load python tool as the tool had no openapi binding')
+            
+        if spec is None or spec.binding is None or spec.binding.openapi is None:
+            raise BadRequest('failed to load openapi tool as the tool had no openapi binding')
 
         return OpenAPITool(spec=spec)
 

{ibm_watsonx_orchestrate-1.11.0b0 → ibm_watsonx_orchestrate-1.12.0b0}/src/ibm_watsonx_orchestrate/agent_builder/tools/types.py

@@ -1,8 +1,9 @@
 from enum import Enum
 from typing import List, Any, Dict, Literal, Optional, Union
 
-from pydantic import BaseModel, model_validator, ConfigDict, Field, AliasChoices
+from pydantic import BaseModel, model_validator, ConfigDict, Field, AliasChoices, ValidationError
 from ibm_watsonx_orchestrate.utils.exceptions import BadRequest
+from ibm_watsonx_orchestrate.agent_builder.connections import KeyValueConnectionCredentials
 
 
 class ToolPermission(str, Enum):
@@ -159,6 +160,21 @@ class FlowToolBinding(BaseModel):
     flow_id: str
     model: Optional[dict] = None
 
+class LangflowToolBinding(BaseModel):
+    langflow_id: Optional[str] = None
+    project_id: Optional[str] = None
+    langflow_version: str
+    connections: Optional[dict] = None
+
+    @model_validator(mode='after')
+    def validate_connection_type(self) -> 'LangflowToolBinding':
+        if self.connections:
+            for k,v in self.connections.items():
+                if not v:
+                    raise ValidationError(f"No connection provided for '{k}'")
+        return self
+
+
 class ToolBinding(BaseModel):
     openapi: OpenApiToolBinding = None
     python: PythonToolBinding = None
@@ -167,6 +183,7 @@ class ToolBinding(BaseModel):
     client_side: ClientSideToolBinding = None
     mcp: McpToolBinding = None
     flow: FlowToolBinding = None
+    langflow: LangflowToolBinding = None
 
     @model_validator(mode='after')
     def validate_binding_type(self) -> 'ToolBinding':
@@ -177,7 +194,8 @@ class ToolBinding(BaseModel):
             self.skill is not None,
             self.client_side is not None,
             self.mcp is not None,
-            self.flow is not None
+            self.flow is not None,
+            self.langflow is not None
         ]
         if sum(bindings) == 0:
             raise BadRequest("One binding must be set")

{ibm_watsonx_orchestrate-1.11.0b0 → ibm_watsonx_orchestrate-1.12.0b0}/src/ibm_watsonx_orchestrate/cli/commands/agents/agents_command.py

@@ -1,5 +1,5 @@
 import typer
-from typing_extensions import Annotated, List
+from typing_extensions import Annotated, List, Optional
 from ibm_watsonx_orchestrate.cli.commands.agents.agents_controller import AgentsController
 from ibm_watsonx_orchestrate.agent_builder.agents.types import DEFAULT_LLM, AgentKind, AgentStyle, ExternalAgentAuthScheme, AgentProvider
 import json
@@ -14,7 +14,7 @@ def agent_import(
         typer.Option("--file", "-f", help="YAML file with agent definition"),
     ],
     app_id: Annotated[
-        str, typer.Option(
+        Optional[str], typer.Option(
             '--app-id', '-a',
             help='The app id of the connection to associate with this external agent. An application connection represents the server authentication credentials needed to connection to this agent (for example Api Keys, Basic, Bearer or OAuth credentials).'
         )
@@ -46,6 +46,13 @@ def agent_create(
         AgentKind,
         typer.Option("--kind", "-k", help="The kind of agent you wish to create"),
     ] = AgentKind.NATIVE,
+    instructions: Annotated[
+        str,
+        typer.Option(
+            "--instructions",
+            help="A set of instructions for how the agent should preform actions.",
+        ),
+    ] = None,
     api_url: Annotated[
         str,
         typer.Option("--api", "-a", help="External Api url your Agent will use"),
@@ -175,6 +182,7 @@ def agent_create(
         kind=kind,
         description=description,
         title=title,
+        instructions=instructions,
         api_url=api_url,
         auth_scheme=auth_scheme,
         auth_config=auth_config_dict,