vellum-ai 0.7.11__py3-none-any.whl → 0.8.4__py3-none-any.whl

vellum/resources/document_indexes/client.py

@@ -1,19 +1,19 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
+from ...core.client_wrapper import SyncClientWrapper
+from .types.document_indexes_list_request_status import DocumentIndexesListRequestStatus
+from ...core.request_options import RequestOptions
+from ...types.paginated_document_index_read_list import PaginatedDocumentIndexReadList
+from ...core.pydantic_utilities import parse_obj_as
 from json.decoder import JSONDecodeError
-
 from ...core.api_error import ApiError
-from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
-from ...core.jsonable_encoder import jsonable_encoder
-from ...core.pydantic_utilities import pydantic_v1
-from ...core.request_options import RequestOptions
 from ...types.document_index_indexing_config_request import DocumentIndexIndexingConfigRequest
-from ...types.document_index_read import DocumentIndexRead
 from ...types.entity_status import EntityStatus
 from ...types.environment_enum import EnvironmentEnum
-from ...types.paginated_document_index_read_list import PaginatedDocumentIndexReadList
-from .types.document_indexes_list_request_status import DocumentIndexesListRequestStatus
+from ...types.document_index_read import DocumentIndexRead
+from ...core.jsonable_encoder import jsonable_encoder
+from ...core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -66,7 +66,7 @@ class DocumentIndexesClient:
 
         Examples
         --------
-        from vellum.client import Vellum
+        from vellum import Vellum
 
         client = Vellum(
             api_key="YOUR_API_KEY",
@@ -77,12 +77,24 @@ class DocumentIndexesClient:
             "v1/document-indexes",
             base_url=self._client_wrapper.get_environment().default,
             method="GET",
-            params={"limit": limit, "offset": offset, "ordering": ordering, "search": search, "status": status},
+            params={
+                "limit": limit,
+                "offset": offset,
+                "ordering": ordering,
+                "search": search,
+                "status": status,
+            },
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(PaginatedDocumentIndexReadList, _response.json())  # type: ignore
+                return typing.cast(
+                    PaginatedDocumentIndexReadList,
+                    parse_obj_as(
+                        type_=PaginatedDocumentIndexReadList,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -139,25 +151,35 @@ class DocumentIndexesClient:
         Examples
         --------
         from vellum import (
-            DocumentIndexChunkingRequest_ReductoChunker,
             DocumentIndexIndexingConfigRequest,
-            IndexingConfigVectorizerRequest_TextEmbedding3Small,
+            HkunlpInstructorXlVectorizerRequest,
+            InstructorVectorizerConfigRequest,
+            SentenceChunkerConfigRequest,
+            SentenceChunkingRequest,
+            Vellum,
         )
-        from vellum.client import Vellum
 
         client = Vellum(
             api_key="YOUR_API_KEY",
         )
         client.document_indexes.create(
-            label="string",
-            name="string",
-            status="ACTIVE",
-            environment="DEVELOPMENT",
+            label="My Document Index",
+            name="my-document-index",
             indexing_config=DocumentIndexIndexingConfigRequest(
-                vectorizer=IndexingConfigVectorizerRequest_TextEmbedding3Small(),
-                chunking=DocumentIndexChunkingRequest_ReductoChunker(),
+                vectorizer=HkunlpInstructorXlVectorizerRequest(
+                    config=InstructorVectorizerConfigRequest(
+                        instruction_domain="",
+                        instruction_query_text_type="plain_text",
+                        instruction_document_text_type="plain_text",
+                    ),
+                ),
+                chunking=SentenceChunkingRequest(
+                    chunker_config=SentenceChunkerConfigRequest(
+                        character_limit=1000,
+                        min_overlap_ratio=0.5,
+                    ),
+                ),
             ),
-            copy_documents_from_index_id="string",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -177,7 +199,13 @@ class DocumentIndexesClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(DocumentIndexRead, _response.json())  # type: ignore
+                return typing.cast(
+                    DocumentIndexRead,
+                    parse_obj_as(
+                        type_=DocumentIndexRead,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -202,13 +230,13 @@ class DocumentIndexesClient:
 
         Examples
         --------
-        from vellum.client import Vellum
+        from vellum import Vellum
 
         client = Vellum(
             api_key="YOUR_API_KEY",
         )
         client.document_indexes.retrieve(
-            id="string",
+            id="id",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -219,7 +247,13 @@ class DocumentIndexesClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(DocumentIndexRead, _response.json())  # type: ignore
+                return typing.cast(
+                    DocumentIndexRead,
+                    parse_obj_as(
+                        type_=DocumentIndexRead,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -268,29 +302,37 @@ class DocumentIndexesClient:
 
         Examples
         --------
-        from vellum.client import Vellum
+        from vellum import Vellum
 
         client = Vellum(
             api_key="YOUR_API_KEY",
         )
         client.document_indexes.update(
-            id="string",
-            label="string",
-            status="ACTIVE",
-            environment="DEVELOPMENT",
+            id="id",
+            label="label",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
             f"v1/document-indexes/{jsonable_encoder(id)}",
             base_url=self._client_wrapper.get_environment().default,
             method="PUT",
-            json={"label": label, "status": status, "environment": environment},
+            json={
+                "label": label,
+                "status": status,
+                "environment": environment,
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(DocumentIndexRead, _response.json())  # type: ignore
+                return typing.cast(
+                    DocumentIndexRead,
+                    parse_obj_as(
+                        type_=DocumentIndexRead,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -314,7 +356,7 @@ class DocumentIndexesClient:
 
         Examples
         --------
-        from vellum.client import Vellum
+        from vellum import Vellum
 
         client = Vellum(
             api_key="YOUR_API_KEY",
@@ -380,29 +422,36 @@ class DocumentIndexesClient:
 
         Examples
         --------
-        from vellum.client import Vellum
+        from vellum import Vellum
 
         client = Vellum(
             api_key="YOUR_API_KEY",
         )
         client.document_indexes.partial_update(
-            id="string",
-            label="string",
-            status="ACTIVE",
-            environment="DEVELOPMENT",
+            id="id",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
             f"v1/document-indexes/{jsonable_encoder(id)}",
             base_url=self._client_wrapper.get_environment().default,
             method="PATCH",
-            json={"label": label, "status": status, "environment": environment},
+            json={
+                "label": label,
+                "status": status,
+                "environment": environment,
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(DocumentIndexRead, _response.json())  # type: ignore
+                return typing.cast(
+                    DocumentIndexRead,
+                    parse_obj_as(
+                        type_=DocumentIndexRead,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -431,7 +480,7 @@ class DocumentIndexesClient:
 
         Examples
         --------
-        from vellum.client import Vellum
+        from vellum import Vellum
 
         client = Vellum(
             api_key="YOUR_API_KEY",
@@ -478,7 +527,7 @@ class DocumentIndexesClient:
 
         Examples
         --------
-        from vellum.client import Vellum
+        from vellum import Vellum
 
         client = Vellum(
             api_key="YOUR_API_KEY",
@@ -552,7 +601,7 @@ class AsyncDocumentIndexesClient:
         --------
         import asyncio
 
-        from vellum.client import AsyncVellum
+        from vellum import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
@@ -569,12 +618,24 @@ class AsyncDocumentIndexesClient:
             "v1/document-indexes",
             base_url=self._client_wrapper.get_environment().default,
             method="GET",
-            params={"limit": limit, "offset": offset, "ordering": ordering, "search": search, "status": status},
+            params={
+                "limit": limit,
+                "offset": offset,
+                "ordering": ordering,
+                "search": search,
+                "status": status,
+            },
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(PaginatedDocumentIndexReadList, _response.json())  # type: ignore
+                return typing.cast(
+                    PaginatedDocumentIndexReadList,
+                    parse_obj_as(
+                        type_=PaginatedDocumentIndexReadList,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -633,11 +694,13 @@ class AsyncDocumentIndexesClient:
         import asyncio
 
         from vellum import (
-            DocumentIndexChunkingRequest_ReductoChunker,
+            AsyncVellum,
             DocumentIndexIndexingConfigRequest,
-            IndexingConfigVectorizerRequest_TextEmbedding3Small,
+            HkunlpInstructorXlVectorizerRequest,
+            InstructorVectorizerConfigRequest,
+            SentenceChunkerConfigRequest,
+            SentenceChunkingRequest,
         )
-        from vellum.client import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
@@ -646,15 +709,23 @@ class AsyncDocumentIndexesClient:
 
         async def main() -> None:
             await client.document_indexes.create(
-                label="string",
-                name="string",
-                status="ACTIVE",
-                environment="DEVELOPMENT",
+                label="My Document Index",
+                name="my-document-index",
                 indexing_config=DocumentIndexIndexingConfigRequest(
-                    vectorizer=IndexingConfigVectorizerRequest_TextEmbedding3Small(),
-                    chunking=DocumentIndexChunkingRequest_ReductoChunker(),
+                    vectorizer=HkunlpInstructorXlVectorizerRequest(
+                        config=InstructorVectorizerConfigRequest(
+                            instruction_domain="",
+                            instruction_query_text_type="plain_text",
+                            instruction_document_text_type="plain_text",
+                        ),
+                    ),
+                    chunking=SentenceChunkingRequest(
+                        chunker_config=SentenceChunkerConfigRequest(
+                            character_limit=1000,
+                            min_overlap_ratio=0.5,
+                        ),
+                    ),
                 ),
-                copy_documents_from_index_id="string",
             )
 
 
@@ -677,7 +748,13 @@ class AsyncDocumentIndexesClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(DocumentIndexRead, _response.json())  # type: ignore
+                return typing.cast(
+                    DocumentIndexRead,
+                    parse_obj_as(
+                        type_=DocumentIndexRead,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -704,7 +781,7 @@ class AsyncDocumentIndexesClient:
         --------
         import asyncio
 
-        from vellum.client import AsyncVellum
+        from vellum import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
@@ -713,7 +790,7 @@ class AsyncDocumentIndexesClient:
 
         async def main() -> None:
             await client.document_indexes.retrieve(
-                id="string",
+                id="id",
             )
 
 
@@ -727,7 +804,13 @@ class AsyncDocumentIndexesClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(DocumentIndexRead, _response.json())  # type: ignore
+                return typing.cast(
+                    DocumentIndexRead,
+                    parse_obj_as(
+                        type_=DocumentIndexRead,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -778,7 +861,7 @@ class AsyncDocumentIndexesClient:
         --------
         import asyncio
 
-        from vellum.client import AsyncVellum
+        from vellum import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
@@ -787,10 +870,8 @@ class AsyncDocumentIndexesClient:
 
         async def main() -> None:
             await client.document_indexes.update(
-                id="string",
-                label="string",
-                status="ACTIVE",
-                environment="DEVELOPMENT",
+                id="id",
+                label="label",
             )
 
 
@@ -800,13 +881,23 @@ class AsyncDocumentIndexesClient:
             f"v1/document-indexes/{jsonable_encoder(id)}",
             base_url=self._client_wrapper.get_environment().default,
             method="PUT",
-            json={"label": label, "status": status, "environment": environment},
+            json={
+                "label": label,
+                "status": status,
+                "environment": environment,
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(DocumentIndexRead, _response.json())  # type: ignore
+                return typing.cast(
+                    DocumentIndexRead,
+                    parse_obj_as(
+                        type_=DocumentIndexRead,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -832,7 +923,7 @@ class AsyncDocumentIndexesClient:
         --------
         import asyncio
 
-        from vellum.client import AsyncVellum
+        from vellum import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
@@ -906,7 +997,7 @@ class AsyncDocumentIndexesClient:
         --------
         import asyncio
 
-        from vellum.client import AsyncVellum
+        from vellum import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
@@ -915,10 +1006,7 @@ class AsyncDocumentIndexesClient:
 
         async def main() -> None:
             await client.document_indexes.partial_update(
-                id="string",
-                label="string",
-                status="ACTIVE",
-                environment="DEVELOPMENT",
+                id="id",
             )
 
 
@@ -928,13 +1016,23 @@ class AsyncDocumentIndexesClient:
             f"v1/document-indexes/{jsonable_encoder(id)}",
             base_url=self._client_wrapper.get_environment().default,
             method="PATCH",
-            json={"label": label, "status": status, "environment": environment},
+            json={
+                "label": label,
+                "status": status,
+                "environment": environment,
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(DocumentIndexRead, _response.json())  # type: ignore
+                return typing.cast(
+                    DocumentIndexRead,
+                    parse_obj_as(
+                        type_=DocumentIndexRead,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -965,7 +1063,7 @@ class AsyncDocumentIndexesClient:
         --------
         import asyncio
 
-        from vellum.client import AsyncVellum
+        from vellum import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
@@ -1020,7 +1118,7 @@ class AsyncDocumentIndexesClient:
         --------
         import asyncio
 
-        from vellum.client import AsyncVellum
+        from vellum import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",