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

vellum_ai-0.6.5/PKG-INFO

@@ -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!
+

vellum_ai-0.6.5/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.5}/pyproject.toml

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

{vellum_ai-0.6.4 → vellum_ai-0.6.5}/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.5",
         }
         headers["X_API_KEY"] = self.api_key
         return headers

{vellum_ai-0.6.4 → vellum_ai-0.6.5}/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.4 → vellum_ai-0.6.5}/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.

vellum_ai-0.6.4/PKG-INFO

@@ -1,109 +0,0 @@
-Metadata-Version: 2.1
-Name: vellum-ai
-Version: 0.6.4
-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)
-[![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 Library 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).
-
-## Installation
-
-```sh
-pip install --upgrade vellum-ai
-```
-
-## Usage
-
-```python
-import vellum
-from vellum.client import Vellum
-
-
-client = Vellum(api_key="YOUR_API_KEY")
-
-result = client.generate(
-    deployment_name="my-deployment",
-    requests=[
-        vellum.GenerateRequest(
-            input_values={"question": "Can I get a refund?"})]
-    )
-
-print(result.text)
-```
-
-## Async Client
-
-```python
-import vellum
-from vellum.client import AsyncVellum
-
-raven = AsyncVellum(api_key="YOUR_API_KEY")
-
-async def generate() -> str:
-  result = client.generate(
-    deployment_name="my-deployment",
-    requests=[
-        vellum.GenerateRequest(
-            input_values={"question": "Can I get a refund?"})]
-    )
-  
-  return result.text
-```
-
-## Uploading documents
-
-Documents can be uploaded to Vellum via either the UI or this API. Once uploaded and indexed, Vellum's Search allows you to perform semantic searches against them.
-
-```python
-from vellum.client import Vellum
-
-client = Vellum(api_key="YOUR_API_KEY")
-
-with open("/path/to/your/file.txt", "rb") as file:
-    result = client.documents.upload(
-        # File to upload
-        contents=file,
-        # Document label
-        label="Human-friendly label for your document",
-        # The names of indexes that you'd like this document to be added to.
-        add_to_index_names=["<your-index-name>"],
-        # Optionally include a unique ID from your system to this document later.
-        #   Useful if you want to perform updates later
-        external_id="<your-index-name>",
-        # Optionally include keywords to associate with the document that can be used in hybrid search
-        keywords=[],
-    )
-
-print(result)
-```
-
-## Beta status
-
-This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your pyproject.toml file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
-
-## Contributing
-
-While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, 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!
-
-On the other hand, contributions to the README are always very welcome!
-

vellum_ai-0.6.4/README.md

@@ -1,91 +0,0 @@
-# Vellum Python Library
-
-[![pypi](https://img.shields.io/pypi/v/vellum-ai.svg)](https://pypi.python.org/pypi/vellum-ai)
-[![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 Library 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).
-
-## Installation
-
-```sh
-pip install --upgrade vellum-ai
-```
-
-## Usage
-
-```python
-import vellum
-from vellum.client import Vellum
-
-
-client = Vellum(api_key="YOUR_API_KEY")
-
-result = client.generate(
-    deployment_name="my-deployment",
-    requests=[
-        vellum.GenerateRequest(
-            input_values={"question": "Can I get a refund?"})]
-    )
-
-print(result.text)
-```
-
-## Async Client
-
-```python
-import vellum
-from vellum.client import AsyncVellum
-
-raven = AsyncVellum(api_key="YOUR_API_KEY")
-
-async def generate() -> str:
-  result = client.generate(
-    deployment_name="my-deployment",
-    requests=[
-        vellum.GenerateRequest(
-            input_values={"question": "Can I get a refund?"})]
-    )
-  
-  return result.text
-```
-
-## Uploading documents
-
-Documents can be uploaded to Vellum via either the UI or this API. Once uploaded and indexed, Vellum's Search allows you to perform semantic searches against them.
-
-```python
-from vellum.client import Vellum
-
-client = Vellum(api_key="YOUR_API_KEY")
-
-with open("/path/to/your/file.txt", "rb") as file:
-    result = client.documents.upload(
-        # File to upload
-        contents=file,
-        # Document label
-        label="Human-friendly label for your document",
-        # The names of indexes that you'd like this document to be added to.
-        add_to_index_names=["<your-index-name>"],
-        # Optionally include a unique ID from your system to this document later.
-        #   Useful if you want to perform updates later
-        external_id="<your-index-name>",
-        # Optionally include keywords to associate with the document that can be used in hybrid search
-        keywords=[],
-    )
-
-print(result)
-```
-
-## Beta status
-
-This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your pyproject.toml file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
-
-## Contributing
-
-While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, 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!
-
-On the other hand, contributions to the README are always very welcome!