vellum-ai 0.6.3__py3-none-any.whl → 0.6.5__py3-none-any.whl

vellum/types/replaced_enum.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ReplacedEnum = typing.Literal["REPLACED"]

vellum/types/test_suite_test_case_bulk_operation_request.py

@@ -0,0 +1,46 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+from .test_suite_test_case_create_bulk_operation_request import TestSuiteTestCaseCreateBulkOperationRequest
+from .test_suite_test_case_delete_bulk_operation_request import TestSuiteTestCaseDeleteBulkOperationRequest
+from .test_suite_test_case_replace_bulk_operation_request import TestSuiteTestCaseReplaceBulkOperationRequest
+
+
+class TestSuiteTestCaseBulkOperationRequest_Create(TestSuiteTestCaseCreateBulkOperationRequest):
+    type: typing.Literal["CREATE"] = "CREATE"
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+        populate_by_name = True
+
+
+class TestSuiteTestCaseBulkOperationRequest_Replace(TestSuiteTestCaseReplaceBulkOperationRequest):
+    type: typing.Literal["REPLACE"] = "REPLACE"
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+        populate_by_name = True
+
+
+class TestSuiteTestCaseBulkOperationRequest_Delete(TestSuiteTestCaseDeleteBulkOperationRequest):
+    type: typing.Literal["DELETE"] = "DELETE"
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+        populate_by_name = True
+
+
+TestSuiteTestCaseBulkOperationRequest = typing.Union[
+    TestSuiteTestCaseBulkOperationRequest_Create,
+    TestSuiteTestCaseBulkOperationRequest_Replace,
+    TestSuiteTestCaseBulkOperationRequest_Delete,
+]

vellum/types/test_suite_test_case_bulk_result.py

@@ -0,0 +1,58 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+from .test_suite_test_case_created_bulk_result import TestSuiteTestCaseCreatedBulkResult
+from .test_suite_test_case_deleted_bulk_result import TestSuiteTestCaseDeletedBulkResult
+from .test_suite_test_case_rejected_bulk_result import TestSuiteTestCaseRejectedBulkResult
+from .test_suite_test_case_replaced_bulk_result import TestSuiteTestCaseReplacedBulkResult
+
+
+class TestSuiteTestCaseBulkResult_Created(TestSuiteTestCaseCreatedBulkResult):
+    type: typing.Literal["CREATED"] = "CREATED"
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+        populate_by_name = True
+
+
+class TestSuiteTestCaseBulkResult_Replaced(TestSuiteTestCaseReplacedBulkResult):
+    type: typing.Literal["REPLACED"] = "REPLACED"
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+        populate_by_name = True
+
+
+class TestSuiteTestCaseBulkResult_Deleted(TestSuiteTestCaseDeletedBulkResult):
+    type: typing.Literal["DELETED"] = "DELETED"
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+        populate_by_name = True
+
+
+class TestSuiteTestCaseBulkResult_Rejected(TestSuiteTestCaseRejectedBulkResult):
+    type: typing.Literal["REJECTED"] = "REJECTED"
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+        populate_by_name = True
+
+
+TestSuiteTestCaseBulkResult = typing.Union[
+    TestSuiteTestCaseBulkResult_Created,
+    TestSuiteTestCaseBulkResult_Replaced,
+    TestSuiteTestCaseBulkResult_Deleted,
+    TestSuiteTestCaseBulkResult_Rejected,
+]

vellum/types/test_suite_test_case_create_bulk_operation_request.py

@@ -0,0 +1,35 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
+from .bulk_create_test_suite_test_case_data_request import BulkCreateTestSuiteTestCaseDataRequest
+
+
+class TestSuiteTestCaseCreateBulkOperationRequest(pydantic_v1.BaseModel):
+    """
+    A bulk operation that represents the creation of a Test Case.
+    """
+
+    id: str = pydantic_v1.Field()
+    """
+    An ID representing this specific operation. Can later be used to look up information about the operation's success in the response.
+    """
+
+    data: BulkCreateTestSuiteTestCaseDataRequest
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/test_suite_test_case_created_bulk_result.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
+from .test_suite_test_case_created_bulk_result_data import TestSuiteTestCaseCreatedBulkResultData
+
+
+class TestSuiteTestCaseCreatedBulkResult(pydantic_v1.BaseModel):
+    """
+    The result of a bulk operation that created a Test Case.
+    """
+
+    id: str
+    data: TestSuiteTestCaseCreatedBulkResultData
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/test_suite_test_case_created_bulk_result_data.py

@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
+
+
+class TestSuiteTestCaseCreatedBulkResultData(pydantic_v1.BaseModel):
+    """
+    Information about the Test Case that was created.
+    """
+
+    id: str
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/test_suite_test_case_delete_bulk_operation_data_request.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
+
+
+class TestSuiteTestCaseDeleteBulkOperationDataRequest(pydantic_v1.BaseModel):
+    id: str
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/test_suite_test_case_delete_bulk_operation_request.py

@@ -0,0 +1,38 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
+from .test_suite_test_case_delete_bulk_operation_data_request import TestSuiteTestCaseDeleteBulkOperationDataRequest
+
+
+class TestSuiteTestCaseDeleteBulkOperationRequest(pydantic_v1.BaseModel):
+    """
+    A bulk operation that represents the deletion of a Test Case.
+    """
+
+    id: str = pydantic_v1.Field()
+    """
+    An ID representing this specific operation. Can later be used to look up information about the operation's success in the response.
+    """
+
+    data: TestSuiteTestCaseDeleteBulkOperationDataRequest = pydantic_v1.Field()
+    """
+    Information about the Test Case to delete
+    """
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/test_suite_test_case_deleted_bulk_result.py

@@ -0,0 +1,35 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
+from .test_suite_test_case_deleted_bulk_result_data import TestSuiteTestCaseDeletedBulkResultData
+
+
+class TestSuiteTestCaseDeletedBulkResult(pydantic_v1.BaseModel):
+    """
+    The result of a bulk operation that deleted a Test Case.
+    """
+
+    id: str = pydantic_v1.Field()
+    """
+    An ID that maps back to one of the initially supplied operations. Can be used to determine the result of a given operation.
+    """
+
+    data: TestSuiteTestCaseDeletedBulkResultData
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/test_suite_test_case_deleted_bulk_result_data.py

@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
+
+
+class TestSuiteTestCaseDeletedBulkResultData(pydantic_v1.BaseModel):
+    """
+    Information about the Test Case that was deleted
+    """
+
+    id: str
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/test_suite_test_case_rejected_bulk_result.py

@@ -0,0 +1,37 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
+
+
+class TestSuiteTestCaseRejectedBulkResult(pydantic_v1.BaseModel):
+    """
+    The result of a bulk operation that failed to operate on a Test Case.
+    """
+
+    id: str = pydantic_v1.Field()
+    """
+    An ID that maps back to one of the initially supplied operations. Can be used to determine the result of a given operation.
+    """
+
+    data: typing.Dict[str, typing.Any] = pydantic_v1.Field()
+    """
+    Details about the error that occurred
+    """
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/test_suite_test_case_replace_bulk_operation_request.py

@@ -0,0 +1,35 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
+from .bulk_replace_test_suite_test_case_data_request import BulkReplaceTestSuiteTestCaseDataRequest
+
+
+class TestSuiteTestCaseReplaceBulkOperationRequest(pydantic_v1.BaseModel):
+    """
+    A bulk operation that represents the replacing of a Test Case.
+    """
+
+    id: str = pydantic_v1.Field()
+    """
+    An ID representing this specific operation. Can later be used to look up information about the operation's success in the response.
+    """
+
+    data: BulkReplaceTestSuiteTestCaseDataRequest
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/test_suite_test_case_replaced_bulk_result.py

@@ -0,0 +1,35 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
+from .test_suite_test_case_replaced_bulk_result_data import TestSuiteTestCaseReplacedBulkResultData
+
+
+class TestSuiteTestCaseReplacedBulkResult(pydantic_v1.BaseModel):
+    """
+    The result of a bulk operation that replaced a Test Case.
+    """
+
+    id: str = pydantic_v1.Field()
+    """
+    An ID that maps back to one of the initially supplied operations. Can be used to determine the result of a given operation.
+    """
+
+    data: TestSuiteTestCaseReplacedBulkResultData
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/test_suite_test_case_replaced_bulk_result_data.py

@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
+
+
+class TestSuiteTestCaseReplacedBulkResultData(pydantic_v1.BaseModel):
+    """
+    Information about the Test Case that was replaced
+    """
+
+    id: str
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/workflow_deployment_read.py

@@ -41,6 +41,11 @@ class WorkflowDeploymentRead(pydantic_v1.BaseModel):
 
     created: dt.datetime
     last_deployed_on: dt.datetime
+    last_deployed_history_item_id: str = pydantic_v1.Field()
+    """
+    The ID of the history item associated with this Workflow Deployment's LATEST Release Tag
+    """
+
     input_variables: typing.List[VellumVariable] = pydantic_v1.Field()
     """
     The input variables this Workflow Deployment expects to receive values for when it is executed.

vellum_ai-0.6.5.dist-info/METADATA

@@ -0,0 +1,126 @@
+Metadata-Version: 2.1
+Name: vellum-ai
+Version: 0.6.5
+Summary: 
+Requires-Python: >=3.8,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: cdktf (>=0.20.5,<0.21.0)
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: publication (==0.0.3)
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: typing_extensions (>=4.0.0)
+Description-Content-Type: text/markdown
+
+# Vellum Python Library
+
+[![pypi](https://img.shields.io/pypi/v/vellum-ai.svg)](https://pypi.python.org/pypi/vellum-ai)
+![license badge](https://img.shields.io/github/license/vellum-ai/vellum-client-python)
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://buildwithfern.com/?utm_source=vellum-ai/vellum-client-python/readme)
+
+The Vellum Python SDK provides access to the Vellum API from python.
+
+
+## API Docs
+You can find Vellum's complete API docs at [docs.vellum.ai](https://docs.vellum.ai/api-reference/introduction/getting-started).
+
+## Installation
+
+```sh
+pip install --upgrade vellum-ai
+```
+
+## Usage
+Below is how you would invoke a deployed Prompt from the Vellum API. For a complete list of all APIs
+that Vellum supports, check out our [API Reference](https://docs.vellum.ai/api-reference/introduction/getting-started).
+
+```python
+from vellum import (
+    PromptDeploymentInputRequest_String,
+)
+from vellum.client import Vellum
+
+client = Vellum(
+    api_key="YOUR_API_KEY",
+)
+
+def execute() -> str:
+    result = client.execute_prompt(
+        prompt_deployment_name="<example-deployment-name>>",
+        release_tag="LATEST",
+        inputs=[
+            PromptDeploymentInputRequest_String(
+                name="input_a",
+                type="STRING",
+                value="Hello, world!",
+            )
+        ],
+    )
+    
+    if result.state == "REJECTED":
+        raise Exception(result.error.message)
+
+    return result.outputs[0].value
+
+if __name__ == "__main__":
+    print(execute())
+```
+
+> [!TIP]
+> You can set a system environment variable `VELLUM_API_KEY` to avoid writing your api key within your code. To do so, add `export VELLUM_API_KEY=<your-api-token>`
+> to your ~/.zshrc or ~/.bashrc, open a new terminal, and then any code calling `vellum.Vellum()` will read this key.
+
+## Async Client
+This SDK has an async version. Here's how to use it:
+
+
+
+```python
+import asyncio
+
+import vellum
+from vellum.client import AsyncVellum
+
+client = AsyncVellum(api_key="YOUR_API_KEY")
+
+async def execute() -> str:
+    result = await client.execute_prompt(
+        prompt_deployment_name="<example-deployment-name>>",
+        release_tag="LATEST",
+        inputs=[
+            vellum.PromptDeploymentInputRequest_String(
+                name="input_a",
+                value="Hello, world!",
+            )
+        ],
+    )
+
+    if result.state == "REJECTED":
+        raise Exception(result.error.message)
+    
+    return result.outputs[0].value
+
+if __name__ == "__main__":
+    print(asyncio.run(execute()))
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, most of this library is generated programmatically.
+
+Please feel free to make contributions to any of the directories or files below:
+```plaintext
+examples/*
+src/vellum/lib/*
+tests/*
+README.md
+```
+
+Any additions made to files beyond those directories and files above would have to be moved over to our generation code
+(found in the separate [vellum-client-generator](https://github.com/vellum-ai/vellum-client-generator) repo),
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept,
+but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
+