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

ibm_watsonx_orchestrate/__init__.py

@@ -5,7 +5,7 @@
 
 pkg_name = "ibm-watsonx-orchestrate"
 
-__version__ = "1.6.0b0"
+__version__ = "1.7.0a0"
 
 
 

ibm_watsonx_orchestrate/agent_builder/agents/agent.py

@@ -14,6 +14,7 @@ class Agent(AgentSpec):
                 content = json.load(f)
             else:
                 raise ValueError('file must end in .json, .yaml, or .yml')
+            
             if not content.get("spec_version"):
                 raise ValueError(f"Field 'spec_version' not provided. Please ensure provided spec conforms to a valid spec format")
             agent = Agent.model_validate(content)

ibm_watsonx_orchestrate/agent_builder/agents/types.py

@@ -6,6 +6,7 @@ from pydantic import BaseModel, model_validator, ConfigDict
 from ibm_watsonx_orchestrate.agent_builder.tools import BaseTool, PythonTool
 from ibm_watsonx_orchestrate.agent_builder.knowledge_bases.types import KnowledgeBaseSpec, KnowledgeBaseBuiltInVectorIndexConfig, HAPFiltering, HAPFilteringConfig, CitationsConfig, ConfidenceThresholds, QueryRewriteConfig, GenerationConfiguration
 from ibm_watsonx_orchestrate.agent_builder.knowledge_bases.knowledge_base import KnowledgeBase
+from ibm_watsonx_orchestrate.agent_builder.agents.webchat_customizations import StarterPrompts, WelcomeContent
 from pydantic import Field, AliasChoices
 from typing import Annotated
 
@@ -32,7 +33,8 @@ class AgentProvider(str, Enum):
     WXAI = "wx.ai"
     EXT_CHAT = "external_chat"
     SALESFORCE = "salesforce"
-    WATSONX = "watsonx" #provider type returned from an assistant agent
+    WATSONX = "watsonx"
+    A2A = 'external_chat/A2A/0.2.1' #provider type returned from an assistant agent
 
 
 class AssistantAgentAuthType(str, Enum):
@@ -114,6 +116,8 @@ class AgentSpec(BaseAgentSpec):
     hidden: bool = False
     knowledge_base: Optional[List[str]] | Optional[List['KnowledgeBaseSpec']] = []
     chat_with_docs: Optional[ChatWithDocsConfig] = None
+    starter_prompts: Optional[StarterPrompts] = None
+    welcome_content: Optional[WelcomeContent] = None
 
 
     def __init__(self, *args, **kwargs):

ibm_watsonx_orchestrate/agent_builder/agents/webchat_customizations/__init__.py

@@ -0,0 +1,2 @@
+from .prompts import AgentPrompt, StarterPrompts
+from .welcome_content import WelcomeContent

ibm_watsonx_orchestrate/agent_builder/agents/webchat_customizations/prompts.py

@@ -0,0 +1,33 @@
+from enum import Enum
+from typing import Optional, Dict, List, Annotated
+from annotated_types import Len
+from pydantic import BaseModel, model_validator
+
+
+class PromptState(str,Enum):
+    ACTIVE = "active"
+    INACTIVE = "inactive"
+
+
+class AgentPrompt(BaseModel):
+    id: str
+    title: str
+    subtitle: Optional[str] = None
+    prompt: str
+    state: PromptState = PromptState.ACTIVE
+        
+    @model_validator(mode='before')
+    def validate_fields(cls,values):
+        return validate_agent_prompt_fields(values)
+
+
+def validate_agent_prompt_fields(values: Dict):
+    for field in ['id','title','prompt','state']:
+        value = values.get(field)
+        if value and not str(value).strip():
+            raise ValueError(f"{field} cannot be empty or just whitespace")
+    return values
+
+class StarterPrompts(BaseModel):
+    is_default_prompts: bool = False
+    prompts: Annotated[List[AgentPrompt], Len(min_length=1)]

ibm_watsonx_orchestrate/agent_builder/agents/webchat_customizations/welcome_content.py

@@ -0,0 +1,20 @@
+
+from typing import Optional,Dict
+from pydantic import BaseModel, model_validator
+
+class WelcomeContent(BaseModel):
+    welcome_message: str
+    description: Optional[str] = None
+    is_default_message: bool = False
+
+    @model_validator(mode='before')
+    def validate_fields(cls,values):
+        return validate_welcome_content_fields(values)
+
+
+def validate_welcome_content_fields(values: Dict):
+    for field in ['welcome_message']:
+        value = values.get(field)
+        if value and not str(value).strip():
+            raise ValueError(f"{field} cannot be empty or just whitespace")
+    return values

ibm_watsonx_orchestrate/agent_builder/connections/__init__.py

@@ -15,8 +15,8 @@ from .types import (
     BearerTokenAuthCredentials,
     APIKeyAuthCredentials,
     OAuth2TokenCredentials,
-    # OAuth2AuthCodeCredentials,
-    # OAuth2ClientCredentials,
+    OAuth2AuthCodeCredentials,
+    OAuth2ClientCredentials,
     # OAuth2ImplicitCredentials,
     # OAuth2PasswordCredentials,
     OAuthOnBehalfOfCredentials,

ibm_watsonx_orchestrate/agent_builder/connections/types.py

@@ -6,10 +6,10 @@ class ConnectionKind(str, Enum):
     basic = 'basic'
     bearer = 'bearer'
     api_key = 'api_key'
-    # oauth_auth_code_flow = 'oauth_auth_code_flow'
+    oauth_auth_code_flow = 'oauth_auth_code_flow'
     # oauth_auth_implicit_flow = 'oauth_auth_implicit_flow'
     # oauth_auth_password_flow = 'oauth_auth_password_flow'
-    # oauth_auth_client_credentials_flow = 'oauth_auth_client_credentials_flow'
+    oauth_auth_client_credentials_flow = 'oauth_auth_client_credentials_flow'
     oauth_auth_on_behalf_of_flow = 'oauth_auth_on_behalf_of_flow'
     key_value = 'key_value'
     kv = 'kv'
@@ -32,10 +32,10 @@ class ConnectionPreference(str, Enum):
         return self.value
 
 class ConnectionAuthType(str, Enum):
-    # OAUTH2_AUTH_CODE = 'oauth2_auth_code'
+    OAUTH2_AUTH_CODE = 'oauth2_auth_code'
     # OAUTH2_IMPLICIT = 'oauth2_implicit'
     # OAUTH2_PASSWORD = 'oauth2_password'
-    # OAUTH2_CLIENT_CREDS = 'oauth2_client_creds'
+    OAUTH2_CLIENT_CREDS = 'oauth2_client_creds'
     OAUTH_ON_BEHALF_OF_FLOW = 'oauth_on_behalf_of_flow'
 
     def __str__(self):
@@ -63,10 +63,10 @@ class ConnectionType(str, Enum):
     BASIC_AUTH = ConnectionSecurityScheme.BASIC_AUTH.value
     BEARER_TOKEN = ConnectionSecurityScheme.BEARER_TOKEN.value
     API_KEY_AUTH = ConnectionSecurityScheme.API_KEY_AUTH.value
-    # OAUTH2_AUTH_CODE = ConnectionAuthType.OAUTH2_AUTH_CODE.value
+    OAUTH2_AUTH_CODE = ConnectionAuthType.OAUTH2_AUTH_CODE.value
     # OAUTH2_IMPLICIT = ConnectionAuthType.OAUTH2_IMPLICIT.value
     # OAUTH2_PASSWORD = ConnectionAuthType.OAUTH2_PASSWORD.value
-    # OAUTH2_CLIENT_CREDS = ConnectionAuthType.OAUTH2_CLIENT_CREDS.value
+    OAUTH2_CLIENT_CREDS = ConnectionAuthType.OAUTH2_CLIENT_CREDS.value
     OAUTH_ON_BEHALF_OF_FLOW = ConnectionAuthType.OAUTH_ON_BEHALF_OF_FLOW.value
     KEY_VALUE = ConnectionSecurityScheme.KEY_VALUE.value
 
@@ -77,8 +77,8 @@ class ConnectionType(str, Enum):
         return repr(self.value)
 
 OAUTH_CONNECTION_TYPES = {
-    # ConnectionType.OAUTH2_AUTH_CODE,
-    # ConnectionType.OAUTH2_CLIENT_CREDS,
+    ConnectionType.OAUTH2_AUTH_CODE,
+    ConnectionType.OAUTH2_CLIENT_CREDS,
     # ConnectionType.OAUTH2_IMPLICIT,
     # ConnectionType.OAUTH2_PASSWORD,
     ConnectionType.OAUTH_ON_BEHALF_OF_FLOW,
@@ -137,10 +137,15 @@ class ConnectionConfiguration(BaseModel):
 
     @model_validator(mode="after")
     def validate_config(self):
-        if self.sso and self.security_scheme != ConnectionSecurityScheme.OAUTH2:
-            raise ValueError(f"SSO not supported for auth scheme '{self.security_scheme}'. SSO can only be used with OAuth auth types")
-        if not self.sso and self.security_scheme == ConnectionSecurityScheme.OAUTH2:
-            raise ValueError(f"SSO required for OAuth auth schemes. Please enable SSO.")
+        conn_type = None
+        if self.security_scheme == ConnectionSecurityScheme.OAUTH2:
+            conn_type = self.auth_type
+        else:
+            conn_type = self.security_scheme
+        if self.sso and conn_type != ConnectionAuthType.OAUTH_ON_BEHALF_OF_FLOW:
+            raise ValueError(f"SSO not supported for auth scheme '{conn_type}'. SSO can only be used with OAuth auth types")
+        if not self.sso and conn_type == ConnectionAuthType.OAUTH_ON_BEHALF_OF_FLOW:
+            raise ValueError(f"SSO required for '{conn_type}'. Please enable SSO.")
         if self.sso:
             if not self.idp_config_data:
                 raise ValueError("For SSO auth 'idp_config_data' is a required field")
@@ -167,11 +172,12 @@ class OAuth2TokenCredentials(BaseModel):
     access_token: str
     url: Optional[str] = None
 
-# class OAuth2AuthCodeCredentials(BaseModel):
-#     client_id: str
-#     client_secret: str
-#     token_url: str
-#     authorization_url: str
+class OAuth2AuthCodeCredentials(BaseModel):
+    client_id: str
+    client_secret: str
+    token_url: str
+    authorization_url: str
+    scopes : Optional[List[str]] = None
 
 # class OAuth2ImplicitCredentials(BaseModel):
 #     client_id: str
@@ -183,10 +189,11 @@ class OAuth2TokenCredentials(BaseModel):
 #     token_url: str
 #     authorization_url: str
 
-# class OAuth2ClientCredentials(BaseModel):
-#     client_id: str
-#     client_secret: str
-#     token_url: str
+class OAuth2ClientCredentials(BaseModel):
+    client_id: str
+    client_secret: str
+    token_url: str
+    scopes : Optional[List[str]] = None
 
 class OAuthOnBehalfOfCredentials(BaseModel):
     client_id: str
@@ -205,10 +212,10 @@ CREDENTIALS_SET = Union[
     BasicAuthCredentials,
     BearerTokenAuthCredentials,
     APIKeyAuthCredentials,
-    # OAuth2AuthCodeCredentials,
+    OAuth2AuthCodeCredentials,
     # OAuth2ImplicitCredentials,
     # OAuth2PasswordCredentials,
-    # OAuth2ClientCredentials,
+    OAuth2ClientCredentials,
     OAuthOnBehalfOfCredentials,
     KeyValueConnectionCredentials
 ]
@@ -219,20 +226,20 @@ CONNECTION_KIND_SCHEME_MAPPING = {
     ConnectionKind.basic: ConnectionSecurityScheme.BASIC_AUTH,
     ConnectionKind.bearer: ConnectionSecurityScheme.BEARER_TOKEN,
     ConnectionKind.api_key: ConnectionSecurityScheme.API_KEY_AUTH,
-    # ConnectionKind.oauth_auth_code_flow: ConnectionSecurityScheme.OAUTH2,
+    ConnectionKind.oauth_auth_code_flow: ConnectionSecurityScheme.OAUTH2,
     # ConnectionKind.oauth_auth_implicit_flow: ConnectionSecurityScheme.OAUTH2,
     # ConnectionKind.oauth_auth_password_flow: ConnectionSecurityScheme.OAUTH2,
-    # ConnectionKind.oauth_auth_client_credentials_flow: ConnectionSecurityScheme.OAUTH2,
+    ConnectionKind.oauth_auth_client_credentials_flow: ConnectionSecurityScheme.OAUTH2,
     ConnectionKind.oauth_auth_on_behalf_of_flow: ConnectionSecurityScheme.OAUTH2,
     ConnectionKind.key_value: ConnectionSecurityScheme.KEY_VALUE,
     ConnectionKind.kv: ConnectionSecurityScheme.KEY_VALUE,
 }
 
 CONNECTION_KIND_OAUTH_TYPE_MAPPING = {
-    # ConnectionKind.oauth_auth_code_flow: ConnectionAuthType.OAUTH2_AUTH_CODE,
+    ConnectionKind.oauth_auth_code_flow: ConnectionAuthType.OAUTH2_AUTH_CODE,
     # ConnectionKind.oauth_auth_implicit_flow: ConnectionAuthType.OAUTH2_IMPLICIT,
     # ConnectionKind.oauth_auth_password_flow: ConnectionAuthType.OAUTH2_PASSWORD,
-    # ConnectionKind.oauth_auth_client_credentials_flow: ConnectionAuthType.OAUTH2_CLIENT_CREDS,
+    ConnectionKind.oauth_auth_client_credentials_flow: ConnectionAuthType.OAUTH2_CLIENT_CREDS,
     ConnectionKind.oauth_auth_on_behalf_of_flow: ConnectionAuthType.OAUTH_ON_BEHALF_OF_FLOW,
 }
 
@@ -240,10 +247,10 @@ CONNECTION_TYPE_CREDENTIAL_MAPPING = {
     ConnectionType.BASIC_AUTH: BasicAuthCredentials,
     ConnectionType.BEARER_TOKEN: BearerTokenAuthCredentials,
     ConnectionType.API_KEY_AUTH: APIKeyAuthCredentials,
-    # ConnectionType.OAUTH2_AUTH_CODE: BearerTokenAuthCredentials,
-    # ConnectionType.OAUTH2_IMPLICIT: BearerTokenAuthCredentials,
-    # ConnectionType.OAUTH2_PASSWORD: BearerTokenAuthCredentials,
-    # ConnectionType.OAUTH2_CLIENT_CREDS: BearerTokenAuthCredentials,
+    ConnectionType.OAUTH2_AUTH_CODE: OAuth2TokenCredentials,
+    # ConnectionType.OAUTH2_IMPLICIT: OAuth2TokenCredentials,
+    # ConnectionType.OAUTH2_PASSWORD: OAuth2TokenCredentials,
+    ConnectionType.OAUTH2_CLIENT_CREDS: OAuth2TokenCredentials,
     ConnectionType.OAUTH_ON_BEHALF_OF_FLOW: OAuth2TokenCredentials,
     ConnectionType.KEY_VALUE: KeyValueConnectionCredentials,
 }

ibm_watsonx_orchestrate/agent_builder/tools/flow_tool.py

@@ -0,0 +1,83 @@
+
+import json
+import logging
+
+from ibm_watsonx_orchestrate.utils.utils import yaml_safe_load
+from .types import FlowToolBinding, ToolBinding, ToolSpec
+from .base_tool import BaseTool
+from .types import ToolPermission
+
+import json
+
+logger = logging.getLogger(__name__)
+
+
+class FlowTool(BaseTool):
+    def __init__(self, spec: ToolSpec):
+        BaseTool.__init__(self, spec=spec)
+
+    async def __call__(self, **kwargs):
+        raise RuntimeError('Flow Tools are only available when deployed onto watson orchestrate or the watson '
+                           'orchestrate-light runtime')
+
+    @staticmethod
+    def from_spec(file: str) -> 'FlowTool':
+        with open(file, 'r') as f:
+            if file.endswith('.yaml') or file.endswith('.yml'):
+                spec = ToolSpec.model_validate(yaml_safe_load(f))
+            elif file.endswith('.json'):
+                spec = ToolSpec.model_validate(json.load(f))
+            else:
+                raise ValueError('file must end in .json, .yaml, or .yml')
+
+        if spec.binding.openapi is None or spec.binding.openapi is None:
+            raise ValueError('failed to load python tool as the tool had no openapi binding')
+
+        return FlowTool(spec=spec)
+
+    def __repr__(self):
+        return f"FlowTool(model={self.__tool_spec__.binding.flow.model}, name='{self.__tool_spec__.name}', description='{self.__tool_spec__.description}')"
+
+    def __str__(self):
+        return self.__repr__()
+
+    @property
+    def __doc__(self):
+        return self.__tool_spec__.description
+
+
+def create_flow_json_tool(
+        flow_model: dict,
+        name: str = None,
+        description: str = None,
+        permission: ToolPermission = None,
+        ) -> FlowTool:
+    """
+    Creates a flow tool from a Flow JSON model
+
+    Here we create the basic tool spec.  The remaining properties of the tool spec
+    are set by the server when the tool is registered.  The server will publish the model to the
+    flow engine and generate the rest of the tool spec based on it's openAPI specification.
+    """
+
+    spec_name = name
+    spec_permission = permission
+    if spec_name is None:
+        raise ValueError(
+            f"No name provided for tool.")
+
+    spec_description = description
+    if spec_description is None:
+        raise ValueError(
+            f"No description provided for tool.")
+
+    spec = ToolSpec(
+        name=spec_name,
+        description=spec_description,
+        permission=spec_permission
+    )
+
+    spec.binding = ToolBinding(flow=FlowToolBinding(flow_id=name, model=flow_model))
+
+    return FlowTool(spec=spec)
+

ibm_watsonx_orchestrate/agent_builder/tools/types.py

@@ -148,6 +148,10 @@ class McpToolBinding(BaseModel):
     source: str
     connections: Dict[str, str] | None
 
+class FlowToolBinding(BaseModel):
+    flow_id: str
+    model: Optional[dict] = None
+
 class ToolBinding(BaseModel):
     openapi: OpenApiToolBinding = None
     python: PythonToolBinding = None
@@ -155,6 +159,7 @@ class ToolBinding(BaseModel):
     skill: SkillToolBinding = None
     client_side: ClientSideToolBinding = None
     mcp: McpToolBinding = None
+    flow: FlowToolBinding = None
 
     @model_validator(mode='after')
     def validate_binding_type(self) -> 'ToolBinding':
@@ -164,7 +169,8 @@ class ToolBinding(BaseModel):
             self.wxflows is not None,
             self.skill is not None,
             self.client_side is not None,
-            self.mcp is not None
+            self.mcp is not None,
+            self.flow is not None
         ]
         if sum(bindings) == 0:
             raise ValueError("One binding must be set")

ibm_watsonx_orchestrate/cli/commands/agents/agents_controller.py

@@ -122,6 +122,18 @@ def parse_create_native_args(name: str, kind: AgentKind, description: str | None
     context_variables = [x.strip() for x in context_variables if x.strip() != ""]
     agent_details["context_variables"] = context_variables
 
+    # hidden = args.get("hidden")
+    # if hidden:
+    #     agent_details["hidden"] = hidden 
+
+    # starter_prompts = args.get("starter_prompts")
+    # if starter_prompts:
+    #     agent_details["starter_prompts"] = starter_prompts 
+
+    # welcome_content = args.get("welcome_content")
+    # if welcome_content:
+    #     agent_details["welcome_content"] = welcome_content 
+
     return agent_details
 
 def parse_create_external_args(name: str, kind: AgentKind, description: str | None, **args) -> dict:
@@ -553,7 +565,7 @@ class AgentsController:
 
         return agent
     
-    def dereference_external_or_assistant_agent_dependencies(self, agent: ExternalAgent | AssistantAgent) -> ExternalAgent | AssistantAgent: 
+    def dereference_external_or_assistant_agent_dependencies(self, agent: ExternalAgent | AssistantAgent) -> ExternalAgent | AssistantAgent:
         agent_dict = agent.model_dump()
 
         if agent_dict.get("app_id") or agent.config.model_dump().get("app_id"):
@@ -561,7 +573,7 @@ class AgentsController:
 
         return agent
 
-    def reference_external_or_assistant_agent_dependencies(self, agent: ExternalAgent | AssistantAgent) -> ExternalAgent | AssistantAgent: 
+    def reference_external_or_assistant_agent_dependencies(self, agent: ExternalAgent | AssistantAgent) -> ExternalAgent | AssistantAgent:
         agent_dict = agent.model_dump()
 
         if agent_dict.get("connection_id") or agent.config.model_dump().get("connection_id"):
@@ -754,14 +766,14 @@ class AgentsController:
                     show_lines=True
                 )
                 column_args = {
-                    "Name": {},
+                    "Name": {"overflow": "fold"},
                     "Description": {},
                     "LLM": {"overflow": "fold"},
                     "Style": {},
                     "Collaborators": {},
                     "Tools": {},
                     "Knowledge Base": {},
-                    "ID": {},
+                    "ID": {"overflow": "fold"},
                 }
                 for column in column_args:
                     native_table.add_column(column, **column_args[column])
@@ -811,7 +823,7 @@ class AgentsController:
                     show_lines=True
                 )
                 column_args = {
-                    "Name": {},
+                    "Name": {"overflow": "fold"},
                     "Title": {},
                     "Description": {},
                     "Tags": {},
@@ -819,9 +831,9 @@ class AgentsController:
                     "Chat Params": {},
                     "Config": {},
                     "Nickname": {},
-                    "App ID": {},
-                    "ID": {}
-                    }
+                    "App ID": {"overflow": "fold"},
+                    "ID": {"overflow": "fold"}
+                }
                 
                 for column in column_args:
                     external_table.add_column(column, **column_args[column])
@@ -872,17 +884,17 @@ class AgentsController:
                     title="Assistant Agents",
                     show_lines=True)
                 column_args = {
-                    "Name": {},
+                    "Name": {"overflow": "fold"},
                     "Title": {},
                     "Description": {},
                     "Tags": {},
                     "Nickname": {},
                     "CRN": {},
                     "Instance URL": {},
-                    "Assistant ID": {},
-                    "Environment ID": {},
-                    "ID": {}
-                    }
+                    "Assistant ID": {"overflow": "fold"},
+                    "Environment ID": {"overflow": "fold"},
+                    "ID": {"overflow": "fold"}
+                }
                 
                 for column in column_args:
                     assistants_table.add_column(column, **column_args[column])
@@ -969,7 +981,6 @@ class AgentsController:
         
 
     def export_agent(self, name: str, kind: AgentKind, output_path: str, agent_only_flag: bool=False, zip_file_out: zipfile.ZipFile | None = None) -> None:
-    
         output_file = Path(output_path)
         output_file_extension = output_file.suffix
         output_file_name = output_file.stem