feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 2
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/nanonets%2Fdocstrange-75dd621006675868b0701738226a045f2e9d7211242fece922f06478bef66738.yml
-openapi_spec_hash: 47cb78aa2caa018fe58742fc19b0a49c
-config_hash: aed0d6cc8b4cffa1f02021baec0a6da3
+configured_endpoints: 9
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/nanonets%2Fdocstrange-a418fe45369669cc2d14b549ee010f3a7ee52f6e47fea3489e560d33064be099.yml
+openapi_spec_hash: 02f7f52faae1eb42188c290c32c25f10
+config_hash: 1804754b97b5ccf95ad31183c74527bc

README.md

@@ -33,7 +33,6 @@ client = Docstrange(
 )
 
 extract_response = client.extract.sync(
-    file=b"raw file contents",
     output_format="markdown",
 )
 print(extract_response.record_id)
@@ -60,7 +59,6 @@ client = AsyncDocstrange(
 
 async def main() -> None:
     extract_response = await client.extract.sync(
-        file=b"raw file contents",
         output_format="markdown",
     )
     print(extract_response.record_id)
@@ -97,7 +95,6 @@ async def main() -> None:
         http_client=DefaultAioHttpClient(),
     ) as client:
         extract_response = await client.extract.sync(
-            file=b"raw file contents",
             output_format="markdown",
         )
         print(extract_response.record_id)
@@ -115,6 +112,67 @@ Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typ
 
 Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
 
+## Pagination
+
+List methods in the Docstrange API are paginated.
+
+This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
+
+```python
+from docstrange import Docstrange
+
+client = Docstrange()
+
+all_results = []
+# Automatically fetches more pages as needed.
+for result in client.extract.results.list():
+    # Do something with result here
+    all_results.append(result)
+print(all_results)
+```
+
+Or, asynchronously:
+
+```python
+import asyncio
+from docstrange import AsyncDocstrange
+
+client = AsyncDocstrange()
+
+
+async def main() -> None:
+    all_results = []
+    # Iterate through items across all pages, issuing requests as needed.
+    async for result in client.extract.results.list():
+        all_results.append(result)
+    print(all_results)
+
+
+asyncio.run(main())
+```
+
+Alternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:
+
+```python
+first_page = await client.extract.results.list()
+if first_page.has_next_page():
+    print(f"will fetch next page using these details: {first_page.next_page_info()}")
+    next_page = await first_page.get_next_page()
+    print(f"number of items we just fetched: {len(next_page.results)}")
+
+# Remove `await` for non-async usage.
+```
+
+Or just work directly with the returned data:
+
+```python
+first_page = await client.extract.results.list()
+for result in first_page.results:
+    print(result.record_id)
+
+# Remove `await` for non-async usage.
+```
+
 ## File uploads
 
 Request parameters that correspond to file uploads can be passed as `bytes`, or a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance or a tuple of `(filename, contents, media type)`.
@@ -126,8 +184,8 @@ from docstrange import Docstrange
 client = Docstrange()
 
 client.extract.sync(
-    file=Path("/path/to/file"),
     output_format="markdown",
+    file=Path("/path/to/file"),
 )
 ```
 
@@ -150,7 +208,6 @@ client = Docstrange()
 
 try:
     client.extract.sync(
-        file=b"raw file contents",
         output_format="markdown",
     )
 except docstrange.APIConnectionError as e:
@@ -196,7 +253,6 @@ client = Docstrange(
 
 # Or, configure per-request:
 client.with_options(max_retries=5).extract.sync(
-    file=b"raw file contents",
     output_format="markdown",
 )
 ```
@@ -222,7 +278,6 @@ client = Docstrange(
 
 # Override per-request:
 client.with_options(timeout=5.0).extract.sync(
-    file=b"raw file contents",
     output_format="markdown",
 )
 ```
@@ -266,7 +321,6 @@ from docstrange import Docstrange
 
 client = Docstrange()
 response = client.extract.with_raw_response.sync(
-    file=b"raw file contents",
     output_format="markdown",
 )
 print(response.headers.get('X-My-Header'))
@@ -287,7 +341,6 @@ To stream the response body, use `.with_streaming_response` instead, which requi
 
 ```python
 with client.extract.with_streaming_response.sync(
-    file=b"raw file contents",
     output_format="markdown",
 ) as response:
     print(response.headers.get("X-My-Header"))

api.md

@@ -3,21 +3,62 @@
 Types:
 
 ```python
-from docstrange.types import ExtractRequestBody, ExtractResponse
+from docstrange.types import (
+    BatchExtractResponse,
+    ExtractResponse,
+    ExtractionFormatResult,
+    ExtractionMetadata,
+    ExtractionResult,
+    ExtractStreamResponse,
+)
 ```
 
 Methods:
 
+- <code title="post /api/v1/extract/async">client.extract.<a href="./src/docstrange/resources/extract/extract.py">async\_</a>(\*\*<a href="src/docstrange/types/extract_async_params.py">params</a>) -> <a href="./src/docstrange/types/extract_response.py">ExtractResponse</a></code>
+- <code title="post /api/v1/extract/batch">client.extract.<a href="./src/docstrange/resources/extract/extract.py">batch</a>(\*\*<a href="src/docstrange/types/extract_batch_params.py">params</a>) -> <a href="./src/docstrange/types/batch_extract_response.py">BatchExtractResponse</a></code>
+- <code title="post /api/v1/extract/stream">client.extract.<a href="./src/docstrange/resources/extract/extract.py">stream</a>(\*\*<a href="src/docstrange/types/extract_stream_params.py">params</a>) -> str</code>
 - <code title="post /api/v1/extract/sync">client.extract.<a href="./src/docstrange/resources/extract/extract.py">sync</a>(\*\*<a href="src/docstrange/types/extract_sync_params.py">params</a>) -> <a href="./src/docstrange/types/extract_response.py">ExtractResponse</a></code>
 
+## Results
+
+Types:
+
+```python
+from docstrange.types.extract import ExtractionListResponse, PaginationInfo
+```
+
+Methods:
+
+- <code title="get /api/v1/extract/results/{record_id}">client.extract.results.<a href="./src/docstrange/resources/extract/results.py">retrieve</a>(record_id, \*\*<a href="src/docstrange/types/extract/result_retrieve_params.py">params</a>) -> <a href="./src/docstrange/types/extract_response.py">ExtractResponse</a></code>
+- <code title="get /api/v1/extract/results">client.extract.results.<a href="./src/docstrange/resources/extract/results.py">list</a>(\*\*<a href="src/docstrange/types/extract/result_list_params.py">params</a>) -> <a href="./src/docstrange/types/extract_response.py">SyncPageNumberPagination[ExtractResponse]</a></code>
+
 # Classify
 
 Types:
 
 ```python
-from docstrange.types import ClassifyRequestBody, ClassifyResponse
+from docstrange.types import (
+    BatchClassifyResponse,
+    ClassifyResponse,
+    FileClassificationResult,
+    PageClassification,
+)
 ```
 
 Methods:
 
+- <code title="post /api/v1/classify/batch">client.classify.<a href="./src/docstrange/resources/classify.py">batch</a>(\*\*<a href="src/docstrange/types/classify_batch_params.py">params</a>) -> <a href="./src/docstrange/types/batch_classify_response.py">BatchClassifyResponse</a></code>
 - <code title="post /api/v1/classify/sync">client.classify.<a href="./src/docstrange/resources/classify.py">sync</a>(\*\*<a href="src/docstrange/types/classify_sync_params.py">params</a>) -> <a href="./src/docstrange/types/classify_response.py">ClassifyResponse</a></code>
+
+# Chat
+
+Types:
+
+```python
+from docstrange.types import ChatCompletionsRequest
+```
+
+Methods:
+
+- <code title="post /v1/chat/completions">client.chat.<a href="./src/docstrange/resources/chat.py">create_completion</a>(\*\*<a href="src/docstrange/types/chat_create_completion_params.py">params</a>) -> object</code>

src/docstrange/_client.py

@@ -31,7 +31,8 @@
 )
 
 if TYPE_CHECKING:
-    from .resources import extract, classify
+    from .resources import chat, extract, classify
+    from .resources.chat import ChatResource, AsyncChatResource
     from .resources.classify import ClassifyResource, AsyncClassifyResource
     from .resources.extract.extract import ExtractResource, AsyncExtractResource
 
@@ -114,6 +115,12 @@ def classify(self) -> ClassifyResource:
 
         return ClassifyResource(self)
 
+    @cached_property
+    def chat(self) -> ChatResource:
+        from .resources.chat import ChatResource
+
+        return ChatResource(self)
+
     @cached_property
     def with_raw_response(self) -> DocstrangeWithRawResponse:
         return DocstrangeWithRawResponse(self)
@@ -294,6 +301,12 @@ def classify(self) -> AsyncClassifyResource:
 
         return AsyncClassifyResource(self)
 
+    @cached_property
+    def chat(self) -> AsyncChatResource:
+        from .resources.chat import AsyncChatResource
+
+        return AsyncChatResource(self)
+
     @cached_property
     def with_raw_response(self) -> AsyncDocstrangeWithRawResponse:
         return AsyncDocstrangeWithRawResponse(self)
@@ -425,6 +438,12 @@ def classify(self) -> classify.ClassifyResourceWithRawResponse:
 
         return ClassifyResourceWithRawResponse(self._client.classify)
 
+    @cached_property
+    def chat(self) -> chat.ChatResourceWithRawResponse:
+        from .resources.chat import ChatResourceWithRawResponse
+
+        return ChatResourceWithRawResponse(self._client.chat)
+
 
 class AsyncDocstrangeWithRawResponse:
     _client: AsyncDocstrange
@@ -444,6 +463,12 @@ def classify(self) -> classify.AsyncClassifyResourceWithRawResponse:
 
         return AsyncClassifyResourceWithRawResponse(self._client.classify)
 
+    @cached_property
+    def chat(self) -> chat.AsyncChatResourceWithRawResponse:
+        from .resources.chat import AsyncChatResourceWithRawResponse
+
+        return AsyncChatResourceWithRawResponse(self._client.chat)
+
 
 class DocstrangeWithStreamedResponse:
     _client: Docstrange
@@ -463,6 +488,12 @@ def classify(self) -> classify.ClassifyResourceWithStreamingResponse:
 
         return ClassifyResourceWithStreamingResponse(self._client.classify)
 
+    @cached_property
+    def chat(self) -> chat.ChatResourceWithStreamingResponse:
+        from .resources.chat import ChatResourceWithStreamingResponse
+
+        return ChatResourceWithStreamingResponse(self._client.chat)
+
 
 class AsyncDocstrangeWithStreamedResponse:
     _client: AsyncDocstrange
@@ -482,6 +513,12 @@ def classify(self) -> classify.AsyncClassifyResourceWithStreamingResponse:
 
         return AsyncClassifyResourceWithStreamingResponse(self._client.classify)
 
+    @cached_property
+    def chat(self) -> chat.AsyncChatResourceWithStreamingResponse:
+        from .resources.chat import AsyncChatResourceWithStreamingResponse
+
+        return AsyncChatResourceWithStreamingResponse(self._client.chat)
+
 
 Client = Docstrange
 

src/docstrange/resources/__init__.py

@@ -1,5 +1,13 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+from .chat import (
+    ChatResource,
+    AsyncChatResource,
+    ChatResourceWithRawResponse,
+    AsyncChatResourceWithRawResponse,
+    ChatResourceWithStreamingResponse,
+    AsyncChatResourceWithStreamingResponse,
+)
 from .extract import (
     ExtractResource,
     AsyncExtractResource,
@@ -30,4 +38,10 @@
     "AsyncClassifyResourceWithRawResponse",
     "ClassifyResourceWithStreamingResponse",
     "AsyncClassifyResourceWithStreamingResponse",
+    "ChatResource",
+    "AsyncChatResource",
+    "ChatResourceWithRawResponse",
+    "AsyncChatResourceWithRawResponse",
+    "ChatResourceWithStreamingResponse",
+    "AsyncChatResourceWithStreamingResponse",
 ]