aiverify-moonshot 0.4.1__py3-none-any.whl → 0.4.2__py3-none-any.whl

moonshot/integrations/cli/benchmark/cookbook.py

@@ -23,6 +23,7 @@ from moonshot.integrations.cli.benchmark.recipe import (
     display_view_statistics_format,
 )
 from moonshot.integrations.cli.common.display_helper import display_view_list_format
+from moonshot.src.utils.find_feature import find_keyword
 
 console = Console()
 
@@ -55,7 +56,7 @@ def add_cookbook(args) -> None:
         print(f"[add_cookbook]: {str(e)}")
 
 
-def list_cookbooks() -> None:
+def list_cookbooks(args) -> list | None:
     """
     List all available cookbooks.
 
@@ -63,12 +64,27 @@ def list_cookbooks() -> None:
     moonshot.api module.
     It then displays the retrieved cookbooks using the display_cookbooks function.
 
+    Args:
+        args: A namespace object from argparse. It should have an optional attribute:
+        find (str): Optional field to find cookbook(s) with a keyword.
+
     Returns:
-        None
+        list | None: A list of Cookbook or None if there is no result.
     """
     try:
         cookbooks_list = api_get_all_cookbook()
-        display_cookbooks(cookbooks_list)
+        keyword = args.find.lower() if args.find else ""
+        if keyword:
+            filtered_cookbooks_list = find_keyword(keyword, cookbooks_list)
+            if filtered_cookbooks_list:
+                display_cookbooks(filtered_cookbooks_list)
+                return filtered_cookbooks_list
+            else:
+                print("No cookbooks containing keyword found.")
+                return None
+        else:
+            display_cookbooks(cookbooks_list)
+            return cookbooks_list
     except Exception as e:
         print(f"[list_cookbooks]: {str(e)}")
 
@@ -340,9 +356,9 @@ def show_cookbook_results(cookbooks, endpoints, cookbook_results, duration):
         console.print("[red]There are no results.[/red]")
 
     # Print run stats
-    console.print(
-        f"{'='*50}\n[blue]Time taken to run: {duration}s[/blue]\n*Overall rating will be the lowest grade that the recipes have in each cookbook\n{'='*50}"
-    )
+    run_stats = f"""{'='*50}\n[blue]Time taken to run: {duration}s[/blue]\n*Overall rating will be the lowest grade
+     that the recipes have in each cookbook\n{'='*50}"""
+    console.print(run_stats)
 
 
 def generate_cookbook_table(cookbooks: list, endpoints: list, results: dict) -> None:
@@ -543,3 +559,17 @@ run_cookbook_args.add_argument(
     default="benchmarking-result",
     help="Result processing module to use",
 )
+
+# List cookbook arguments
+list_cookbooks_args = cmd2.Cmd2ArgumentParser(
+    description="List all cookbooks.",
+    epilog='Example:\n list_cookbooks -f "risk"',
+)
+
+list_cookbooks_args.add_argument(
+    "-f",
+    "--find",
+    type=str,
+    help="Optional field to find cookbook(s) with keyword",
+    nargs="?",
+)

moonshot/integrations/cli/benchmark/datasets.py

@@ -8,6 +8,7 @@ from moonshot.api import (
     api_get_all_datasets_name,
 )
 from moonshot.integrations.cli.common.display_helper import display_view_str_format
+from moonshot.src.utils.find_feature import find_keyword
 
 console = Console()
 
@@ -15,7 +16,7 @@ console = Console()
 # ------------------------------------------------------------------------------
 # CLI Functions
 # ------------------------------------------------------------------------------
-def list_datasets() -> None:
+def list_datasets(args) -> list | None:
     """
     List all available datasets.
 
@@ -23,13 +24,28 @@ def list_datasets() -> None:
     moonshot.api module. It then displays the datasets using the display_datasets function. If an exception occurs,
     it prints an error message.
 
+    Args:
+        args: A namespace object from argparse. It should have an optional attribute:
+        find (str): Optional field to find dataset(s) with a keyword.
+
     Returns:
-        None
+        list | None: A list of Dataset or None if there is no result.
     """
     try:
         print("Listing datasets may take a while...")
         datasets_list = api_get_all_datasets()
-        display_datasets(datasets_list)
+        keyword = args.find.lower() if args.find else ""
+        if keyword:
+            filtered_datasets_list = find_keyword(keyword, datasets_list)
+            if filtered_datasets_list:
+                display_datasets(filtered_datasets_list)
+                return filtered_datasets_list
+            else:
+                print("No datasets containing keyword found.")
+                return None
+        else:
+            display_datasets(datasets_list)
+            return datasets_list
     except Exception as e:
         print(f"[list_datasets]: {str(e)}")
 
@@ -162,3 +178,17 @@ delete_dataset_args = cmd2.Cmd2ArgumentParser(
     epilog="Example:\n delete_dataset bbq-lite-age-ambiguous",
 )
 delete_dataset_args.add_argument("dataset", type=str, help="Name of the dataset")
+
+# List dataset arguments
+list_datasets_args = cmd2.Cmd2ArgumentParser(
+    description="List all datasets.",
+    epilog='Example:\n list_datasets -f "bbq"',
+)
+
+list_datasets_args.add_argument(
+    "-f",
+    "--find",
+    type=str,
+    help="Optional field to find dataset(s) with keyword",
+    nargs="?",
+)

moonshot/integrations/cli/benchmark/metrics.py

@@ -3,6 +3,7 @@ from rich.console import Console
 from rich.table import Table
 
 from moonshot.api import api_delete_metric, api_get_all_metric, api_get_all_metric_name
+from moonshot.src.utils.find_feature import find_keyword
 
 console = Console()
 
@@ -10,7 +11,7 @@ console = Console()
 # ------------------------------------------------------------------------------
 # CLI Functions
 # ------------------------------------------------------------------------------
-def list_metrics() -> None:
+def list_metrics(args) -> list | None:
     """
     List all available metrics.
 
@@ -18,13 +19,28 @@ def list_metrics() -> None:
     moonshot.api module. It then displays the metrics using the display_metrics function. If an exception occurs,
     it prints an error message.
 
+    Args:
+        args: A namespace object from argparse. It should have an optional attribute:
+        find (str): Optional field to find metric(s) with a keyword.
+
     Returns:
-        None
+        list | None: A list of Metric or None if there is no result.
     """
     try:
         print("Listing metrics may take a while...")
         metrics_list = api_get_all_metric()
-        display_metrics(metrics_list)
+        keyword = args.find.lower() if args.find else ""
+        if keyword:
+            filtered_metrics_list = find_keyword(keyword, metrics_list)
+            if filtered_metrics_list:
+                display_metrics(filtered_metrics_list)
+                return filtered_metrics_list
+            else:
+                print("No metrics containing keyword found.")
+                return None
+        else:
+            display_metrics(metrics_list)
+            return metrics_list
     except Exception as e:
         print(f"[list_metrics]: {str(e)}")
 
@@ -139,3 +155,17 @@ delete_metric_args = cmd2.Cmd2ArgumentParser(
     epilog="Example:\n delete_metric my-new-metric",
 )
 delete_metric_args.add_argument("metric", type=str, help="Name of the metric")
+
+# List metric arguments
+list_metrics_args = cmd2.Cmd2ArgumentParser(
+    description="List all metrics.",
+    epilog='Example:\n list_metrics -f "exact"',
+)
+
+list_metrics_args.add_argument(
+    "-f",
+    "--find",
+    type=str,
+    help="Optional field to find metric(s) with keyword",
+    nargs="?",
+)

moonshot/integrations/cli/benchmark/recipe.py

@@ -18,6 +18,7 @@ from moonshot.api import (
     api_update_recipe,
 )
 from moonshot.integrations.cli.common.display_helper import display_view_list_format
+from moonshot.src.utils.find_feature import find_keyword
 
 console = Console()
 
@@ -74,7 +75,7 @@ def add_recipe(args) -> None:
         print(f"[add_recipe]: {str(e)}")
 
 
-def list_recipes() -> None:
+def list_recipes(args) -> list | None:
     """
     List all available recipes.
 
@@ -82,12 +83,27 @@ def list_recipes() -> None:
     moonshot.api module.
     It then displays the retrieved recipes using the display_recipes function.
 
+    Args:
+        args: A namespace object from argparse. It should have an optional attribute:
+        find (str): Optional field to find recipe(s) with a keyword.
+
     Returns:
-        None
+        list | None: A list of Recipe or None if there is no result.
     """
     try:
         recipes_list = api_get_all_recipe()
-        display_recipes(recipes_list)
+        keyword = args.find.lower() if args.find else ""
+        if keyword:
+            filtered_recipes_list = find_keyword(keyword, recipes_list)
+            if filtered_recipes_list:
+                display_recipes(filtered_recipes_list)
+                return filtered_recipes_list
+            else:
+                print("No recipes containing keyword found.")
+                return None
+        else:
+            display_recipes(recipes_list)
+            return recipes_list
     except Exception as e:
         print(f"[list_recipes]: {str(e)}")
 
@@ -382,9 +398,9 @@ def show_recipe_results(recipes, endpoints, recipe_results, duration):
         console.print("[red]There are no results.[/red]")
 
     # Print run stats
-    console.print(
-        f"{'='*50}\n[blue]Time taken to run: {duration}s[/blue]\n*Overall rating will be the lowest grade that the recipes have in each cookbook\n{'='*50}"
-    )
+    run_stats = f"""{'='*50}\n[blue]Time taken to run: {duration}s[/blue]\n*Overall rating will be the lowest grade
+    that the recipes have in each cookbook\n{'='*50}"""
+    console.print(run_stats)
 
 
 def generate_recipe_table(recipes: list, endpoints: list, results: dict) -> None:
@@ -596,3 +612,17 @@ run_recipe_args.add_argument(
     default="benchmarking-result",
     help="Result processing module to use",
 )
+
+# List recipe arguments
+list_recipes_args = cmd2.Cmd2ArgumentParser(
+    description="List all recipes.",
+    epilog='Example:\n list_recipes -f "mmlu"',
+)
+
+list_recipes_args.add_argument(
+    "-f",
+    "--find",
+    type=str,
+    help="Optional field to find recipe(s) with keyword",
+    nargs="?",
+)

moonshot/integrations/cli/benchmark/result.py

@@ -9,6 +9,7 @@ from moonshot.integrations.cli.common.display_helper import (
     display_view_list_format,
     display_view_str_format,
 )
+from moonshot.src.utils.find_feature import find_keyword
 
 console = Console()
 
@@ -16,7 +17,7 @@ console = Console()
 # ------------------------------------------------------------------------------
 # CLI Functions
 # ------------------------------------------------------------------------------
-def list_results() -> None:
+def list_results(args) -> list | None:
     """
     List all available results.
 
@@ -24,12 +25,27 @@ def list_results() -> None:
     moonshot.api module. It then creates a table with the result id and name. If there are no results, it prints a
     message indicating that no results were found.
 
+    Args:
+        args: A namespace object from argparse. It should have an optional attribute:
+        find (str): Optional field to find result(s) with a keyword.
+
     Returns:
-        None
+        list | None: A list of Result or None if there is no result.
     """
     try:
         results_list = api_get_all_result()
-        display_results(results_list)
+        keyword = args.find.lower() if args.find else ""
+        if keyword:
+            filtered_results_list = find_keyword(keyword, results_list)
+            if filtered_results_list:
+                display_results(filtered_results_list)
+                return filtered_results_list
+            else:
+                print("No results containing keyword found.")
+                return None
+        else:
+            display_results(results_list)
+            return results_list
     except Exception as e:
         print(f"[list_results]: {str(e)}")
 
@@ -214,3 +230,17 @@ delete_result_args = cmd2.Cmd2ArgumentParser(
     epilog="Example:\n delete_result my-new-cookbook-runner",
 )
 delete_result_args.add_argument("result", type=str, help="Name of the result")
+
+# List result arguments
+list_results_args = cmd2.Cmd2ArgumentParser(
+    description="List all results.",
+    epilog='Example:\n list_results -f "my-runner"',
+)
+
+list_results_args.add_argument(
+    "-f",
+    "--find",
+    type=str,
+    help="Optional field to find result(s) with keyword",
+    nargs="?",
+)

moonshot/integrations/cli/benchmark/run.py

@@ -7,6 +7,7 @@ from moonshot.integrations.cli.common.display_helper import (
     display_view_list_format,
     display_view_str_format,
 )
+from moonshot.src.utils.find_feature import find_keyword
 
 console = Console()
 
@@ -14,7 +15,7 @@ console = Console()
 # ------------------------------------------------------------------------------
 # CLI Functions
 # ------------------------------------------------------------------------------
-def list_runs() -> None:
+def list_runs(args) -> list | None:
     """
     List all runs.
 
@@ -23,12 +24,27 @@ def list_runs() -> None:
     in a user-friendly format on the command line interface. If an exception occurs during the retrieval
     or display process, it prints an error message.
 
+    Args:
+        args: A namespace object from argparse. It should have an optional attribute:
+        find (str): Optional field to find run(s) with a keyword.
+
     Returns:
-        None
+        list | None: A list of Run or None if there is no result.
     """
     try:
         runner_run_info = api_get_all_run()
-        display_runs(runner_run_info)
+        keyword = args.find.lower() if args.find else ""
+        if keyword:
+            filtered_runs_list = find_keyword(keyword, runner_run_info)
+            if filtered_runs_list:
+                display_runs(filtered_runs_list)
+                return filtered_runs_list
+            else:
+                print("No runs containing keyword found.")
+                return None
+        else:
+            display_runs(runner_run_info)
+            return runner_run_info
     except Exception as e:
         print(f"[list_runs]: {str(e)}")
 
@@ -138,3 +154,18 @@ view_run_args = cmd2.Cmd2ArgumentParser(
     epilog="Example:\n view_run my-new-cookbook-runner",
 )
 view_run_args.add_argument("runner_id", type=str, help="Name of the runner")
+
+
+# List run arguments
+list_runs_args = cmd2.Cmd2ArgumentParser(
+    description="List all runs.",
+    epilog='Example:\n list_runs -f "my-run"',
+)
+
+list_runs_args.add_argument(
+    "-f",
+    "--find",
+    type=str,
+    help="Optional field to find run(s) with keyword",
+    nargs="?",
+)

moonshot/integrations/cli/common/common.py

@@ -8,7 +8,9 @@ from moonshot.integrations.cli.common.connectors import (
     delete_endpoint,
     delete_endpoint_args,
     list_connector_types,
+    list_connector_types_args,
     list_endpoints,
+    list_endpoints_args,
     update_endpoint,
     update_endpoint_args,
     view_endpoint,
@@ -18,6 +20,7 @@ from moonshot.integrations.cli.common.prompt_template import (
     delete_prompt_template,
     delete_prompt_template_args,
     list_prompt_templates,
+    list_prompt_templates_args,
 )
 
 
@@ -30,14 +33,17 @@ class CommonCommandSet(cmd2.CommandSet):
     # List contents
     # ------------------------------------------------------------------------------
 
-    def do_list_connector_types(self, _: cmd2.Statement) -> None:
-        list_connector_types()
+    @cmd2.with_argparser(list_connector_types_args)
+    def do_list_connector_types(self, args: argparse.Namespace) -> None:
+        list_connector_types(args)
 
-    def do_list_endpoints(self, _: cmd2.Statement) -> None:
-        list_endpoints()
+    @cmd2.with_argparser(list_endpoints_args)
+    def do_list_endpoints(self, args: argparse.Namespace) -> None:
+        list_endpoints(args)
 
-    def do_list_prompt_templates(self, _: cmd2.Statement) -> None:
-        list_prompt_templates()
+    @cmd2.with_argparser(list_prompt_templates_args)
+    def do_list_prompt_templates(self, args: argparse.Namespace) -> None:
+        list_prompt_templates(args)
 
     @cmd2.with_argparser(delete_prompt_template_args)
     def do_delete_prompt_template(self, args: argparse.Namespace) -> None:

moonshot/integrations/cli/common/connectors.py

@@ -13,6 +13,7 @@ from moonshot.api import (
     api_read_endpoint,
     api_update_endpoint,
 )
+from moonshot.src.utils.find_feature import find_keyword
 
 console = Console()
 
@@ -57,36 +58,66 @@ def add_endpoint(args) -> None:
         print(f"[add_endpoint]: {str(e)}")
 
 
-def list_endpoints() -> None:
+def list_endpoints(args) -> list | None:
     """
     List all endpoints.
 
     This function retrieves all endpoints by calling the api_get_all_endpoint function from the
     moonshot.api module. It then displays the endpoints using the display_endpoints function.
 
+    Args:
+        args: A namespace object from argparse. It should have an optional attribute:
+        find (str): Optional field to find endpoint(s) with a keyword.
+
     Returns:
-        None
+        list | None: A list of ConnectorEndpoint or None if there is no result.
     """
     try:
-        endpoint_list = api_get_all_endpoint()
-        display_endpoints(endpoint_list)
+        endpoints_list = api_get_all_endpoint()
+        keyword = args.find.lower() if args.find else ""
+        if keyword:
+            filtered_endpoints_list = find_keyword(keyword, endpoints_list)
+            if filtered_endpoints_list:
+                display_endpoints(filtered_endpoints_list)
+                return filtered_endpoints_list
+            else:
+                print("No endpoints containing keyword found.")
+                return None
+        else:
+            display_endpoints(endpoints_list)
+            return endpoints_list
     except Exception as e:
         print(f"[list_endpoints]: {str(e)}")
 
 
-def list_connector_types() -> None:
+def list_connector_types(args) -> list | None:
     """
     List all connector types.
 
     This function retrieves all connector types by calling the api_get_all_connector_type function from the
     moonshot.api module. It then displays the connector types using the display_connector_types function.
 
+    Args:
+        args: A namespace object from argparse. It should have an optional attribute:
+        find (str): Optional field to find connector type(s) with a keyword.
+
     Returns:
-        None
+        list | None: A list of Connector or None if there is no result.
     """
     try:
         connector_type_list = api_get_all_connector_type()
-        display_connector_types(connector_type_list)
+        keyword = args.find.lower() if args.find else ""
+        if keyword:
+            filtered_connector_type_list = find_keyword(keyword, connector_type_list)
+            if filtered_connector_type_list:
+                display_connector_types(filtered_connector_type_list)
+                return filtered_connector_type_list
+            else:
+                print("No connectors containing keyword found.")
+                return None
+        else:
+            display_connector_types(connector_type_list)
+            return connector_type_list
     except Exception as e:
         print(f"[list_connector_types]: {str(e)}")
 
@@ -170,7 +201,7 @@ def delete_endpoint(args) -> None:
 # ------------------------------------------------------------------------------
 # Helper functions: Display on cli
 # ------------------------------------------------------------------------------
-def display_connector_types(connector_types):
+def display_connector_types(connector_types: list) -> None:
     """
     Display a list of connector types.
 
@@ -305,7 +336,11 @@ update_endpoint_args = cmd2.Cmd2ArgumentParser(
         "('uri', 'my-uri-loc'), ('token', 'my-token-here')]\""
     ),
 )
-update_endpoint_args.add_argument("endpoint", type=str, help="ID of the endpoint. This field is not editable via CLI after creation.")
+update_endpoint_args.add_argument(
+    "endpoint",
+    type=str,
+    help="ID of the endpoint. This field is not editable via CLI after creation.",
+)
 update_endpoint_args.add_argument(
     "update_kwargs", type=str, help="Update endpoint key/value"
 )
@@ -323,3 +358,32 @@ delete_endpoint_args = cmd2.Cmd2ArgumentParser(
     epilog="Example:\n delete_endpoint openai-gpt4",
 )
 delete_endpoint_args.add_argument("endpoint", type=str, help="ID of the endpoint")
+
+# List endpoint arguments
+list_endpoints_args = cmd2.Cmd2ArgumentParser(
+    description="List all endpoints.",
+    epilog='Example:\n list_endpoints -f "gpt"',
+)
+
+list_endpoints_args.add_argument(
+    "-f",
+    "--find",
+    type=str,
+    help="Optional field to find endpoint(s) with keyword",
+    nargs="?",
+)
+
+
+# List connector types arguments
+list_connector_types_args = cmd2.Cmd2ArgumentParser(
+    description="List all connector types.",
+    epilog='Example:\n list_connector_types -f "openai"',
+)
+
+list_connector_types_args.add_argument(
+    "-f",
+    "--find",
+    type=str,
+    help="Optional field to find connector type(s) with keyword",
+    nargs="?",
+)

moonshot/integrations/cli/common/prompt_template.py

@@ -3,6 +3,7 @@ from rich.console import Console
 from rich.table import Table
 
 from moonshot.api import api_delete_prompt_template, api_get_all_prompt_template_detail
+from moonshot.src.utils.find_feature import find_keyword
 
 console = Console()
 
@@ -10,13 +11,33 @@ console = Console()
 # ------------------------------------------------------------------------------
 # CLI Functions
 # ------------------------------------------------------------------------------
-def list_prompt_templates() -> None:
+def list_prompt_templates(args) -> list | None:
     """
     List all prompt templates available.
+
+    Args:
+        args: A namespace object from argparse. It should have an optional attribute:
+        find (str): Optional field to find prompt template(s) with a keyword.
+
+    Returns:
+        list | None: A list of PromptTemplate or None if there is no result.
     """
     try:
-        prompt_templates = api_get_all_prompt_template_detail()
-        display_prompt_templates(prompt_templates)
+        prompt_templates_list = api_get_all_prompt_template_detail()
+        keyword = args.find.lower() if args.find else ""
+        if keyword:
+            filtered_prompt_templates_list = find_keyword(
+                keyword, prompt_templates_list
+            )
+            if filtered_prompt_templates_list:
+                display_prompt_templates(filtered_prompt_templates_list)
+                return filtered_prompt_templates_list
+            else:
+                print("No prompt templates containing keyword found.")
+                return None
+        else:
+            display_prompt_templates(prompt_templates_list)
+            return prompt_templates_list
     except Exception as e:
         print(f"[list_prompt_templates]: {str(e)}")
 
@@ -92,3 +113,17 @@ delete_prompt_template_args = cmd2.Cmd2ArgumentParser(
 delete_prompt_template_args.add_argument(
     "prompt_template", type=str, help="The ID of the prompt template to delete"
 )
+
+# List prompt template arguments
+list_prompt_templates_args = cmd2.Cmd2ArgumentParser(
+    description="List all prompt templates.",
+    epilog='Example:\n list_prompt_templates -f "toxicity"',
+)
+
+list_prompt_templates_args.add_argument(
+    "-f",
+    "--find",
+    type=str,
+    help="Optional field to find prompt template(s) with keyword",
+    nargs="?",
+)