vellum-ai 0.14.41__py3-none-any.whl → 1.11.2__py3-none-any.whl

vellum/types/prompt_request_video_input.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.prompt_request_video_input import *

vellum/types/prompt_version_build_config_sandbox.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.prompt_version_build_config_sandbox import *

vellum/types/scenario_input_audio_variable_value.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.scenario_input_audio_variable_value import *

vellum/types/scenario_input_document_variable_value.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.scenario_input_document_variable_value import *

vellum/types/scenario_input_image_variable_value.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.scenario_input_image_variable_value import *

vellum/types/scenario_input_video_variable_value.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.scenario_input_video_variable_value import *

vellum/types/scheduled_trigger_context.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.scheduled_trigger_context import *

vellum/types/slim_composio_tool_definition.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.slim_composio_tool_definition import *

vellum/types/slim_integration_auth_config_read.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.slim_integration_auth_config_read import *

vellum/types/slim_integration_read.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.slim_integration_read import *

vellum/types/test_case_audio_variable_value.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.test_case_audio_variable_value import *

vellum/types/test_case_document_variable_value.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.test_case_document_variable_value import *

vellum/types/test_case_image_variable_value.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.test_case_image_variable_value import *

vellum/types/test_case_video_variable_value.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.test_case_video_variable_value import *

vellum/types/thinking_vellum_value.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.thinking_vellum_value import *

vellum/types/thinking_vellum_value_request.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.thinking_vellum_value_request import *

vellum/types/update_active_workspace_response.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.update_active_workspace_response import *

vellum/types/uploaded_file_read.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.uploaded_file_read import *

vellum/types/vellum_video.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.vellum_video import *

vellum/types/vellum_video_request.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.vellum_video_request import *

vellum/types/video_chat_message_content.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.video_chat_message_content import *

vellum/types/video_chat_message_content_request.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.video_chat_message_content_request import *

vellum/types/video_input.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.video_input import *

vellum/types/video_input_request.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.video_input_request import *

vellum/types/video_prompt_block.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.video_prompt_block import *

vellum/types/video_vellum_value.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.video_vellum_value import *

vellum/types/video_vellum_value_request.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.video_vellum_value_request import *

vellum/types/workflow_deployment_display_data.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.workflow_deployment_display_data import *

vellum/types/workflow_display_icon.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.workflow_display_icon import *

vellum/types/workflow_event.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.workflow_event import *

vellum/types/workflow_execution_detail.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.workflow_execution_detail import *

vellum/types/workflow_execution_usage_calculation_error.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.workflow_execution_usage_calculation_error import *

vellum/types/workflow_execution_usage_calculation_error_code_enum.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.workflow_execution_usage_calculation_error_code_enum import *

vellum/types/workflow_execution_usage_result.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.workflow_execution_usage_result import *

vellum/types/workflow_input.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.workflow_input import *

vellum/types/workflow_output_audio.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.workflow_output_audio import *

vellum/types/workflow_output_document.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.workflow_output_document import *

vellum/types/workflow_output_video.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.workflow_output_video import *

vellum/types/workflow_request_audio_input_request.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.workflow_request_audio_input_request import *

vellum/types/workflow_request_document_input_request.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.workflow_request_document_input_request import *

vellum/types/workflow_request_image_input_request.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.workflow_request_image_input_request import *

vellum/types/workflow_request_video_input_request.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.workflow_request_video_input_request import *

vellum/types/workflow_resolved_state.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.workflow_resolved_state import *

vellum/types/workflow_result_event_state.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.workflow_result_event_state import *

vellum/types/workflow_sandbox_display_data.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.workflow_sandbox_display_data import *

vellum/types/workspace_display_config.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.workspace_display_config import *

vellum/utils/files/__init__.py

@@ -0,0 +1,18 @@
+from vellum.utils.files.exceptions import FileNotFoundError, FileRetrievalError, InvalidFileSourceError, VellumFileError
+from vellum.utils.files.mixin import VellumFileMixin
+from vellum.utils.files.read import read_vellum_file
+from vellum.utils.files.stream import stream_vellum_file
+from vellum.utils.files.types import VellumFileTypes
+from vellum.utils.files.upload import upload_vellum_file
+
+__all__ = [
+    "read_vellum_file",
+    "stream_vellum_file",
+    "upload_vellum_file",
+    "VellumFileTypes",
+    "VellumFileMixin",
+    "VellumFileError",
+    "InvalidFileSourceError",
+    "FileRetrievalError",
+    "FileNotFoundError",
+]

vellum/utils/files/constants.py

@@ -0,0 +1,47 @@
+"""Constants for Vellum file handling."""
+
+# Regex pattern to match Vellum uploaded file IDs in the format:
+# vellum:uploaded-file:12345678-1234-1234-1234-123456789abc
+VELLUM_FILE_SRC_PATTERN = r"vellum:uploaded-file:([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"
+
+# Regex pattern to match base64 data URLs with optional MIME type and charset:
+# data:text/plain;charset=utf-8;base64,SGVsbG8=
+# data:image/png;base64,iVBORw0KGgo=
+# data:;base64,
+BASE64_DATA_URL_PATTERN = (
+    r"^data:([a-zA-Z0-9+/.-]+/[a-zA-Z0-9+.-]+)?(;charset=[a-zA-Z0-9-]+)?;base64,(.*)$"  # noqa: E501
+)
+
+# Regex pattern to match HTTP/HTTPS URLs
+URL_PATTERN = r"^(https?://[^\s]+)$"
+
+# Fallback MIME type to file extension mappings for types that mimetypes.guess_extension
+# might not handle well or returns undesirable extensions
+MIME_TYPE_TO_EXTENSION = {
+    "application/octet-stream": ".bin",
+    "text/plain": ".txt",
+    # Markdown variants
+    "text/markdown": ".md",
+    "text/x-markdown": ".md",
+    # YAML variants
+    "application/x-yaml": ".yaml",
+    "text/yaml": ".yaml",
+    "application/yaml": ".yaml",
+    # Compression formats
+    "application/gzip": ".gz",
+    "application/x-gzip": ".gz",
+}
+
+# File extension overrides to prefer more common extensions
+EXTENSION_OVERRIDES = {
+    # Image formats - prefer shorter extensions
+    ".jpe": ".jpg",
+    ".jpeg": ".jpg",
+    ".tif": ".tiff",
+    # HTML - prefer .html over .htm
+    ".htm": ".html",
+    # XML - prefer .xml over .xsl (mimetypes returns .xsl for application/xml)
+    ".xsl": ".xml",
+    # YAML - prefer .yaml over .yml for consistency
+    ".yml": ".yaml",
+}

vellum/utils/files/exceptions.py

@@ -0,0 +1,25 @@
+"""Exceptions for Vellum file operations."""
+
+
+class VellumFileError(Exception):
+    """Base exception for all Vellum file errors."""
+
+    pass
+
+
+class InvalidFileSourceError(VellumFileError):
+    """Raised when a file source URL/identifier is malformed or unsupported."""
+
+    pass
+
+
+class FileRetrievalError(VellumFileError):
+    """Raised when a file cannot be retrieved from its source."""
+
+    pass
+
+
+class FileNotFoundError(FileRetrievalError):
+    """Raised when a file cannot be found at its source."""
+
+    pass

vellum/utils/files/extensions.py

@@ -0,0 +1,59 @@
+"""File extension inference utilities."""
+
+import mimetypes
+import os
+from typing import Optional
+
+from vellum.utils.files.constants import EXTENSION_OVERRIDES, MIME_TYPE_TO_EXTENSION
+
+
+def ensure_filename_with_extension(filename: Optional[str], mime_type: str) -> str:
+    """
+    Ensure the filename has an appropriate extension, infering one based on the provided MIME type if necessary.
+
+    Args:
+        filename: Optional filename provided by the user
+        mime_type: The MIME type of the file (e.g., "application/pdf", "image/png"). This'll be used to infer the
+            extension if the filename lacks one.
+
+    Returns:
+        A filename with an appropriate extension
+
+    Examples:
+        >>> ensure_filename_with_extension(None, "application/pdf")
+        'file.pdf'
+        >>> ensure_filename_with_extension("document", "application/pdf")
+        'document.pdf'
+        >>> ensure_filename_with_extension("document.pdf", "application/pdf")
+        'document.pdf'
+        >>> ensure_filename_with_extension("document.pdf", "image/jpeg")
+        'document.pdf'  # Prioritizes existing extension
+    """
+    # Strip parameters from MIME type (e.g., "text/html; charset=utf-8" -> "text/html")
+    mime_type = mime_type.split(";")[0].strip()
+
+    # If no filename provided, start with "file"
+    if not filename:
+        base_name = "file"
+        has_extension = False
+    else:
+        base_name = filename
+        # Check if filename already has an extension
+        _, ext = os.path.splitext(filename)
+        has_extension = bool(ext)
+
+    # If the provided filename already has an extension, keep it
+    if filename and has_extension:
+        return filename
+
+    # Otherwise, infer extension from MIME type
+    extension = mimetypes.guess_extension(mime_type)
+
+    # Handle cases where mimetypes returns None or undesirable extensions
+    if not extension:
+        extension = MIME_TYPE_TO_EXTENSION.get(mime_type, ".bin")
+
+    # Some MIME types have multiple possible extensions; prefer the most common ones
+    extension = EXTENSION_OVERRIDES.get(extension, extension)
+
+    return f"{base_name}{extension}"

vellum/utils/files/mixin.py

@@ -0,0 +1,109 @@
+from typing import Any, ContextManager, Iterator, Optional
+
+from vellum.client.core.pydantic_utilities import UniversalBaseModel
+from vellum.utils.files.read import read_vellum_file
+from vellum.utils.files.stream import stream_vellum_file
+from vellum.utils.files.upload import upload_vellum_file
+from vellum.utils.files.urls import get_signed_url
+
+
+class VellumFileMixin(UniversalBaseModel):
+    """Mixin class that provides stream, read, and upload methods for Vellum file types.
+
+    This class extends UniversalBaseModel, so file types can inherit from this
+    instead of both UniversalBaseModel and VellumFileMixin.
+    """
+
+    def stream(
+        self: Any,
+        *,
+        chunk_size: int = 8192,
+        vellum_client: Optional[Any] = None,
+    ) -> ContextManager[Iterator[bytes]]:
+        """
+        Stream the file content in chunks using a context manager.
+
+        This is the recommended way to read large files, as it avoids loading
+        the entire file into memory at once.
+
+        Args:
+            chunk_size: Size of chunks to yield in bytes (default 8KB)
+            vellum_client: An optional Vellum client instance. If not provided, a default client will be created.
+
+        Returns:
+            A context manager that yields an iterator of file content chunks.
+
+        Example:
+            ```python
+            with file.stream() as chunks:
+                for chunk in chunks:
+                    process(chunk)
+            ```
+        """
+        return stream_vellum_file(self, chunk_size=chunk_size, vellum_client=vellum_client)
+
+    def read(
+        self: Any,
+        *,
+        vellum_client: Optional[Any] = None,
+    ) -> bytes:
+        """
+        Read the entire file content into memory.
+
+        For large files (e.g., videos, large datasets), consider using
+        stream() directly to avoid memory issues.
+
+        Args:
+            vellum_client: An optional Vellum client instance. If not provided, a default client will be created.
+
+        Returns:
+            bytes: The complete file content
+        """
+        return read_vellum_file(self, vellum_client=vellum_client)
+
+    def upload(
+        self: Any,
+        *,
+        filename: Optional[str] = None,
+        vellum_client: Optional[Any] = None,
+    ) -> Any:
+        """
+        Upload a file to Vellum and return a new VellumFile with the uploaded source.
+
+        This function takes any VellumFile object (with a src that could be a base64 data URL,
+        HTTP/HTTPS URL, or existing vellum:uploaded-file: identifier), downloads its content,
+        and uploads it to Vellum's storage.
+
+        Args:
+            vellum_file: A VellumDocument, VellumImage, VellumAudio, or VellumVideo instance
+            filename: Optional filename to use when uploading. If not provided, defaults to "file"
+                     with an appropriate extension inferred from the MIME type. If provided without
+                     an extension, the extension will be automatically added based on the MIME type.
+            vellum_client: An optional Vellum client instance. If not provided, a default client will be created.
+
+        Returns:
+            A new instance with the vellum:uploaded-file:{id} source
+        """
+        return upload_vellum_file(self, filename=filename, vellum_client=vellum_client)
+
+    def get_signed_url(
+        self: Any,
+        *,
+        expiry_seconds: int = 7 * 24 * 60 * 60,  # 7 days
+        vellum_client: Optional[Any] = None,
+    ) -> str:
+        """
+        Retrieved a signed url for a file that's been uploaded to Vellum
+
+        This function takes any VellumFile object (with a src that could be a base64 data URL,
+        HTTP/HTTPS URL, or existing vellum:uploaded-file: identifier), uploads it to Vellum (if not already uploaded),
+        and returns a signed url for accessing the file.
+
+        Args:
+            expiry_seconds: The number of seconds until the signed URL expires. Defaults to 7 days.
+            vellum_client: An optional Vellum client instance. If not provided, a default client will be created.
+
+        Returns:
+            str: A signed URL for accessing the uploaded file
+        """
+        return get_signed_url(self, expiry_seconds=expiry_seconds, vellum_client=vellum_client)

vellum/utils/files/read.py

@@ -0,0 +1,41 @@
+"""Convenience utilities for reading Vellum files."""
+
+from typing import TYPE_CHECKING, Optional
+
+from vellum.utils.files.stream import stream_vellum_file
+from vellum.utils.files.types import VellumFileTypes
+
+if TYPE_CHECKING:
+    from vellum.client import Vellum as VellumClient
+
+
+def read_vellum_file(vellum_file: VellumFileTypes, *, vellum_client: Optional["VellumClient"] = None) -> bytes:
+    """
+    Convenience function that reads the entire file content into memory.
+
+    This function is implemented using stream_vellum_file() under the hood.
+    For large files (e.g., videos, large datasets), consider using
+    stream_vellum_file() directly to avoid memory issues.
+
+    Args:
+        vellum_file: A VellumDocument, VellumImage, VellumAudio, or VellumVideo instance
+        vellum_client: An optional Vellum client instance. If not provided, a default client will be created.
+
+    Returns:
+        bytes: The complete file content
+
+    Example:
+        ```python
+        from vellum import VellumDocument
+        from vellum.utils.files import read_vellum_file
+
+        document = VellumDocument(src="data:text/plain;base64,SGVsbG8gV29ybGQ=")
+        content = read_vellum_file(document)
+        print(content.decode('utf-8'))  # "Hello World"
+        ```
+    """
+    chunks = []
+    with stream_vellum_file(vellum_file, vellum_client=vellum_client) as chunk_iter:
+        for chunk in chunk_iter:
+            chunks.append(chunk)
+    return b"".join(chunks)