shaped 1.0.1__py3-none-any.whl → 2.0.0__py3-none-any.whl

shaped/cli/shaped_cli.py

@@ -1,8 +1,6 @@
 import json
 import sys
-import urllib
 from pathlib import Path
-from typing import List, Optional
 
 import pandas as pd
 import pyarrow.parquet as pq
@@ -40,7 +38,7 @@ def _read_config() -> Config:
 
 
 def _get_shaped_url(config: Config) -> str:
-    return f"https://api.{config.env}.shaped.ai/v1"
+    return f"https://api.{config.env}.shaped.ai/v2"
 
 
 def _parse_file_as_json(file: typer.FileText) -> str:
@@ -64,19 +62,45 @@ def _parse_response_as_yaml(content: str) -> str:
 
 
 @app.command()
-def init(api_key: str = typer.Option(...), env: str = typer.Option("prod")):
+def init(
+    api_key: str = typer.Option(..., help="Your Shaped API key."),
+    env: str = typer.Option("prod", help="Environment to use (e.g., prod, dev, staging)."),
+):
+    """
+    Initialize the Shaped CLI with your API key and environment.
+    
+    This command saves your configuration locally so you don't need to
+    provide your API key for every command.
+    """
     config = Config(api_key=api_key, env=env)
     _write_config(config)
     typer.echo(f"Initializing with config: {config.dict()}")
 
 
+##############
+# ENGINE API #
+##############
+
 @app.command()
-def create_model(
-    file: typer.FileText = typer.Option(None),
+def create_engine(
+    file: typer.FileText = typer.Option(
+        None, help="Path to a JSON or YAML file containing the engine configuration."
+    ),
 ):
+    """
+    Create a new engine.
+    
+    The engine configuration can be provided via:
+    - --file: Path to a JSON/YAML file
+    - stdin: Pipe JSON/YAML content
+    """
     config = _read_config()
-    url = f"{_get_shaped_url(config)}/models"
-    headers = {"accept": "application/json", "x-api-key": config.api_key}
+    url = f"{_get_shaped_url(config)}/engines"
+    headers = {
+        "accept": "application/json",
+        "content-type": "application/json",
+        "x-api-key": config.api_key,
+    }
 
     if not sys.stdin.isatty():
         payload = sys.stdin.read()
@@ -87,14 +111,32 @@ def create_model(
 
     typer.echo(payload)
     response = requests.post(url, headers=headers, data=payload)
+    if response.status_code not in [200, 201]:
+        typer.echo(f"Error: {response.status_code}\n{response.text}")
+        raise typer.Exit(1)
     typer.echo(_parse_response_as_yaml(response.text))
 
 
 @app.command()
-def update_model(file: typer.FileText = typer.Option(None)):
+def update_engine(
+    file: typer.FileText = typer.Option(
+        None, help="Path to a JSON or YAML file containing the engine configuration."
+    ),
+):
+    """
+    Update an existing engine.
+    
+    The engine configuration can be provided via:
+    - --file: Path to a JSON/YAML file
+    - stdin: Pipe JSON/YAML content
+    """
     config = _read_config()
-    url = f"{_get_shaped_url(config)}/models"
-    headers = {"accept": "application/json", "x-api-key": config.api_key}
+    url = f"{_get_shaped_url(config)}/engines"
+    headers = {
+        "accept": "application/json",
+        "content-type": "application/json",
+        "x-api-key": config.api_key,
+    }
 
     if not sys.stdin.isatty():
         payload = sys.stdin.read()
@@ -105,150 +147,80 @@ def update_model(file: typer.FileText = typer.Option(None)):
 
     typer.echo(payload)
     response = requests.patch(url, headers=headers, data=payload)
+    if response.status_code != 200:
+        typer.echo(f"Error: {response.status_code}\n{response.text}")
+        raise typer.Exit(1)
     typer.echo(_parse_response_as_yaml(response.text))
 
 
 @app.command()
-def list_models():
-    config = _read_config()
-    url = f"{_get_shaped_url(config)}/models"
-    headers = {"accept": "application/json", "x-api-key": config.api_key}
-    response = requests.get(url, headers=headers)
-    typer.echo(_parse_response_as_yaml(response.text))
-
-
-@app.command()
-def view_model(model_name: str = typer.Option(...)):
+def list_engines():
+    """
+    List all engines.
+    """
     config = _read_config()
-    url = f"{_get_shaped_url(config)}/models/{model_name}"
+    url = f"{_get_shaped_url(config)}/engines"
     headers = {"accept": "application/json", "x-api-key": config.api_key}
     response = requests.get(url, headers=headers)
+    if response.status_code != 200:
+        typer.echo(f"Error: {response.status_code}\n{response.text}")
+        raise typer.Exit(1)
     typer.echo(_parse_response_as_yaml(response.text))
 
 
 @app.command()
-def delete_model(model_name: str = typer.Option(...)):
-    config = _read_config()
-    url = f"{_get_shaped_url(config)}/models/{model_name}"
-    headers = {"accept": "application/json", "x-api-key": config.api_key}
-    response = requests.delete(url, headers=headers)
-    typer.echo(_parse_response_as_yaml(response.text))
-
-
-@app.command()
-def rank(
-    model_name: str = typer.Option(...),
-    user_id=typer.Option(None),
-    limit=typer.Option(15),
-    filter_predicate=typer.Option(None),
-    text_query: str = typer.Option(None),
-    return_metadata: bool = typer.Option(False),
-    flush_paginations: bool = typer.Option(False),
-    exploration_factor: float = typer.Option(0.0),
-    diversity_factor: float = typer.Option(0.0),
-    extra_query_args: str = typer.Option(None),
+def view_engine(
+    engine_name: str = typer.Option(..., help="Name of the engine to view."),
 ):
+    """
+    View the configuration of a specific engine.
+    """
     config = _read_config()
-    url = f"{_get_shaped_url(config)}/models/{model_name}/rank"
+    url = f"{_get_shaped_url(config)}/engines/{engine_name}"
     headers = {"accept": "application/json", "x-api-key": config.api_key}
-    if exploration_factor < 0.0 or exploration_factor > 1.0:
-        raise typer.BadParameter("`exploration_factor` must be between 0.0 and 1.0")
-
-    if diversity_factor < 0.0:
-        raise typer.BadParameter("`diversity_factor` must be greater than 0.0")
-
-    query_args = {
-        "exploration_factor": exploration_factor,
-        "diversity_factor": diversity_factor,
-        "limit": str(limit),
-    }
-
-    if user_id is not None:
-        query_args |= {"user_id": user_id}
-    if filter_predicate is not None:
-        query_args |= {"filter_predicate": filter_predicate}
-    if return_metadata is not None:
-        query_args |= {"return_metadata": bool(return_metadata)}
-    if text_query is not None:
-        query_args |= {"text_query": text_query}
-    if flush_paginations is not None:
-        query_args |= {"flush_paginations": flush_paginations}
-    if extra_query_args is not None:
-        extra_query_args = json.loads(extra_query_args)
-        query_args |= extra_query_args
-
-    response = requests.post(url, headers=headers, json=query_args)
+    response = requests.get(url, headers=headers)
+    if response.status_code != 200:
+        typer.echo(f"Error: {response.status_code}\n{response.text}")
+        raise typer.Exit(1)
     typer.echo(_parse_response_as_yaml(response.text))
 
 
 @app.command()
-def complement_items(
-    model_name: str = typer.Option(...),
-    item_ids: List[str] = typer.Option(...),
-    user_id: Optional[str] = typer.Option(None),
-    return_metadata: bool = typer.Option(False),
-    limit=typer.Option(15),
+def delete_engine(
+    engine_name: str = typer.Option(..., help="Name of the engine to delete."),
 ):
+    """
+    Delete an engine.
+    """
     config = _read_config()
-    url = f"{_get_shaped_url(config)}/models/{model_name}/complement_items"
+    url = f"{_get_shaped_url(config)}/engines/{engine_name}"
     headers = {"accept": "application/json", "x-api-key": config.api_key}
-    query_args = {
-        "config": {
-            "limit": str(limit),
-        },
-        "item_ids": item_ids,
-    }
-    if user_id is not None:
-        query_args |= {"user_id": user_id}
-    if return_metadata is not None:
-        query_args |= {"return_metadata": bool(return_metadata)}
-
-    response = requests.post(url, headers=headers, json=query_args)
-    typer.echo(_parse_response_as_yaml(response.text))
+    response = requests.delete(url, headers=headers)
+    if response.status_code not in [200, 204]:
+        typer.echo(f"Error: {response.status_code}\n{response.text}")
+        raise typer.Exit(1)
+    if response.text:
+        typer.echo(_parse_response_as_yaml(response.text))
 
 
-@app.command()
-def similar_items(
-    model_name: str = typer.Option(...),
-    item_id: str = typer.Option(...),
-    user_id: Optional[str] = typer.Option(None),
-    limit=typer.Option(15),
-    extra_query_args: str = typer.Option(None),
-):
-    config = _read_config()
-    item_id = urllib.parse.quote(item_id, safe="/", encoding=None, errors=None)
-    path = f"/models/{model_name}/similar_items"
-    path += f"?limit={limit}&item_id={item_id}"
-    if user_id is not None:
-        user_id = urllib.parse.quote(user_id, safe="/", encoding=None, errors=None)
-        path += f"&user_id={user_id}"
-
-    url = f"{_get_shaped_url(config)}{path}"
-    headers = {"accept": "application/json", "x-api-key": config.api_key}
-    response = requests.get(url, headers=headers)
-    typer.echo(_parse_response_as_yaml(response.text))
+##############
+# TABLE API   #
+##############
 
 
 @app.command()
-def similar_users(
-    model_name: str = typer.Option(...),
-    user_id: str = typer.Option(...),
-    limit=typer.Option(15),
-):
-    config = _read_config()
-    url = f"{_get_shaped_url(config)}/models/{model_name}/similar_users"
-    url += f"?limit={limit}&user_id={user_id}"
-    headers = {"accept": "application/json", "x-api-key": config.api_key}
-    response = requests.get(url, headers=headers)
-    typer.echo(_parse_response_as_yaml(response.text))
-
-
-@app.command()
-def create_dataset_from_uri(
-    name: str = typer.Option(...),
-    path: str = typer.Option(...),
-    type: str = typer.Option(...),
+def create_table_from_uri(
+    name: str = typer.Option(..., help="Name of the table to create."),
+    path: str = typer.Option(..., help="Path to the data file."),
+    type: str = typer.Option(
+        ..., help="File type. One of: parquet, csv, tsv, json, jsonl."
+    ),
 ):
+    """
+    Create a table from a data file and automatically insert the data.
+    
+    The table schema is inferred from the first chunk of data.
+    """
     chunks = _read_chunks(path, type, chunk_size=1)
     chunk = next(iter(chunks))
     if chunk is None:
@@ -259,18 +231,29 @@ def create_dataset_from_uri(
         raise ValueError("No columns found.")
 
     chunk_column_definitions = {col: "String" for col in chunk_columns}
-    dataset_definition = {
-        "dataset_name": name,
+    table_definition = {
+        "name": name,
         "schema_type": "CUSTOM",
-        "schema": chunk_column_definitions,
+        "column_schema": chunk_column_definitions,
     }
-    dataset_created = _create_dataset_from_payload(json.dumps(dataset_definition))
-    if dataset_created:
-        dataset_insert(name, path, type)
+    table_created = _create_table_from_payload(json.dumps(table_definition))
+    if table_created:
+        table_insert(name, path, type)
 
 
 @app.command()
-def create_dataset(file: typer.FileText = typer.Option(None)):
+def create_table(
+    file: typer.FileText = typer.Option(
+        None, help="Path to a JSON or YAML file containing the table configuration."
+    ),
+):
+    """
+    Create a new table.
+    
+    The table configuration can be provided via:
+    - --file: Path to a JSON/YAML file
+    - stdin: Pipe JSON/YAML content
+    """
     if not sys.stdin.isatty():
         payload = sys.stdin.read()
     elif file is not None:
@@ -278,42 +261,78 @@ def create_dataset(file: typer.FileText = typer.Option(None)):
     else:
         raise ValueError("Must provide either a '--file' or stdin input.")
 
-    _create_dataset_from_payload(payload)
+    _create_table_from_payload(payload)
 
 
-def _create_dataset_from_payload(payload: str) -> bool:
+def _create_table_from_payload(payload: str) -> bool:
     config = _read_config()
-    url = f"{_get_shaped_url(config)}/datasets"
-    headers = {"accept": "application/json", "x-api-key": config.api_key}
+    url = f"{_get_shaped_url(config)}/tables"
+    headers = {
+        "accept": "application/json",
+        "content-type": "application/json",
+        "x-api-key": config.api_key,
+    }
     typer.echo(payload)
     response = requests.post(url, headers=headers, data=payload)
+    if response.status_code not in [200, 201]:
+        typer.echo(f"Error: {response.status_code}\n{response.text}")
+        raise typer.Exit(1)
     typer.echo(_parse_response_as_yaml(response.text))
-    return response.status_code == 200
+    return response.status_code in [200, 201]
 
 
 @app.command()
-def list_datasets():
+def list_tables():
+    """
+    List all tables.
+    """
     config = _read_config()
-    url = f"{_get_shaped_url(config)}/datasets"
+    url = f"{_get_shaped_url(config)}/tables"
     headers = {"accept": "application/json", "x-api-key": config.api_key}
     response = requests.get(url, headers=headers)
+    if response.status_code != 200:
+        typer.echo(f"Error: {response.status_code}\n{response.text}")
+        raise typer.Exit(1)
     typer.echo(_parse_response_as_yaml(response.text))
 
 
 @app.command()
-def view_dataset(dataset_name: str = typer.Option(...)):
+def view_table(
+    table_name: str = typer.Option(..., help="Name of the table to view."),
+):
+    """
+    View the configuration of a specific table.
+    """
     config = _read_config()
-    url = f"{_get_shaped_url(config)}/datasets/{dataset_name}"
+    url = f"{_get_shaped_url(config)}/tables/{table_name}"
     headers = {"accept": "application/json", "x-api-key": config.api_key}
     response = requests.get(url, headers=headers)
+    if response.status_code != 200:
+        typer.echo(f"Error: {response.status_code}\n{response.text}")
+        raise typer.Exit(1)
     typer.echo(_parse_response_as_yaml(response.text))
 
 
 @app.command()
-def update_dataset(file: typer.FileText = typer.Option(None)):
+def update_table(
+    file: typer.FileText = typer.Option(
+        None, help="Path to a JSON or YAML file containing the table configuration."
+    ),
+):
+    """
+    Update an existing table.
+    
+    The table configuration can be provided via:
+    - --file: Path to a JSON/YAML file
+    - stdin: Pipe JSON/YAML content
+    """
     config = _read_config()
-    url = f"{_get_shaped_url(config)}/datasets"
-    headers = {"accept": "application/json", "x-api-key": config.api_key}
+    url = f"{_get_shaped_url(config)}/tables"
+    headers = {
+        "accept": "application/json",
+        "content-type": "application/json",
+        "x-api-key": config.api_key,
+    }
 
     if not sys.stdin.isatty():
         payload = sys.stdin.read()
@@ -324,18 +343,32 @@ def update_dataset(file: typer.FileText = typer.Option(None)):
 
     typer.echo(payload)
     response = requests.patch(url, headers=headers, data=payload)
+    if response.status_code != 200:
+        typer.echo(f"Error: {response.status_code}\n{response.text}")
+        raise typer.Exit(1)
     typer.echo(_parse_response_as_yaml(response.text))
 
 
 @app.command()
-def dataset_insert(
-    dataset_name: str = typer.Option(...),
-    file: str = typer.Option(...),
-    type: str = typer.Option(...),
+def table_insert(
+    table_name: str = typer.Option(..., help="Name of the table to insert data into."),
+    file: str = typer.Option(..., help="Path to the data file to insert."),
+    type: str = typer.Option(
+        ..., help="File type. One of: parquet, csv, tsv, json, jsonl."
+    ),
 ):
+    """
+    Insert data into a table from a file.
+    
+    Data is read in chunks and uploaded progressively with a progress bar.
+    """
     config = _read_config()
-    url = f"{_get_shaped_url(config)}/datasets/{dataset_name}/insert"
-    headers = {"accept": "application/json", "x-api-key": config.api_key}
+    url = f"{_get_shaped_url(config)}/tables/{table_name}/insert"
+    headers = {
+        "accept": "application/json",
+        "content-type": "application/json",
+        "x-api-key": config.api_key,
+    }
     bar = tqdm(unit=" Records")
 
     def _write_chunk(chunk: pd.DataFrame):
@@ -343,14 +376,15 @@ def dataset_insert(
         payload = json.dumps({"data": json.loads(chunk.to_json(orient="records"))})
         response = requests.post(url, headers=headers, data=payload)
         if response.status_code != 200:
-            typer.echo(response.text)
-            return
-
-        _parse_response_as_yaml(response.text)
+            typer.echo(f"Error: {response.status_code}\n{response.text}")
+            bar.close()
+            raise typer.Exit(1)
 
     # Chunk read and upload.
     for chunk in _read_chunks(file, type, chunk_size=1000):
         _write_chunk(chunk)
+    
+    bar.close()
 
 
 def _read_chunks(file: str, type: str, chunk_size: int) -> pd.DataFrame:
@@ -381,11 +415,254 @@ def _read_chunks(file: str, type: str, chunk_size: int) -> pd.DataFrame:
 
 
 @app.command()
-def delete_dataset(dataset_name: str = typer.Option(...)):
+def delete_table(
+    table_name: str = typer.Option(..., help="Name of the table to delete."),
+):
+    """
+    Delete a table.
+    """
     config = _read_config()
-    url = f"{_get_shaped_url(config)}/datasets/{dataset_name}"
+    url = f"{_get_shaped_url(config)}/tables/{table_name}"
     headers = {"accept": "application/json", "x-api-key": config.api_key}
     response = requests.delete(url, headers=headers)
+    if response.status_code not in [200, 204]:
+        typer.echo(f"Error: {response.status_code}\n{response.text}")
+        raise typer.Exit(1)
+    if response.text:
+        typer.echo(_parse_response_as_yaml(response.text))
+
+
+@app.command()
+def create_view(
+    file: typer.FileText = typer.Option(
+        None, help="Path to a JSON or YAML file containing the view configuration."
+    ),
+):
+    """
+    Create a new view.
+    
+    The view configuration can be provided via:
+    - --file: Path to a JSON/YAML file
+    - stdin: Pipe JSON/YAML content
+    """
+    config = _read_config()
+    url = f"{_get_shaped_url(config)}/views"
+    headers = {
+        "accept": "application/json",
+        "content-type": "application/json",
+        "x-api-key": config.api_key,
+    }
+
+    if not sys.stdin.isatty():
+        payload = sys.stdin.read()
+    elif file is not None:
+        payload = _parse_file_as_json(file)
+    else:
+        raise ValueError("Must provide either a '--file' or stdin input.")
+
+    typer.echo(payload)
+    response = requests.post(url, headers=headers, data=payload)
+    if response.status_code not in [200, 201]:
+        typer.echo(f"Error: {response.status_code}\n{response.text}")
+        raise typer.Exit(1)
+    typer.echo(_parse_response_as_yaml(response.text))
+
+
+#################
+# VIEW API       #
+#################
+
+
+@app.command()
+def list_views():
+    """
+    List all views.
+    """
+    config = _read_config()
+    url = f"{_get_shaped_url(config)}/views"
+    headers = {"accept": "application/json", "x-api-key": config.api_key}
+    response = requests.get(url, headers=headers)
+    if response.status_code != 200:
+        typer.echo(f"Error: {response.status_code}\n{response.text}")
+        raise typer.Exit(1)
+    typer.echo(_parse_response_as_yaml(response.text))
+
+
+@app.command()
+def view_view(
+    view_name: str = typer.Option(..., help="Name of the view to view."),
+):
+    """
+    View the configuration of a specific view.
+    """
+    config = _read_config()
+    url = f"{_get_shaped_url(config)}/views/{view_name}"
+    headers = {"accept": "application/json", "x-api-key": config.api_key}
+    response = requests.get(url, headers=headers)
+    if response.status_code != 200:
+        typer.echo(f"Error: {response.status_code}\n{response.text}")
+        raise typer.Exit(1)
+    typer.echo(_parse_response_as_yaml(response.text))
+
+
+@app.command()
+def update_view(
+    file: typer.FileText = typer.Option(
+        None, help="Path to a JSON or YAML file containing the view configuration."
+    ),
+):
+    """
+    Update an existing view.
+    
+    The view configuration can be provided via:
+    - --file: Path to a JSON/YAML file
+    - stdin: Pipe JSON/YAML content
+    """
+    config = _read_config()
+    url = f"{_get_shaped_url(config)}/views"
+    headers = {
+        "accept": "application/json",
+        "content-type": "application/json",
+        "x-api-key": config.api_key,
+    }
+
+    if not sys.stdin.isatty():
+        payload = sys.stdin.read()
+    elif file is not None:
+        payload = _parse_file_as_json(file)
+    else:
+        raise ValueError("Must provide either a '--file' or stdin input.")
+
+    typer.echo(payload)
+    response = requests.patch(url, headers=headers, data=payload)
+    if response.status_code != 200:
+        typer.echo(f"Error: {response.status_code}\n{response.text}")
+        raise typer.Exit(1)
+    typer.echo(_parse_response_as_yaml(response.text))
+
+
+@app.command()
+def delete_view(
+    view_name: str = typer.Option(..., help="Name of the view to delete."),
+):
+    """
+    Delete a view.
+    """
+    config = _read_config()
+    url = f"{_get_shaped_url(config)}/views/{view_name}"
+    headers = {"accept": "application/json", "x-api-key": config.api_key}
+    response = requests.delete(url, headers=headers)
+    if response.status_code not in [200, 204]:
+        typer.echo(f"Error: {response.status_code}\n{response.text}")
+        raise typer.Exit(1)
+    if response.text:
+        typer.echo(_parse_response_as_yaml(response.text))
+
+
+#################
+# QUERY API     #
+#################
+
+
+@app.command()
+def query(
+    engine_name: str = typer.Option(..., help="Name of the engine to execute the query against."),
+    query_file: typer.FileText = typer.Option(
+        None, help="Path to a JSON or YAML file containing the query."
+    ),
+    query: str = typer.Option(
+        None, help="JSON string containing the query. Can be used instead of --query-file."
+    ),
+):
+    """
+    Execute an ad-hoc query against an engine.
+    
+    The query can be provided via:
+    - --query-file: Path to a JSON/YAML file
+    - --query: JSON string directly
+    - stdin: Pipe JSON/YAML content
+    """
+    config = _read_config()
+    url = f"{_get_shaped_url(config)}/engines/{engine_name}/query"
+    headers = {
+        "accept": "application/json",
+        "content-type": "application/json",
+        "x-api-key": config.api_key,
+    }
+
+    if not sys.stdin.isatty():
+        payload = sys.stdin.read()
+    elif query_file is not None:
+        payload = _parse_file_as_json(query_file)
+    elif query is not None:
+        payload = query
+    else:
+        raise ValueError(
+            "Must provide either a '--query-file', '--query' JSON string, or stdin input."
+        )
+
+    typer.echo(payload)
+    response = requests.post(url, headers=headers, data=payload)
+    if response.status_code != 200:
+        typer.echo(f"Error: {response.status_code}\n{response.text}")
+        raise typer.Exit(1)
+    typer.echo(_parse_response_as_yaml(response.text))
+
+
+@app.command()
+def execute_saved_query(
+    engine_name: str = typer.Option(..., help="Name of the engine containing the saved query."),
+    query_name: str = typer.Option(..., help="Name of the saved query to execute."),
+):
+    """
+    Execute a previously saved query by name.
+    """
+    config = _read_config()
+    url = f"{_get_shaped_url(config)}/engines/{engine_name}/queries/{query_name}"
+    headers = {
+        "accept": "application/json",
+        "content-type": "application/json",
+        "x-api-key": config.api_key,
+    }
+    response = requests.post(url, headers=headers)
+    if response.status_code != 200:
+        typer.echo(f"Error: {response.status_code}\n{response.text}")
+        raise typer.Exit(1)
+    typer.echo(_parse_response_as_yaml(response.text))
+
+
+@app.command()
+def view_saved_query(
+    engine_name: str = typer.Option(..., help="Name of the engine containing the saved query."),
+    query_name: str = typer.Option(..., help="Name of the saved query to view."),
+):
+    """
+    View the definition of a saved query.
+    """
+    config = _read_config()
+    url = f"{_get_shaped_url(config)}/engines/{engine_name}/queries/{query_name}"
+    headers = {"accept": "application/json", "x-api-key": config.api_key}
+    response = requests.get(url, headers=headers)
+    if response.status_code != 200:
+        typer.echo(f"Error: {response.status_code}\n{response.text}")
+        raise typer.Exit(1)
+    typer.echo(_parse_response_as_yaml(response.text))
+
+
+@app.command()
+def list_saved_queries(
+    engine_name: str = typer.Option(..., help="Name of the engine to list saved queries for."),
+):
+    """
+    List all saved queries for an engine.
+    """
+    config = _read_config()
+    url = f"{_get_shaped_url(config)}/engines/{engine_name}/queries"
+    headers = {"accept": "application/json", "x-api-key": config.api_key}
+    response = requests.get(url, headers=headers)
+    if response.status_code != 200:
+        typer.echo(f"Error: {response.status_code}\n{response.text}")
+        raise typer.Exit(1)
     typer.echo(_parse_response_as_yaml(response.text))
 
 

shaped-2.0.0.dist-info/METADATA

@@ -0,0 +1,341 @@
+Metadata-Version: 2.4
+Name: shaped
+Version: 2.0.0
+Summary: CLI and SDK tools for interacting with the Shaped API.
+Home-page: https://github.com/shaped-ai/shaped-cli
+Author: Shaped Team
+Author-email: support@shaped.ai
+Keywords: shaped-ai
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Programming Language :: Python :: 3
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Requires-Python: >=3.9, <3.14
+Description-Content-Type: text/markdown
+Requires-Dist: pyarrow==20.0.0
+Requires-Dist: pandas==2.3.0
+Requires-Dist: numpy==1.26.4
+Requires-Dist: typer>=0.7.0
+Requires-Dist: requests>=2.28.1
+Requires-Dist: pydantic>=2.8.2
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: tqdm==4.67.1
+Requires-Dist: s3fs==0.4.2
+Requires-Dist: fsspec==2023.5.0
+Requires-Dist: urllib3<2.1.0,>=1.25.3
+Requires-Dist: python-dateutil
+Requires-Dist: typing-extensions>=4.7.1
+Requires-Dist: pytest>=6.2.5
+Requires-Dist: pytest-mock==3.14.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Shaped CLI
+
+CLI for interactions with the Shaped API.
+
+## Installing the Shaped CLI
+
+```
+pip install shaped
+```
+
+## Initialize
+
+```
+shaped init --api-key <API_KEY> [--env <ENV>]
+```
+
+The `--env` option defaults to `prod` and can be set to other environments like `dev` or `staging`.
+
+## Engine API
+
+### Create Engine
+
+```
+shaped create-engine --file <PATH_TO_FILE>
+```
+
+Or pipe from stdin:
+
+```
+cat <PATH_TO_FILE> | shaped create-engine
+```
+
+### Update Engine
+
+```
+shaped update-engine --file <PATH_TO_FILE>
+```
+
+Or pipe from stdin:
+
+```
+cat <PATH_TO_FILE> | shaped update-engine
+```
+
+### List Engines
+
+```
+shaped list-engines
+```
+
+### View Engine
+
+```
+shaped view-engine --engine-name <ENGINE_NAME>
+```
+
+### Delete Engine
+
+```
+shaped delete-engine --engine-name <ENGINE_NAME>
+```
+
+## Table API
+
+### Create Table
+
+```
+shaped create-table --file <PATH_TO_FILE>
+```
+
+Or pipe from stdin:
+
+```
+cat <PATH_TO_FILE> | shaped create-table
+```
+
+### Create Table from URI
+
+Create a table and automatically insert data from a file:
+
+```
+shaped create-table-from-uri --name <TABLE_NAME> --path <PATH_TO_FILE> --type <FILE_TYPE>
+```
+
+Supported file types: `parquet`, `csv`, `tsv`, `json`, `jsonl`
+
+### List Tables
+
+```
+shaped list-tables
+```
+
+### Table Insert
+
+Insert data into an existing table:
+
+```
+shaped table-insert --table-name <TABLE_NAME> --file <DATAFRAME_FILE> --type <FILE_TYPE>
+```
+
+Supported file types: `parquet`, `csv`, `tsv`, `json`, `jsonl`
+
+### View Table
+
+```
+shaped view-table --table-name <TABLE_NAME>
+```
+
+### Update Table
+
+```
+shaped update-table --file <PATH_TO_FILE>
+```
+
+Or pipe from stdin:
+
+```
+cat <PATH_TO_FILE> | shaped update-table
+```
+
+### Delete Table
+
+```
+shaped delete-table --table-name <TABLE_NAME>
+```
+
+## View API
+
+### Create View
+
+```
+shaped create-view --file <PATH_TO_FILE>
+```
+
+Or pipe from stdin:
+
+```
+cat <PATH_TO_FILE> | shaped create-view
+```
+
+### List Views
+
+```
+shaped list-views
+```
+
+### View View
+
+```
+shaped view-view --view-name <VIEW_NAME>
+```
+
+### Update View
+
+```
+shaped update-view --file <PATH_TO_FILE>
+```
+
+Or pipe from stdin:
+
+```
+cat <PATH_TO_FILE> | shaped update-view
+```
+
+### Delete View
+
+```
+shaped delete-view --view-name <VIEW_NAME>
+```
+
+## Query API
+
+### Execute Query
+
+Execute an ad-hoc query against an engine. The query can be provided in three ways:
+
+**From a file:**
+```
+shaped query --engine-name <ENGINE_NAME> --query-file <PATH_TO_FILE>
+```
+
+**As a JSON string:**
+```
+shaped query --engine-name <ENGINE_NAME> --query '{"sql": "SELECT * FROM table"}'
+```
+
+**From stdin:**
+```
+cat <PATH_TO_FILE> | shaped query --engine-name <ENGINE_NAME>
+```
+
+### Execute Saved Query
+
+Execute a previously saved query by name:
+
+```
+shaped execute-saved-query --engine-name <ENGINE_NAME> --query-name <QUERY_NAME>
+```
+
+### List Saved Queries
+
+List all saved queries for an engine:
+
+```
+shaped list-saved-queries --engine-name <ENGINE_NAME>
+```
+
+### View Saved Query
+
+View the definition of a saved query:
+
+```
+shaped view-saved-query --engine-name <ENGINE_NAME> --query-name <QUERY_NAME>
+```
+
+---
+
+# Python SDK
+
+## Installation
+
+### Pip Installation
+
+```sh
+pip install shaped
+```
+
+## Rank
+
+```python
+import shaped
+
+api_key = 'your_api_key' 
+client = shaped.Client(api_key=api_key)
+
+api_response = client.rank(
+    model_name="amazon_beauty_product_recommendations",
+    user_id="A2FRWMTWYJUK7P",
+    return_metadata=True,
+    item_ids=['B01AHSUT8M', 'B00GW7H5EY', 'B01GLA54SA', 'B0016PKWK6', 'B00PJD7KPG', 'B00BCI8OP2', 'B004FK7R02'],
+)
+print(api_response)
+```
+
+## Retrieve
+```python
+import shaped
+
+api_key = 'your_api_key' 
+client = shaped.Client(api_key=api_key)
+
+api_response = client.retrieve(
+    model_name="amazon_beauty_product_recommendations",
+)
+print(api_response)
+```
+
+## Similar Items
+```python
+import shaped
+
+api_key = 'your_api_key' 
+client = shaped.Client(api_key=api_key)
+
+api_response = client.similar_items(
+    model_name="amazon_beauty_product_recommendations", 
+    item_id="B000FOI48G",
+)
+print(api_response)
+```
+
+## Similar Users
+```python
+import shaped
+
+api_key = 'your_api_key' 
+client = shaped.Client(api_key=api_key)
+
+api_response = client.similar_users(
+    model_name="amazon_beauty_product_recommendations", 
+    user_id="A2FRWMTWYJUK7P",
+)
+print(api_response)
+```
+
+## Complement Items
+```python
+import shaped
+
+api_key = 'your_api_key' 
+client = shaped.Client(api_key=api_key)
+
+api_response = client.complement_items(
+    model_name="amazon_beauty_product_recommendations", 
+    item_ids=['B000URXP6E', 'B0012Y0ZG2'],
+)
+print(api_response)
+```
+
+---

{shaped-1.0.1.dist-info → shaped-2.0.0.dist-info}/RECORD

@@ -64,10 +64,10 @@ shaped/autogen/models/validation_error.py,sha256=kVstUJ1nwQ6Y9kssgDBpeoKGFScWegp
 shaped/autogen/models/value_type.py,sha256=uxlGNPto3CK17jHKDRvAl3BqNCPkHlxfRBPdofi_qdM,2917
 shaped/autogen/models/view_model_response.py,sha256=4xzesZSHMcPCZHsevo5Bt_3P9jBNiEbd_PFTWQ5Q9KU,5757
 shaped/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-shaped/cli/shaped_cli.py,sha256=kOxCiPivUEjNPs4mNETGpi43_PzTXp61dN-dr9fp7C0,12822
-shaped-1.0.1.dist-info/METADATA,sha256=idA0EhKKTsUJgbAS2UWQLRShSaI78cds6XoCHo1hBck,5433
-shaped-1.0.1.dist-info/WHEEL,sha256=A3WOREP4zgxI0fKrHUG8DC8013e3dK3n7a6HDbcEIwE,91
-shaped-1.0.1.dist-info/entry_points.txt,sha256=4xoVmnNTKtmzjGNX5ezp9MCWLgi7880TtfqFByN1u5U,53
-shaped-1.0.1.dist-info/top_level.txt,sha256=w-lDaoadQVYpze9N9gZyK9qngb7fZCJ-KCdHLGvt0SU,7
-shaped-1.0.1.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-shaped-1.0.1.dist-info/RECORD,,
+shaped/cli/shaped_cli.py,sha256=DzBbnRlk2XWkCq8eGGUVRatm6ntVHclfsrNHYEYxdyA,20562
+shaped-2.0.0.dist-info/METADATA,sha256=uNlIBs-grJV6aNnpdVM-NyICOtzi0mEUMxeqJdktkSU,5761
+shaped-2.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+shaped-2.0.0.dist-info/entry_points.txt,sha256=4xoVmnNTKtmzjGNX5ezp9MCWLgi7880TtfqFByN1u5U,53
+shaped-2.0.0.dist-info/top_level.txt,sha256=w-lDaoadQVYpze9N9gZyK9qngb7fZCJ-KCdHLGvt0SU,7
+shaped-2.0.0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+shaped-2.0.0.dist-info/RECORD,,

{shaped-1.0.1.dist-info → shaped-2.0.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.7.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

shaped-1.0.1.dist-info/METADATA

@@ -1,256 +0,0 @@
-Metadata-Version: 2.1
-Name: shaped
-Version: 1.0.1
-Summary: CLI and SDK tools for interacting with the Shaped API.
-Home-page: https://github.com/shaped-ai/shaped-cli
-Author: Shaped Team
-Author-email: support@shaped.ai
-Keywords: shaped-ai
-Classifier: Operating System :: POSIX :: Linux
-Classifier: Operating System :: MacOS :: MacOS X
-Classifier: Programming Language :: Python :: 3
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Requires-Python: >=3.8, <3.12
-Description-Content-Type: text/markdown
-Requires-Dist: typer>=0.7.0
-Requires-Dist: requests>=2.28.1
-Requires-Dist: pydantic>=2.8.2
-Requires-Dist: pyyaml>=6.0
-Requires-Dist: pyarrow==11.0.0
-Requires-Dist: pandas==1.5.3
-Requires-Dist: tqdm==4.65.0
-Requires-Dist: s3fs==0.4.2
-Requires-Dist: fsspec==2023.5.0
-Requires-Dist: numpy==1.26.4
-Requires-Dist: urllib3<2.1.0,>=1.25.3
-Requires-Dist: python-dateutil
-Requires-Dist: typing-extensions>=4.7.1
-Requires-Dist: pytest>=6.2.5
-Requires-Dist: pytest-mock==3.14.0
-
-# Python SDK
-
-## Installation
-
-### Local Development
-
-```sh
-pip install -e .
-```
-
-### Pip Installation
-
-```sh
-pip install shaped
-```
-
-## Rank
-
-```python
-import shaped
-
-api_key = 'your_api_key' 
-client = shaped.Client(api_key=api_key)
-
-api_response = client.rank(
-    model_name="amazon_beauty_product_recommendations",
-    user_id="A2FRWMTWYJUK7P",
-    return_metadata=True,
-    item_ids=['B01AHSUT8M', 'B00GW7H5EY', 'B01GLA54SA', 'B0016PKWK6', 'B00PJD7KPG', 'B00BCI8OP2', 'B004FK7R02'],
-)
-print(api_response)
-```
-
-## Retrieve
-```python
-import shaped
-
-api_key = 'your_api_key' 
-client = shaped.Client(api_key=api_key)
-
-api_response = client.retrieve(
-    model_name="amazon_beauty_product_recommendations",
-)
-print(api_response)
-```
-
-## Similar Items
-```python
-import shaped
-
-api_key = 'your_api_key' 
-client = shaped.Client(api_key=api_key)
-
-api_response = client.similar_items(
-    model_name="amazon_beauty_product_recommendations", 
-    item_id="B000FOI48G",
-)
-print(api_response)
-```
-
-## Similar Users
-```python
-import shaped
-
-api_key = 'your_api_key' 
-client = shaped.Client(api_key=api_key)
-
-api_response = client.similar_users(
-    model_name="amazon_beauty_product_recommendations", 
-    user_id="A2FRWMTWYJUK7P",
-)
-print(api_response)
-```
-
-## Complement Items
-```python
-import shaped
-
-api_key = 'your_api_key' 
-client = shaped.Client(api_key=api_key)
-
-api_response = client.complement_items(
-    model_name="amazon_beauty_product_recommendations", 
-    item_ids=['B000URXP6E', 'B0012Y0ZG2'],
-)
-print(api_response)
-```
-
-## Maintainer Notes
-
-To recreate the autogenerated code:
-
-1. `brew install openapi-generator`
-2. Copy across `openapi.yaml` from the `shaped-docs` repository to `~` 
-1. Change `-g python` to the language you want to generate
-1. Change `-o python/` to the directory you want to output to
-3. Navigate to `~` and run the command:
-
-### Python
-```bash
-openapi-generator generate -g python -i openapi.yaml -o python/ -p packageName=shaped.autogen --global-property models,apis,apiDocs=false,modelDocs=false,modelTests=false,apiTests=false,supportingFiles=api_client.py:api_response.py:configuration.py:exceptions.py:rest.py:__init__.py
-```
-
-### Node.js
-```bash
-openapi-generator generate -i openapi.yaml -g javascript -o nodejs/src -c config.yaml --global-property models,apis,apiDocs=false,modelDocs=false,modelTests=false,apiTests=false,supportingFiles=ApiClient.js
-```
-
-## Testing
-`pytest python/tests/test_rank.py --api-key 'api_key'`
-`npm test`
----
-
-# Shaped CLI
-
-CLI for interactions with the Shaped API.
-
-## Installing the Shaped CLI
-
-```
-pip install shaped
-```
-
-## Initialize
-
-```
-shaped init --api-key <API_KEY>
-```
-
-## Model API
-
-### Create Model (File)
-
-```
-shaped create-model --file <PATH_TO_FILE>
-```
-
-### Create Model (STDIN)
-
-```
-cat $(PATH_TO_FILE) | shaped create-model
-```
-
-### List Models
-
-```
-shaped list-models
-```
-
-### View Model
-
-```
-shaped view-model --model-name <MODEL_NAME>
-```
-
-## Delete Model
-
-```
-shaped delete-model --model-name <MODEL_NAME>
-```
-
-## Dataset API
-
-### Create Dataset
-
-```
-shaped create-dataset --file <PATH_TO_FILE>
-```
-
-### List Datasets
-
-```
-shaped list-datasets
-```
-
-### Dataset Insert
-
-```
-shaped dataset-insert --dataset-name <DATASET_NAME> --file <DATAFRAME_FILE> --type <FILE_TYPE> 
-```
-
-## Delete dataset
-
-```
-shaped delete-dataset --dataset-name <DATASET_NAME>
-```
-
-## Rank API
-
-### Rank
-
-```
-shaped rank --model-name <MODEL_NAME> --user-id <USER_ID>
-```
-
-### Similar Items
-
-```
-shaped similar --model-name <MODEL_NAME> --item-id <ITEM_ID>
-```
-
-### Similar Users
-
-```
-shaped similar --model-name <MODEL_NAME> --user-id <USER_ID>
-```
-
-# Development
-
-## Installing the Shaped CLI from Test PyPI
-
-Upon all pushes to main branch, a new version of the CLI is published to Test PyPI. To install the latest version of the CLI from Test PyPI, run the following commands:
-
-```bash
-conda create -n cli-dev python=3.9
-conda activate cli-dev
-export PACKAGE_VERSION={} # Specify the version you want to install
-pip install --extra-index-url https://test.pypi.org/simple/ shaped-cli==$PACKAGE_VERSION
-```
-
-## Releasing a new CLI version to PyPI
-
-To release a new version of the CLI to PyPI, open a PR changing the version of the package in `setup.py`, following [Semantic Versioning](https://semver.org) principles, e.g. `0.1.1`.
-
-CircleCI will generate an approval prompt when this branch is merged to main, and upon approval will publish to PyPI.