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

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.8",
         }
         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_ai-0.6.7.dist-info → vellum_ai-0.6.8.dist-info}/METADATA

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

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

@@ -2,7 +2,7 @@ vellum/__init__.py,sha256=G55NRop_hz8IpafXnIM326D0I9YSBsQJLtzBNgoVNDM,45651
 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=q4MSX71tkX6HJqK9iZFBghW2ykYtsMzuw8Vm2U6njxo,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
@@ -470,7 +470,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.8.dist-info/LICENSE,sha256=CcaljEIoOBaU-wItPH4PmM_mDCGpyuUY0Er1BGu5Ti8,1073
+vellum_ai-0.6.8.dist-info/METADATA,sha256=nJyQBLYfdBqx3TaaTf8QLuLHWsALydR2wN7U1Twez1o,3872
+vellum_ai-0.6.8.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+vellum_ai-0.6.8.dist-info/RECORD,,