vellum-ai 0.6.7__py3-none-any.whl → 0.6.9__py3-none-any.whl

vellum/__init__.py

@@ -193,6 +193,7 @@ from .types import (
     InstructorVectorizerConfig,
     InstructorVectorizerConfigRequest,
     IntfloatMultilingualE5LargeEnum,
+    IterationStateEnum,
     JsonEnum,
     JsonInputRequest,
     JsonVariableValue,
@@ -826,6 +827,7 @@ __all__ = [
     "InstructorVectorizerConfigRequest",
     "InternalServerError",
     "IntfloatMultilingualE5LargeEnum",
+    "IterationStateEnum",
     "JsonEnum",
     "JsonInputRequest",
     "JsonVariableValue",

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

vellum/resources/document_indexes/client.py

@@ -256,10 +256,10 @@ class DocumentIndexesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> DocumentIndexRead:
         """
-        Used to fully update a Document Index given its ID.
+        Used to fully update a Document Index given its ID or name.
 
         Parameters:
-            - id: str. A UUID string identifying this document index.
+            - id: str. Either the Document Index's ID or its unique name
 
             - label: str. A human-readable label for the document index
 
@@ -329,10 +329,10 @@ class DocumentIndexesClient:
 
     def destroy(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
-        Used to delete a Document Index given its ID.
+        Used to delete a Document Index given its ID or name.
 
         Parameters:
-            - id: str. A UUID string identifying this document index.
+            - id: str. Either the Document Index's ID or its unique name
 
             - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
         ---
@@ -385,10 +385,10 @@ class DocumentIndexesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> DocumentIndexRead:
         """
-        Used to partial update a Document Index given its ID.
+        Used to partial update a Document Index given its ID or name.
 
         Parameters:
-            - id: str. A UUID string identifying this document index.
+            - id: str. Either the Document Index's ID or its unique name
 
             - label: typing.Optional[str]. A human-readable label for the document index
 
@@ -458,6 +458,60 @@ class DocumentIndexesClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    def remove_document(
+        self, document_id: str, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Removes a Document from a Document Index without deleting the Document itself.
+
+        Parameters:
+            - document_id: str. Either the Vellum-generated ID or the originally supplied external_id that uniquely identifies the Document you'd like to remove.
+
+            - id: str. Either the Vellum-generated ID or the originally specified name that uniquely identifies the Document Index from which you'd like to remove a Document.
+
+            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
+        ---
+        from vellum.client import Vellum
+
+        client = Vellum(
+            api_key="YOUR_API_KEY",
+        )
+        client.document_indexes.remove_document(
+            document_id="document_id",
+            id="id",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            method="DELETE",
+            url=urllib.parse.urljoin(
+                f"{self._client_wrapper.get_environment().default}/",
+                f"v1/document-indexes/{jsonable_encoder(id)}/documents/{jsonable_encoder(document_id)}",
+            ),
+            params=jsonable_encoder(
+                request_options.get("additional_query_parameters") if request_options is not None else None
+            ),
+            headers=jsonable_encoder(
+                remove_none_from_dict(
+                    {
+                        **self._client_wrapper.get_headers(),
+                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
+                    }
+                )
+            ),
+            timeout=request_options.get("timeout_in_seconds")
+            if request_options is not None and request_options.get("timeout_in_seconds") is not None
+            else self._client_wrapper.get_timeout(),
+            retries=0,
+            max_retries=request_options.get("max_retries") if request_options is not None else 0,  # type: ignore
+        )
+        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)
+
 
 class AsyncDocumentIndexesClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -694,10 +748,10 @@ class AsyncDocumentIndexesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> DocumentIndexRead:
         """
-        Used to fully update a Document Index given its ID.
+        Used to fully update a Document Index given its ID or name.
 
         Parameters:
-            - id: str. A UUID string identifying this document index.
+            - id: str. Either the Document Index's ID or its unique name
 
             - label: str. A human-readable label for the document index
 
@@ -767,10 +821,10 @@ class AsyncDocumentIndexesClient:
 
     async def destroy(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
-        Used to delete a Document Index given its ID.
+        Used to delete a Document Index given its ID or name.
 
         Parameters:
-            - id: str. A UUID string identifying this document index.
+            - id: str. Either the Document Index's ID or its unique name
 
             - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
         ---
@@ -823,10 +877,10 @@ class AsyncDocumentIndexesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> DocumentIndexRead:
         """
-        Used to partial update a Document Index given its ID.
+        Used to partial update a Document Index given its ID or name.
 
         Parameters:
-            - id: str. A UUID string identifying this document index.
+            - id: str. Either the Document Index's ID or its unique name
 
             - label: typing.Optional[str]. A human-readable label for the document index
 
@@ -895,3 +949,57 @@ 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 remove_document(
+        self, document_id: str, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Removes a Document from a Document Index without deleting the Document itself.
+
+        Parameters:
+            - document_id: str. Either the Vellum-generated ID or the originally supplied external_id that uniquely identifies the Document you'd like to remove.
+
+            - id: str. Either the Vellum-generated ID or the originally specified name that uniquely identifies the Document Index from which you'd like to remove a Document.
+
+            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
+        ---
+        from vellum.client import AsyncVellum
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+        await client.document_indexes.remove_document(
+            document_id="document_id",
+            id="id",
+        )
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            method="DELETE",
+            url=urllib.parse.urljoin(
+                f"{self._client_wrapper.get_environment().default}/",
+                f"v1/document-indexes/{jsonable_encoder(id)}/documents/{jsonable_encoder(document_id)}",
+            ),
+            params=jsonable_encoder(
+                request_options.get("additional_query_parameters") if request_options is not None else None
+            ),
+            headers=jsonable_encoder(
+                remove_none_from_dict(
+                    {
+                        **self._client_wrapper.get_headers(),
+                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
+                    }
+                )
+            ),
+            timeout=request_options.get("timeout_in_seconds")
+            if request_options is not None and request_options.get("timeout_in_seconds") is not None
+            else self._client_wrapper.get_timeout(),
+            retries=0,
+            max_retries=request_options.get("max_retries") if request_options is not None else 0,  # type: ignore
+        )
+        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)

vellum/types/__init__.py

@@ -230,6 +230,7 @@ from .initiated_workflow_node_result_event import InitiatedWorkflowNodeResultEve
 from .instructor_vectorizer_config import InstructorVectorizerConfig
 from .instructor_vectorizer_config_request import InstructorVectorizerConfigRequest
 from .intfloat_multilingual_e_5_large_enum import IntfloatMultilingualE5LargeEnum
+from .iteration_state_enum import IterationStateEnum
 from .json_enum import JsonEnum
 from .json_input_request import JsonInputRequest
 from .json_variable_value import JsonVariableValue
@@ -884,6 +885,7 @@ __all__ = [
     "InstructorVectorizerConfig",
     "InstructorVectorizerConfigRequest",
     "IntfloatMultilingualE5LargeEnum",
+    "IterationStateEnum",
     "JsonEnum",
     "JsonInputRequest",
     "JsonVariableValue",

vellum/types/iteration_state_enum.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+IterationStateEnum = typing.Union[typing.Literal["INITIATED", "FULFILLED"], typing.Any]

vellum/types/map_node_result_data.py

@@ -5,10 +5,12 @@ import typing
 
 from ..core.datetime_utils import serialize_datetime
 from ..core.pydantic_utilities import pydantic_v1
+from .iteration_state_enum import IterationStateEnum
 
 
 class MapNodeResultData(pydantic_v1.BaseModel):
     execution_ids: typing.List[str]
+    iteration_state: typing.Optional[IterationStateEnum] = None
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

{vellum_ai-0.6.7.dist-info → vellum_ai-0.6.9.dist-info}/METADATA

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

{vellum_ai-0.6.7.dist-info → vellum_ai-0.6.9.dist-info}/RECORD

@@ -1,8 +1,8 @@
-vellum/__init__.py,sha256=G55NRop_hz8IpafXnIM326D0I9YSBsQJLtzBNgoVNDM,45651
+vellum/__init__.py,sha256=OcHXzyp3Csd35fdH_THYQwUM0distNnT5B1re41UI44,45701
 vellum/client.py,sha256=FklbOzCaDTPP_EQn0HJXUq1_ZFOHuSePt6_nVQ_YLgY,97463
 vellum/core/__init__.py,sha256=1pNSKkwyQvMl_F0wohBqmoQAITptg3zlvCwsoSSzy7c,853
 vellum/core/api_error.py,sha256=RE8LELok2QCjABadECTvtDp7qejA1VmINCh6TbqPwSE,426
-vellum/core/client_wrapper.py,sha256=-vO_h8n0NNqy3sN2pTSTXlDAoM41JPD3YuBYc80k9PU,1697
+vellum/core/client_wrapper.py,sha256=O-MwUsnrzYAjhRtuFZAdCMSoFYXq9V_stJOY-Sb7IAo,1697
 vellum/core/datetime_utils.py,sha256=nBys2IsYrhPdszxGKCNRPSOCwa-5DWOHG95FB8G9PKo,1047
 vellum/core/file.py,sha256=sy1RUGZ3aJYuw998bZytxxo6QdgKmlnlgBaMvwEKCGg,1480
 vellum/core/http_client.py,sha256=5ok6hqgZDJhg57EHvMnr0BBaHdG50QxFPKaCZ9aVWTc,5059
@@ -32,7 +32,7 @@ vellum/resources/deployments/client.py,sha256=p-n2k6RQIwNBDm9dU-wE6pI0kRhNjQiARB
 vellum/resources/deployments/types/__init__.py,sha256=IhwnmoXJ0r_QEhh1b2tBcaAm_x3fWMVuIhYmAapp_ZA,183
 vellum/resources/deployments/types/deployments_list_request_status.py,sha256=CxlQD16KZXme7x31YYCe_3aAgEueutDTeJo5A4Au-aU,174
 vellum/resources/document_indexes/__init__.py,sha256=YpOl_9IV7xOlH4OmusQxtAJB11kxQfCSMDyT1_UD0oM,165
-vellum/resources/document_indexes/client.py,sha256=ps7XrRmNptUsS4aZGlyhLVg_jWqjzC0JN2wGxinoFXI,40388
+vellum/resources/document_indexes/client.py,sha256=DgJn_ZpIt-WY8OR3P3sCQ_x7FVtQ5WVj_TR1t9PwDf0,45370
 vellum/resources/document_indexes/types/__init__.py,sha256=IoFqKHN_VBdEhC7VL8_6Jbatrn0e0zuYEJAJUahcUR0,196
 vellum/resources/document_indexes/types/document_indexes_list_request_status.py,sha256=sfUEB0cvOSmlE2iITqnMVyHv05Zy2fWP4QjCIYqMg0M,178
 vellum/resources/documents/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
@@ -60,7 +60,7 @@ vellum/terraform/document_index/__init__.py,sha256=qq2zENI22bUvqGk_a1lmsoTr5O_xC
 vellum/terraform/provider/__init__.py,sha256=K1yLlTZkYBxhD4bhUV1v23hxDGgbfsAIGsSyeB54dNQ,10298
 vellum/terraform/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 vellum/terraform/versions.json,sha256=STW6Mg3BKDacFmbWHXziHxE90GWncZf4AIzCLiXm_7o,56
-vellum/types/__init__.py,sha256=CmRjPmzpzRtCbzM5bjZk_dd3S3Gcz2SCFRuUt1PIwKA,61260
+vellum/types/__init__.py,sha256=kXwzN3eE2Ec000S2qo5QBGX3ybDdD4JGWhCVj1Cmfv0,61339
 vellum/types/add_openai_api_key_enum.py,sha256=GB7sLK_Ou7-Xn73sKJHUo6Gx3TjyhU7uJvWZAg4UeaI,92
 vellum/types/api_node_result.py,sha256=SvYIi1T-N_P3FVjzv9I91PaCT0IN958A3easp5Q7jqE,983
 vellum/types/api_node_result_data.py,sha256=KFBmmizcEg73GwQMXUtEdJ4e9YGFpRLYAnalwxIcDug,1161
@@ -183,6 +183,7 @@ vellum/types/initiated_workflow_node_result_event.py,sha256=21Q_wO3U1qbYuNUAWBaX
 vellum/types/instructor_vectorizer_config.py,sha256=SjOqNyt2e1_4itwmORbDMvnJ3hJN-G1XYThez4rJanc,1025
 vellum/types/instructor_vectorizer_config_request.py,sha256=SiR6BT6rFqmZ85iN6kj_GwHXmuZJ5-0YqXCULR18hno,1032
 vellum/types/intfloat_multilingual_e_5_large_enum.py,sha256=hq41gaU723etcyr8--yEzHFqdR_x7ixSMRXTCHthknM,163
+vellum/types/iteration_state_enum.py,sha256=yjwnPhqKQQbWgQUqP2qws4kVMhRY8sFTGK_diuSrsR0,168
 vellum/types/json_enum.py,sha256=0Se0lTWxLGQe-JdQ8E9KwFt5NWXuI7BkOdWQcFKJg-8,114
 vellum/types/json_input_request.py,sha256=fpBb3QS-E0a3hZU_mHZ5Yjkwr10-qqbQoMJbfhfGu_4,1048
 vellum/types/json_variable_value.py,sha256=KdKz67NgVwVHpxXFgSxFPBeGBdjzTwZ_VKe22kcaWjo,904
@@ -191,7 +192,7 @@ vellum/types/logical_operator.py,sha256=MuuMZ1-gOCDvy1WDQkMFfiBNHsRCqKgJei-b3727
 vellum/types/logprobs_enum.py,sha256=D_458cZX2CAb6dX_ovrQ6HARlJkYcZRadKwsi1Cr-JM,151
 vellum/types/map_enum.py,sha256=ABInkGAOBdgmsKzcCcM0AKEPQt-iwim-GmHEkXEHEs0,112
 vellum/types/map_node_result.py,sha256=x5S8E8_jhIZHc9aAeE0GqGAw8v5XoLXTA4uiFTVtqA0,1006
-vellum/types/map_node_result_data.py,sha256=aQ63NmLtaFQ1R-NgS_3Eq-al2-BT9oONLrj-2Fp2BXI,876
+vellum/types/map_node_result_data.py,sha256=XRaiU2_8zY9g_N_wYsqUgHmNME3ePHl3_VhSUTumCzI,993
 vellum/types/merge_enum.py,sha256=TeAaXV2eWEGJHR3BqHdtIRkHUhctvfUo_Wu8MeqHYtU,116
 vellum/types/merge_node_result.py,sha256=R6AndgFRFuFQk8APapAr7bkv4vqkukz-D71kl8rIubU,905
 vellum/types/metadata_filter_config_request.py,sha256=_1CVIxmDmtXezTMWoaqeea9boe8hyCmmAn28u69NEUk,1355
@@ -470,7 +471,7 @@ vellum/types/workflow_result_event_output_data_search_results.py,sha256=gazaUrC5
 vellum/types/workflow_result_event_output_data_string.py,sha256=aVWIIGbLj4TJJhTTj6WzhbYXQkcZatKuhhNy8UYwXbw,1482
 vellum/types/workflow_stream_event.py,sha256=KA6Bkk_XA6AIPWR-1vKnwF1A8l_Bm5y0arQCWWWRpsk,911
 vellum/version.py,sha256=neLt8HBHHUtDF9M5fsyUzHT-pKooEPvceaLDqqIGb0s,77
-vellum_ai-0.6.7.dist-info/LICENSE,sha256=CcaljEIoOBaU-wItPH4PmM_mDCGpyuUY0Er1BGu5Ti8,1073
-vellum_ai-0.6.7.dist-info/METADATA,sha256=tv89fOOL-Pj8-X5-m-EKElAzGf5eOKYDPNq5ZTYL5fU,3872
-vellum_ai-0.6.7.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-vellum_ai-0.6.7.dist-info/RECORD,,
+vellum_ai-0.6.9.dist-info/LICENSE,sha256=CcaljEIoOBaU-wItPH4PmM_mDCGpyuUY0Er1BGu5Ti8,1073
+vellum_ai-0.6.9.dist-info/METADATA,sha256=T7NTne4Imv4xgnDZnD2QrOmjeoJmwPim5UyD2bX6e7g,3872
+vellum_ai-0.6.9.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+vellum_ai-0.6.9.dist-info/RECORD,,