Python Client SDK for Unstructured API
Project description
Python SDK for the Unstructured API
This is a Python client for the Unstructured API.
SDK Installation
pip install unstructured-client
/docs/models/shared/partitionparameters.md
Usage
Only the files
parameter is required. See the general partition page for all available parameters.
from unstructured_client import UnstructuredClient
from unstructured_client.models import shared
from unstructured_client.models.errors import SDKError
s = UnstructuredClient(api_key_auth="YOUR_API_KEY")
filename = "sample-docs/layout-parser-paper-fast.pdf"
with open(filename, "rb") as f:
# Note that this currently only supports a single file
files=shared.Files(
content=f.read(),
file_name=filename,
)
req = shared.PartitionParameters(
files=files,
# Other partition params
strategy='ocr_only',
languages=["eng"],
)
try:
resp = s.general.partition(req)
print(resp.elements[0])
except SDKError as e:
print(e)
# {
# 'type': 'UncategorizedText',
# 'element_id': 'fc550084fda1e008e07a0356894f5816',
# 'metadata': {
# 'filename': 'layout-parser-paper-fast.pdf',
# 'filetype': 'application/pdf',
# 'languages': ['eng'],
# 'page_number': 1
# }
# }
Change the base URL
If you are self hosting the API, or developing locally, you can change the server URL when setting up the client.
# Using a local server
s = unstructured_client.UnstructuredClient(
server_url="http://localhost:8000",
api_key_auth=api_key,
)
# Using your own server
s = unstructured_client.UnstructuredClient(
server_url="https://your-server",
api_key_auth=api_key,
)
Custom HTTP Client
The Python SDK makes API calls using the requests 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 a custom requests.Session
object.
For example, you could specify a header for every request that this sdk makes as follows:
import unstructured_client
import requests
http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = unstructured_client.UnstructuredClient(client: http_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.
Contributions
While we value open-source contributions to this SDK, this library is generated programmatically. 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
Hashes for unstructured-client-0.21.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ccd4dfc998b5374287ade1507d62df522275e1031720fe022f5df14fdaad8cf4 |
|
MD5 | fe1e756eb4395d485b57453920a335fc |
|
BLAKE2b-256 | 2262ca539c7ecca4368c84acaeb76f595b3023ab37085091461dcedc2f1d7290 |
Hashes for unstructured_client-0.21.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 128ea438bd3496b3f12d1d4bacd2c1bad1a67003b301d035abe6ddd1da602cd0 |
|
MD5 | dc6dd0eb965dc2cce867b3ae1011bcff |
|
BLAKE2b-256 | f026c8b110227a8edff0879386085317fa6a2e27706442a0a5a3605745200a81 |