vellum-ai 0.6.4__tar.gz → 0.6.6__tar.gz

vellum_ai-0.6.6/PKG-INFO

@@ -0,0 +1,126 @@
+Metadata-Version: 2.1
+Name: vellum-ai
+Version: 0.6.6
+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!
+

vellum_ai-0.6.6/README.md

@@ -0,0 +1,108 @@
+# 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!

{vellum_ai-0.6.4 → vellum_ai-0.6.6}/pyproject.toml

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

{vellum_ai-0.6.4 → vellum_ai-0.6.6}/src/vellum/__init__.py

@@ -295,6 +295,9 @@ from .types import (
     PaginatedSlimWorkflowDeploymentList,
     PaginatedTestSuiteRunExecutionList,
     PaginatedTestSuiteTestCaseList,
+    PdfEnum,
+    PdfSearchResultMetaSource,
+    PdfSearchResultMetaSourceRequest,
     ProcessingFailureReasonEnum,
     ProcessingStateEnum,
     PromptDeploymentExpandMetaRequestRequest,
@@ -341,6 +344,12 @@ from .types import (
     SearchResultDocument,
     SearchResultDocumentRequest,
     SearchResultMergingRequest,
+    SearchResultMeta,
+    SearchResultMetaRequest,
+    SearchResultMetaSource,
+    SearchResultMetaSourceRequest,
+    SearchResultMetaSourceRequest_Pdf,
+    SearchResultMetaSource_Pdf,
     SearchResultRequest,
     SearchResultsEnum,
     SearchWeightsRequest,
@@ -915,6 +924,9 @@ __all__ = [
     "PaginatedSlimWorkflowDeploymentList",
     "PaginatedTestSuiteRunExecutionList",
     "PaginatedTestSuiteTestCaseList",
+    "PdfEnum",
+    "PdfSearchResultMetaSource",
+    "PdfSearchResultMetaSourceRequest",
     "ProcessingFailureReasonEnum",
     "ProcessingStateEnum",
     "PromptDeploymentExpandMetaRequestRequest",
@@ -961,6 +973,12 @@ __all__ = [
     "SearchResultDocument",
     "SearchResultDocumentRequest",
     "SearchResultMergingRequest",
+    "SearchResultMeta",
+    "SearchResultMetaRequest",
+    "SearchResultMetaSource",
+    "SearchResultMetaSourceRequest",
+    "SearchResultMetaSourceRequest_Pdf",
+    "SearchResultMetaSource_Pdf",
     "SearchResultRequest",
     "SearchResultsEnum",
     "SearchWeightsRequest",

{vellum_ai-0.6.4 → vellum_ai-0.6.6}/src/vellum/core/client_wrapper.py

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

{vellum_ai-0.6.4 → vellum_ai-0.6.6}/src/vellum/types/__init__.py

@@ -342,6 +342,9 @@ from .paginated_slim_document_list import PaginatedSlimDocumentList
 from .paginated_slim_workflow_deployment_list import PaginatedSlimWorkflowDeploymentList
 from .paginated_test_suite_run_execution_list import PaginatedTestSuiteRunExecutionList
 from .paginated_test_suite_test_case_list import PaginatedTestSuiteTestCaseList
+from .pdf_enum import PdfEnum
+from .pdf_search_result_meta_source import PdfSearchResultMetaSource
+from .pdf_search_result_meta_source_request import PdfSearchResultMetaSourceRequest
 from .processing_failure_reason_enum import ProcessingFailureReasonEnum
 from .processing_state_enum import ProcessingStateEnum
 from .prompt_deployment_expand_meta_request_request import PromptDeploymentExpandMetaRequestRequest
@@ -390,6 +393,10 @@ from .search_result import SearchResult
 from .search_result_document import SearchResultDocument
 from .search_result_document_request import SearchResultDocumentRequest
 from .search_result_merging_request import SearchResultMergingRequest
+from .search_result_meta import SearchResultMeta
+from .search_result_meta_request import SearchResultMetaRequest
+from .search_result_meta_source import SearchResultMetaSource, SearchResultMetaSource_Pdf
+from .search_result_meta_source_request import SearchResultMetaSourceRequest, SearchResultMetaSourceRequest_Pdf
 from .search_result_request import SearchResultRequest
 from .search_results_enum import SearchResultsEnum
 from .search_weights_request import SearchWeightsRequest
@@ -974,6 +981,9 @@ __all__ = [
     "PaginatedSlimWorkflowDeploymentList",
     "PaginatedTestSuiteRunExecutionList",
     "PaginatedTestSuiteTestCaseList",
+    "PdfEnum",
+    "PdfSearchResultMetaSource",
+    "PdfSearchResultMetaSourceRequest",
     "ProcessingFailureReasonEnum",
     "ProcessingStateEnum",
     "PromptDeploymentExpandMetaRequestRequest",
@@ -1020,6 +1030,12 @@ __all__ = [
     "SearchResultDocument",
     "SearchResultDocumentRequest",
     "SearchResultMergingRequest",
+    "SearchResultMeta",
+    "SearchResultMetaRequest",
+    "SearchResultMetaSource",
+    "SearchResultMetaSourceRequest",
+    "SearchResultMetaSourceRequest_Pdf",
+    "SearchResultMetaSource_Pdf",
     "SearchResultRequest",
     "SearchResultsEnum",
     "SearchWeightsRequest",

{vellum_ai-0.6.4 → vellum_ai-0.6.6}/src/vellum/types/deployment_read.py

@@ -47,6 +47,11 @@ class DeploymentRead(pydantic_v1.BaseModel):
     Deprecated. The Prompt execution endpoints return a `prompt_version_id` that could be used instead.
     """
 
+    last_deployed_history_item_id: str = pydantic_v1.Field()
+    """
+    The ID of the history item associated with this Deployment's LATEST Release Tag
+    """
+
     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)

vellum_ai-0.6.6/src/vellum/types/pdf_enum.py

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

vellum_ai-0.6.6/src/vellum/types/pdf_search_result_meta_source.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 PdfSearchResultMetaSource(pydantic_v1.BaseModel):
+    """
+    The source of a search result from a PDF document.
+    """
+
+    start_page_num: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    The 1-indexed page number where the chunk starts in the document. Only available for supported chunking strategies and document types.
+    """
+
+    end_page_num: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    The 1-indexed page number where the chunk ends in the document. Only available for supported chunking strategies and document types.
+    """
+
+    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_ai-0.6.6/src/vellum/types/pdf_search_result_meta_source_request.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 PdfSearchResultMetaSourceRequest(pydantic_v1.BaseModel):
+    """
+    The source of a search result from a PDF document.
+    """
+
+    start_page_num: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    The 1-indexed page number where the chunk starts in the document. Only available for supported chunking strategies and document types.
+    """
+
+    end_page_num: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    The 1-indexed page number where the chunk ends in the document. Only available for supported chunking strategies and document types.
+    """
+
+    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_ai-0.6.4 → vellum_ai-0.6.6}/src/vellum/types/search_result.py

@@ -6,6 +6,7 @@ import typing
 from ..core.datetime_utils import serialize_datetime
 from ..core.pydantic_utilities import pydantic_v1
 from .search_result_document import SearchResultDocument
+from .search_result_meta import SearchResultMeta
 
 
 class SearchResult(pydantic_v1.BaseModel):
@@ -25,6 +26,11 @@ class SearchResult(pydantic_v1.BaseModel):
     The document that contains the chunk that matched the search query.
     """
 
+    meta: typing.Optional[SearchResultMeta] = pydantic_v1.Field(default=None)
+    """
+    Additional information about the search result.
+    """
+
     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)

vellum_ai-0.6.6/src/vellum/types/search_result_meta.py

@@ -0,0 +1,26 @@
+# 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 .search_result_meta_source import SearchResultMetaSource
+
+
+class SearchResultMeta(pydantic_v1.BaseModel):
+    source: SearchResultMetaSource
+
+    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_ai-0.6.6/src/vellum/types/search_result_meta_request.py

@@ -0,0 +1,26 @@
+# 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 .search_result_meta_source_request import SearchResultMetaSourceRequest
+
+
+class SearchResultMetaRequest(pydantic_v1.BaseModel):
+    source: SearchResultMetaSourceRequest
+
+    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_ai-0.6.6/src/vellum/types/search_result_meta_source.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+from .pdf_search_result_meta_source import PdfSearchResultMetaSource
+
+
+class SearchResultMetaSource_Pdf(PdfSearchResultMetaSource):
+    document_type: typing.Literal["PDF"] = "PDF"
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+        populate_by_name = True
+
+
+SearchResultMetaSource = typing.Union[SearchResultMetaSource_Pdf]

vellum_ai-0.6.6/src/vellum/types/search_result_meta_source_request.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+from .pdf_search_result_meta_source_request import PdfSearchResultMetaSourceRequest
+
+
+class SearchResultMetaSourceRequest_Pdf(PdfSearchResultMetaSourceRequest):
+    document_type: typing.Literal["PDF"] = "PDF"
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+        populate_by_name = True
+
+
+SearchResultMetaSourceRequest = typing.Union[SearchResultMetaSourceRequest_Pdf]

{vellum_ai-0.6.4 → vellum_ai-0.6.6}/src/vellum/types/search_result_request.py

@@ -6,6 +6,7 @@ import typing
 from ..core.datetime_utils import serialize_datetime
 from ..core.pydantic_utilities import pydantic_v1
 from .search_result_document_request import SearchResultDocumentRequest
+from .search_result_meta_request import SearchResultMetaRequest
 
 
 class SearchResultRequest(pydantic_v1.BaseModel):
@@ -25,6 +26,11 @@ class SearchResultRequest(pydantic_v1.BaseModel):
     The document that contains the chunk that matched the search query.
     """
 
+    meta: typing.Optional[SearchResultMetaRequest] = pydantic_v1.Field(default=None)
+    """
+    Additional information about the search result.
+    """
+
     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)

{vellum_ai-0.6.4 → vellum_ai-0.6.6}/src/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.