vellum-ai 0.12.14__py3-none-any.whl → 0.12.15__py3-none-any.whl

vellum/__init__.py

@@ -24,6 +24,7 @@ from .types import (
     ArrayVellumValueRequest,
     AudioChatMessageContent,
     AudioChatMessageContentRequest,
+    AudioPromptBlock,
     AudioVariableValue,
     AudioVellumValue,
     AudioVellumValueRequest,
@@ -134,6 +135,7 @@ from .types import (
     FunctionCallChatMessageContentValue,
     FunctionCallChatMessageContentValueRequest,
     FunctionCallInput,
+    FunctionCallPromptBlock,
     FunctionCallRequest,
     FunctionCallVariableValue,
     FunctionCallVellumValue,
@@ -158,6 +160,7 @@ from .types import (
     HkunlpInstructorXlVectorizerRequest,
     ImageChatMessageContent,
     ImageChatMessageContentRequest,
+    ImagePromptBlock,
     ImageVariableValue,
     ImageVellumValue,
     ImageVellumValueRequest,
@@ -548,6 +551,7 @@ __all__ = [
     "AsyncVellum",
     "AudioChatMessageContent",
     "AudioChatMessageContentRequest",
+    "AudioPromptBlock",
     "AudioVariableValue",
     "AudioVellumValue",
     "AudioVellumValueRequest",
@@ -663,6 +667,7 @@ __all__ = [
     "FunctionCallChatMessageContentValue",
     "FunctionCallChatMessageContentValueRequest",
     "FunctionCallInput",
+    "FunctionCallPromptBlock",
     "FunctionCallRequest",
     "FunctionCallVariableValue",
     "FunctionCallVellumValue",
@@ -687,6 +692,7 @@ __all__ = [
     "HkunlpInstructorXlVectorizerRequest",
     "ImageChatMessageContent",
     "ImageChatMessageContentRequest",
+    "ImagePromptBlock",
     "ImageVariableValue",
     "ImageVellumValue",
     "ImageVellumValueRequest",

vellum/client/__init__.py

@@ -154,8 +154,6 @@ class Vellum:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> CodeExecutorResponse:
         """
-        An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
-
         Parameters
         ----------
         code : str
@@ -203,7 +201,7 @@ class Vellum:
         """
         _response = self._client_wrapper.httpx_client.request(
             "v1/execute-code",
-            base_url=self._client_wrapper.get_environment().default,
+            base_url=self._client_wrapper.get_environment().predict,
             method="POST",
             json={
                 "code": code,
@@ -1419,8 +1417,6 @@ class AsyncVellum:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> CodeExecutorResponse:
         """
-        An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
-
         Parameters
         ----------
         code : str
@@ -1476,7 +1472,7 @@ class AsyncVellum:
         """
         _response = await self._client_wrapper.httpx_client.request(
             "v1/execute-code",
-            base_url=self._client_wrapper.get_environment().default,
+            base_url=self._client_wrapper.get_environment().predict,
             method="POST",
             json={
                 "code": code,

vellum/client/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.12.14",
+            "X-Fern-SDK-Version": "0.12.15",
         }
         headers["X_API_KEY"] = self.api_key
         return headers

vellum/client/environment.py

@@ -6,12 +6,12 @@ from __future__ import annotations
 class VellumEnvironment:
     PRODUCTION: VellumEnvironment
 
-    def __init__(self, *, default: str, documents: str, predict: str):
+    def __init__(self, *, default: str, predict: str, documents: str):
         self.default = default
-        self.documents = documents
         self.predict = predict
+        self.documents = documents
 
 
 VellumEnvironment.PRODUCTION = VellumEnvironment(
-    default="https://api.vellum.ai", documents="https://documents.vellum.ai", predict="https://predict.vellum.ai"
+    default="https://api.vellum.ai", predict="https://predict.vellum.ai", documents="https://documents.vellum.ai"
 )

vellum/client/resources/ad_hoc/client.py

@@ -43,8 +43,6 @@ class AdHocClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.Iterator[AdHocExecutePromptEvent]:
         """
-        An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
-
         Parameters
         ----------
         ml_model : str
@@ -111,7 +109,7 @@ class AdHocClient:
         """
         with self._client_wrapper.httpx_client.stream(
             "v1/ad-hoc/execute-prompt-stream",
-            base_url=self._client_wrapper.get_environment().default,
+            base_url=self._client_wrapper.get_environment().predict,
             method="POST",
             json={
                 "ml_model": ml_model,
@@ -211,8 +209,6 @@ class AsyncAdHocClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.AsyncIterator[AdHocExecutePromptEvent]:
         """
-        An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
-
         Parameters
         ----------
         ml_model : str
@@ -287,7 +283,7 @@ class AsyncAdHocClient:
         """
         async with self._client_wrapper.httpx_client.stream(
             "v1/ad-hoc/execute-prompt-stream",
-            base_url=self._client_wrapper.get_environment().default,
+            base_url=self._client_wrapper.get_environment().predict,
             method="POST",
             json={
                 "ml_model": ml_model,

vellum/client/resources/container_images/client.py

@@ -134,8 +134,6 @@ class ContainerImagesClient:
 
     def docker_service_token(self, *, request_options: typing.Optional[RequestOptions] = None) -> DockerServiceToken:
         """
-        An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
-
         Parameters
         ----------
         request_options : typing.Optional[RequestOptions]
@@ -184,8 +182,6 @@ class ContainerImagesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ContainerImageRead:
         """
-        An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
-
         Parameters
         ----------
         name : str
@@ -378,8 +374,6 @@ class AsyncContainerImagesClient:
         self, *, request_options: typing.Optional[RequestOptions] = None
     ) -> DockerServiceToken:
         """
-        An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
-
         Parameters
         ----------
         request_options : typing.Optional[RequestOptions]
@@ -436,8 +430,6 @@ class AsyncContainerImagesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ContainerImageRead:
         """
-        An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
-
         Parameters
         ----------
         name : str

vellum/client/resources/metric_definitions/client.py

@@ -30,8 +30,6 @@ class MetricDefinitionsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> MetricDefinitionExecution:
         """
-        An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
-
         Parameters
         ----------
         id : str
@@ -68,7 +66,7 @@ class MetricDefinitionsClient:
         """
         _response = self._client_wrapper.httpx_client.request(
             f"v1/metric-definitions/{jsonable_encoder(id)}/execute",
-            base_url=self._client_wrapper.get_environment().default,
+            base_url=self._client_wrapper.get_environment().predict,
             method="POST",
             json={
                 "inputs": convert_and_respect_annotation_metadata(
@@ -159,8 +157,6 @@ class AsyncMetricDefinitionsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> MetricDefinitionExecution:
         """
-        An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
-
         Parameters
         ----------
         id : str
@@ -205,7 +201,7 @@ class AsyncMetricDefinitionsClient:
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"v1/metric-definitions/{jsonable_encoder(id)}/execute",
-            base_url=self._client_wrapper.get_environment().default,
+            base_url=self._client_wrapper.get_environment().predict,
             method="POST",
             json={
                 "inputs": convert_and_respect_annotation_metadata(

vellum/client/resources/workflows/client.py

@@ -35,8 +35,6 @@ class WorkflowsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.Iterator[bytes]:
         """
-        An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
-
         Parameters
         ----------
         id : str
@@ -102,11 +100,10 @@ class WorkflowsClient:
         workflow_sandbox_id: typing.Optional[str] = OMIT,
         deployment_config: typing.Optional[WorkflowPushDeploymentConfigRequest] = OMIT,
         artifact: typing.Optional[core.File] = OMIT,
+        dry_run: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> WorkflowPushResponse:
         """
-        An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
-
         Parameters
         ----------
         exec_config : WorkflowPushExecConfig
@@ -121,6 +118,8 @@ class WorkflowsClient:
         artifact : typing.Optional[core.File]
             See core.File for more documentation
 
+        dry_run : typing.Optional[bool]
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -150,6 +149,7 @@ class WorkflowsClient:
                 "label": label,
                 "workflow_sandbox_id": workflow_sandbox_id,
                 "deployment_config": deployment_config,
+                "dry_run": dry_run,
             },
             files={
                 "artifact": artifact,
@@ -188,8 +188,6 @@ class AsyncWorkflowsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.AsyncIterator[bytes]:
         """
-        An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
-
         Parameters
         ----------
         id : str
@@ -255,11 +253,10 @@ class AsyncWorkflowsClient:
         workflow_sandbox_id: typing.Optional[str] = OMIT,
         deployment_config: typing.Optional[WorkflowPushDeploymentConfigRequest] = OMIT,
         artifact: typing.Optional[core.File] = OMIT,
+        dry_run: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> WorkflowPushResponse:
         """
-        An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
-
         Parameters
         ----------
         exec_config : WorkflowPushExecConfig
@@ -274,6 +271,8 @@ class AsyncWorkflowsClient:
         artifact : typing.Optional[core.File]
             See core.File for more documentation
 
+        dry_run : typing.Optional[bool]
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -311,6 +310,7 @@ class AsyncWorkflowsClient:
                 "label": label,
                 "workflow_sandbox_id": workflow_sandbox_id,
                 "deployment_config": deployment_config,
+                "dry_run": dry_run,
             },
             files={
                 "artifact": artifact,

vellum/client/types/__init__.py

@@ -20,6 +20,7 @@ from .array_vellum_value import ArrayVellumValue
 from .array_vellum_value_request import ArrayVellumValueRequest
 from .audio_chat_message_content import AudioChatMessageContent
 from .audio_chat_message_content_request import AudioChatMessageContentRequest
+from .audio_prompt_block import AudioPromptBlock
 from .audio_variable_value import AudioVariableValue
 from .audio_vellum_value import AudioVellumValue
 from .audio_vellum_value_request import AudioVellumValueRequest
@@ -138,6 +139,7 @@ from .function_call_chat_message_content_request import FunctionCallChatMessageC
 from .function_call_chat_message_content_value import FunctionCallChatMessageContentValue
 from .function_call_chat_message_content_value_request import FunctionCallChatMessageContentValueRequest
 from .function_call_input import FunctionCallInput
+from .function_call_prompt_block import FunctionCallPromptBlock
 from .function_call_request import FunctionCallRequest
 from .function_call_variable_value import FunctionCallVariableValue
 from .function_call_vellum_value import FunctionCallVellumValue
@@ -166,6 +168,7 @@ from .hkunlp_instructor_xl_vectorizer import HkunlpInstructorXlVectorizer
 from .hkunlp_instructor_xl_vectorizer_request import HkunlpInstructorXlVectorizerRequest
 from .image_chat_message_content import ImageChatMessageContent
 from .image_chat_message_content_request import ImageChatMessageContentRequest
+from .image_prompt_block import ImagePromptBlock
 from .image_variable_value import ImageVariableValue
 from .image_vellum_value import ImageVellumValue
 from .image_vellum_value_request import ImageVellumValueRequest
@@ -542,6 +545,7 @@ __all__ = [
     "ArrayVellumValueRequest",
     "AudioChatMessageContent",
     "AudioChatMessageContentRequest",
+    "AudioPromptBlock",
     "AudioVariableValue",
     "AudioVellumValue",
     "AudioVellumValueRequest",
@@ -652,6 +656,7 @@ __all__ = [
     "FunctionCallChatMessageContentValue",
     "FunctionCallChatMessageContentValueRequest",
     "FunctionCallInput",
+    "FunctionCallPromptBlock",
     "FunctionCallRequest",
     "FunctionCallVariableValue",
     "FunctionCallVellumValue",
@@ -676,6 +681,7 @@ __all__ = [
     "HkunlpInstructorXlVectorizerRequest",
     "ImageChatMessageContent",
     "ImageChatMessageContentRequest",
+    "ImagePromptBlock",
     "ImageVariableValue",
     "ImageVellumValue",
     "ImageVellumValueRequest",

vellum/client/types/audio_prompt_block.py

@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .prompt_block_state import PromptBlockState
+from .ephemeral_prompt_cache_config import EphemeralPromptCacheConfig
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class AudioPromptBlock(UniversalBaseModel):
+    """
+    A block that represents an audio file in a prompt template.
+    """
+
+    block_type: typing.Literal["AUDIO"] = "AUDIO"
+    state: typing.Optional[PromptBlockState] = None
+    cache_config: typing.Optional[EphemeralPromptCacheConfig] = None
+    src: str
+    metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vellum/client/types/function_call_prompt_block.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .prompt_block_state import PromptBlockState
+from .ephemeral_prompt_cache_config import EphemeralPromptCacheConfig
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class FunctionCallPromptBlock(UniversalBaseModel):
+    """
+    A block that represents a function call in a prompt template.
+    """
+
+    block_type: typing.Literal["FUNCTION_CALL"] = "FUNCTION_CALL"
+    state: typing.Optional[PromptBlockState] = None
+    cache_config: typing.Optional[EphemeralPromptCacheConfig] = None
+    id: typing.Optional[str] = None
+    name: str
+    arguments: typing.Dict[str, typing.Optional[typing.Any]]
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vellum/client/types/image_prompt_block.py

@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .prompt_block_state import PromptBlockState
+from .ephemeral_prompt_cache_config import EphemeralPromptCacheConfig
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class ImagePromptBlock(UniversalBaseModel):
+    """
+    A block that represents an image in a prompt template.
+    """
+
+    block_type: typing.Literal["IMAGE"] = "IMAGE"
+    state: typing.Optional[PromptBlockState] = None
+    cache_config: typing.Optional[EphemeralPromptCacheConfig] = None
+    src: str
+    metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vellum/client/types/prompt_block.py

@@ -5,8 +5,19 @@ import typing
 from .jinja_prompt_block import JinjaPromptBlock
 from .variable_prompt_block import VariablePromptBlock
 from .rich_text_prompt_block import RichTextPromptBlock
+from .audio_prompt_block import AudioPromptBlock
+from .function_call_prompt_block import FunctionCallPromptBlock
+from .image_prompt_block import ImagePromptBlock
 import typing
 
 if typing.TYPE_CHECKING:
     from .chat_message_prompt_block import ChatMessagePromptBlock
-PromptBlock = typing.Union[JinjaPromptBlock, "ChatMessagePromptBlock", VariablePromptBlock, RichTextPromptBlock]
+PromptBlock = typing.Union[
+    JinjaPromptBlock,
+    "ChatMessagePromptBlock",
+    VariablePromptBlock,
+    RichTextPromptBlock,
+    AudioPromptBlock,
+    FunctionCallPromptBlock,
+    ImagePromptBlock,
+]

vellum/client/types/workflow_push_response.py

@@ -9,6 +9,7 @@ import pydantic
 class WorkflowPushResponse(UniversalBaseModel):
     workflow_sandbox_id: str
     workflow_deployment_id: typing.Optional[str] = None
+    proposed_diffs: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

vellum/types/audio_prompt_block.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.audio_prompt_block import *

vellum/types/function_call_prompt_block.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.function_call_prompt_block import *

vellum/types/image_prompt_block.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.image_prompt_block import *

{vellum_ai-0.12.14.dist-info → vellum_ai-0.12.15.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vellum-ai
-Version: 0.12.14
+Version: 0.12.15
 Summary: 
 License: MIT
 Requires-Python: >=3.9,<4.0
@@ -95,7 +95,7 @@ more below](#workflows-sdk).
 
 ## Client SDK
 
-The Vellum Client SDK, found within `src/client` is a low-level client used to interact directly with the Vellum API.
+The Vellum Client SDK, found within `src/vellum/client` is a low-level client used to interact directly with the Vellum API.
 Learn more and get started by visiting the [Vellum Client SDK README](/src/vellum/client/README.md).
 
 ## Workflows SDK