vellum-ai 1.10.7__tar.gz → 1.11.17__tar.gz

vellum_ai-1.11.17/PKG-INFO

@@ -0,0 +1,125 @@
+Metadata-Version: 2.1
+Name: vellum-ai
+Version: 1.11.17
+Summary: 
+License: MIT
+Requires-Python: >=3.9,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: Jinja2 (>=3.1.0,<4.0.0)
+Requires-Dist: click (>=8.1.7,<9.0.0)
+Requires-Dist: docker (>=7.1.0,<8.0.0)
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: jsonschema (>=4.0.0)
+Requires-Dist: orderly-set (>=5.2.2,<6.0.0)
+Requires-Dist: publication (==0.0.3)
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: pydantic-core (>=2.18.2)
+Requires-Dist: pydash (>=7.0.0,<8.0.0)
+Requires-Dist: python-dateutil (>=2.8.0,<3.0.0)
+Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
+Requires-Dist: pytz (>=2022.0,<2026.0)
+Requires-Dist: pyyaml (>=6.0.0,<7.0.0)
+Requires-Dist: requests (>=2.31.0,<3.0.0)
+Requires-Dist: tomli (>=2.0.0,<3.0.0)
+Requires-Dist: typing_extensions (>=4.0.0)
+Project-URL: Repository, https://github.com/vellum-ai/vellum-python-sdks
+Description-Content-Type: text/markdown
+
+<p align="center">
+   <a href="https://vellum.ai">
+    <picture>
+      <img alt="Vellum README banner" src="https://storage.googleapis.com/vellum-public/assets/github-readme-banner.png" height="128">
+    </picture>
+  </a>
+  <p align="center">
+    <a href="https://vellum.ai">Learn more</a>
+    ·
+    <a href="https://www.vellum.ai/landing-pages/request-demo">Talk to us</a>
+  </p>
+</p>
+
+<p align="center">
+  <a href="https://pepy.tech/project/vellum-ai">
+    <img src="https://img.shields.io/pypi/dm/vellum-ai" alt="Vellum AI PyPI - Downloads" >
+  </a>
+  <a href="https://pypi.org/project/vellum-ai" target="_blank">
+    <img src="https://img.shields.io/pypi/v/vellum-ai?color=%2334D058&label=pypi%20package" alt="Package version">
+  </a>
+  <a href="https://www.ycombinator.com/companies/vellum">
+    <img src="https://img.shields.io/badge/Y%20Combinator-W23-orange?style=flat-square" alt="Y Combinator S24">
+  </a>
+</p>
+
+# Introduction
+
+[Vellum](https://www.vellum.ai/) is the end-to-end development platform for building production-grade AI applications.
+
+### Core Features
+
+- **Orchestration:** A powerful SDK and IDE for defining and debugging the control flow of your AI applications
+- **Prompting:** A best-in-class prompt playground for iterating on and refining prompts between models from any provider
+- **Evaluations**: An evaluations framework that makes it easy to measure the quality of your AI systems at scale
+- **Retrieval:** A ready-to-go service for turning unstructured content into intelligent, context-aware solutions
+  optimized for AI systems
+- **Deployment:** Decouple updates to your AI systems from your application code with an easy integration +
+  one-click deploy
+- **Observability:** Monitor and debug your AI systems in real-time with detailed logs, metrics, and end-user feedback
+
+## Table of Contents
+
+- [Get Started](#get-started)
+- [Client SDK](#client-sdk)
+- [Workflows SDK](#workflows-sdk)
+- [Contributing](#contributing)
+- [Open-source vs paid](#open-source-vs-paid)
+
+## Get Started
+
+Most functionality within the Vellum SDK requires a Vellum account and API key. You can sign up for free [here](https://app.vellum.ai/signup?f=wsdk&utm_source=github&utm_medium=repo_readme&utm_campaign=sdk) or visit our [pricing page](https://www.vellum.ai/pricing) for paid options.
+
+Even without a Vellum account, you can use the Workflows SDK to define the control flow of your AI systems. [Learn
+more below](#workflows-sdk).
+
+## Client SDK
+
+The Vellum Client SDK, found within `src/vellum/client` is a low-level client used to interact directly with the Vellum API.
+Learn more and get started by visiting the [Vellum Client SDK README](/src/vellum/client/README.md).
+
+## Workflows SDK
+
+The Vellum Workflows SDK is a high-level framework for defining and debugging the control flow of AI systems. At
+it's core, it's a powerful workflow engine with syntactic sugar for declaratively defining graphs, the nodes within,
+and the relationships between them.
+
+The Workflows SDK can be used with or without a Vellum account, but a Vellum account is required to use certain
+out-of-box nodes and features, including the ability to push and pull your Workflow definition to Vellum for editing
+and debugging via a UI.
+
+To learn more and get started, visit the [Vellum Workflows SDK README](/src/vellum/workflows/README.md).
+
+## Contributing
+
+See the [CONTRIBUTING.md](/CONTRIBUTING.md) for information on how to contribute to the Vellum SDKs.
+
+## Open-Source vs. Paid
+
+This repo is available under the [MIT expat license](https://github.com/vellum-ai/vellum-python-sdks/blob/main/LICENSE), except
+for the `ee` directory (which has its [license here](https://github.com/vellum-ai/vellum-python-sdks/blob/main/ee/LICENSE)) if applicable.
+
+To learn more, [book a demo](https://www.vellum.ai/landing-pages/request-demo) or see our [pricing page](https://www.vellum.ai/pricing).
+

vellum_ai-1.11.17/ee/vellum_cli/__init__.py

@@ -0,0 +1,437 @@
+from typing import List, Optional
+
+import click
+
+from vellum_cli.aliased_group import ClickAliasedGroup
+from vellum_cli.image_push import image_push_command
+from vellum_cli.init import init_command
+from vellum_cli.move import move_command
+from vellum_cli.ping import ping_command
+from vellum_cli.pull import pull_command
+from vellum_cli.push import push_command
+
+
+@click.group(cls=ClickAliasedGroup)
+def main() -> None:
+    """Vellum SDK CLI"""
+    pass
+
+
+@main.command
+def ping() -> None:
+    """
+    Ping Vellum to confirm that requests are correctly authenticated and to return information about the active
+    Workspace/Organization
+    """
+    ping_command()
+
+
+class PushGroup(ClickAliasedGroup):
+    def get_command(self, ctx, cmd_name):
+        # First try to get the command normally
+        cmd = super().get_command(ctx, cmd_name)
+        if cmd is not None:
+            return cmd
+
+        # If no command found, call our catch-all
+        return push_module
+
+
+@main.group(invoke_without_command=True, cls=PushGroup)
+@click.pass_context
+@click.option("--workspace", type=str, help="The specific Workspace config to use when pushing")
+def push(
+    ctx: click.Context,
+    workspace: Optional[str],
+) -> None:
+    """Push Resources to Vellum"""
+
+    if ctx.invoked_subcommand is None:
+        push_command(workspace=workspace)
+
+
+@main.group()
+def workflows():
+    """Operations related to Vellum Workflows"""
+    pass
+
+
+@workflows.command(name="push")
+@click.argument("module", required=False)
+@click.option(
+    "--workflow-sandbox-id",
+    type=str,
+    help="""The specific Workflow Sandbox ID to use when pushing. Must either be already associated \
+with the provided module or be available for use. The Workflow Sandbox must also exist in Vellum.""",
+)
+@click.option("--deploy", is_flag=True, help="Deploy the Workflow after pushing it to Vellum")
+@click.option("--deployment-label", type=str, help="Label to use for the Deployment")
+@click.option("--deployment-name", type=str, help="Unique name for the Deployment")
+@click.option("--deployment-description", type=str, help="Description for the Deployment")
+@click.option("--release-tag", help="Release Tag for the Deployment", multiple=True)
+@click.option("--release-description", type=str, help="Description for the Release")
+@click.option(
+    "--dry-run",
+    is_flag=True,
+    help="Check the Workflow for errors and expected changes, without updating its state in Vellum.",
+)
+@click.option(
+    "--strict",
+    is_flag=True,
+    help="Raises an error if we detect an unexpected discrepancy in the generated artifact.",
+)
+@click.option("--workspace", type=str, help="The specific Workspace config to use when pushing")
+def workflows_push(
+    module: Optional[str],
+    workflow_sandbox_id: Optional[str],
+    deploy: Optional[bool],
+    deployment_label: Optional[str],
+    deployment_name: Optional[str],
+    deployment_description: Optional[str],
+    release_tag: Optional[List[str]],
+    release_description: Optional[str],
+    dry_run: Optional[bool],
+    strict: Optional[bool],
+    workspace: Optional[str],
+) -> None:
+    """
+    Push Workflows to Vellum. If a module is provided, only the Workflow for that module will be pushed.
+    If no module is provided, the first configured Workflow will be pushed.
+    """
+
+    push_command(
+        module=module,
+        workflow_sandbox_id=workflow_sandbox_id,
+        deploy=deploy,
+        deployment_label=deployment_label,
+        deployment_name=deployment_name,
+        deployment_description=deployment_description,
+        release_tags=release_tag,
+        release_description=release_description,
+        dry_run=dry_run,
+        strict=strict,
+        workspace=workspace,
+    )
+
+
+@push.command(name="*", hidden=True)
+@click.pass_context
+@click.option("--workflow-sandbox-id", type=str, help="The specific Workflow Sandbox ID to use when pushing")
+@click.option("--deploy", is_flag=True, help="Deploy the Resource after pushing it to Vellum")
+@click.option("--deployment-label", type=str, help="Label to use for the Deployment")
+@click.option("--deployment-name", type=str, help="Unique name for the Deployment")
+@click.option("--deployment-description", type=str, help="Description for the Deployment")
+@click.option("--release-tag", help="Release Tag for the Deployment", multiple=True)
+@click.option("--release-description", type=str, help="Description for the Release")
+@click.option(
+    "--dry-run",
+    is_flag=True,
+    help="Check the Workflow for errors and expected changes, without updating its state in Vellum.",
+)
+@click.option(
+    "--strict",
+    is_flag=True,
+    help="Raises an error if we detect an unexpected discrepancy in the generated artifact.",
+)
+@click.option("--workspace", type=str, help="The specific Workspace config to use when pushing")
+def push_module(
+    ctx: click.Context,
+    workflow_sandbox_id: Optional[str],
+    deploy: Optional[bool],
+    deployment_label: Optional[str],
+    deployment_name: Optional[str],
+    deployment_description: Optional[str],
+    release_tag: Optional[List[str]],
+    release_description: Optional[str],
+    dry_run: Optional[bool],
+    strict: Optional[bool],
+    workspace: Optional[str],
+) -> None:
+    """Push a specific module to Vellum"""
+
+    if ctx.parent:
+        push_command(
+            module=ctx.parent.invoked_subcommand,
+            workflow_sandbox_id=workflow_sandbox_id,
+            deploy=deploy,
+            deployment_label=deployment_label,
+            deployment_name=deployment_name,
+            deployment_description=deployment_description,
+            release_tags=release_tag,
+            release_description=release_description,
+            dry_run=dry_run,
+            strict=strict,
+            workspace=workspace,
+        )
+
+
+class PullGroup(ClickAliasedGroup):
+    def get_command(self, ctx, cmd_name):
+        # First try to get the command normally
+        cmd = super().get_command(ctx, cmd_name)
+        if cmd is not None:
+            return cmd
+
+        # If no command found, call our catch-all
+        return pull_module
+
+
+@main.group(invoke_without_command=True, cls=PullGroup)
+@click.pass_context
+@click.option(
+    "--include-json",
+    is_flag=True,
+    help="""Include the JSON representation of each Resource in the pull response. \
+Should only be used for debugging purposes.""",
+)
+@click.option(
+    "--exclude-code",
+    is_flag=True,
+    help="""Exclude the code definition of each Resource from the pull response. \
+Should only be used for debugging purposes.""",
+)
+@click.option(
+    "--strict",
+    is_flag=True,
+    help="""Raises an error immediately if there are any issues with the pulling of the Resource.""",
+)
+@click.option(
+    "--include-sandbox",
+    is_flag=True,
+    help="""Generates a runnable sandbox.py file containing test data from the Resource's sandbox. \
+Helpful for running and debugging workflows locally.""",
+)
+@click.option(
+    "--target-dir",
+    "target_directory",  # Internal parameter name is target_directory
+    type=str,
+    help="""Directory to pull the workflow into. If not specified, \
+the workflow will be pulled into the current working directory.""",
+)
+@click.option(
+    "--release-tag",
+    type=str,
+    help="""Release tag to use when pulling from a deployment.""",
+)
+def pull(
+    ctx: click.Context,
+    include_json: Optional[bool],
+    exclude_code: Optional[bool],
+    strict: Optional[bool],
+    include_sandbox: Optional[bool],
+    target_directory: Optional[str],
+    release_tag: Optional[str],
+) -> None:
+    """Pull Resources from Vellum"""
+
+    if ctx.invoked_subcommand is None:
+        pull_command(
+            include_json=include_json,
+            exclude_code=exclude_code,
+            strict=strict,
+            include_sandbox=include_sandbox,
+            target_directory=target_directory,
+            release_tag=release_tag,
+        )
+
+
+@workflows.command(name="pull")
+@click.argument("module", required=False)
+@click.option(
+    "--include-json",
+    is_flag=True,
+    help="""Include the JSON representation of the Workflow in the pull response. \
+Should only be used for debugging purposes.""",
+)
+@click.option("--workflow-sandbox-id", type=str, help="Pull the Workflow from a specific Sandbox ID")
+@click.option(
+    "--workflow-deployment",
+    type=str,
+    help="""Pull the Workflow from a specific Deployment. Can use the name or the ID of the Deployment.""",
+)
+@click.option(
+    "--exclude-code",
+    is_flag=True,
+    help="""Exclude the code definition of the Workflow from the pull response. \
+Should only be used for debugging purposes.""",
+)
+@click.option(
+    "--strict",
+    is_flag=True,
+    help="""Raises an error immediately if there are any issues with the pulling of the Workflow.""",
+)
+@click.option(
+    "--include-sandbox",
+    is_flag=True,
+    help="""Generates a runnable sandbox.py file containing test data from the Resource's sandbox. \
+Helpful for running and debugging workflows locally.""",
+)
+@click.option(
+    "--target-dir",
+    "target_directory",  # Internal parameter name is target_directory
+    type=str,
+    help="""Directory to pull the workflow into. If not specified, \
+the workflow will be pulled into the current working directory.""",
+)
+@click.option(
+    "--workspace",
+    type=str,
+    help="The specific Workspace config to use when pulling",
+)
+@click.option(
+    "--release-tag",
+    type=str,
+    help="""Release tag to use when pulling from a deployment.""",
+)
+def workflows_pull(
+    module: Optional[str],
+    include_json: Optional[bool],
+    workflow_sandbox_id: Optional[str],
+    workflow_deployment: Optional[str],
+    exclude_code: Optional[bool],
+    strict: Optional[bool],
+    include_sandbox: Optional[bool],
+    target_directory: Optional[str],
+    workspace: Optional[str],
+    release_tag: Optional[str],
+) -> None:
+    """
+    Pull Workflows from Vellum. If a module is provided, only the Workflow for that module will be pulled.
+    If no module is provided, the first configured Workflow will be pulled.
+    """
+
+    pull_command(
+        module=module,
+        include_json=include_json,
+        workflow_sandbox_id=workflow_sandbox_id,
+        workflow_deployment=workflow_deployment,
+        exclude_code=exclude_code,
+        strict=strict,
+        include_sandbox=include_sandbox,
+        target_directory=target_directory,
+        workspace=workspace,
+        release_tag=release_tag,
+    )
+
+
+@pull.command(name="*")
+@click.pass_context
+@click.option(
+    "--include-json",
+    is_flag=True,
+    help="""Include the JSON representation of the Resource in the pull response. \
+Should only be used for debugging purposes.""",
+)
+@click.option(
+    "--exclude-code",
+    is_flag=True,
+    help="""Exclude the code definition of the Resource from the pull response. \
+Should only be used for debugging purposes.""",
+)
+@click.option(
+    "--strict",
+    is_flag=True,
+    help="""Raises an error immediately if there are any issues with the pulling of the Resource.""",
+)
+@click.option(
+    "--include-sandbox",
+    is_flag=True,
+    help="""Generates a runnable sandbox.py file containing test data from the Resource's sandbox. \
+Helpful for running and debugging resources locally.""",
+)
+@click.option(
+    "--target-dir",
+    "target_directory",  # Internal parameter name is target_directory
+    type=str,
+    help="""Directory to pull the workflow into. If not specified, \
+the workflow will be pulled into the current working directory.""",
+)
+@click.option(
+    "--release-tag",
+    type=str,
+    help="""Release tag to use when pulling from a deployment.""",
+)
+def pull_module(
+    ctx: click.Context,
+    include_json: Optional[bool],
+    exclude_code: Optional[bool],
+    strict: Optional[bool],
+    include_sandbox: Optional[bool],
+    target_directory: Optional[str],
+    release_tag: Optional[str],
+) -> None:
+    """Pull a specific module from Vellum"""
+
+    if ctx.parent:
+        pull_command(
+            module=ctx.parent.invoked_subcommand,
+            include_json=include_json,
+            exclude_code=exclude_code,
+            strict=strict,
+            include_sandbox=include_sandbox,
+            target_directory=target_directory,
+            release_tag=release_tag,
+        )
+
+
+@main.group(aliases=["images", "image"])
+def images() -> None:
+    """Vellum Docker Images"""
+    pass
+
+
+@images.command(name="push")
+@click.argument("image", required=True)
+@click.option(
+    "--tag",
+    "-t",
+    multiple=True,
+    help="Tags the provided image inside of Vellum's repo. "
+    "This field does not push multiple local tags of the passed in image.",
+)
+@click.option("--workspace", type=str, help="The specific Workspace config to use when pushing")
+@click.option("--source", type=str, help="Path to Dockerfile to build before pushing")
+def image_push(
+    image: str, tag: Optional[List[str]] = None, workspace: Optional[str] = None, source: Optional[str] = None
+) -> None:
+    """Push Docker image to Vellum"""
+    image_push_command(image, tag, workspace, source)
+
+
+@workflows.command(name="move")
+@click.argument("old_module", required=True)
+@click.argument("new_module", required=True)
+@click.option("--workspace", type=str, help="The specific Workspace config to use when moving")
+def workflows_move(
+    old_module: str,
+    new_module: str,
+    workspace: Optional[str],
+) -> None:
+    """
+    Move/rename a Workflow module. Updates both the filesystem structure and configuration.
+    """
+
+    move_command(
+        old_module=old_module,
+        new_module=new_module,
+        workspace=workspace,
+    )
+
+
+@workflows.command(name="init")
+@click.argument("template_name", required=False)
+@click.option(
+    "--target-dir",
+    "target_directory",  # Internal parameter name is target_directory
+    type=str,
+    help="""Directory to pull the workflow into. If not specified, \
+the workflow will be pulled into the current working directory.""",
+)
+def workflows_init(template_name: Optional[str] = None, target_directory: Optional[str] = None) -> None:
+    """Initialize a new Vellum Workflow using a predefined template"""
+
+    init_command(template_name=template_name, target_directory=target_directory)
+
+
+if __name__ == "__main__":
+    main()