agenta 0.12.2__py3-none-any.whl → 0.32.0a1__py3-none-any.whl

agenta/__init__.py

@@ -1,19 +1,76 @@
-from .sdk.agenta_decorator import app, entrypoint
-from .sdk.context import get_contexts, save_context
+from typing import Any, Callable, Optional
+
+from .sdk.utils.preinit import PreInitObject
+
+import agenta.client.backend.types as client_types  # pylint: disable=wrong-import-order
+
 from .sdk.types import (
-    Context,
+    MCField,
     DictInput,
+    MultipleChoice,
     FloatParam,
-    InFile,
     IntParam,
     MultipleChoiceParam,
+    GroupedMultipleChoiceParam,
     MessagesInput,
     TextParam,
     FileInputURL,
     BinaryParam,
+    Prompt,
+    PromptTemplate,
 )
-from .sdk.utils.preinit import PreInitObject
-from .sdk.agenta_init import Config, init
-from .sdk.utils.helper.openai_cost import calculate_token_usage
+
+from .sdk.utils.logging import log as logging
+from .sdk.tracing import Tracing, get_tracer
+from .sdk.decorators.tracing import instrument
+from .sdk.tracing.conventions import Reference
+from .sdk.decorators.routing import entrypoint, app, route
+from .sdk.agenta_init import Config, AgentaSingleton, init as _init
+from .sdk.utils.costs import calculate_token_usage
+from .sdk.client import Agenta
+from .sdk.litellm import litellm as callbacks
+from .sdk.managers.vault import VaultManager
+from .sdk.managers.secrets import SecretsManager
+from .sdk.managers.config import ConfigManager
+from .sdk.managers.variant import VariantManager
+from .sdk.managers.deployment import DeploymentManager
+from .sdk import assets as assets
+from .sdk import tracer
 
 config = PreInitObject("agenta.config", Config)
+DEFAULT_AGENTA_SINGLETON_INSTANCE = AgentaSingleton()
+
+types = client_types
+
+api = None
+async_api = None
+
+tracing = DEFAULT_AGENTA_SINGLETON_INSTANCE.tracing  # type: ignore
+tracer = get_tracer(tracing)
+
+
+def init(
+    host: Optional[str] = None,
+    api_key: Optional[str] = None,
+    config_fname: Optional[str] = None,
+    redact: Optional[Callable[..., Any]] = None,
+    redact_on_error: Optional[bool] = True,
+    # DEPRECATING
+    app_id: Optional[str] = None,
+):
+    global api, async_api, tracing, tracer  # pylint: disable=global-statement
+
+    _init(
+        host=host,
+        api_key=api_key,
+        config_fname=config_fname,
+        redact=redact,
+        redact_on_error=redact_on_error,
+        app_id=app_id,
+    )
+
+    api = DEFAULT_AGENTA_SINGLETON_INSTANCE.api  # type: ignore
+    async_api = DEFAULT_AGENTA_SINGLETON_INSTANCE.async_api  # type: ignore
+
+    tracing = DEFAULT_AGENTA_SINGLETON_INSTANCE.tracing  # type: ignore
+    tracer = get_tracer(tracing)

agenta/cli/helper.py

@@ -15,6 +15,9 @@ import toml
 from agenta.client.backend.client import AgentaApi
 
 BACKEND_URL_SUFFIX = os.environ.get("BACKEND_URL_SUFFIX", "api")
+POSTHOG_KEY = os.environ.get(
+    "POSTHOG_KEY", "phc_hmVSxIjTW1REBHXgj2aw4HW9X6CXb6FzerBgP9XenC7"
+)
 
 
 def get_global_config(var_name: str) -> Optional[Any]:
@@ -97,7 +100,7 @@ def get_api_key(backend_host: str) -> str:
     ).ask()
 
     if api_key:
-        set_global_config("api_key", api_key)
+        set_global_config("api_key", api_key.strip())
 
         return api_key
     elif api_key is None:  # User pressed Ctrl+C
@@ -111,7 +114,8 @@ def init_telemetry_config() -> None:
     ):
         set_global_config("telemetry_tracking_enabled", True)
         set_global_config(
-            "telemetry_api_key", "phc_hmVSxIjTW1REBHXgj2aw4HW9X6CXb6FzerBgP9XenC7"
+            "telemetry_api_key",
+            POSTHOG_KEY,
         )
 
 
@@ -137,7 +141,7 @@ def update_variants_from_backend(
     )
 
     try:
-        variants: List[AppVariant] = client.list_app_variants(app_id=app_id)
+        variants: List[AppVariant] = client.apps.list_app_variants(app_id=app_id)
     except Exception as ex:
         raise ex
 

agenta/cli/main.py

@@ -47,9 +47,9 @@ def check_latest_version() -> Union[str, None]:
 
 
 def notify_update(available_version: str):
-    import pkg_resources
+    import importlib.metadata
 
-    installed_version = pkg_resources.get_distribution("agenta").version
+    installed_version = importlib.metadata.version("agenta")
     if available_version > installed_version:
         click.echo(
             click.style(
@@ -78,11 +78,15 @@ def cli():
 
 
 @click.command()
-@click.option("--app_name", default="")
-@click.option("--backend_host", default="")
+@click.option("--app-name", "--app_name", default=None)
+@click.option("--backend-host", "backend_host", default=None)
 def init(app_name: str, backend_host: str):
-    init_option = "Blank App" if backend_host != "" and app_name != "" else ""
     """Initialize a new Agenta app with the template files."""
+
+    init_option = "Blank App" if backend_host != "" and app_name != "" else ""
+
+    api_key = os.getenv("AGENTA_API_KEY")
+
     if not app_name:
         while True:
             app_name = questionary.text("Please enter the app name").ask()
@@ -125,7 +129,8 @@ def init(app_name: str, backend_host: str):
                 else:
                     backend_host = "https://cloud.agenta.ai"
 
-                api_key = helper.get_api_key(backend_host)
+                if not api_key:
+                    api_key = helper.get_api_key(backend_host)
 
             elif where_question is None:  # User pressed Ctrl+C
                 sys.exit(0)
@@ -141,50 +146,9 @@ def init(app_name: str, backend_host: str):
             api_key=api_key if where_question == "On agenta cloud" else "",
         )
 
-        # list of user organizations
-        user_organizations = []
-
-        # validate the api key if it is provided
-        if where_question == "On agenta cloud":
-            try:
-                key_prefix = api_key.split(".")[0]
-                client.validate_api_key(key_prefix=key_prefix)
-
-                # Make request to fetch user organizations after api key validation
-                organizations = client.list_organizations()
-                if len(organizations) >= 1:
-                    user_organizations = organizations
-            except Exception as ex:
-                if ex.status_code == 401:
-                    click.echo(click.style("Error: Invalid API key", fg="red"))
-                    sys.exit(1)
-                else:
-                    click.echo(click.style(f"Error: {ex}", fg="red"))
-                    sys.exit(1)
-
-        filtered_org = None
-        if where_question == "On agenta cloud":
-            which_organization = questionary.select(
-                "Which organization do you want to create the app for?",
-                choices=[
-                    f"{org.name}: {org.description}" for org in user_organizations
-                ],
-            ).ask()
-            filtered_org = next(
-                (
-                    org
-                    for org in user_organizations
-                    if org.name == which_organization.split(":")[0]
-                ),
-                None,
-            )
-
         # Get app_id after creating new app in the backend server
         try:
-            app_id = client.create_app(
-                app_name=app_name,
-                organization_id=filtered_org.id if filtered_org else None,
-            ).app_id
+            app_id = client.apps.create_app(app_name=app_name).app_id
         except Exception as ex:
             click.echo(click.style(f"Error: {ex}", fg="red"))
             sys.exit(1)
@@ -241,8 +205,9 @@ def init(app_name: str, backend_host: str):
         gitignore_content = (
             "# Environments \nenv/\nvenv/\nENV/\nenv.bak/\nvenv.bak/\nmyenv/\n"
         )
-        with open(".gitignore", "w") as gitignore_file:
-            gitignore_file.write(gitignore_content)
+        if not os.path.exists(".agentaignore"):
+            with open(".agentaignore", "w") as gitignore_file:
+                gitignore_file.write(gitignore_content)
 
         click.echo("App initialized successfully")
         if init_option == "Start from template":

agenta/cli/variant_commands.py

@@ -9,13 +9,15 @@ from requests.exceptions import ConnectionError
 import click
 import questionary
 import toml
+
 from agenta.cli import helper
 from agenta.cli.telemetry import event_track
+from agenta.client.backend.client import AgentaApi
+from agenta.client.api import add_variant_to_server
 from agenta.client.api_models import AppVariant, Image
 from agenta.docker.docker_utils import build_tar_docker_container
+from agenta.client.backend.types.variant_action import VariantAction
 
-from agenta.client.api import add_variant_to_server
-from agenta.client.backend.client import AgentaApi
 
 BACKEND_URL_SUFFIX = os.environ.get("BACKEND_URL_SUFFIX", "api")
 
@@ -27,7 +29,7 @@ def variant():
 
 
 def add_variant(
-    app_folder: str, file_name: str, host: str, config_name="default"
+    app_folder: str, file_name: str, host: str, overwrite: bool, config_name="default"
 ) -> str:
     """
     Adds a variant to the backend. Sends the code as a tar to the backend, which then containerizes it and adds it to the backend store.
@@ -95,20 +97,20 @@ def add_variant(
 
     # update the config file with the variant names from the backend
     variant_name = f"{base_name}.{config_name}"
-    overwrite = False
 
     client = AgentaApi(
         base_url=f"{host}/{BACKEND_URL_SUFFIX}",
         api_key=api_key,
     )
 
-    if variant_name in config["variants"]:
-        overwrite = questionary.confirm(
-            "This variant already exists. Do you want to overwrite it?"
-        ).ask()
+    if variant_name in config["variants"] and not overwrite:
         if not overwrite:
-            click.echo("Operation cancelled.")
-            sys.exit(0)
+            overwrite = questionary.confirm(
+                "This variant already exists. Do you want to overwrite it?"
+            ).ask()
+            if not overwrite:
+                click.echo("Operation cancelled.")
+                return
 
     try:
         click.echo(
@@ -126,7 +128,7 @@ def add_variant(
             )
         )
         with tar_path.open("rb") as tar_file:
-            built_image: Image = client.build_image(
+            built_image: Image = client.containers.build_image(
                 app_id=app_id,
                 base_name=base_name,
                 tar_file=tar_file,
@@ -137,7 +139,7 @@ def add_variant(
 
     except Exception as ex:
         click.echo(click.style(f"Error while building image: {ex}", fg="red"))
-        return None
+        raise
     try:
         if overwrite:
             click.echo(
@@ -147,14 +149,20 @@ def add_variant(
                 )
             )
             variant_id = config["variant_ids"][config["variants"].index(variant_name)]
-            client.update_variant_image(
+            client.variants.update_variant_image(
                 variant_id=variant_id,
-                request=image,  # because Fern code uses "request: Image" instead of "image: Image"
+                docker_id=image.docker_id,
+                tags=image.tags,
+                type=image.type,
             )  # this automatically restarts
         else:
             click.echo(click.style(f"Adding {variant_name} to server...", fg="yellow"))
             response = add_variant_to_server(
-                app_id, base_name, image, f"{host}/{BACKEND_URL_SUFFIX}", api_key
+                app_id,
+                base_name,
+                image,
+                f"{host}/{BACKEND_URL_SUFFIX}",
+                api_key,
             )
             variant_id = response["variant_id"]
             config["variants"].append(variant_name)
@@ -164,7 +172,7 @@ def add_variant(
             click.echo(click.style(f"Error while updating variant: {ex}", fg="red"))
         else:
             click.echo(click.style(f"Error while adding variant: {ex}", fg="red"))
-        return None
+        raise
 
     agenta_dir = Path.home() / ".agenta"
     global_toml_file = toml.load(agenta_dir / "config.toml")
@@ -172,7 +180,7 @@ def add_variant(
     if overwrite:
         # Track a deployment event
         if tracking_enabled:
-            get_user_id = client.user_profile()
+            get_user_id = client.fetch_user_profile()
             user_id = get_user_id["id"]
             event_track.capture_event(
                 "app_deployment",
@@ -194,7 +202,7 @@ def add_variant(
     else:
         # Track a deployment event
         if tracking_enabled:
-            get_user_id = client.user_profile()
+            get_user_id = client.fetch_user_profile()
             user_id = get_user_id["id"]
             event_track.capture_event(
                 "app_deployment",
@@ -259,7 +267,11 @@ def start_variant(variant_id: str, app_folder: str, host: str):
         api_key=api_key,
     )
 
-    endpoint = client.start_variant(variant_id=variant_id, action={"action": "START"})
+    variant = client.variants.start_variant(
+        variant_id=variant_id,
+        action=VariantAction(action="START"),
+    )
+    endpoint = variant.uri
     click.echo("\n" + click.style("Congratulations! 🎉", bold=True, fg="green"))
     click.echo(
         click.style("Your app has been deployed locally as an API. 🚀", fg="cyan")
@@ -327,7 +339,7 @@ def remove_variant(variant_name: str, app_folder: str, host: str):
     )
 
     try:
-        client.remove_variant(variant_id=variant_id)
+        client.variants.remove_variant(variant_id=variant_id)
     except Exception as ex:
         click.echo(
             click.style(
@@ -365,7 +377,7 @@ def list_variants(app_folder: str, host: str):
     )
 
     try:
-        variants: List[AppVariant] = client.list_app_variants(app_id=app_id)
+        variants: List[AppVariant] = client.apps.list_app_variants(app_id=app_id)
     except Exception as ex:
         raise ex
 
@@ -436,9 +448,14 @@ def remove_variant_cli(variant_name: str, app_folder: str):
 )
 @click.option("--app_folder", default=".")
 @click.option("--file_name", default=None, help="The name of the file to run")
+@click.option(
+    "--overwrite",
+    is_flag=True,
+    help="Overwrite the existing variant if it exists",
+)
 @click.pass_context
-def serve_cli(ctx, app_folder: str, file_name: str):
-    """Adds a variant to the web ui and serves the API locally."""
+def serve_cli(ctx, app_folder: str, file_name: str, overwrite: bool):
+    """Adds a variant to the web UI and serves the API locally."""
 
     if not file_name:
         if ctx.args:
@@ -449,35 +466,37 @@ def serve_cli(ctx, app_folder: str, file_name: str):
             error_msg += "or\n"
             error_msg += ">>> agenta variant serve <filename>.py"
             click.echo(click.style(f"{error_msg}", fg="red"))
-            sys.exit(0)
+            sys.exit(1)
 
     try:
         config_check(app_folder)
     except Exception as e:
         click.echo(click.style("Failed during configuration check.", fg="red"))
         click.echo(click.style(f"Error message: {str(e)}", fg="red"))
-        return
+        sys.exit(1)
 
     try:
         host = get_host(app_folder)
     except Exception as e:
         click.echo(click.style("Failed to retrieve the host.", fg="red"))
         click.echo(click.style(f"Error message: {str(e)}", fg="red"))
-        return
+        sys.exit(1)
 
     try:
         api_key = helper.get_global_config("api_key")
     except Exception as e:
         click.echo(click.style("Failed to retrieve the api key.", fg="red"))
         click.echo(click.style(f"Error message: {str(e)}", fg="red"))
-        return
+        sys.exit(1)
 
     try:
-        variant_id = add_variant(app_folder=app_folder, file_name=file_name, host=host)
+        variant_id = add_variant(
+            app_folder=app_folder, file_name=file_name, host=host, overwrite=overwrite
+        )
     except Exception as e:
         click.echo(click.style("Failed to add variant.", fg="red"))
         click.echo(click.style(f"Error message: {str(e)}", fg="red"))
-        return
+        sys.exit(1)
 
     if variant_id:
         try:
@@ -489,9 +508,11 @@ def serve_cli(ctx, app_folder: str, file_name: str):
                 "- Second, try restarting the containers (if using Docker Compose)."
             )
             click.echo(click.style(f"{error_msg}", fg="red"))
+            sys.exit(1)
         except Exception as e:
             click.echo(click.style("Failed to start container with LLM app.", fg="red"))
             click.echo(click.style(f"Error message: {str(e)}", fg="red"))
+            sys.exit(1)
 
 
 @variant.command(name="list")

agenta/client/Readme.md

@@ -7,90 +7,98 @@ Currently the models are manually copied from the backend code. This needs to ch
 To generate the client code using Fern, follow the steps below. 
 
 1. Open a Terminal and navigate to the folder where this Readme.md file is. For example;
-    ```
-    $ cd agenta/agenta-cli/agenta/client
-    ```
+```bash
+cd agenta/agenta-cli/agenta/client
+```
 
 2. Next ensure you have installed Fern by executing the command;
-    ```
-    $ npm install -g fern-api
-    ```
+```bash
+npm install -g fern-api
+```
+
 3. Execute this command to initialize Fern to import and use the OpenAPI spec;
 
 > To use an OpenAPI spec, you can pass in the filepath or URL.
-> We'll be using a url to the openapi.json for [Agenta Cloud](https://cloud.agenta.ai)
+> We'll need to log in to use fern.
+> We'll be using a url to the openapi.json for [Agenta Cloud](https://cloud.agenta.ai).
+> Alternatively, for `cloud-dev` we could use [Cloud Local](http://localhost).
 
-```
+```bash
 fern init --openapi https://cloud.agenta.ai/api/openapi.json
+# fern init --openapi http://localhost/api/openapi.json
 ```    
    
 4. Add the Fern Python SDK;
-   ```bash
-   fern add fern-python-sdk
-   ```
+```bash
+fern add fern-python-sdk
+```
 
 5. Go to the generators.yml, which would look like this;
-
-    ```yaml
-    default-group: local
-    groups:
-      local:
-        generators:
-          - name: fernapi/fern-typescript-node-sdk
-            version: 0.7.2
-            output:
-              location: local-file-system
-              path: ../generated/typescript
-          - name: fernapi/fern-python-sdk
-            version: 0.6.0
-    ```
-
-    Replace the following;
-
-    ```yaml
+```yaml
+default-group: local
+groups:
+  local:
+    generators:
       - name: fernapi/fern-typescript-node-sdk
-        version: 0.7.2
-    ```
-
-    with this and delete it from the bottom of the file after;
-
-    ```yaml
+        version: 0.9.5
+        output:
+          location: local-file-system
+          path: ../sdks/typescript
       - name: fernapi/fern-python-sdk
         version: 0.6.0
-    ```
+```
 
-6. Change the path from this `path: ../generated/typescript` to this path: `../backend`
+6. Remove `fernapi/fern-typescript-node-sdk`;
+```yaml
+default-group: local
+groups:
+  local:
+    generators:
+      - name: fernapi/fern-python-sdk
+        version: 3.10.6
+```
 
-    Now your generators.yml should look like this;
-    ```yaml
-    default-group: local
-    groups:
-      local:
-        generators:
-          - name: fernapi/fern-python-sdk
-            version: 0.6.0
-            output:
-              location: local-file-system
-              path: ../backend
-    ```
-    <img width="1001" alt="image" src="https://github.com/Agenta-AI/agenta/assets/56418363/f537691d-8dbb-4363-b7c0-ecef9f464053">
+7. Update `fernapi/fern-python-sdk`, which would look like this;
+```yaml
+default-group: local
+groups:
+  local:
+    generators:
+      - name: fernapi/fern-python-sdk
+        version: 3.10.6
+        output:
+          location: local-file-system
+          path: ../backend
+```
+<img width="1001" alt="image" src="https://github.com/Agenta-AI/agenta/assets/56418363/f537691d-8dbb-4363-b7c0-ecef9f464053">
 
 
-7.  Go to the fern.config.json file and change the value of "organization" to `agenta`
-    <img width="593" alt="image" src="https://github.com/Agenta-AI/agenta/assets/56418363/0f44255e-50b5-4d78-863b-d33a3ec2eea0">
+8. Go to the fern.config.json file and change the value of "organization" to `agenta`
+<img width="593" alt="image" src="https://github.com/Agenta-AI/agenta/assets/56418363/0f44255e-50b5-4d78-863b-d33a3ec2eea0">
 
    
-9.  Generate the client code
-   
-    ```bash
-        fern generate
-    ```
-
-10.  Change the timeout for the build_image function endpoint
-    Go to the client.py in the generated code folder search for the `build_image` function in the AgentaApi class and change the timeout to 600.
-    When done, it should look like this;
-    <img width="995" alt="image" src="https://github.com/Agenta-AI/agenta/assets/56418363/8fab19e3-5226-405b-8a6f-4dcb6df588c9">
-
+9. Generate the client code
+```bash
+    fern generate
+```
 
+10. Go to `./backend/containers/client.py`, search for the `build_image` function in the AgentaApi class and update `timeout_in_seconds` to `600` in `request_options'. It should now look like this;
+```python
+_response = self._client_wrapper.httpx_client.request(
+    "containers/build_image",
+    method="POST",
+    params={
+        "app_id": app_id,
+        "base_name": base_name,
+    },
+    data={},
+    files={
+        "tar_file": tar_file,
+    },
+    request_options={**request_options, "timeout_in_seconds": 600},
+    omit=OMIT,
+)
+```
+<img width="995" alt="image" src="https://github.com/Agenta-AI/agenta/assets/56418363/8fab19e3-5226-405b-8a6f-4dcb6df588c9">
 
-11. Delete the fern folder.
+11. Delete the `./fern` folder.

agenta/client/api.py

@@ -47,7 +47,7 @@ def add_variant_to_server(
     )
     for attempt in range(retries):
         try:
-            response = client.add_variant_from_image(
+            response = client.apps.add_variant_from_image(
                 app_id=app_id,
                 variant_name=f"{base_name.lower()}.default",
                 base_name=base_name,
@@ -55,7 +55,7 @@ def add_variant_to_server(
                 docker_id=image.docker_id,
                 tags=image.tags,
             )
-            click.echo(click.style("\nVariant added successfully.", fg="green"))
+            click.echo(click.style("\nVariant added successfully!", fg="green"))
             return response
         except RequestException as e:
             if attempt < retries - 1: