vellum-ai 0.0.29__tar.gz → 0.0.31__tar.gz

{vellum_ai-0.0.29 → vellum_ai-0.0.31}/PKG-INFO

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

{vellum_ai-0.0.29 → vellum_ai-0.0.31}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "vellum-ai"
-version = "v0.0.29"
+version = "v0.0.31"
 description = ""
 readme = "README.md"
 authors = []
@@ -10,8 +10,8 @@ packages = [
 
 [tool.poetry.dependencies]
 python = "^3.7"
-pydantic = "^1.9.2"
 httpx = "0.23.3"
+pydantic = "^1.9.2"
 
 [tool.poetry.dev-dependencies]
 mypy = "0.971"

{vellum_ai-0.0.29 → vellum_ai-0.0.31}/src/vellum/__init__.py

@@ -11,11 +11,13 @@ from .types import (
     DeploymentNodeResult,
     DeploymentNodeResultData,
     DeploymentRead,
-    DeploymentReadStatusEnum,
+    DeploymentStatus,
     Document,
     DocumentDocumentToDocumentIndex,
     DocumentIndexRead,
     DocumentIndexStatus,
+    DocumentRead,
+    DocumentStatus,
     EnrichedNormalizedCompletion,
     EnvironmentEnum,
     EvaluationParams,
@@ -90,7 +92,6 @@ from .types import (
     SearchResultMergingRequest,
     SearchWeightsRequest,
     SlimDocument,
-    SlimDocumentStatusEnum,
     SubmitCompletionActualRequest,
     SubmitCompletionActualsErrorResponse,
     TerminalNodeChatHistoryResult,
@@ -163,11 +164,13 @@ __all__ = [
     "DeploymentNodeResult",
     "DeploymentNodeResultData",
     "DeploymentRead",
-    "DeploymentReadStatusEnum",
+    "DeploymentStatus",
     "Document",
     "DocumentDocumentToDocumentIndex",
     "DocumentIndexRead",
     "DocumentIndexStatus",
+    "DocumentRead",
+    "DocumentStatus",
     "EnrichedNormalizedCompletion",
     "EnvironmentEnum",
     "EvaluationParams",
@@ -245,7 +248,6 @@ __all__ = [
     "SearchResultMergingRequest",
     "SearchWeightsRequest",
     "SlimDocument",
-    "SlimDocumentStatusEnum",
     "SubmitCompletionActualRequest",
     "SubmitCompletionActualsErrorResponse",
     "TerminalNodeChatHistoryResult",

{vellum_ai-0.0.29 → vellum_ai-0.0.31}/src/vellum/client.py

@@ -109,12 +109,14 @@ class Vellum:
                         continue
                     yield pydantic.parse_obj_as(WorkflowStreamEvent, json.loads(_text))  # type: ignore
                 return
+            _response.read()
+            if _response.status_code == 400:
+                raise BadRequestError(pydantic.parse_obj_as(typing.Any, _response.json()))  # type: ignore
             if _response.status_code == 404:
                 raise NotFoundError(pydantic.parse_obj_as(typing.Any, _response.json()))  # type: ignore
             if _response.status_code == 500:
                 raise InternalServerError(pydantic.parse_obj_as(typing.Any, _response.json()))  # type: ignore
             try:
-                _response.read()
                 _response_json = _response.json()
             except JSONDecodeError:
                 raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -218,6 +220,7 @@ class Vellum:
                         continue
                     yield pydantic.parse_obj_as(GenerateStreamResponse, json.loads(_text))  # type: ignore
                 return
+            _response.read()
             if _response.status_code == 400:
                 raise BadRequestError(pydantic.parse_obj_as(typing.Any, _response.json()))  # type: ignore
             if _response.status_code == 403:
@@ -227,7 +230,6 @@ class Vellum:
             if _response.status_code == 500:
                 raise InternalServerError(pydantic.parse_obj_as(typing.Any, _response.json()))  # type: ignore
             try:
-                _response.read()
                 _response_json = _response.json()
             except JSONDecodeError:
                 raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -405,12 +407,14 @@ class AsyncVellum:
                         continue
                     yield pydantic.parse_obj_as(WorkflowStreamEvent, json.loads(_text))  # type: ignore
                 return
+            await _response.aread()
+            if _response.status_code == 400:
+                raise BadRequestError(pydantic.parse_obj_as(typing.Any, _response.json()))  # type: ignore
             if _response.status_code == 404:
                 raise NotFoundError(pydantic.parse_obj_as(typing.Any, _response.json()))  # type: ignore
             if _response.status_code == 500:
                 raise InternalServerError(pydantic.parse_obj_as(typing.Any, _response.json()))  # type: ignore
             try:
-                await _response.aread()
                 _response_json = _response.json()
             except JSONDecodeError:
                 raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -514,6 +518,7 @@ class AsyncVellum:
                         continue
                     yield pydantic.parse_obj_as(GenerateStreamResponse, json.loads(_text))  # type: ignore
                 return
+            await _response.aread()
             if _response.status_code == 400:
                 raise BadRequestError(pydantic.parse_obj_as(typing.Any, _response.json()))  # type: ignore
             if _response.status_code == 403:
@@ -523,7 +528,6 @@ class AsyncVellum:
             if _response.status_code == 500:
                 raise InternalServerError(pydantic.parse_obj_as(typing.Any, _response.json()))  # type: ignore
             try:
-                await _response.aread()
                 _response_json = _response.json()
             except JSONDecodeError:
                 raise ApiError(status_code=_response.status_code, body=_response.text)

{vellum_ai-0.0.29 → vellum_ai-0.0.31}/src/vellum/core/client_wrapper.py

@@ -10,7 +10,11 @@ class BaseClientWrapper:
         self.api_key = api_key
 
     def get_headers(self) -> typing.Dict[str, str]:
-        headers: typing.Dict[str, str] = {}
+        headers: typing.Dict[str, str] = {
+            "X-Fern-Language": "Python",
+            "X-Fern-SDK-Name": "vellum-ai",
+            "X-Fern-SDK-Version": "v0.0.31",
+        }
         headers["X_API_KEY"] = self.api_key
         return headers
 

{vellum_ai-0.0.29 → vellum_ai-0.0.31}/src/vellum/resources/documents/client.py

@@ -14,6 +14,8 @@ from ...environment import VellumEnvironment
 from ...errors.bad_request_error import BadRequestError
 from ...errors.internal_server_error import InternalServerError
 from ...errors.not_found_error import NotFoundError
+from ...types.document_read import DocumentRead
+from ...types.document_status import DocumentStatus
 from ...types.paginated_slim_document_list import PaginatedSlimDocumentList
 from ...types.upload_document_response import UploadDocumentResponse
 
@@ -68,6 +70,52 @@ class DocumentsClient:
             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[DocumentStatus] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+    ) -> DocumentRead:
+        """
+
+        <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+
+        Update a Document, keying off of its Vellum-generated ID. Particularly useful for updating its metadata.
+
+        Parameters:
+            - id: str. A UUID string identifying this document.
+
+            - label: typing.Optional[str]. A human-readable label for the document. Defaults to the originally uploaded file's file name. <span style="white-space: nowrap">`non-empty`</span> <span style="white-space: nowrap">`<= 1000 characters`</span>
+
+            - status: typing.Optional[DocumentStatus]. The current status of the document
+
+                                                       * `ACTIVE` - Active
+            - metadata: typing.Optional[typing.Dict[str, typing.Any]]. A JSON object containing any metadata associated with the document that you'd like to filter upon later.
+        """
+        _request: typing.Dict[str, typing.Any] = {}
+        if label is not OMIT:
+            _request["label"] = label
+        if status is not OMIT:
+            _request["status"] = status
+        if metadata is not OMIT:
+            _request["metadata"] = metadata
+        _response = self._client_wrapper.httpx_client.request(
+            "PATCH",
+            urllib.parse.urljoin(f"{self._environment.default}/", f"v1/documents/{id}"),
+            json=jsonable_encoder(_request),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic.parse_obj_as(DocumentRead, _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 upload(
         self,
         *,
@@ -176,6 +224,52 @@ class AsyncDocumentsClient:
             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[DocumentStatus] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+    ) -> DocumentRead:
+        """
+
+        <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+
+        Update a Document, keying off of its Vellum-generated ID. Particularly useful for updating its metadata.
+
+        Parameters:
+            - id: str. A UUID string identifying this document.
+
+            - label: typing.Optional[str]. A human-readable label for the document. Defaults to the originally uploaded file's file name. <span style="white-space: nowrap">`non-empty`</span> <span style="white-space: nowrap">`<= 1000 characters`</span>
+
+            - status: typing.Optional[DocumentStatus]. The current status of the document
+
+                                                       * `ACTIVE` - Active
+            - metadata: typing.Optional[typing.Dict[str, typing.Any]]. A JSON object containing any metadata associated with the document that you'd like to filter upon later.
+        """
+        _request: typing.Dict[str, typing.Any] = {}
+        if label is not OMIT:
+            _request["label"] = label
+        if status is not OMIT:
+            _request["status"] = status
+        if metadata is not OMIT:
+            _request["metadata"] = metadata
+        _response = await self._client_wrapper.httpx_client.request(
+            "PATCH",
+            urllib.parse.urljoin(f"{self._environment.default}/", f"v1/documents/{id}"),
+            json=jsonable_encoder(_request),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic.parse_obj_as(DocumentRead, _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 upload(
         self,
         *,

{vellum_ai-0.0.29 → vellum_ai-0.0.31}/src/vellum/types/__init__.py

@@ -10,11 +10,13 @@ from .content_type import ContentType
 from .deployment_node_result import DeploymentNodeResult
 from .deployment_node_result_data import DeploymentNodeResultData
 from .deployment_read import DeploymentRead
-from .deployment_read_status_enum import DeploymentReadStatusEnum
+from .deployment_status import DeploymentStatus
 from .document import Document
 from .document_document_to_document_index import DocumentDocumentToDocumentIndex
 from .document_index_read import DocumentIndexRead
 from .document_index_status import DocumentIndexStatus
+from .document_read import DocumentRead
+from .document_status import DocumentStatus
 from .enriched_normalized_completion import EnrichedNormalizedCompletion
 from .environment_enum import EnvironmentEnum
 from .evaluation_params import EvaluationParams
@@ -89,7 +91,6 @@ from .search_result import SearchResult
 from .search_result_merging_request import SearchResultMergingRequest
 from .search_weights_request import SearchWeightsRequest
 from .slim_document import SlimDocument
-from .slim_document_status_enum import SlimDocumentStatusEnum
 from .submit_completion_actual_request import SubmitCompletionActualRequest
 from .submit_completion_actuals_error_response import SubmitCompletionActualsErrorResponse
 from .terminal_node_chat_history_result import TerminalNodeChatHistoryResult
@@ -154,11 +155,13 @@ __all__ = [
     "DeploymentNodeResult",
     "DeploymentNodeResultData",
     "DeploymentRead",
-    "DeploymentReadStatusEnum",
+    "DeploymentStatus",
     "Document",
     "DocumentDocumentToDocumentIndex",
     "DocumentIndexRead",
     "DocumentIndexStatus",
+    "DocumentRead",
+    "DocumentStatus",
     "EnrichedNormalizedCompletion",
     "EnvironmentEnum",
     "EvaluationParams",
@@ -233,7 +236,6 @@ __all__ = [
     "SearchResultMergingRequest",
     "SearchWeightsRequest",
     "SlimDocument",
-    "SlimDocumentStatusEnum",
     "SubmitCompletionActualRequest",
     "SubmitCompletionActualsErrorResponse",
     "TerminalNodeChatHistoryResult",

{vellum_ai-0.0.29 → vellum_ai-0.0.31}/src/vellum/types/deployment_read.py

@@ -6,7 +6,7 @@ import typing
 import pydantic
 
 from ..core.datetime_utils import serialize_datetime
-from .deployment_read_status_enum import DeploymentReadStatusEnum
+from .deployment_status import DeploymentStatus
 from .environment_enum import EnvironmentEnum
 from .input_variable import InputVariable
 from .model_type_enum import ModelTypeEnum
@@ -21,7 +21,7 @@ class DeploymentRead(pydantic.BaseModel):
     name: str = pydantic.Field(
         description='A name that uniquely identifies this deployment within its workspace <span style="white-space: nowrap">`<= 150 characters`</span> '
     )
-    status: typing.Optional[DeploymentReadStatusEnum] = pydantic.Field(
+    status: typing.Optional[DeploymentStatus] = pydantic.Field(
         description=(
             "The current status of the deployment\n"
             "\n"

vellum_ai-0.0.29/src/vellum/types/deployment_read_status_enum.py → vellum_ai-0.0.31/src/vellum/types/deployment_status.py

@@ -6,7 +6,7 @@ import typing
 T_Result = typing.TypeVar("T_Result")
 
 
-class DeploymentReadStatusEnum(str, enum.Enum):
+class DeploymentStatus(str, enum.Enum):
     """
     * `ACTIVE` - Active
     * `INACTIVE` - Inactive
@@ -23,9 +23,9 @@ class DeploymentReadStatusEnum(str, enum.Enum):
         inactive: typing.Callable[[], T_Result],
         archived: typing.Callable[[], T_Result],
     ) -> T_Result:
-        if self is DeploymentReadStatusEnum.ACTIVE:
+        if self is DeploymentStatus.ACTIVE:
             return active()
-        if self is DeploymentReadStatusEnum.INACTIVE:
+        if self is DeploymentStatus.INACTIVE:
             return inactive()
-        if self is DeploymentReadStatusEnum.ARCHIVED:
+        if self is DeploymentStatus.ARCHIVED:
             return archived()

vellum_ai-0.0.31/src/vellum/types/document_read.py

@@ -0,0 +1,53 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+from .document_document_to_document_index import DocumentDocumentToDocumentIndex
+from .document_status import DocumentStatus
+from .processing_state_enum import ProcessingStateEnum
+
+
+class DocumentRead(pydantic.BaseModel):
+    id: str
+    external_id: typing.Optional[str] = pydantic.Field(
+        description="The unique id of this document as it exists in the user's system."
+    )
+    last_uploaded_at: str
+    label: str = pydantic.Field(
+        description='A human-readable label for the document. Defaults to the originally uploaded file\'s file name. <span style="white-space: nowrap">`<= 1000 characters`</span> '
+    )
+    processing_state: typing.Optional[ProcessingStateEnum] = pydantic.Field(
+        description=(
+            "The current processing state of the document\n"
+            "\n"
+            "* `QUEUED` - Queued\n"
+            "* `PROCESSING` - Processing\n"
+            "* `PROCESSED` - Processed\n"
+            "* `FAILED` - Failed\n"
+        )
+    )
+    status: typing.Optional[DocumentStatus] = pydantic.Field(
+        description=("The current status of the document\n" "\n" "* `ACTIVE` - Active\n")
+    )
+    original_file_url: typing.Optional[str]
+    processed_file_url: typing.Optional[str]
+    document_to_document_indexes: typing.List[DocumentDocumentToDocumentIndex]
+    metadata: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(
+        description="A previously supplied JSON object containing metadata that can filtered on when searching."
+    )
+
+    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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum_ai-0.0.29/src/vellum/types/slim_document_status_enum.py → vellum_ai-0.0.31/src/vellum/types/document_status.py

@@ -2,4 +2,4 @@
 
 import typing_extensions
 
-SlimDocumentStatusEnum = typing_extensions.Literal["ACTIVE"]
+DocumentStatus = typing_extensions.Literal["ACTIVE"]

{vellum_ai-0.0.29 → vellum_ai-0.0.31}/src/vellum/types/slim_document.py

@@ -7,9 +7,9 @@ import pydantic
 
 from ..core.datetime_utils import serialize_datetime
 from .document_document_to_document_index import DocumentDocumentToDocumentIndex
+from .document_status import DocumentStatus
 from .processing_failure_reason_enum import ProcessingFailureReasonEnum
 from .processing_state_enum import ProcessingStateEnum
-from .slim_document_status_enum import SlimDocumentStatusEnum
 
 
 class SlimDocument(pydantic.BaseModel):
@@ -41,7 +41,7 @@ class SlimDocument(pydantic.BaseModel):
             "* `INVALID_FILE` - Invalid File\n"
         )
     )
-    status: typing.Optional[SlimDocumentStatusEnum] = pydantic.Field(
+    status: typing.Optional[DocumentStatus] = pydantic.Field(
         description=("The document's current status.\n" "\n" "* `ACTIVE` - Active\n")
     )
     keywords: typing.Optional[typing.List[str]] = pydantic.Field(

{vellum_ai-0.0.29 → vellum_ai-0.0.31}/src/vellum/types/terminal_node_chat_history_result.py

@@ -11,7 +11,7 @@ from .chat_message import ChatMessage
 
 class TerminalNodeChatHistoryResult(pydantic.BaseModel):
     name: str = pydantic.Field(description="The unique name given to the terminal node that produced this output.")
-    value: typing.List[ChatMessage]
+    value: typing.Optional[typing.List[ChatMessage]]
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

{vellum_ai-0.0.29 → vellum_ai-0.0.31}/src/vellum/types/terminal_node_json_result.py

@@ -10,7 +10,7 @@ from ..core.datetime_utils import serialize_datetime
 
 class TerminalNodeJsonResult(pydantic.BaseModel):
     name: str = pydantic.Field(description="The unique name given to the terminal node that produced this output.")
-    value: typing.Dict[str, typing.Any]
+    value: typing.Optional[typing.Dict[str, typing.Any]]
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

{vellum_ai-0.0.29 → vellum_ai-0.0.31}/src/vellum/types/terminal_node_string_result.py

@@ -10,7 +10,7 @@ from ..core.datetime_utils import serialize_datetime
 
 class TerminalNodeStringResult(pydantic.BaseModel):
     name: str = pydantic.Field(description="The unique name given to the terminal node that produced this output.")
-    value: str
+    value: typing.Optional[str]
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}