vellum-ai 0.3.11__tar.gz → 0.3.12__tar.gz

{vellum_ai-0.3.11 → vellum_ai-0.3.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vellum-ai
-Version: 0.3.11
+Version: 0.3.12
 Summary: 
 Requires-Python: >=3.7,<4.0
 Classifier: Programming Language :: Python :: 3

{vellum_ai-0.3.11 → vellum_ai-0.3.12}/pyproject.toml

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

{vellum_ai-0.3.11 → vellum_ai-0.3.12}/src/vellum/__init__.py

@@ -18,6 +18,7 @@ from .types import (
     ArrayVariableValueItem_ChatHistory,
     ArrayVariableValueItem_Error,
     ArrayVariableValueItem_FunctionCall,
+    ArrayVariableValueItem_Image,
     ArrayVariableValueItem_Json,
     ArrayVariableValueItem_Number,
     ArrayVariableValueItem_SearchResults,
@@ -129,6 +130,7 @@ from .types import (
     ImageChatMessageContent,
     ImageChatMessageContentRequest,
     ImageEnum,
+    ImageVariableValue,
     IndexingStateEnum,
     InitiatedEnum,
     InitiatedExecutePromptEvent,
@@ -445,6 +447,7 @@ __all__ = [
     "ArrayVariableValueItem_ChatHistory",
     "ArrayVariableValueItem_Error",
     "ArrayVariableValueItem_FunctionCall",
+    "ArrayVariableValueItem_Image",
     "ArrayVariableValueItem_Json",
     "ArrayVariableValueItem_Number",
     "ArrayVariableValueItem_SearchResults",
@@ -561,6 +564,7 @@ __all__ = [
     "ImageChatMessageContent",
     "ImageChatMessageContentRequest",
     "ImageEnum",
+    "ImageVariableValue",
     "IndexingStateEnum",
     "InitiatedEnum",
     "InitiatedExecutePromptEvent",

{vellum_ai-0.3.11 → vellum_ai-0.3.12}/src/vellum/core/client_wrapper.py

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

{vellum_ai-0.3.11 → vellum_ai-0.3.12}/src/vellum/resources/document_indexes/client.py

@@ -187,6 +187,147 @@ class DocumentIndexesClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    def update(
+        self,
+        id: str,
+        *,
+        label: str,
+        status: typing.Optional[EntityStatus] = OMIT,
+        environment: typing.Optional[EnvironmentEnum] = OMIT,
+    ) -> DocumentIndexRead:
+        """
+        Used to fully update a Document Index given its ID.
+
+        Parameters:
+            - id: str. A UUID string identifying this document index.
+
+            - label: str. A human-readable label for the document index
+
+            - status: typing.Optional[EntityStatus]. The current status of the document index
+
+                                                     * `ACTIVE` - Active
+                                                     * `ARCHIVED` - Archived
+            - environment: typing.Optional[EnvironmentEnum]. The environment this document index is used in
+
+                                                             * `DEVELOPMENT` - Development
+                                                             * `STAGING` - Staging
+                                                             * `PRODUCTION` - Production---
+        from vellum.client import Vellum
+
+        client = Vellum(
+            api_key="YOUR_API_KEY",
+        )
+        client.document_indexes.update(
+            id="id",
+            label="label",
+        )
+        """
+        _request: typing.Dict[str, typing.Any] = {"label": label}
+        if status is not OMIT:
+            _request["status"] = status
+        if environment is not OMIT:
+            _request["environment"] = environment
+        _response = self._client_wrapper.httpx_client.request(
+            "PUT",
+            urllib.parse.urljoin(f"{self._client_wrapper.get_environment().default}/", f"v1/document-indexes/{id}"),
+            json=jsonable_encoder(_request),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic.parse_obj_as(DocumentIndexRead, _response.json())  # type: ignore
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    def destroy(self, id: str) -> None:
+        """
+        Used to delete a Document Index given its ID.
+
+        Parameters:
+            - id: str. A UUID string identifying this document index.
+        ---
+        from vellum.client import Vellum
+
+        client = Vellum(
+            api_key="YOUR_API_KEY",
+        )
+        client.document_indexes.destroy(
+            id="id",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "DELETE",
+            urllib.parse.urljoin(f"{self._client_wrapper.get_environment().default}/", f"v1/document-indexes/{id}"),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
+        if 200 <= _response.status_code < 300:
+            return
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    def partial_update(
+        self,
+        id: str,
+        *,
+        label: typing.Optional[str] = OMIT,
+        status: typing.Optional[EntityStatus] = OMIT,
+        environment: typing.Optional[EnvironmentEnum] = OMIT,
+    ) -> DocumentIndexRead:
+        """
+        Used to partial update a Document Index given its ID.
+
+        Parameters:
+            - id: str. A UUID string identifying this document index.
+
+            - label: typing.Optional[str]. A human-readable label for the document index
+
+            - status: typing.Optional[EntityStatus]. The current status of the document index
+
+                                                     * `ACTIVE` - Active
+                                                     * `ARCHIVED` - Archived
+            - environment: typing.Optional[EnvironmentEnum]. The environment this document index is used in
+
+                                                             * `DEVELOPMENT` - Development
+                                                             * `STAGING` - Staging
+                                                             * `PRODUCTION` - Production---
+        from vellum.client import Vellum
+
+        client = Vellum(
+            api_key="YOUR_API_KEY",
+        )
+        client.document_indexes.partial_update(
+            id="id",
+        )
+        """
+        _request: typing.Dict[str, typing.Any] = {}
+        if label is not OMIT:
+            _request["label"] = label
+        if status is not OMIT:
+            _request["status"] = status
+        if environment is not OMIT:
+            _request["environment"] = environment
+        _response = self._client_wrapper.httpx_client.request(
+            "PATCH",
+            urllib.parse.urljoin(f"{self._client_wrapper.get_environment().default}/", f"v1/document-indexes/{id}"),
+            json=jsonable_encoder(_request),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic.parse_obj_as(DocumentIndexRead, _response.json())  # type: ignore
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
 
 class AsyncDocumentIndexesClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -351,3 +492,144 @@ class AsyncDocumentIndexesClient:
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def update(
+        self,
+        id: str,
+        *,
+        label: str,
+        status: typing.Optional[EntityStatus] = OMIT,
+        environment: typing.Optional[EnvironmentEnum] = OMIT,
+    ) -> DocumentIndexRead:
+        """
+        Used to fully update a Document Index given its ID.
+
+        Parameters:
+            - id: str. A UUID string identifying this document index.
+
+            - label: str. A human-readable label for the document index
+
+            - status: typing.Optional[EntityStatus]. The current status of the document index
+
+                                                     * `ACTIVE` - Active
+                                                     * `ARCHIVED` - Archived
+            - environment: typing.Optional[EnvironmentEnum]. The environment this document index is used in
+
+                                                             * `DEVELOPMENT` - Development
+                                                             * `STAGING` - Staging
+                                                             * `PRODUCTION` - Production---
+        from vellum.client import AsyncVellum
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+        await client.document_indexes.update(
+            id="id",
+            label="label",
+        )
+        """
+        _request: typing.Dict[str, typing.Any] = {"label": label}
+        if status is not OMIT:
+            _request["status"] = status
+        if environment is not OMIT:
+            _request["environment"] = environment
+        _response = await self._client_wrapper.httpx_client.request(
+            "PUT",
+            urllib.parse.urljoin(f"{self._client_wrapper.get_environment().default}/", f"v1/document-indexes/{id}"),
+            json=jsonable_encoder(_request),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic.parse_obj_as(DocumentIndexRead, _response.json())  # type: ignore
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def destroy(self, id: str) -> None:
+        """
+        Used to delete a Document Index given its ID.
+
+        Parameters:
+            - id: str. A UUID string identifying this document index.
+        ---
+        from vellum.client import AsyncVellum
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+        await client.document_indexes.destroy(
+            id="id",
+        )
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "DELETE",
+            urllib.parse.urljoin(f"{self._client_wrapper.get_environment().default}/", f"v1/document-indexes/{id}"),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
+        if 200 <= _response.status_code < 300:
+            return
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def partial_update(
+        self,
+        id: str,
+        *,
+        label: typing.Optional[str] = OMIT,
+        status: typing.Optional[EntityStatus] = OMIT,
+        environment: typing.Optional[EnvironmentEnum] = OMIT,
+    ) -> DocumentIndexRead:
+        """
+        Used to partial update a Document Index given its ID.
+
+        Parameters:
+            - id: str. A UUID string identifying this document index.
+
+            - label: typing.Optional[str]. A human-readable label for the document index
+
+            - status: typing.Optional[EntityStatus]. The current status of the document index
+
+                                                     * `ACTIVE` - Active
+                                                     * `ARCHIVED` - Archived
+            - environment: typing.Optional[EnvironmentEnum]. The environment this document index is used in
+
+                                                             * `DEVELOPMENT` - Development
+                                                             * `STAGING` - Staging
+                                                             * `PRODUCTION` - Production---
+        from vellum.client import AsyncVellum
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+        await client.document_indexes.partial_update(
+            id="id",
+        )
+        """
+        _request: typing.Dict[str, typing.Any] = {}
+        if label is not OMIT:
+            _request["label"] = label
+        if status is not OMIT:
+            _request["status"] = status
+        if environment is not OMIT:
+            _request["environment"] = environment
+        _response = await self._client_wrapper.httpx_client.request(
+            "PATCH",
+            urllib.parse.urljoin(f"{self._client_wrapper.get_environment().default}/", f"v1/document-indexes/{id}"),
+            json=jsonable_encoder(_request),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic.parse_obj_as(DocumentIndexRead, _response.json())  # type: ignore
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)

{vellum_ai-0.3.11 → vellum_ai-0.3.12}/src/vellum/types/__init__.py

@@ -22,6 +22,7 @@ from .array_variable_value_item import (
     ArrayVariableValueItem_ChatHistory,
     ArrayVariableValueItem_Error,
     ArrayVariableValueItem_FunctionCall,
+    ArrayVariableValueItem_Image,
     ArrayVariableValueItem_Json,
     ArrayVariableValueItem_Number,
     ArrayVariableValueItem_SearchResults,
@@ -146,6 +147,7 @@ from .generate_stream_result_data import GenerateStreamResultData
 from .image_chat_message_content import ImageChatMessageContent
 from .image_chat_message_content_request import ImageChatMessageContentRequest
 from .image_enum import ImageEnum
+from .image_variable_value import ImageVariableValue
 from .indexing_state_enum import IndexingStateEnum
 from .initiated_enum import InitiatedEnum
 from .initiated_execute_prompt_event import InitiatedExecutePromptEvent
@@ -471,6 +473,7 @@ __all__ = [
     "ArrayVariableValueItem_ChatHistory",
     "ArrayVariableValueItem_Error",
     "ArrayVariableValueItem_FunctionCall",
+    "ArrayVariableValueItem_Image",
     "ArrayVariableValueItem_Json",
     "ArrayVariableValueItem_Number",
     "ArrayVariableValueItem_SearchResults",
@@ -582,6 +585,7 @@ __all__ = [
     "ImageChatMessageContent",
     "ImageChatMessageContentRequest",
     "ImageEnum",
+    "ImageVariableValue",
     "IndexingStateEnum",
     "InitiatedEnum",
     "InitiatedExecutePromptEvent",

{vellum_ai-0.3.11 → vellum_ai-0.3.12}/src/vellum/types/array_variable_value_item.py

@@ -9,6 +9,7 @@ import typing_extensions
 from .chat_history_variable_value import ChatHistoryVariableValue
 from .error_variable_value import ErrorVariableValue
 from .function_call_variable_value import FunctionCallVariableValue
+from .image_variable_value import ImageVariableValue
 from .json_variable_value import JsonVariableValue
 from .number_variable_value import NumberVariableValue
 from .search_results_variable_value import SearchResultsVariableValue
@@ -78,6 +79,15 @@ class ArrayVariableValueItem_FunctionCall(FunctionCallVariableValue):
         allow_population_by_field_name = True
 
 
+class ArrayVariableValueItem_Image(ImageVariableValue):
+    type: typing_extensions.Literal["IMAGE"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
 ArrayVariableValueItem = typing.Union[
     ArrayVariableValueItem_String,
     ArrayVariableValueItem_Number,
@@ -86,4 +96,5 @@ ArrayVariableValueItem = typing.Union[
     ArrayVariableValueItem_SearchResults,
     ArrayVariableValueItem_Error,
     ArrayVariableValueItem_FunctionCall,
+    ArrayVariableValueItem_Image,
 ]

{vellum_ai-0.3.11 → vellum_ai-0.3.12}/src/vellum/types/fulfilled_workflow_node_result_event.py

@@ -23,7 +23,9 @@ class FulfilledWorkflowNodeResultEvent(pydantic.BaseModel):
     node_result_id: str
     ts: typing.Optional[dt.datetime]
     data: typing.Optional[WorkflowNodeResultData]
+    source_execution_id: typing.Optional[str]
     output_values: typing.Optional[typing.List[NodeOutputCompiledValue]]
+    mocked: typing.Optional[bool]
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

{vellum_ai-0.3.11 → vellum_ai-0.3.12}/src/vellum/types/generate_request.py

@@ -17,7 +17,7 @@ class GenerateRequest(pydantic.BaseModel):
         description="Key/value pairs for each template variable defined in the deployment's prompt."
     )
     chat_history: typing.Optional[typing.List[ChatMessageRequest]] = pydantic.Field(
-        description="Optionally provide a list of chat messages that'll be used in place of the special {$chat_history} variable, if included in the prompt."
+        description="Optionally provide a list of chat messages that'll be used in place of the special chat_history variable, if included in the prompt."
     )
     external_ids: typing.Optional[typing.List[str]] = pydantic.Field(
         description="Optionally include a unique identifier for each generation, as represented outside of Vellum. Note that this should generally be a list of length one."

vellum_ai-0.3.12/src/vellum/types/image_variable_value.py

@@ -0,0 +1,33 @@
+# 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 .vellum_image import VellumImage
+
+try:
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class ImageVariableValue(pydantic.BaseModel):
+    """
+    A base Vellum primitive value representing an image.
+    """
+
+    value: typing.Optional[VellumImage]
+
+    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
+        json_encoders = {dt.datetime: serialize_datetime}

{vellum_ai-0.3.11 → vellum_ai-0.3.12}/src/vellum/types/initiated_workflow_node_result_event.py

@@ -23,6 +23,7 @@ class InitiatedWorkflowNodeResultEvent(pydantic.BaseModel):
     node_result_id: str
     ts: typing.Optional[dt.datetime]
     data: typing.Optional[WorkflowNodeResultData]
+    source_execution_id: typing.Optional[str]
     input_values: typing.Optional[typing.List[NodeInputVariableCompiledValue]]
 
     def json(self, **kwargs: typing.Any) -> str:

{vellum_ai-0.3.11 → vellum_ai-0.3.12}/src/vellum/types/rejected_workflow_node_result_event.py

@@ -23,6 +23,7 @@ class RejectedWorkflowNodeResultEvent(pydantic.BaseModel):
     node_result_id: str
     ts: typing.Optional[dt.datetime]
     data: typing.Optional[WorkflowNodeResultData]
+    source_execution_id: typing.Optional[str]
     error: WorkflowEventError
 
     def json(self, **kwargs: typing.Any) -> str:

{vellum_ai-0.3.11 → vellum_ai-0.3.12}/src/vellum/types/streaming_workflow_node_result_event.py

@@ -23,6 +23,7 @@ class StreamingWorkflowNodeResultEvent(pydantic.BaseModel):
     node_result_id: str
     ts: typing.Optional[dt.datetime]
     data: typing.Optional[WorkflowNodeResultData]
+    source_execution_id: typing.Optional[str]
     output: typing.Optional[NodeOutputCompiledValue]
     output_index: typing.Optional[int]
 

{vellum_ai-0.3.11 → vellum_ai-0.3.12}/src/vellum/types/workflow_execution_event_error_code.py

@@ -9,6 +9,7 @@ T_Result = typing.TypeVar("T_Result")
 class WorkflowExecutionEventErrorCode(str, enum.Enum):
     """
     - `WORKFLOW_INITIALIZATION` - WORKFLOW_INITIALIZATION
+    - `WORKFLOW_CANCELLED` - WORKFLOW_CANCELLED
     - `NODE_EXECUTION_COUNT_LIMIT_REACHED` - NODE_EXECUTION_COUNT_LIMIT_REACHED
     - `INTERNAL_SERVER_ERROR` - INTERNAL_SERVER_ERROR
     - `NODE_EXECUTION` - NODE_EXECUTION
@@ -18,6 +19,7 @@ class WorkflowExecutionEventErrorCode(str, enum.Enum):
     """
 
     WORKFLOW_INITIALIZATION = "WORKFLOW_INITIALIZATION"
+    WORKFLOW_CANCELLED = "WORKFLOW_CANCELLED"
     NODE_EXECUTION_COUNT_LIMIT_REACHED = "NODE_EXECUTION_COUNT_LIMIT_REACHED"
     INTERNAL_SERVER_ERROR = "INTERNAL_SERVER_ERROR"
     NODE_EXECUTION = "NODE_EXECUTION"
@@ -28,6 +30,7 @@ class WorkflowExecutionEventErrorCode(str, enum.Enum):
     def visit(
         self,
         workflow_initialization: typing.Callable[[], T_Result],
+        workflow_cancelled: typing.Callable[[], T_Result],
         node_execution_count_limit_reached: typing.Callable[[], T_Result],
         internal_server_error: typing.Callable[[], T_Result],
         node_execution: typing.Callable[[], T_Result],
@@ -37,6 +40,8 @@ class WorkflowExecutionEventErrorCode(str, enum.Enum):
     ) -> T_Result:
         if self is WorkflowExecutionEventErrorCode.WORKFLOW_INITIALIZATION:
             return workflow_initialization()
+        if self is WorkflowExecutionEventErrorCode.WORKFLOW_CANCELLED:
+            return workflow_cancelled()
         if self is WorkflowExecutionEventErrorCode.NODE_EXECUTION_COUNT_LIMIT_REACHED:
             return node_execution_count_limit_reached()
         if self is WorkflowExecutionEventErrorCode.INTERNAL_SERVER_ERROR: