ibm-watsonx-orchestrate 1.10.2__py3-none-any.whl → 1.11.0b1__py3-none-any.whl

ibm_watsonx_orchestrate/__init__.py

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

ibm_watsonx_orchestrate/agent_builder/agents/types.py

@@ -223,6 +223,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 +281,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/agent_builder/connections/types.py

@@ -165,6 +165,53 @@ class ConnectionConfiguration(BaseModel):
             raise ValueError("Connection of type 'key_value' cannot be configured at the 'member' level. Key value connections must be of type 'team'")
         return self
 
+class ConnectionCredentialsEntryLocation(str, Enum):
+    BODY = 'body'
+    HEADER = 'header',
+    QUERY = 'query'
+
+    def __str__(self):
+        return self.value
+
+class ConnectionCredentialsEntry(BaseModel):
+    key: str
+    value: str
+    location: ConnectionCredentialsEntryLocation
+
+    def __str__(self):
+        return f"<ConnectionCredentialsEntry: {self.location}:{self.key}={self.value}>"
+
+class BaseOAuthCredentials(BaseModel):
+    custom_token_query: Optional[dict] = None
+    custom_token_header: Optional[dict] = None
+    custom_token_body: Optional[dict] = None
+    custom_auth_query: Optional[dict] = None
+
+class ConnectionCredentialsCustomFields(BaseOAuthCredentials):
+    def add_field(self, entry: ConnectionCredentialsEntry, is_token:bool=True) -> None:
+        match entry.location:
+            case ConnectionCredentialsEntryLocation.HEADER:
+                if not is_token:
+                    return
+                attribute = "custom_token_header"
+            case ConnectionCredentialsEntryLocation.BODY:
+                if not is_token:
+                    return
+                attribute = "custom_token_body"
+            case ConnectionCredentialsEntryLocation.QUERY:
+                if is_token:
+                     attribute = "custom_token_query"
+                else:
+                    attribute = "custom_auth_query"
+            case _:
+                return
+        
+        fields = getattr(self, attribute)
+        if not fields:
+            setattr(self, attribute, {})
+            fields = getattr(self, attribute)
+        fields[entry.key] = entry.value
+
 class BasicAuthCredentials(BaseModel):
     username: str
     password: str
@@ -182,7 +229,7 @@ class OAuth2TokenCredentials(BaseModel):
     access_token: str
     url: Optional[str] = None
 
-class OAuth2AuthCodeCredentials(BaseModel):
+class OAuth2AuthCodeCredentials(BaseOAuthCredentials):
     client_id: str
     client_secret: str
     token_url: str
@@ -193,7 +240,7 @@ class OAuth2AuthCodeCredentials(BaseModel):
 #     client_id: str
 #     authorization_url: str
 
-class OAuth2PasswordCredentials(BaseModel):
+class OAuth2PasswordCredentials(BaseOAuthCredentials):
     username: str
     password: str
     client_id: str
@@ -203,7 +250,7 @@ class OAuth2PasswordCredentials(BaseModel):
     grant_type: str = "password"
     
 
-class OAuth2ClientCredentials(BaseModel):
+class OAuth2ClientCredentials(BaseOAuthCredentials):
     client_id: str
     client_secret: str
     token_url: str
@@ -211,7 +258,7 @@ class OAuth2ClientCredentials(BaseModel):
     send_via: ConnectionSendVia = ConnectionSendVia.HEADER
     grant_type: str = "client_credentials"
 
-class OAuthOnBehalfOfCredentials(BaseModel):
+class OAuthOnBehalfOfCredentials(BaseOAuthCredentials):
     client_id: str
     access_token_url: str
     grant_type: str
@@ -267,7 +314,7 @@ CONNECTION_TYPE_CREDENTIAL_MAPPING = {
     ConnectionSecurityScheme.KEY_VALUE: KeyValueConnectionCredentials,
 }
 
-class IdentityProviderCredentials(BaseModel):
+class IdentityProviderCredentials(BaseOAuthCredentials):
     idp_url: str = Field(validation_alias=AliasChoices('idp_url', 'url'), serialization_alias='idp_url')
     client_id: str
     client_secret: str
@@ -276,4 +323,4 @@ class IdentityProviderCredentials(BaseModel):
 
 class ExpectedCredentials(BaseModel):
     app_id: str
-    type: ConnectionType | List[ConnectionType]
+    type: ConnectionType | List[ConnectionType]

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]
+    collection: Optional[str] = None
+    table: Optional[str] = None
+    index_column: Optional[str] = None
     embedding_mode: str
-    embedding_model_id: Optional[str]
-    credentials: dict
-    search_mode: str
+    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/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,