Python Client SDK for Unstructured API
Project description
Python SDK for the Unstructured API
NOTE: This README is for the 0.26.0-beta
version. The current published SDK, 0.25.5
can be found here.
This is a Python client for the Unstructured API and you can sign up for your API key on https://app.unstructured.io.
Please refer to the Unstructured docs for a full guide to using the client.
Summary
Table of Contents
- SDK Installation
- IDE Support
- SDK Example Usage
- Available Resources and Operations
- File uploads
- Retries
- Error Handling
- Server Selection
- Custom HTTP Client
- Authentication
- Debugging
SDK Installation
The SDK can be installed with either pip or poetry package managers.
PIP
PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
pip install unstructured-client
Poetry
Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml
file to handle project metadata and dependencies.
poetry add unstructured-client
SDK Example Usage
Example
import os
import unstructured_client
from unstructured_client.models import operations, shared
client = unstructured_client.UnstructuredClient(
api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
server_url=os.getenv("UNSTRUCTURED_API_URL"),
)
filename = "PATH_TO_FILE"
with open(filename, "rb") as f:
data = f.read()
req = operations.PartitionRequest(
partition_parameters=shared.PartitionParameters(
files=shared.Files(
content=data,
file_name=filename,
),
# --- Other partition parameters ---
strategy=shared.Strategy.AUTO,
languages=['eng'],
),
)
try:
res = client.general.partition(request=req)
print(res.elements[0])
except Exception as e:
print(e)
Refer to the API parameters page for all available parameters.
Configuration
Splitting PDF by pages
See page splitting for more details.
In order to speed up processing of large PDF files, the client splits up PDFs into smaller files, sends these to the API concurrently, and recombines the results. split_pdf_page
can be set to False
to disable this.
The amount of workers utilized for splitting PDFs is dictated by the split_pdf_concurrency_level
parameter, with a default of 5 and a maximum of 15 to keep resource usage and costs in check. The splitting process leverages asyncio
to manage concurrency effectively.
The size of each batch of pages (ranging from 2 to 20) is internally determined based on the concurrency level and the total number of pages in the document. Because the splitting process uses asyncio
the client can encouter event loop issues if it is nested in another async runner, like running in a gevent
spawned task. Instead, this is safe to run in multiprocessing workers (e.g., using multiprocessing.Pool
with fork
context).
Example:
req = shared.PartitionParameters(
files=files,
strategy="fast",
languages=["eng"],
split_pdf_concurrency_level=8
)
Sending specific page ranges
When split_pdf_page=True
(the default), you can optionally specify a page range to send only a portion of your PDF to be extracted. The parameter takes a list of two integers to specify the range, inclusive. A ValueError is thrown if the page range is invalid.
Example:
req = shared.PartitionParameters(
files=files,
strategy="fast",
languages=["eng"],
split_pdf_page_range=[10,15],
)
Splitting PDF by pages - strict mode
When split_pdf_allow_failed=False
(the default), any errors encountered during sending parallel request will break the process and raise an exception.
When split_pdf_allow_failed=True
, the process will continue even if some requests fail, and the results will be combined at the end (the output from the errored pages will not be included).
Example:
req = shared.PartitionParameters(
files=files,
strategy="fast",
languages=["eng"],
split_pdf_allow_failed=True,
)
Retries
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a RetryConfig
object to the call:
from unstructured_client import UnstructuredClient
from unstructured_client.models import shared
from unstructured_client.utils import BackoffStrategy, RetryConfig
s = UnstructuredClient()
res = s.general.partition(request={
"partition_parameters": {
"files": {
"content": open("example.file", "rb"),
"file_name": "example.file",
},
"chunking_strategy": shared.ChunkingStrategy.BY_TITLE,
"split_pdf_page_range": [
1,
10,
],
"strategy": shared.Strategy.HI_RES,
},
},
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
if res.elements is not None:
# handle response
pass
If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config
optional parameter when initializing the SDK:
from unstructured_client import UnstructuredClient
from unstructured_client.models import shared
from unstructured_client.utils import BackoffStrategy, RetryConfig
s = UnstructuredClient(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
)
res = s.general.partition(request={
"partition_parameters": {
"files": {
"content": open("example.file", "rb"),
"file_name": "example.file",
},
"chunking_strategy": shared.ChunkingStrategy.BY_TITLE,
"split_pdf_page_range": [
1,
10,
],
"strategy": shared.Strategy.HI_RES,
},
})
if res.elements is not None:
# handle response
pass
Custom HTTP Client
The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.
Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient
or AsyncHttpClient
respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client
or httpx.AsyncClient
directly.
For example, you could specify a header for every request that this sdk makes as follows:
from unstructured_client import UnstructuredClient
import httpx
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = UnstructuredClient(client=http_client)
or you could wrap the client with your own custom logic:
from unstructured_client import UnstructuredClient
from unstructured_client.httpclient import AsyncHttpClient
import httpx
class CustomClient(AsyncHttpClient):
client: AsyncHttpClient
def __init__(self, client: AsyncHttpClient):
self.client = client
async def send(
self,
request: httpx.Request,
*,
stream: bool = False,
auth: Union[
httpx._types.AuthTypes, httpx._client.UseClientDefault, None
] = httpx.USE_CLIENT_DEFAULT,
follow_redirects: Union[
bool, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
) -> httpx.Response:
request.headers["Client-Level-Header"] = "added by client"
return await self.client.send(
request, stream=stream, auth=auth, follow_redirects=follow_redirects
)
def build_request(
self,
method: str,
url: httpx._types.URLTypes,
*,
content: Optional[httpx._types.RequestContent] = None,
data: Optional[httpx._types.RequestData] = None,
files: Optional[httpx._types.RequestFiles] = None,
json: Optional[Any] = None,
params: Optional[httpx._types.QueryParamTypes] = None,
headers: Optional[httpx._types.HeaderTypes] = None,
cookies: Optional[httpx._types.CookieTypes] = None,
timeout: Union[
httpx._types.TimeoutTypes, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
extensions: Optional[httpx._types.RequestExtensions] = None,
) -> httpx.Request:
return self.client.build_request(
method,
url,
content=content,
data=data,
files=files,
json=json,
params=params,
headers=headers,
cookies=cookies,
timeout=timeout,
extensions=extensions,
)
s = UnstructuredClient(async_client=CustomClient(httpx.AsyncClient()))
IDE Support
PyCharm
Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.
File uploads
Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
[!TIP]
For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.
from unstructured_client import UnstructuredClient
from unstructured_client.models import shared
s = UnstructuredClient()
res = s.general.partition(request={
"partition_parameters": {
"files": {
"content": open("example.file", "rb"),
"file_name": "example.file",
},
"chunking_strategy": shared.ChunkingStrategy.BY_TITLE,
"split_pdf_page_range": [
1,
10,
],
"strategy": shared.Strategy.HI_RES,
},
})
if res.elements is not None:
# handle response
pass
Debugging
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass your own logger class directly into your SDK.
from unstructured_client import UnstructuredClient
import logging
logging.basicConfig(level=logging.DEBUG)
s = UnstructuredClient(debug_logger=logging.getLogger("unstructured_client"))
Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
Installation Instructions for Local Development
The following instructions are intended to help you get up and running with unstructured-python-client
locally if you are planning to contribute to the project.
-
Using
pyenv
to manage virtualenv's is recommended but not necessary -
Create a virtualenv to work in and activate it, e.g. for one named
unstructured-python-client
:pyenv virtualenv 3.10 unstructured-python-client
pyenv activate unstructured-python-client
-
Run
make install
andmake test
Contributions
While we value open-source contributions to this SDK, this library is generated programmatically by Speakeasy. In order to start working with this repo, you need to:
- Install Speakeasy client locally https://github.com/speakeasy-api/speakeasy#installation
- Run
speakeasy auth login
- Run
make client-generate
. This allows to iterate development with python client.
There are two important files used by make client-generate
:
openapi.json
which is actually not stored here, but fetched from unstructured-api, represents the API that is supported on backend.overlay_client.yaml
is a handcrafted diff that when applied over above, producesopenapi_client.json
which is used to generate SDK.
Once PR with changes is merged, Github CI will autogenerate the Speakeasy client in a new PR, using
the openapi.json
and overlay_client.yaml
You will have to manually bring back the human created lines in it.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
SDK Created by Speakeasy
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file unstructured_client-0.26.0b3.tar.gz
.
File metadata
- Download URL: unstructured_client-0.26.0b3.tar.gz
- Upload date:
- Size: 47.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.8.18 Linux/6.8.0-1014-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8be2e11b2971e524c621f11a1f492de1f124499ed973139143eb0519c028426e |
|
MD5 | e0302b580144f9018374299fe744deff |
|
BLAKE2b-256 | 39c1d5f90e001dffabf9f87ae6311fe9b539a1b1eea25d2085b764cd6fb279fb |
File details
Details for the file unstructured_client-0.26.0b3-py3-none-any.whl
.
File metadata
- Download URL: unstructured_client-0.26.0b3-py3-none-any.whl
- Upload date:
- Size: 60.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.8.18 Linux/6.8.0-1014-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9e6905a1a1d3459304d225660a18e8e6a62c39aacd3e4b1037df5cc9c738133a |
|
MD5 | 597a27a963deb477ecb276f2ef9aaec7 |
|
BLAKE2b-256 | c2016acb9d0d8225d355c2643be7505bd2b26579212e785e5653d7232759a60c |