ibm-watsonx-orchestrate 1.9.0b2__py3-none-any.whl → 1.10.0b1__py3-none-any.whl

ibm_watsonx_orchestrate/__init__.py

@@ -5,7 +5,8 @@
 
 pkg_name = "ibm-watsonx-orchestrate"
 
-__version__ = "1.9.0b2"
+__version__ = "1.10.0b1"
+
 
 
 

ibm_watsonx_orchestrate/agent_builder/agents/types.py

@@ -77,6 +77,8 @@ class BaseAgentSpec(BaseModel):
     description: Annotated[str, Field(json_schema_extra={"min_length_str":1})]
     context_access_enabled: bool = True
     context_variables: Optional[List[str]] = []
+    voice_configuration_id: Optional[str] = None
+    voice_configuration: Optional[str] = None
 
     def dump_spec(self, file: str) -> None:
         dumped = self.model_dump(mode='json', exclude_unset=True, exclude_none=True)

ibm_watsonx_orchestrate/agent_builder/connections/__init__.py

@@ -18,7 +18,7 @@ from .types import (
     OAuth2AuthCodeCredentials,
     OAuth2ClientCredentials,
     # OAuth2ImplicitCredentials,
-    # OAuth2PasswordCredentials,
+    OAuth2PasswordCredentials,
     OAuthOnBehalfOfCredentials,
     KeyValueConnectionCredentials,
     CONNECTION_KIND_SCHEME_MAPPING,

ibm_watsonx_orchestrate/agent_builder/connections/connections.py

@@ -37,7 +37,7 @@ connection_type_security_schema_map = {
     ConnectionType.OAUTH2_CLIENT_CREDS: ConnectionSecurityScheme.OAUTH2,
     ConnectionType.OAUTH_ON_BEHALF_OF_FLOW: ConnectionSecurityScheme.OAUTH2,
     # ConnectionType.OAUTH2_IMPLICIT: ConnectionSecurityScheme.OAUTH2,
-    # ConnectionType.OAUTH2_PASSWORD: ConnectionSecurityScheme.OAUTH2
+    ConnectionType.OAUTH2_PASSWORD: ConnectionSecurityScheme.OAUTH2
 }
 
 def _clean_env_vars(vars: dict[str:str], requirements: List[str], app_id: str) -> dict[str,str]:

ibm_watsonx_orchestrate/agent_builder/connections/types.py

@@ -8,7 +8,7 @@ class ConnectionKind(str, Enum):
     api_key = 'api_key'
     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_password_flow = 'oauth_auth_password_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'
@@ -34,7 +34,7 @@ class ConnectionPreference(str, Enum):
 class ConnectionAuthType(str, Enum):
     OAUTH2_AUTH_CODE = 'oauth2_auth_code'
     # OAUTH2_IMPLICIT = 'oauth2_implicit'
-    # OAUTH2_PASSWORD = 'oauth2_password'
+    OAUTH2_PASSWORD = 'oauth2_password'
     OAUTH2_CLIENT_CREDS = 'oauth2_client_creds'
     OAUTH_ON_BEHALF_OF_FLOW = 'oauth_on_behalf_of_flow'
 
@@ -65,7 +65,7 @@ class ConnectionType(str, Enum):
     API_KEY_AUTH = ConnectionSecurityScheme.API_KEY_AUTH.value
     OAUTH2_AUTH_CODE = ConnectionAuthType.OAUTH2_AUTH_CODE.value
     # OAUTH2_IMPLICIT = ConnectionAuthType.OAUTH2_IMPLICIT.value
-    # OAUTH2_PASSWORD = ConnectionAuthType.OAUTH2_PASSWORD.value
+    OAUTH2_PASSWORD = ConnectionAuthType.OAUTH2_PASSWORD.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
@@ -90,7 +90,7 @@ OAUTH_CONNECTION_TYPES = {
     ConnectionType.OAUTH2_AUTH_CODE,
     ConnectionType.OAUTH2_CLIENT_CREDS,
     # ConnectionType.OAUTH2_IMPLICIT,
-    # ConnectionType.OAUTH2_PASSWORD,
+    ConnectionType.OAUTH2_PASSWORD,
     ConnectionType.OAUTH_ON_BEHALF_OF_FLOW,
 }
 
@@ -193,11 +193,15 @@ class OAuth2AuthCodeCredentials(BaseModel):
 #     client_id: str
 #     authorization_url: str
 
-# class OAuth2PasswordCredentials(BaseModel):
-#     client_id: str
-#     client_secret: str
-#     token_url: str
-#     authorization_url: str
+class OAuth2PasswordCredentials(BaseModel):
+    username: str
+    password: str
+    client_id: str
+    client_secret: str
+    token_url: str
+    scope: Optional[str] = None
+    grant_type: str = "password"
+    
 
 class OAuth2ClientCredentials(BaseModel):
     client_id: str
@@ -226,7 +230,7 @@ CREDENTIALS_SET = Union[
     APIKeyAuthCredentials,
     OAuth2AuthCodeCredentials,
     # OAuth2ImplicitCredentials,
-    # OAuth2PasswordCredentials,
+    OAuth2PasswordCredentials,
     OAuth2ClientCredentials,
     OAuthOnBehalfOfCredentials,
     KeyValueConnectionCredentials
@@ -240,7 +244,7 @@ CONNECTION_KIND_SCHEME_MAPPING = {
     ConnectionKind.api_key: ConnectionSecurityScheme.API_KEY_AUTH,
     ConnectionKind.oauth_auth_code_flow: ConnectionSecurityScheme.OAUTH2,
     # ConnectionKind.oauth_auth_implicit_flow: ConnectionSecurityScheme.OAUTH2,
-    # ConnectionKind.oauth_auth_password_flow: ConnectionSecurityScheme.OAUTH2,
+    ConnectionKind.oauth_auth_password_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,
@@ -250,7 +254,7 @@ CONNECTION_KIND_SCHEME_MAPPING = {
 CONNECTION_KIND_OAUTH_TYPE_MAPPING = {
     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_password_flow: ConnectionAuthType.OAUTH2_PASSWORD,
     ConnectionKind.oauth_auth_client_credentials_flow: ConnectionAuthType.OAUTH2_CLIENT_CREDS,
     ConnectionKind.oauth_auth_on_behalf_of_flow: ConnectionAuthType.OAUTH_ON_BEHALF_OF_FLOW,
 }

ibm_watsonx_orchestrate/agent_builder/knowledge_bases/types.py

@@ -11,6 +11,7 @@ class SpecVersion(str, Enum):
 class KnowledgeBaseKind(str, Enum):
     KNOWLEDGE_BASE = "knowledge_base"
 class RetrievalConfidenceThreshold(str, Enum):
+    Off = "Off"
     Lowest = "Lowest"
     Low = "Low"
     High = "High"
@@ -24,6 +25,7 @@ class GeneratedResponseLength(str, Enum):
 
 
 class ResponseConfidenceThreshold(str, Enum):
+    Off = "Off"
     Lowest = "Lowest"
     Low = "Low"
     High = "High"
@@ -86,6 +88,8 @@ class GenerationConfiguration(BaseModel):
     {
         "model_id": "meta-llama/llama-3-1-70b-instruct",
         "prompt_instruction": "When the documents are in different languages, you should respond in english.",
+        "max_docs_passed_to_llm": 10,
+        "retrieval_confidence_threshold": "Lowest",
         "generated_response_length": "Moderate",
         "display_text_no_results_found": "no docs found",
         "display_text_connectivity_issue": "conn failed",
@@ -95,6 +99,7 @@ class GenerationConfiguration(BaseModel):
 
     model_id: Optional[str] = None
     prompt_instruction: Optional[str] = None
+    max_docs_passed_to_llm: Optional[int] = None
     generated_response_length: Optional[GeneratedResponseLength] = None
     display_text_no_results_found: Optional[str] = None
     display_text_connectivity_issue: Optional[str] = None
@@ -134,12 +139,13 @@ class MilvusConnection(BaseModel):
     }
     """
     grpc_host: Optional[str] = None
+    grpc_port: Optional[str] = None
+    server_cert: Optional[str] = None
     database: Optional[str] = None
     collection: Optional[str] = None
     index: Optional[str] = None
     embedding_model_id: Optional[str] = None
     limit : Optional[int] = None
-    grpc_port: Optional[str] = None
     filter: Optional[str] = None
     field_mapping: Optional[FieldMapping] = None
 
@@ -197,12 +203,46 @@ class CustomSearchConnection(BaseModel):
     filter: Optional[str] = None
     metadata: Optional[dict] = None
 
+class AstraDBConnection(BaseModel):
+    """
+    example:
+    {
+        "api_endpoint": "https://xxx-us-east-2.apps.astra.datastax.com",
+        "key_space": "default_keyspace",
+        "collection": "search_wa_docs",
+        "embedding_model_id": "sentence-transformers/all-minilm-l12-v2",
+        "port": "443",
+        "filter": "productType: \"boots\"",
+        "limit": 5,
+        "field_mapping": {
+                        "title": "title",
+                        "body": "text",
+                        "url": "some-url"
+                    }
+    }
+    """
+    api_endpoint: str
+    port: Optional[str] = None
+    server_cert: Optional[str] = None
+    keyspace: Optional[str]
+    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
+    limit: Optional[int] = 5
+    filter: Optional[str] = None
+    field_mapping: Optional[FieldMapping] = None
+
 class IndexConnection(BaseModel):
     connection_id: Optional[str] = None
     milvus: Optional[MilvusConnection] = None
     elastic_search: Optional[ElasticSearchConnection] = None
     custom_search: Optional[CustomSearchConnection] = None
-
+    astradb: Optional[AstraDBConnection] = None
     
 class ConversationalSearchConfig(BaseModel):
     language: Optional[str] = None
@@ -218,6 +258,10 @@ class KnowledgeBaseBuiltInVectorIndexConfig(BaseModel):
     chunk_size: Optional[int] = None
     chunk_overlap: Optional[int] = None
     limit: Optional[int] = None
+
+class FileUpload(BaseModel):
+    path: str
+    url: Optional[str] = None
     
 class KnowledgeBaseSpec(BaseModel):
     """Schema for a complete knowledge-base."""
@@ -236,4 +280,4 @@ class KnowledgeBaseSpec(BaseModel):
     created_on: Optional[datetime] = None 
     updated_at: Optional[datetime] = None
     # For import/update
-    documents: list[str] = None
+    documents: list[str] | list[FileUpload] = None

ibm_watsonx_orchestrate/agent_builder/toolkits/types.py

@@ -1,27 +1,36 @@
-from typing import List, Dict, Optional
+from typing import List, Dict, Optional, Union
 from enum import Enum
-from pydantic import BaseModel, model_validator
+from pydantic import BaseModel 
 
 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 ToolkitTransportKind(str, Enum):
+    STREAMABLE_HTTP = "streamable_http"
+    SSE = "sse"
 
+class Language(str, Enum):
+    NODE = "node"
+    PYTHON ="python"
 
-class McpModel(BaseModel):
-    source: str
+class LocalMcpModel(BaseModel):
+    source: ToolkitSource
     command: str
     args: List[str]
     tools: List[str]
     connections: Dict[str, str]
 
+class RemoteMcpModel(BaseModel):
+    server_url: str
+    transport: ToolkitTransportKind
+    tools: List[str]
+    connections: Dict[str, str]
+
+McpModel = Union[LocalMcpModel, RemoteMcpModel]
 
 class ToolkitSpec(BaseModel):
     id: str
@@ -33,10 +42,4 @@ class ToolkitSpec(BaseModel):
     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
+    mcp: McpModel

ibm_watsonx_orchestrate/agent_builder/tools/python_tool.py

@@ -187,15 +187,27 @@ def _fix_optional(schema):
     replacements = {}
     if schema.required is None:
         schema.required = []
-
     for k, v in schema.properties.items():
+        # Simple null type & required -> not required
         if v.type == 'null' and k in schema.required:
             not_required.append(k)
-        if v.anyOf is not None and next(filter(lambda x: x.type == 'null', v.anyOf)) and k in schema.required:
-            v.anyOf = list(filter(lambda x: x.type != 'null', v.anyOf))
-            if len(v.anyOf) == 1:
-                replacements[k] = v.anyOf[0]
-            not_required.append(k)
+        # Optional with null & required
+        if v.anyOf is not None and [x for x in v.anyOf if x.type == 'null']:
+            if k in schema.required:
+            # required with default -> not required 
+            # required without default -> required & remove null from union
+                if v.default:
+                    not_required.append(k)
+                else:
+                    v.anyOf = list(filter(lambda x: x.type != 'null', v.anyOf))
+                if len(v.anyOf) == 1:
+                    replacements[k] = v.anyOf[0]
+            else:
+            # not required with default -> no change
+            # not required without default -> means default input is 'None'
+                v.default = v.default if v.default else 'null'
+
+
     schema.required = list(filter(lambda x: x not in not_required, schema.required if schema.required is not None else []))
     for k, v in replacements.items():
         combined = {
@@ -204,7 +216,7 @@ def _fix_optional(schema):
         }
         schema.properties[k] = JsonSchemaObject(**combined)
         schema.properties[k].anyOf = None
-
+        
     for k in schema.properties.keys():
         if schema.properties[k].type == 'object':
             schema.properties[k] = _fix_optional(schema.properties[k])

ibm_watsonx_orchestrate/agent_builder/tools/types.py

@@ -152,7 +152,7 @@ class ClientSideToolBinding(BaseModel):
 
 class McpToolBinding(BaseModel):
     server_url: Optional[str] = None
-    source: str
+    source: str | None
     connections: Dict[str, str] | None
 
 class FlowToolBinding(BaseModel):

ibm_watsonx_orchestrate/agent_builder/voice_configurations/__init__.py

@@ -0,0 +1 @@
+from .types import VoiceConfiguration

ibm_watsonx_orchestrate/agent_builder/voice_configurations/types.py

@@ -0,0 +1,98 @@
+import json
+from typing import Annotated, Optional, List, Dict
+from pydantic import BaseModel, Field, model_validator
+
+def _validate_exactly_one_of_fields(object: BaseModel, object_name: str, fields: list[str]):
+  present_fields = [getattr(object,field) for field in fields if getattr(object,field) is not None]
+
+  if len(present_fields) != 1:
+    raise ValueError(f"{object_name} requires exactly one of {','.join(fields)}")
+
+
+def _validate_language_uniqueness(config: BaseModel):
+  if hasattr(config,'language') and hasattr(config,'additional_languages'):
+    if config.language and config.additional_languages and config.language in config.additional_languages:
+      raise ValueError(f"Language '{config.language}' cannot be in both the default language and additional_languages")
+
+
+class WatsonSTTConfig(BaseModel):
+  api_url: Annotated[str, Field(min_length=1,max_length=2048)]
+  api_key: Optional[Annotated[str, Field(min_length=1,max_length=2048)]] = None
+  bearer_token: Optional[Annotated[str, Field(min_length=1,max_length=2048)]] = None
+  model: Annotated[str, Field(min_length=1,max_length=256)]
+
+class EmotechSTTConfig(BaseModel):
+  api_key: Annotated[str,Field(min_length=1,max_length=2048)]
+  api_url: Annotated[str,Field(min_length=1,max_length=2048)]
+
+
+class SpeechToTextConfig(BaseModel):
+  provider: Annotated[str, Field(min_length=1,max_length=128)]
+  watson_stt_config: Optional[WatsonSTTConfig] = None
+  emotech_stt_config: Optional[EmotechSTTConfig] = None
+
+  @model_validator(mode='after')
+  def validate_providers(self):
+    _validate_exactly_one_of_fields(self,'SpeechToTextConfig',['watson_stt_config','emotech_stt_config'])
+    return self
+
+class WatsonTTSConfig(BaseModel):
+  api_url: Annotated[str, Field(min_length=1,max_length=2048)]
+  api_key: Optional[Annotated[str, Field(min_length=1,max_length=2048)]] = None
+  bearer_token: Optional[Annotated[str, Field(min_length=1,max_length=2048)]] = None
+  voice: Annotated[str, Field(min_length=1,max_length=128)]
+  rate_percentage: Optional[int] = None
+  pitch_percentage: Optional[int] = None
+  language: Optional[str] = None
+
+class EmotechTTSConfig(BaseModel):
+  api_url: Annotated[str, Field(min_length=1,max_length=2048)]
+  api_key: Annotated[str, Field(min_length=1,max_length=2048)]
+  voice: Optional[Annotated[str, Field(min_length=1,max_length=128)]]
+
+class TextToSpeechConfig(BaseModel):
+  provider: Annotated[str, Field(min_length=1,max_length=128)]
+  watson_tts_config: Optional[WatsonTTSConfig] = None
+  emotech_tts_config: Optional[EmotechTTSConfig] = None
+
+  @model_validator(mode='after')
+  def validate_providers(self):
+    _validate_exactly_one_of_fields(self,'TextToSpeechConfig',['watson_tts_config','emotech_tts_config'])
+    return self
+
+class AdditionalProperties(BaseModel):
+  speech_to_text: Optional[SpeechToTextConfig] = None
+  text_to_speech: Optional[TextToSpeechConfig] = None
+
+class DTMFInput(BaseModel):
+  inter_digit_timeout_ms: Optional[int] = None
+  termination_key: Optional[str] = None
+  maximum_count: Optional[int] = None
+  ignore_speech: Optional[bool] = None
+
+class AttachedAgent(BaseModel):
+  id: str
+  name: Optional[str] = None
+  display_name: Optional[str] = None
+
+class VoiceConfiguration(BaseModel):
+  name: Annotated[str, Field(min_length=1,max_length=128)]
+  speech_to_text: SpeechToTextConfig
+  text_to_speech: TextToSpeechConfig
+  language: Optional[Annotated[str,Field(min_length=2,max_length=16)]] = None
+  additional_languages: Optional[dict[str,AdditionalProperties]] = None
+  dtmf_input: Optional[DTMFInput] = None
+  voice_configuration_id: Optional[str] = None
+  tenant_id: Optional[Annotated[str, Field(min_length=1,max_length=128)]] = None
+  attached_agents: Optional[list[AttachedAgent]] = None
+
+  @model_validator(mode='after')
+  def validate_language(self):
+    _validate_language_uniqueness(self)
+    return self
+
+  def dumps_spec(self) -> str:
+    dumped = self.model_dump(mode='json', exclude_none=True)
+    return json.dumps(dumped, indent=2)
+
+

ibm_watsonx_orchestrate/cli/commands/agents/agents_command.py

@@ -253,3 +253,23 @@ def export_agent(
 ):  
     agents_controller = AgentsController()
     agents_controller.export_agent(name=name, kind=kind, output_path=output_file, agent_only_flag=agent_only_flag)
+
+@agents_app.command(name="deploy", help="Deploy Agent")
+def deploy_agent(
+    name: Annotated[
+        str,
+        typer.Option("--name", "-n", help="Name of the agent you wish to deploy"),
+    ]
+):
+    agents_controller = AgentsController()
+    agents_controller.deploy_agent(name=name)
+
+@agents_app.command(name="undeploy", help="Undeploy Agent")
+def undeploy_agent(
+    name: Annotated[
+        str,
+        typer.Option("--name", "-n", help="Name of the agent you wish to undeploy"),
+    ]
+):
+    agents_controller = AgentsController()
+    agents_controller.undeploy_agent(name=name)