vellum-ai 0.8.22__tar.gz → 0.8.25__tar.gz

{vellum_ai-0.8.22 → vellum_ai-0.8.25}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vellum-ai
-Version: 0.8.22
+Version: 0.8.25
 Summary: 
 License: MIT
 Requires-Python: >=3.8,<4.0

{vellum_ai-0.8.22 → vellum_ai-0.8.25}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "vellum-ai"
-version = "0.8.22"
+version = "0.8.25"
 description = ""
 readme = "README.md"
 authors = []

{vellum_ai-0.8.22 → vellum_ai-0.8.25}/src/vellum/__init__.py

@@ -99,6 +99,17 @@ from .types import (
     ExternalTestCaseExecution,
     ExternalTestCaseExecutionRequest,
     FinishReasonEnum,
+    FolderEntity,
+    FolderEntityDocumentIndex,
+    FolderEntityDocumentIndexData,
+    FolderEntityFolder,
+    FolderEntityFolderData,
+    FolderEntityPromptSandbox,
+    FolderEntityPromptSandboxData,
+    FolderEntityTestSuite,
+    FolderEntityTestSuiteData,
+    FolderEntityWorkflowSandbox,
+    FolderEntityWorkflowSandboxData,
     FulfilledAdHocExecutePromptEvent,
     FulfilledEnum,
     FulfilledExecutePromptEvent,
@@ -225,6 +236,7 @@ from .types import (
     OpenAiVectorizerTextEmbeddingAda002,
     OpenAiVectorizerTextEmbeddingAda002Request,
     PaginatedDocumentIndexReadList,
+    PaginatedFolderEntityList,
     PaginatedSlimDeploymentReadList,
     PaginatedSlimDocumentList,
     PaginatedSlimWorkflowDeploymentList,
@@ -457,6 +469,7 @@ from .errors import BadRequestError, ForbiddenError, InternalServerError, NotFou
 from .resources import (
     DeploymentsListRequestStatus,
     DocumentIndexesListRequestStatus,
+    FolderEntitiesListRequestEntityStatus,
     WorkflowDeploymentsListRequestStatus,
     ad_hoc,
     deployments,
@@ -577,6 +590,18 @@ __all__ = [
     "ExternalTestCaseExecution",
     "ExternalTestCaseExecutionRequest",
     "FinishReasonEnum",
+    "FolderEntitiesListRequestEntityStatus",
+    "FolderEntity",
+    "FolderEntityDocumentIndex",
+    "FolderEntityDocumentIndexData",
+    "FolderEntityFolder",
+    "FolderEntityFolderData",
+    "FolderEntityPromptSandbox",
+    "FolderEntityPromptSandboxData",
+    "FolderEntityTestSuite",
+    "FolderEntityTestSuiteData",
+    "FolderEntityWorkflowSandbox",
+    "FolderEntityWorkflowSandboxData",
     "ForbiddenError",
     "FulfilledAdHocExecutePromptEvent",
     "FulfilledEnum",
@@ -706,6 +731,7 @@ __all__ = [
     "OpenAiVectorizerTextEmbeddingAda002",
     "OpenAiVectorizerTextEmbeddingAda002Request",
     "PaginatedDocumentIndexReadList",
+    "PaginatedFolderEntityList",
     "PaginatedSlimDeploymentReadList",
     "PaginatedSlimDocumentList",
     "PaginatedSlimWorkflowDeploymentList",

{vellum_ai-0.8.22 → vellum_ai-0.8.25}/src/vellum/core/client_wrapper.py

@@ -17,7 +17,7 @@ class BaseClientWrapper:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "vellum-ai",
-            "X-Fern-SDK-Version": "0.8.22",
+            "X-Fern-SDK-Version": "0.8.25",
         }
         headers["X_API_KEY"] = self.api_key
         return headers

{vellum_ai-0.8.22 → vellum_ai-0.8.25}/src/vellum/lib/test_suites/resources.py

@@ -4,9 +4,10 @@ import logging
 import time
 from functools import cached_property
 from typing import Callable, Generator, List, cast, Iterable
+from uuid import UUID
 
 from vellum import TestSuiteRunRead, TestSuiteRunMetricNumberOutput
-from vellum.client import Vellum
+from vellum.client import Vellum, OMIT
 from vellum.lib.test_suites.constants import (
     DEFAULT_MAX_POLLING_DURATION_MS,
     DEFAULT_POLLING_INTERVAL_MS,
@@ -14,6 +15,8 @@ from vellum.lib.test_suites.constants import (
 from vellum.lib.test_suites.exceptions import TestSuiteRunResultsException
 from vellum.lib.utils.env import get_api_key
 from vellum.lib.utils.paginator import PaginatedResults, get_all_results
+from vellum.lib.utils.typing import cast_not_optional
+from vellum.lib.utils.uuid import is_valid_uuid
 from vellum.types import (
     ExternalTestCaseExecutionRequest,
     NamedTestCaseVariableValueRequest,
@@ -198,7 +201,9 @@ class VellumTestSuiteRunResults:
         output_values = self.get_numeric_metric_output_values(
             metric_identifier=metric_identifier, output_identifier=output_identifier
         )
-        return sum(cast(Iterable[float], filter(lambda o: isinstance(o, float), output_values))) / len(output_values)
+        return sum(
+            cast(Iterable[float], filter(lambda o: isinstance(o, float), output_values))
+        ) / len(output_values)
 
     def get_min_metric_output(
         self, metric_identifier: str | None = None, output_identifier: str | None = None
@@ -207,7 +212,9 @@ class VellumTestSuiteRunResults:
         output_values = self.get_numeric_metric_output_values(
             metric_identifier=metric_identifier, output_identifier=output_identifier
         )
-        return min(cast(Iterable[float], filter(lambda o: isinstance(o, float), output_values)))
+        return min(
+            cast(Iterable[float], filter(lambda o: isinstance(o, float), output_values))
+        )
 
     def get_max_metric_output(
         self, metric_identifier: str | None = None, output_identifier: str | None = None
@@ -216,7 +223,9 @@ class VellumTestSuiteRunResults:
         output_values = self.get_numeric_metric_output_values(
             metric_identifier=metric_identifier, output_identifier=output_identifier
         )
-        return max(cast(Iterable[float], filter(lambda o: isinstance(o, float), output_values)))
+        return max(
+            cast(Iterable[float], filter(lambda o: isinstance(o, float), output_values))
+        )
 
     def wait_until_complete(self) -> None:
         """Wait until the Test Suite Run is no longer in a QUEUED or RUNNING state."""
@@ -282,16 +291,25 @@ class VellumTestSuiteRunResults:
 class VellumTestSuite:
     """A utility class that provides methods for running a Vellum Test Suite and interacting with its results."""
 
+    _test_suite_id: str | None
+    _test_suite_name: str | None
+
     def __init__(
         self,
-        test_suite_id: str,
+        test_suite_identifier: str | UUID,
         *,
         client: Vellum | None = None,
     ) -> None:
         self.client = client or Vellum(
             api_key=get_api_key(),
         )
-        self._test_suite_id = test_suite_id
+
+        if is_valid_uuid(test_suite_identifier):
+            self._test_suite_id = str(test_suite_identifier)
+            self._test_suite_name = None
+        else:
+            self._test_suite_id = None
+            self._test_suite_name = str(test_suite_identifier)
 
     def run_external(
         self,
@@ -305,7 +323,7 @@ class VellumTestSuite:
         Returns a wrapper that polls the generated Test Suite Run until it's done running and returns its results.
         """
         test_cases = self.client.test_suites.list_test_suite_test_cases(
-            id=self._test_suite_id
+            id=cast_not_optional(self._test_suite_id or self._test_suite_name)
         )
         executions: List[ExternalTestCaseExecutionRequest] = []
 
@@ -320,7 +338,8 @@ class VellumTestSuite:
             )
 
         test_suite_run = self.client.test_suite_runs.create(
-            test_suite_id=self._test_suite_id,
+            test_suite_id=self._test_suite_id or OMIT,
+            test_suite_name=self._test_suite_name or OMIT,
             exec_config=TestSuiteRunExternalExecConfigRequest(
                 type="EXTERNAL",
                 data=TestSuiteRunExternalExecConfigDataRequest(

vellum_ai-0.8.25/src/vellum/lib/utils/typing.py

@@ -0,0 +1,10 @@
+from typing import TypeVar, Optional
+
+_T = TypeVar("_T")
+
+
+def cast_not_optional(optional: Optional[_T]) -> _T:
+    """Convert an optional to its value for type checking purposes. Raises an AssertionError if passed None."""
+    if optional is None:
+        raise AssertionError("Not optional check failed")
+    return optional

vellum_ai-0.8.25/src/vellum/lib/utils/uuid.py

@@ -0,0 +1,10 @@
+from typing import Union
+import uuid
+
+
+def is_valid_uuid(val: Union[str, uuid.UUID, None]) -> bool:
+    try:
+        uuid.UUID(str(val))
+        return True
+    except (ValueError, TypeError):
+        return False

{vellum_ai-0.8.22 → vellum_ai-0.8.25}/src/vellum/resources/__init__.py

@@ -15,11 +15,13 @@ from . import (
 )
 from .deployments import DeploymentsListRequestStatus
 from .document_indexes import DocumentIndexesListRequestStatus
+from .folder_entities import FolderEntitiesListRequestEntityStatus
 from .workflow_deployments import WorkflowDeploymentsListRequestStatus
 
 __all__ = [
     "DeploymentsListRequestStatus",
     "DocumentIndexesListRequestStatus",
+    "FolderEntitiesListRequestEntityStatus",
     "WorkflowDeploymentsListRequestStatus",
     "ad_hoc",
     "deployments",

vellum_ai-0.8.25/src/vellum/resources/folder_entities/__init__.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .types import FolderEntitiesListRequestEntityStatus
+
+__all__ = ["FolderEntitiesListRequestEntityStatus"]

vellum_ai-0.8.25/src/vellum/resources/folder_entities/client.py

@@ -0,0 +1,333 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from ...core.client_wrapper import SyncClientWrapper
+from .types.folder_entities_list_request_entity_status import FolderEntitiesListRequestEntityStatus
+from ...core.request_options import RequestOptions
+from ...types.paginated_folder_entity_list import PaginatedFolderEntityList
+from ...core.pydantic_utilities import parse_obj_as
+from json.decoder import JSONDecodeError
+from ...core.api_error import ApiError
+from ...core.jsonable_encoder import jsonable_encoder
+from ...core.client_wrapper import AsyncClientWrapper
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class FolderEntitiesClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def list(
+        self,
+        *,
+        parent_folder_id: str,
+        entity_status: typing.Optional[FolderEntitiesListRequestEntityStatus] = None,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        ordering: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PaginatedFolderEntityList:
+        """
+        List all folder entities within a specified folder.
+
+        Parameters
+        ----------
+        parent_folder_id : str
+            Filter down to only those entities whose parent folder has the specified ID.
+
+            To filter by an entity's parent folder, provide the ID of the parent folder. To filter by the root directory, provide
+            a string representing the entity type of the root directory. Supported root directories include:
+
+            - PROMPT_SANDBOX
+            - WORKFLOW_SANDBOX
+            - DOCUMENT_INDEX
+            - TEST_SUITE
+
+        entity_status : typing.Optional[FolderEntitiesListRequestEntityStatus]
+            Filter down to only those objects whose entities have a status matching the status specified.
+
+            - `ACTIVE` - Active
+            - `ARCHIVED` - Archived
+
+        limit : typing.Optional[int]
+            Number of results to return per page.
+
+        offset : typing.Optional[int]
+            The initial index from which to return the results.
+
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PaginatedFolderEntityList
+
+
+        Examples
+        --------
+        from vellum import Vellum
+
+        client = Vellum(
+            api_key="YOUR_API_KEY",
+        )
+        client.folder_entities.list(
+            parent_folder_id="parent_folder_id",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "v1/folder-entities",
+            base_url=self._client_wrapper.get_environment().default,
+            method="GET",
+            params={
+                "entity_status": entity_status,
+                "limit": limit,
+                "offset": offset,
+                "ordering": ordering,
+                "parent_folder_id": parent_folder_id,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    PaginatedFolderEntityList,
+                    parse_obj_as(
+                        type_=PaginatedFolderEntityList,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    def add_entity_to_folder(
+        self, folder_id: str, *, entity_id: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Add an entity to a specific folder or root directory.
+
+        Adding an entity to a folder will remove it from any other folders it might have been a member of.
+
+        Parameters
+        ----------
+        folder_id : str
+            The ID of the folder to which the entity should be added. This can be a UUID of a folder, or the name of a root
+            directory. Supported root directories include:
+
+            - PROMPT_SANDBOX
+            - WORKFLOW_SANDBOX
+            - DOCUMENT_INDEX
+            - TEST_SUITE
+
+        entity_id : str
+            The ID of the entity you would like to move.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from vellum import Vellum
+
+        client = Vellum(
+            api_key="YOUR_API_KEY",
+        )
+        client.folder_entities.add_entity_to_folder(
+            folder_id="folder_id",
+            entity_id="entity_id",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"v1/folders/{jsonable_encoder(folder_id)}/add-entity",
+            base_url=self._client_wrapper.get_environment().default,
+            method="POST",
+            json={
+                "entity_id": entity_id,
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+
+class AsyncFolderEntitiesClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def list(
+        self,
+        *,
+        parent_folder_id: str,
+        entity_status: typing.Optional[FolderEntitiesListRequestEntityStatus] = None,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        ordering: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PaginatedFolderEntityList:
+        """
+        List all folder entities within a specified folder.
+
+        Parameters
+        ----------
+        parent_folder_id : str
+            Filter down to only those entities whose parent folder has the specified ID.
+
+            To filter by an entity's parent folder, provide the ID of the parent folder. To filter by the root directory, provide
+            a string representing the entity type of the root directory. Supported root directories include:
+
+            - PROMPT_SANDBOX
+            - WORKFLOW_SANDBOX
+            - DOCUMENT_INDEX
+            - TEST_SUITE
+
+        entity_status : typing.Optional[FolderEntitiesListRequestEntityStatus]
+            Filter down to only those objects whose entities have a status matching the status specified.
+
+            - `ACTIVE` - Active
+            - `ARCHIVED` - Archived
+
+        limit : typing.Optional[int]
+            Number of results to return per page.
+
+        offset : typing.Optional[int]
+            The initial index from which to return the results.
+
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PaginatedFolderEntityList
+
+
+        Examples
+        --------
+        import asyncio
+
+        from vellum import AsyncVellum
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.folder_entities.list(
+                parent_folder_id="parent_folder_id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "v1/folder-entities",
+            base_url=self._client_wrapper.get_environment().default,
+            method="GET",
+            params={
+                "entity_status": entity_status,
+                "limit": limit,
+                "offset": offset,
+                "ordering": ordering,
+                "parent_folder_id": parent_folder_id,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    PaginatedFolderEntityList,
+                    parse_obj_as(
+                        type_=PaginatedFolderEntityList,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def add_entity_to_folder(
+        self, folder_id: str, *, entity_id: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Add an entity to a specific folder or root directory.
+
+        Adding an entity to a folder will remove it from any other folders it might have been a member of.
+
+        Parameters
+        ----------
+        folder_id : str
+            The ID of the folder to which the entity should be added. This can be a UUID of a folder, or the name of a root
+            directory. Supported root directories include:
+
+            - PROMPT_SANDBOX
+            - WORKFLOW_SANDBOX
+            - DOCUMENT_INDEX
+            - TEST_SUITE
+
+        entity_id : str
+            The ID of the entity you would like to move.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from vellum import AsyncVellum
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.folder_entities.add_entity_to_folder(
+                folder_id="folder_id",
+                entity_id="entity_id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"v1/folders/{jsonable_encoder(folder_id)}/add-entity",
+            base_url=self._client_wrapper.get_environment().default,
+            method="POST",
+            json={
+                "entity_id": entity_id,
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)

vellum_ai-0.8.25/src/vellum/resources/folder_entities/types/__init__.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .folder_entities_list_request_entity_status import FolderEntitiesListRequestEntityStatus
+
+__all__ = ["FolderEntitiesListRequestEntityStatus"]

vellum_ai-0.8.25/src/vellum/resources/folder_entities/types/folder_entities_list_request_entity_status.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+FolderEntitiesListRequestEntityStatus = typing.Union[typing.Literal["ACTIVE", "ARCHIVED"], typing.Any]

{vellum_ai-0.8.22 → vellum_ai-0.8.25}/src/vellum/resources/test_suite_runs/client.py

@@ -24,8 +24,8 @@ class TestSuiteRunsClient:
     def create(
         self,
         *,
-        test_suite_id: str,
         exec_config: TestSuiteRunExecConfigRequest,
+        test_suite_id: typing.Optional[str] = OMIT,
         test_suite_name: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> TestSuiteRunRead:
@@ -34,12 +34,12 @@ class TestSuiteRunsClient:
 
         Parameters
         ----------
-        test_suite_id : str
-            The ID of the Test Suite to run. Must provide either this or test_suite_id.
-
         exec_config : TestSuiteRunExecConfigRequest
             Configuration that defines how the Test Suite should be run
 
+        test_suite_id : typing.Optional[str]
+            The ID of the Test Suite to run. Must provide either this or test_suite_id.
+
         test_suite_name : typing.Optional[str]
             The name of the Test Suite to run. Must provide either this or test_suite_id.
 
@@ -63,7 +63,6 @@ class TestSuiteRunsClient:
             api_key="YOUR_API_KEY",
         )
         client.test_suite_runs.create(
-            test_suite_id="test_suite_id",
             exec_config=TestSuiteRunDeploymentReleaseTagExecConfigRequest(
                 data=TestSuiteRunDeploymentReleaseTagExecConfigDataRequest(
                     deployment_id="deployment_id",
@@ -227,8 +226,8 @@ class AsyncTestSuiteRunsClient:
     async def create(
         self,
         *,
-        test_suite_id: str,
         exec_config: TestSuiteRunExecConfigRequest,
+        test_suite_id: typing.Optional[str] = OMIT,
         test_suite_name: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> TestSuiteRunRead:
@@ -237,12 +236,12 @@ class AsyncTestSuiteRunsClient:
 
         Parameters
         ----------
-        test_suite_id : str
-            The ID of the Test Suite to run. Must provide either this or test_suite_id.
-
         exec_config : TestSuiteRunExecConfigRequest
             Configuration that defines how the Test Suite should be run
 
+        test_suite_id : typing.Optional[str]
+            The ID of the Test Suite to run. Must provide either this or test_suite_id.
+
         test_suite_name : typing.Optional[str]
             The name of the Test Suite to run. Must provide either this or test_suite_id.
 
@@ -271,7 +270,6 @@ class AsyncTestSuiteRunsClient:
 
         async def main() -> None:
             await client.test_suite_runs.create(
-                test_suite_id="test_suite_id",
                 exec_config=TestSuiteRunDeploymentReleaseTagExecConfigRequest(
                     data=TestSuiteRunDeploymentReleaseTagExecConfigDataRequest(
                         deployment_id="deployment_id",