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-3843cc83cc328a1c86126018a4309fbcd13aac4df5fd9afefd652e21e59530ab.yml
-openapi_spec_hash: b4046d95714426b15edb8ac003f904c6
-config_hash: aed0d6cc8b4cffa1f02021baec0a6da3
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/nanonets%2Fdocstrange-eed2d21f54dac82f72faa7f05408973593e5a6338717864d4f37bf2333274518.yml
+openapi_spec_hash: 47cb78aa2caa018fe58742fc19b0a49c
+config_hash: 6f0ab1fd6c4433590ee82d88ab5298a7

README.md

@@ -127,7 +127,7 @@ client = Docstrange()
 
 client.extract.sync(
     file=Path("/path/to/file"),
-    output_format="output_format",
+    output_format="markdown",
 )
 ```
 

api.md

@@ -8,7 +8,7 @@ from docstrange.types import ExtractResponse
 
 Methods:
 
-- <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>
+- <code title="post /api/v1/extract/sync">client.extract.<a href="./src/docstrange/resources/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>
 
 # Classify
 

src/docstrange/_client.py

@@ -32,8 +32,8 @@
 
 if TYPE_CHECKING:
     from .resources import extract, classify
+    from .resources.extract import ExtractResource, AsyncExtractResource
     from .resources.classify import ClassifyResource, AsyncClassifyResource
-    from .resources.extract.extract import ExtractResource, AsyncExtractResource
 
 __all__ = [
     "Timeout",

src/docstrange/pagination.py

@@ -59,7 +59,7 @@ def sync(
         Classify a single document.
 
         Args:
-          categories: JSON array of categories
+          categories: JSON array of category objects
 
           file: File to classify
 
@@ -129,7 +129,7 @@ async def sync(
         Classify a single document.
 
         Args:
-          categories: JSON array of categories
+          categories: JSON array of category objects
 
           file: File to classify
 

src/docstrange/resources/classify.py

@@ -3,22 +3,23 @@
 from __future__ import annotations
 
 from typing import Mapping, cast
+from typing_extensions import Literal
 
 import httpx
 
-from ...types import extract_sync_params
-from ..._types import Body, Query, Headers, NotGiven, FileTypes, not_given
-from ..._utils import extract_files, maybe_transform, deepcopy_minimal, async_maybe_transform
-from ..._compat import cached_property
-from ..._resource import SyncAPIResource, AsyncAPIResource
-from ..._response import (
+from ..types import extract_sync_params
+from .._types import Body, Omit, Query, Headers, NotGiven, FileTypes, omit, not_given
+from .._utils import extract_files, maybe_transform, deepcopy_minimal, async_maybe_transform
+from .._compat import cached_property
+from .._resource import SyncAPIResource, AsyncAPIResource
+from .._response import (
     to_raw_response_wrapper,
     to_streamed_response_wrapper,
     async_to_raw_response_wrapper,
     async_to_streamed_response_wrapper,
 )
-from ..._base_client import make_request_options
-from ...types.extract_response import ExtractResponse
+from .._base_client import make_request_options
+from ..types.extract_response import ExtractResponse
 
 __all__ = ["ExtractResource", "AsyncExtractResource"]
 
@@ -48,6 +49,13 @@ def sync(
         *,
         file: FileTypes,
         output_format: str,
+        csv_options: str | Omit = omit,
+        custom_instructions: str | Omit = omit,
+        file_base64: str | Omit = omit,
+        file_url: str | Omit = omit,
+        include_metadata: str | Omit = omit,
+        json_options: str | Omit = omit,
+        prompt_mode: Literal["append", "replace"] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -59,9 +67,23 @@ def sync(
         Process a document and return extracted content immediately.
 
         Args:
-          file: File to upload
+          file: File to upload (PDF, Word, Excel, PowerPoint, images)
 
-          output_format: Output format
+          output_format: Output format(s): markdown, html, json, csv.
+
+          csv_options: CSV extraction options
+
+          custom_instructions: Custom extraction instructions
+
+          file_base64: Base64-encoded file content
+
+          file_url: URL to download file from
+
+          include_metadata: Comma-separated metadata types
+
+          json_options: JSON extraction options
+
+          prompt_mode: append or replace
 
           extra_headers: Send extra headers
 
@@ -75,6 +97,13 @@ def sync(
             {
                 "file": file,
                 "output_format": output_format,
+                "csv_options": csv_options,
+                "custom_instructions": custom_instructions,
+                "file_base64": file_base64,
+                "file_url": file_url,
+                "include_metadata": include_metadata,
+                "json_options": json_options,
+                "prompt_mode": prompt_mode,
             }
         )
         files = extract_files(cast(Mapping[str, object], body), paths=[["file"]])
@@ -118,6 +147,13 @@ async def sync(
         *,
         file: FileTypes,
         output_format: str,
+        csv_options: str | Omit = omit,
+        custom_instructions: str | Omit = omit,
+        file_base64: str | Omit = omit,
+        file_url: str | Omit = omit,
+        include_metadata: str | Omit = omit,
+        json_options: str | Omit = omit,
+        prompt_mode: Literal["append", "replace"] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -129,9 +165,23 @@ async def sync(
         Process a document and return extracted content immediately.
 
         Args:
-          file: File to upload
+          file: File to upload (PDF, Word, Excel, PowerPoint, images)
+
+          output_format: Output format(s): markdown, html, json, csv.
+
+          csv_options: CSV extraction options
+
+          custom_instructions: Custom extraction instructions
+
+          file_base64: Base64-encoded file content
+
+          file_url: URL to download file from
+
+          include_metadata: Comma-separated metadata types
+
+          json_options: JSON extraction options
 
-          output_format: Output format
+          prompt_mode: append or replace
 
           extra_headers: Send extra headers
 
@@ -145,6 +195,13 @@ async def sync(
             {
                 "file": file,
                 "output_format": output_format,
+                "csv_options": csv_options,
+                "custom_instructions": custom_instructions,
+                "file_base64": file_base64,
+                "file_url": file_url,
+                "include_metadata": include_metadata,
+                "json_options": json_options,
+                "prompt_mode": prompt_mode,
             }
         )
         files = extract_files(cast(Mapping[str, object], body), paths=[["file"]])

…/docstrange/resources/extract/extract.py src/docstrange/resources/extract.pysrc/docstrange/resources/extract/extract.py renamed to src/docstrange/resources/extract.py src/docstrange/resources/extract/extract.py renamed to src/docstrange/resources/extract.py

@@ -11,7 +11,7 @@
 
 class ClassifySyncParams(TypedDict, total=False):
     categories: Required[str]
-    """JSON array of categories"""
+    """JSON array of category objects"""
 
     file: Required[FileTypes]
     """File to classify"""