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

vellum/client/reference.md

@@ -1457,6 +1457,14 @@ client.integrations.retrieve_integration_tool_definition(
 <dl>
 <dd>
 
+**toolkit_version:** `typing.Optional[str]` — The version of the toolkit to use. Pass 'latest' to get the latest version, or a specific version string to pin it. If not provided, uses the provider's default.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
     
 </dd>
@@ -1509,7 +1517,7 @@ client.integrations.execute_integration_tool(
 <dl>
 <dd>
 
-**integration_name:** `str` — The integration name
+**integration_name_:** `str` — The integration name
     
 </dd>
 </dl>
@@ -1525,7 +1533,7 @@ client.integrations.execute_integration_tool(
 <dl>
 <dd>
 
-**tool_name:** `str` — The tool's unique name, as specified by the integration provider
+**tool_name_:** `str` — The tool's unique name, as specified by the integration provider
     
 </dd>
 </dl>
@@ -1541,6 +1549,46 @@ client.integrations.execute_integration_tool(
 <dl>
 <dd>
 
+**toolkit_version:** `typing.Optional[str]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**integration_name:** `typing.Optional[str]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**integration:** `typing.Optional[str]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**tool_name:** `typing.Optional[str]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**tool:** `typing.Optional[str]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
     
 </dd>
@@ -2230,6 +2278,128 @@ client.container_images.list()
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.container_images.<a href="src/vellum/resources/container_images/client.py">create_container_image</a>(...)</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a new Container Image.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```python
+from vellum import CodeExecutionPackageRequest, Vellum
+
+client = Vellum(
+    api_version="YOUR_API_VERSION",
+    api_key="YOUR_API_KEY",
+)
+client.container_images.create_container_image(
+    name="x",
+    packages=[
+        CodeExecutionPackageRequest(
+            version="x",
+            name="x",
+        ),
+        CodeExecutionPackageRequest(
+            version="x",
+            name="x",
+        ),
+    ],
+    tag="x",
+)
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**name:** `str` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**packages:** `typing.Sequence[CodeExecutionPackageRequest]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**tag:** `str` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**user_script:** `typing.Optional[str]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**is_hotswappable:** `typing.Optional[bool]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**server_version:** `typing.Optional[str]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -2301,6 +2471,128 @@ client.container_images.retrieve(
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.container_images.<a href="src/vellum/resources/container_images/client.py">update_container_image</a>(...)</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Update an existing Container Image.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```python
+from vellum import CodeExecutionPackageRequest, Vellum
+
+client = Vellum(
+    api_version="YOUR_API_VERSION",
+    api_key="YOUR_API_KEY",
+)
+client.container_images.update_container_image(
+    id="id",
+    packages=[
+        CodeExecutionPackageRequest(
+            version="x",
+            name="x",
+        ),
+        CodeExecutionPackageRequest(
+            version="x",
+            name="x",
+        ),
+    ],
+    tag="x",
+)
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `str` — A UUID string identifying this container image.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**packages:** `typing.Sequence[CodeExecutionPackageRequest]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**tag:** `str` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**user_script:** `typing.Optional[str]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**is_hotswappable:** `typing.Optional[bool]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**server_version:** `typing.Optional[str]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -4548,6 +4840,7 @@ client.integration_auth_configs.list_integration_auth_configs()
 
 The response fields to expand for more information.
 - 'integration_credentials' expands the list of integration credentials that the authenticated entity has access to for the auth config.
+- 'additional_parameters' (retrieve only) fetches additional parameter requirements for the auth config.
     
 </dd>
 </dl>
@@ -4693,6 +4986,14 @@ client.integration_providers.retrieve_integration_provider_tool_definition(
 <dl>
 <dd>
 
+**toolkit_version:** `typing.Optional[str]` — The version of the toolkit to use. Pass 'latest' to get the latest version, or a specific version string to pin it. If not provided, uses the provider's default.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
     
 </dd>
@@ -4812,6 +5113,14 @@ client.integration_providers.list_integration_tools(
 <dl>
 <dd>
 
+**toolkit_version:** `typing.Optional[str]` — The version of the toolkit to lookup. Pass 'latest' to get the latest version, or a specific version string to pin it. If not provided, uses the provider's default.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
     
 </dd>
@@ -6264,7 +6573,165 @@ client.test_suites.delete_test_suite_test_case(
 <dl>
 <dd>
 
-**id:** `str` — Either the Test Suites' ID or its unique name
+**id:** `str` — Either the Test Suites' ID or its unique name
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**test_case_id:** `str` — An id identifying the test case that you'd like to delete
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+## UploadedFiles
+<details><summary><code>client.uploaded_files.<a href="src/vellum/resources/uploaded_files/client.py">retrieve</a>(...)</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve a previously uploaded file by its ID
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```python
+from vellum import Vellum
+
+client = Vellum(
+    api_version="YOUR_API_VERSION",
+    api_key="YOUR_API_KEY",
+)
+client.uploaded_files.retrieve(
+    id="id",
+)
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `str` — A UUID string identifying this uploaded file.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**expiry_seconds:** `typing.Optional[int]` — The number of seconds until the signed URL expires. Must be > 0 and <= 2592000 (30 days). Non-numeric or out-of-range values fall back to the default (604800 seconds or 7 days).
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+## WorkflowDeployments
+<details><summary><code>client.workflow_deployments.<a href="src/vellum/resources/workflow_deployments/client.py">list</a>(...)</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Used to list all Workflow Deployments.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```python
+from vellum import Vellum
+
+client = Vellum(
+    api_version="YOUR_API_VERSION",
+    api_key="YOUR_API_KEY",
+)
+client.workflow_deployments.list()
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**limit:** `typing.Optional[int]` — Number of results to return per page.
     
 </dd>
 </dl>
@@ -6272,7 +6739,23 @@ client.test_suites.delete_test_suite_test_case(
 <dl>
 <dd>
 
-**test_case_id:** `str` — An id identifying the test case that you'd like to delete
+**offset:** `typing.Optional[int]` — The initial index from which to return the results.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**ordering:** `typing.Optional[str]` — Which field to use when ordering the results.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**status:** `typing.Optional[WorkflowDeploymentsListRequestStatus]` — status
     
 </dd>
 </dl>
@@ -6292,8 +6775,7 @@ client.test_suites.delete_test_suite_test_case(
 </dl>
 </details>
 
-## UploadedFiles
-<details><summary><code>client.uploaded_files.<a href="src/vellum/resources/uploaded_files/client.py">retrieve</a>(...)</code></summary>
+<details><summary><code>client.workflow_deployments.<a href="src/vellum/resources/workflow_deployments/client.py">retrieve</a>(...)</code></summary>
 <dl>
 <dd>
 
@@ -6305,7 +6787,7 @@ client.test_suites.delete_test_suite_test_case(
 <dl>
 <dd>
 
-Retrieve a previously uploaded file by its ID
+Used to retrieve a workflow deployment given its ID or name.
 </dd>
 </dl>
 </dd>
@@ -6326,7 +6808,7 @@ client = Vellum(
     api_version="YOUR_API_VERSION",
     api_key="YOUR_API_KEY",
 )
-client.uploaded_files.retrieve(
+client.workflow_deployments.retrieve(
     id="id",
 )
 
@@ -6344,15 +6826,7 @@ client.uploaded_files.retrieve(
 <dl>
 <dd>
 
-**id:** `str` — A UUID string identifying this uploaded file.
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**expiry_seconds:** `typing.Optional[int]` — The number of seconds until the signed URL expires. Must be > 0 and <= 2592000 (30 days). Non-numeric or out-of-range values fall back to the default (604800 seconds or 7 days).
+**id:** `str` — Either the Workflow Deployment's ID or its unique name
     
 </dd>
 </dl>
@@ -6372,8 +6846,7 @@ client.uploaded_files.retrieve(
 </dl>
 </details>
 
-## WorkflowDeployments
-<details><summary><code>client.workflow_deployments.<a href="src/vellum/resources/workflow_deployments/client.py">list</a>(...)</code></summary>
+<details><summary><code>client.workflow_deployments.<a href="src/vellum/resources/workflow_deployments/client.py">execute_stream</a>(...)</code></summary>
 <dl>
 <dd>
 
@@ -6385,7 +6858,7 @@ client.uploaded_files.retrieve(
 <dl>
 <dd>
 
-Used to list all Workflow Deployments.
+Executes a deployed Workflow and streams back its results.
 </dd>
 </dl>
 </dd>
@@ -6406,7 +6879,14 @@ client = Vellum(
     api_version="YOUR_API_VERSION",
     api_key="YOUR_API_KEY",
 )
-client.workflow_deployments.list()
+response = client.workflow_deployments.execute_stream(
+    id="my-chat-workflow",
+    trigger="chat",
+    previous_execution_id="550e8400-e29b-41d4-a716-446655440099",
+    inputs={"message": "What is machine learning?"},
+)
+for chunk in response.data:
+    yield chunk
 
 ```
 </dd>
@@ -6422,7 +6902,7 @@ client.workflow_deployments.list()
 <dl>
 <dd>
 
-**limit:** `typing.Optional[int]` — Number of results to return per page.
+**id:** `str` — Either the Workflow Deployment's ID or its unique name
     
 </dd>
 </dl>
@@ -6430,7 +6910,7 @@ client.workflow_deployments.list()
 <dl>
 <dd>
 
-**offset:** `typing.Optional[int]` — The initial index from which to return the results.
+**inputs:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A mapping from input name to value.
     
 </dd>
 </dl>
@@ -6438,7 +6918,7 @@ client.workflow_deployments.list()
 <dl>
 <dd>
 
-**ordering:** `typing.Optional[str]` — Which field to use when ordering the results.
+**trigger:** `typing.Optional[str]` — The name or ID of a workflow trigger to use for this execution. If not specified, then a default manual trigger will be chosen.
     
 </dd>
 </dl>
@@ -6446,7 +6926,7 @@ client.workflow_deployments.list()
 <dl>
 <dd>
 
-**status:** `typing.Optional[WorkflowDeploymentsListRequestStatus]` — status
+**release_tag:** `typing.Optional[str]` — Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
     
 </dd>
 </dl>
@@ -6454,70 +6934,23 @@ client.workflow_deployments.list()
 <dl>
 <dd>
 
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**external_id:** `typing.Optional[str]` — Optionally include a unique identifier for tracking purposes. Must be unique within a given Workspace.
     
 </dd>
 </dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.workflow_deployments.<a href="src/vellum/resources/workflow_deployments/client.py">retrieve</a>(...)</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Used to retrieve a workflow deployment given its ID or name.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
 
 <dl>
 <dd>
 
-<dl>
-<dd>
-
-```python
-from vellum import Vellum
-
-client = Vellum(
-    api_version="YOUR_API_VERSION",
-    api_key="YOUR_API_KEY",
-)
-client.workflow_deployments.retrieve(
-    id="id",
-)
-
-```
-</dd>
-</dl>
+**metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Arbitrary JSON metadata associated with this request. Can be used to capture additional monitoring data such as user id, session id, etc. for future analysis.
+    
 </dd>
 </dl>
 
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
 <dl>
 <dd>
 
-**id:** `str` — Either the Workflow Deployment's ID or its unique name
+**previous_execution_id:** `typing.Optional[str]` — The ID of a previous workflow execution to reference for context.
     
 </dd>
 </dl>
@@ -7554,6 +7987,152 @@ client.workflows.retrieve_state(
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.workflows.<a href="src/vellum/resources/workflows/client.py">execute_node</a>(...)</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```python
+from vellum import Vellum
+
+client = Vellum(
+    api_version="YOUR_API_VERSION",
+    api_key="YOUR_API_KEY",
+)
+client.workflows.execute_node(
+    files={"files": "files"},
+    node="x",
+)
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**files:** `typing.Dict[str, str]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**node:** `str` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**inputs:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.workflows.<a href="src/vellum/resources/workflows/client.py">workflow_execution_status</a>(...)</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Checks if a workflow execution is currently executing (not fulfilled, not rejected, and has no end time).
+Uses the ClickHouse Prime summary materialized view.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```python
+from vellum import Vellum
+
+client = Vellum(
+    api_version="YOUR_API_VERSION",
+    api_key="YOUR_API_KEY",
+)
+client.workflows.workflow_execution_status(
+    execution_id="execution_id",
+)
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**execution_id:** `str` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -7625,6 +8204,28 @@ client.workflows.serialize_workflow_files(
 <dl>
 <dd>
 
+**runner_config:** `typing.Optional[RunnerConfigRequest]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**type_checker:** `typing.Optional[TypeCheckerEnum]` 
+
+Optional type checker to run during serialization. Supported values: mypy, zuban, default.
+
+* `mypy` - Mypy
+* `zuban` - Zuban
+* `default` - Default
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
     
 </dd>