ibm-watsonx-orchestrate 1.13.0b0__tar.gz → 1.13.0b1__tar.gz

{ibm_watsonx_orchestrate-1.13.0b0 → ibm_watsonx_orchestrate-1.13.0b1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ibm-watsonx-orchestrate
-Version: 1.13.0b0
+Version: 1.13.0b1
 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.1.3
+Requires-Dist: ibm-watsonx-orchestrate-evaluation-framework==1.1.5
 Requires-Dist: jsonref==1.1.0
 Requires-Dist: langchain-core<=0.3.63
 Requires-Dist: langsmith<=0.3.45

{ibm_watsonx_orchestrate-1.13.0b0 → ibm_watsonx_orchestrate-1.13.0b1}/pyproject.toml

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

{ibm_watsonx_orchestrate-1.13.0b0 → ibm_watsonx_orchestrate-1.13.0b1}/src/ibm_watsonx_orchestrate/__init__.py

@@ -5,7 +5,7 @@
 
 pkg_name = "ibm-watsonx-orchestrate"
 
-__version__ = "1.13.0b0"
+__version__ = "1.13.0b1"
 
 
 

{ibm_watsonx_orchestrate-1.13.0b0 → ibm_watsonx_orchestrate-1.13.0b1}/src/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"
@@ -240,6 +241,7 @@ class AstraDBConnection(BaseModel):
 
 class IndexConnection(BaseModel):
     connection_id: Optional[str] = None
+    app_id: Optional[str] = None
     milvus: Optional[MilvusConnection] = None
     elastic_search: Optional[ElasticSearchConnection] = None
     custom_search: Optional[CustomSearchConnection] = None

{ibm_watsonx_orchestrate-1.13.0b0 → ibm_watsonx_orchestrate-1.13.0b1}/src/ibm_watsonx_orchestrate/cli/commands/agents/agents_controller.py

@@ -16,7 +16,7 @@ from pydantic import BaseModel
 from ibm_watsonx_orchestrate.agent_builder.agents.types import AgentStyle
 from ibm_watsonx_orchestrate.agent_builder.tools.types import ToolSpec
 from ibm_watsonx_orchestrate.cli.commands.tools.tools_controller import import_python_tool, ToolsController
-from ibm_watsonx_orchestrate.cli.commands.knowledge_bases.knowledge_bases_controller import import_python_knowledge_base
+from ibm_watsonx_orchestrate.cli.commands.knowledge_bases.knowledge_bases_controller import import_python_knowledge_base, KnowledgeBaseController
 from ibm_watsonx_orchestrate.cli.commands.models.models_controller import import_python_model
 from ibm_watsonx_orchestrate.cli.common import ListFormats, rich_table_to_markdown
 
@@ -1362,8 +1362,10 @@ class AgentsController:
                         ToolSpec.model_validate(current_spec).model_dump_json(exclude_unset=True,indent=2)
                     )
         
+        knowledge_base_controller = KnowledgeBaseController()
         for kb_name in agent_spec_file_content.get("knowledge_base", []):
-            logger.warning(f"Skipping {kb_name}, knowledge_bases are currently unsupported by export")
+            knowledge_base_file_path = f"{output_file_name}/knowledge-bases/{kb_name}.yaml"
+            knowledge_base_controller.knowledge_base_export(name=kb_name, output_path=knowledge_base_file_path, zip_file_out=zip_file_out)
         
         if kind == AgentKind.NATIVE:
             for collaborator_id in agent.collaborators:

{ibm_watsonx_orchestrate-1.13.0b0 → ibm_watsonx_orchestrate-1.13.0b1}/src/ibm_watsonx_orchestrate/cli/commands/copilot/copilot_command.py

@@ -43,6 +43,10 @@ def prompt_tume_command(
         str,
         typer.Option("--llm", help="Select the agent LLM"),
     ] = None,
+    chat_llm: Annotated[
+        str,
+        typer.Option("--chat-llm", help="Select the underlying model for the copilot. Currently only llama-3-3-70b-instruct is supported."),
+    ] = None,
     samples: Annotated[
         str,
         typer.Option("--samples", "-s", help="Path to utterances sample file (txt file where each line is a utterance, or csv file with a single \"input\" column)"),
@@ -51,6 +55,7 @@ def prompt_tume_command(
     if file is None:
         # create agent yaml from scratch
         create_agent(
+            chat_llm=chat_llm,
             llm=llm,
             output_file=output_file,
             samples_file=samples,
@@ -59,6 +64,7 @@ def prompt_tume_command(
     else:
         # improve existing agent instruction
         prompt_tune(
+            chat_llm=chat_llm,
             agent_spec=file,
             samples_file=samples,
             output_file=output_file,
@@ -77,12 +83,17 @@ def agent_refine(
     ] = None,
     use_last_chat: Annotated[
         bool,
-        typer.Option("--use_last_chat", "-l", help="Tuning by using the last conversation with the agent instead of prompting the user to choose chats"),
+        typer.Option("--use-last-chat", "-l", help="Tuning by using the last conversation with the agent instead of prompting the user to choose chats"),
     ] = False,
     dry_run_flag: Annotated[
         bool,
         typer.Option("--dry-run",
                      help="Dry run will prevent the tuned content being saved and output the results to console"),
     ] = False,
+    chat_llm: Annotated[
+        str,
+        typer.Option("--chat-llm", help="Select the underlying model for the copilot. Currently only llama-3-3-70b-instruct is supported."),
+    ] = None,
+
 ):
-    refine_agent_with_trajectories(agent_name, output_file, use_last_chat, dry_run_flag)
+    refine_agent_with_trajectories(agent_name, chat_llm=chat_llm, output_file=output_file, use_last_chat=use_last_chat, dry_run_flag=dry_run_flag)

{ibm_watsonx_orchestrate-1.13.0b0 → ibm_watsonx_orchestrate-1.13.0b1}/src/ibm_watsonx_orchestrate/cli/commands/copilot/copilot_controller.py

@@ -3,6 +3,7 @@ import os
 import sys
 import csv
 import difflib
+import re
 from datetime import datetime
 
 import rich
@@ -218,12 +219,12 @@ def get_deployed_tools_agents_and_knowledge_bases():
     return {"tools": all_tools, "collaborators": all_agents, "knowledge_bases": all_knowledge_bases}
 
 
-def pre_cpe_step(cpe_client):
+def pre_cpe_step(cpe_client, chat_llm):
     tools_agents_and_knowledge_bases = get_deployed_tools_agents_and_knowledge_bases()
     user_message = ""
     with _get_progress_spinner() as progress:
         task = progress.add_task(description="Initializing Prompt Engine", total=None)
-        response = cpe_client.submit_pre_cpe_chat(user_message=user_message)
+        response = cpe_client.submit_pre_cpe_chat(chat_llm=chat_llm, user_message=user_message)
         progress.remove_task(task)
 
     res = {}
@@ -258,7 +259,7 @@ def pre_cpe_step(cpe_client):
             return res
         with _get_progress_spinner() as progress:
             task = progress.add_task(description="Thinking...", total=None)
-            response = cpe_client.submit_pre_cpe_chat(**message_content)
+            response = cpe_client.submit_pre_cpe_chat(chat_llm=chat_llm,**message_content)
             progress.remove_task(task)
 
 
@@ -314,7 +315,7 @@ def gather_examples(samples_file=None):
     return examples
 
 
-def talk_to_cpe(cpe_client, samples_file=None, context_data=None):
+def talk_to_cpe(cpe_client, chat_llm, samples_file=None, context_data=None):
     context_data = context_data or {}
     examples = gather_examples(samples_file)
     # upload or gather input examples
@@ -322,7 +323,7 @@ def talk_to_cpe(cpe_client, samples_file=None, context_data=None):
     response = None
     with _get_progress_spinner() as progress:
         task = progress.add_task(description="Thinking...", total=None)
-        response = cpe_client.init_with_context(context_data=context_data)
+        response = cpe_client.init_with_context(chat_llm=chat_llm, context_data=context_data)
         progress.remove_task(task)
     accepted_prompt = None
     while accepted_prompt is None:
@@ -334,13 +335,13 @@ def talk_to_cpe(cpe_client, samples_file=None, context_data=None):
             message = Prompt.ask("\n👤 You").strip()
             with _get_progress_spinner() as progress:
                 task = progress.add_task(description="Thinking...", total=None)
-                response = cpe_client.invoke(prompt=message)
+                response = cpe_client.invoke(chat_llm=chat_llm, prompt=message)
                 progress.remove_task(task)
 
     return accepted_prompt
 
 
-def prompt_tune(agent_spec: str, output_file: str | None, samples_file: str | None, dry_run_flag: bool) -> None:
+def prompt_tune(agent_spec: str, chat_llm: str | None, output_file: str | None, samples_file: str | None, dry_run_flag: bool) -> None:
     agent = AgentsController.import_agent(file=agent_spec, app_id=None)[0]
     agent_kind = agent.kind
 
@@ -353,6 +354,7 @@ def prompt_tune(agent_spec: str, output_file: str | None, samples_file: str | No
         output_file = agent_spec
 
     _validate_output_file(output_file, dry_run_flag)
+    _validate_chat_llm(chat_llm)
 
     client = get_cpe_client()
 
@@ -365,6 +367,7 @@ def prompt_tune(agent_spec: str, output_file: str | None, samples_file: str | No
     knowledge_bases = _get_knowledge_bases_from_names(agent.knowledge_base)
     try:
         new_prompt = talk_to_cpe(cpe_client=client,
+                                 chat_llm=chat_llm,
                                  samples_file=samples_file,
                                  context_data={
                                      "initial_instruction": instr,
@@ -387,21 +390,27 @@ def prompt_tune(agent_spec: str, output_file: str | None, samples_file: str | No
         agent.instructions = new_prompt
 
         if dry_run_flag:
-            rich.print(agent.model_dump(exclude_none=True))
+            rich.print(agent.model_dump(exclude_none=True, mode="json"))
         else:
             if os.path.dirname(output_file):
                 os.makedirs(os.path.dirname(output_file), exist_ok=True)
             AgentsController.persist_record(agent, output_file=output_file)
 
+def _validate_chat_llm(chat_llm):
+    if chat_llm:
+        formatted_chat_llm = re.sub(r'[^a-zA-Z0-9/]', '-', chat_llm)
+        if "llama-3-3-70b-instruct" not in formatted_chat_llm:
+            raise BadRequest(f"Unsupported chat model for copilot {chat_llm}. Copilot supports only llama-3-3-70b-instruct at this point.")
 
-def create_agent(output_file: str, llm: str, samples_file: str | None, dry_run_flag: bool = False) -> None:
+def create_agent(output_file: str, llm: str, chat_llm: str | None, samples_file: str | None, dry_run_flag: bool = False) -> None:
     _validate_output_file(output_file, dry_run_flag)
+    _validate_chat_llm(chat_llm)
     # 1. prepare the clients
     cpe_client = get_cpe_client()
 
     # 2. Pre-CPE stage:
     try:
-        res = pre_cpe_step(cpe_client)
+        res = pre_cpe_step(cpe_client, chat_llm=chat_llm)
     except ConnectionError:
         logger.error(
             "Failed to connect to Copilot server. Please ensure Copilot is running via `orchestrate copilot start`")
@@ -419,7 +428,7 @@ def create_agent(output_file: str, llm: str, samples_file: str | None, dry_run_f
     agent_style = res["agent_style"]
 
     # 4. discuss the instructions
-    instructions = talk_to_cpe(cpe_client, samples_file,
+    instructions = talk_to_cpe(cpe_client, chat_llm, samples_file,
                                {'description': description, 'tools': tools, 'collaborators': collaborators,
                                 'knowledge_bases': knowledge_bases})
 
@@ -438,7 +447,7 @@ def create_agent(output_file: str, llm: str, samples_file: str | None, dry_run_f
     agent.spec_version = SpecVersion.V1
 
     if dry_run_flag:
-        rich.print(agent.model_dump(exclude_none=True))
+        rich.print(agent.model_dump(exclude_none=True, mode="json"))
         return
 
     if os.path.dirname(output_file):
@@ -493,7 +502,8 @@ def _suggest_sorted(user_input: str, options: List[str]) -> List[str]:
     return sorted(options, key=lambda x: difflib.SequenceMatcher(None, user_input, x).ratio(), reverse=True)
 
 
-def refine_agent_with_trajectories(agent_name: str, output_file: str | None, use_last_chat: bool=False, dry_run_flag: bool = False) -> None:
+def refine_agent_with_trajectories(agent_name: str, chat_llm: str | None, output_file: str | None,
+                                   use_last_chat: bool=False, dry_run_flag: bool = False) -> None:
     """
     Refines an existing agent's instructions using user selected chat trajectories and saves the updated agent configuration.
 
@@ -510,6 +520,7 @@ def refine_agent_with_trajectories(agent_name: str, output_file: str | None, use
 
     Parameters:
         agent_name (str): The name of the agent to refine.
+        chat_llm (str): The name of the model used by the refiner. If None, default model (llama-3-3-70b) is used.
         output_file (str): Path to the file where the refined agent configuration will be saved.
         use_last_chat(bool): If true, optimize by using the last conversation with the agent, otherwise let the use choose
         dry_run_flag (bool): If True, prints the refined agent configuration without saving it to disk.
@@ -519,6 +530,7 @@ def refine_agent_with_trajectories(agent_name: str, output_file: str | None, use
     """
 
     _validate_output_file(output_file, dry_run_flag)
+    _validate_chat_llm(chat_llm)
     agents_controller = AgentsController()
     agents_client = get_native_client()
     threads_client = get_threads_client()
@@ -535,9 +547,6 @@ def refine_agent_with_trajectories(agent_name: str, output_file: str | None, use
                              f'Available agents:\n'
                              f'{available_sorted_str}')
 
-        rich.print(Panel(message, title="Agent Lookup", border_style="blue"))
-        return
-
     cpe_client = get_cpe_client()
     # Step 2 - retrieve chats (threads)
     try:
@@ -550,7 +559,6 @@ def refine_agent_with_trajectories(agent_name: str, output_file: str | None, use
                 raise BadRequest(
                     f"No chats found for agent '{agent_name}'. To use autotune, please initiate at least one conversation with the agent. You can start a chat using `orchestrate chat start`.",
                    )
-                return
             last_10_threads = all_threads[:10] #TODO use batching when server allows
             last_10_chats = [_format_thread_messages(chat) for chat in
                              threads_client.get_threads_messages([thread['id'] for thread in last_10_threads])]
@@ -621,8 +629,9 @@ def refine_agent_with_trajectories(agent_name: str, output_file: str | None, use
             knowledge_bases = _get_knowledge_bases_from_names(agent.knowledge_base)
             if agent.instructions is None:
                 raise BadRequest("Agent must have instructions in order to use the autotune command. To build an instruction use `orchestrate copilot prompt-tune -f <path_to_agent_yaml> -o <path_to_new_agent_yaml>`")
-            response = cpe_client.refine_agent_with_chats(agent.instructions, tools=tools, collaborators=collaborators,
-                                                          knowledge_bases=knowledge_bases, trajectories_with_feedback=threads_messages)
+            response = cpe_client.refine_agent_with_chats(instruction=agent.instructions, chat_llm=chat_llm, tools=tools,
+                                                          collaborators=collaborators, knowledge_bases=knowledge_bases,
+                                                          trajectories_with_feedback=threads_messages)
             progress.remove_task(task)
             progress.refresh()
     except ConnectionError:
@@ -638,7 +647,7 @@ def refine_agent_with_trajectories(agent_name: str, output_file: str | None, use
     agent.instructions = response['instruction']
 
     if dry_run_flag:
-        rich.print(agent.model_dump(exclude_none=True))
+        rich.print(agent.model_dump(exclude_none=True, mode="json"))
         return
 
     if os.path.dirname(output_file):

{ibm_watsonx_orchestrate-1.13.0b0 → ibm_watsonx_orchestrate-1.13.0b1}/src/ibm_watsonx_orchestrate/cli/commands/evaluations/evaluations_command.py

@@ -17,10 +17,13 @@ from typing_extensions import Annotated
 
 from ibm_watsonx_orchestrate import __version__
 from ibm_watsonx_orchestrate.cli.commands.evaluations.evaluations_controller import EvaluationsController, EvaluateMode
+from ibm_watsonx_orchestrate.cli.commands.evaluations.evaluations_environment_manager import run_environment_manager
 from ibm_watsonx_orchestrate.cli.commands.agents.agents_controller import AgentsController
 
 logger = logging.getLogger(__name__)
 
+HIDE_ENVIRONMENT_MGR_PANEL = os.environ.get("HIDE_ENVIRONMENT_MGR_PANEL", "true").lower() == "true"
+
 evaluation_app = typer.Typer(no_args_is_help=True)
 
 def _native_agent_template():
@@ -142,14 +145,38 @@ def evaluate(
             "--env-file", "-e", 
             help="Path to a .env file that overrides default.env. Then environment variables override both."
         ),
-    ] = None
+    ] = None,
+    env_manager_path: Annotated[
+        Optional[str],
+        typer.Option(
+            "--env-manager-path",
+            help="""
+                Path to YAML configuration file containing environment settings.\n
+                See `./examples/evaluations/environment_manager` on how to create the environment manager file.
+                Note: When using this feature, you must pass the `output_dir`.
+            """,
+            rich_help_panel="Environment Manager",
+            hidden=HIDE_ENVIRONMENT_MGR_PANEL
+        )
+    ] = None,
 ):
+    validate_watsonx_credentials(user_env_file)
+
+    if env_manager_path:
+        if output_dir:
+            return run_environment_manager(
+                environment_manager_path=env_manager_path,
+                output_dir=output_dir,
+            )
+        else:
+            logger.error("Error: `--env_manager_path`, `--output_dir` must be provided to use the environment manager feature.")
+            sys.exit(1)
+
     if not config_file:
         if not test_paths or not output_dir:
             logger.error("Error: Both --test-paths and --output-dir must be provided when not using a config file")
             exit(1)
-    
-    validate_watsonx_credentials(user_env_file)
+
     controller = EvaluationsController()
     controller.evaluate(config_file=config_file, test_paths=test_paths, output_dir=output_dir)
 

ibm_watsonx_orchestrate-1.13.0b1/src/ibm_watsonx_orchestrate/cli/commands/evaluations/evaluations_environment_manager.py

@@ -0,0 +1,158 @@
+import logging
+import yaml
+from typing import Mapping, Any
+from enum import StrEnum
+from pathlib import Path
+
+from ibm_watsonx_orchestrate.cli.commands.agents.agents_controller import (
+    AgentsController,
+    Agent,
+    ExternalAgent,
+    AssistantAgent,
+)
+from ibm_watsonx_orchestrate.cli.commands.tools.tools_controller import (
+    ToolsController,
+    BaseTool,
+)
+from ibm_watsonx_orchestrate.cli.commands.knowledge_bases.knowledge_bases_controller import (
+    KnowledgeBaseController,
+    KnowledgeBase,
+)
+from ibm_watsonx_orchestrate.cli.commands.knowledge_bases.knowledge_bases_controller import (
+    parse_file as kb_parse_file,
+)
+from ibm_watsonx_orchestrate.cli.commands.evaluations.evaluations_controller import (
+    EvaluationsController,
+    EvaluateMode,
+)
+
+
+logger = logging.getLogger(__name__)
+
+
+class ArtifactTypes(StrEnum):
+    """The allowed artifacts in the environment manager path.
+
+    The environment manager config looks like this:
+    ```json
+        env1:
+            agent:
+                agents_path: None
+            tools:
+                tools_path: None
+                tool_kind: None
+                # any other tool flags
+            knowledge:
+                knowledge_base_path: None
+        test_config: # path to config.yaml
+        clean_up: True
+    ```
+    The allowed artifacts/keys are "agent", "tools", "knowledge"
+    """
+
+    agent = "agent"
+    tools = "tools"
+    knowledge = "knowledge"
+
+
+class TestCaseManager:
+    def __init__(
+        self,
+        env_settings: Mapping[str, Any],
+        output_dir: str,
+        mode: EvaluateMode = EvaluateMode.default,
+    ):
+        self.env_settings = env_settings
+        self.cleanup = env_settings.get("clean_up", False)
+        self.output_dir = output_dir
+        self.mode = mode
+
+        self.agent_controller = AgentsController()
+        self.knowledge_controller = KnowledgeBaseController()
+        self.tool_controller = None
+        if (tool_settings := env_settings.get(ArtifactTypes.tools)):
+            self.tool_controller = ToolsController(
+                tool_kind=tool_settings.get("kind"),
+                file=tool_settings.get("file"),
+                requirements_file=tool_settings.get("requirements_file")
+            )
+
+        self.imported_artifacts = []
+
+    def __enter__(self):
+        for artifact in [
+            ArtifactTypes.tools,
+            ArtifactTypes.knowledge,
+            ArtifactTypes.agent,
+        ]:
+            if artifact not in self.env_settings:
+                continue
+
+            artifact_settings = self.env_settings.get(artifact)
+            if artifact == ArtifactTypes.tools:
+                tools = ToolsController.import_tool(**artifact_settings)
+                # import_tool returns Iterator[BaseTool], copy the iterator into a list for preservation
+                # this is needed if user wants environment cleanup
+                tools = [tool for tool in tools]
+                self.imported_artifacts.append(tools)
+                self.tool_controller.publish_or_update_tools(tools)
+            elif artifact == ArtifactTypes.knowledge:
+                KnowledgeBaseController.import_knowledge_base(**artifact_settings)
+                kb_spec = kb_parse_file(artifact_settings.get("file"))
+                self.imported_artifacts.append(kb_spec)
+            elif artifact == ArtifactTypes.agent:
+                artifact_settings["app_id"] = artifact_settings.get("app_id", None)
+                agents = AgentsController.import_agent(**artifact_settings)
+                self.agent_controller.publish_or_update_agents(agents)
+                self.imported_artifacts.append(agents)
+
+        eval = EvaluationsController()
+        eval.evaluate(
+            test_paths=self.env_settings.get("test_paths"),
+            output_dir=self.output_dir,
+            mode=self.mode,
+        )
+
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        if self.cleanup:
+            logger.info("Cleaning environment")
+            for artifact in self.imported_artifacts:
+                # artifact can be a list of agents, tools
+                for item in artifact:
+                    if isinstance(item, BaseTool):
+                        self.tool_controller.remove_tool(item.__tool_spec__.name)
+                    if isinstance(item, KnowledgeBase):
+                        self.knowledge_controller.remove_knowledge_base(
+                            item.id, item.name
+                        )
+                    if isinstance(item, (Agent, AssistantAgent, ExternalAgent)):
+                        self.agent_controller.remove_agent(item.name, item.kind)
+
+
+def run_environment_manager(
+    environment_manager_path: str,
+    mode: EvaluateMode = EvaluateMode.default,
+    output_dir: str = None,
+):
+    with open(environment_manager_path, encoding="utf-8", mode="r") as f:
+        env_settings = yaml.load(f, Loader=yaml.SafeLoader)
+
+    for env in env_settings:
+        if not env_settings.get(env).get("enabled"):
+            continue
+        results_folder = Path(output_dir) / env
+        results_folder.mkdir(parents=True, exist_ok=True)
+        logger.info(
+            "Processing environment: '%s'. Results will be saved to '%s'",
+            env,
+            results_folder,
+        )
+
+        with TestCaseManager(
+            env_settings=env_settings.get(env),
+            output_dir=str(results_folder),
+            mode=mode,
+        ):
+            logger.info("Finished evaluation for environment: '%s'", env)

{ibm_watsonx_orchestrate-1.13.0b0 → ibm_watsonx_orchestrate-1.13.0b1}/src/ibm_watsonx_orchestrate/cli/commands/knowledge_bases/knowledge_bases_command.py

@@ -59,3 +59,29 @@ def knowledge_base_status(
 ):  
     controller = KnowledgeBaseController()
     controller.knowledge_base_status(id=id, name=name)
+
+@knowledge_bases_app.command(name="export", help='Export a knowledge base spec to a yaml')
+def knowledge_base_export(
+    output_file: Annotated[
+        str,
+        typer.Option(
+            "--output",
+            "-o",
+            help="Path to a where the zip file containing the exported data should be saved",
+        ),
+    ],
+    name: Annotated[
+        str,
+        typer.Option("--name", "-n", help="The name of the knowledge base you want to export"),
+    ]=None,
+    id: Annotated[
+        str,
+        typer.Option("--id", "-i", help="The ID of the knowledge base you wish export"),
+    ]=None,
+):
+    controller = KnowledgeBaseController()
+    controller.knowledge_base_export(
+        id=id,
+        name=name,
+        output_path=output_file
+    )