Python Client SDK Generated by Speakeasy
Project description
Python SDK for the Unstructured API
This is a Python client for the Unstructured API.
SDK Installation
pip install unstructured-client
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
# Note - in an upcoming release, the Security object is removed
# You'll pass the api key directly
s = UnstructuredClient(
security=shared.Security(
api_key_auth="YOUR_API_KEY",
),
)
filename = "sample-docs/layout-parser-paper.pdf"
file = open(filename, "rb")
req = shared.PartitionParameters(
files=shared.PartitionParametersFiles(
content=file.read(),
files=filename,
),
# Other partition params
strategy="fast",
)
try:
res = s.general.partition(req)
print(res.elements[0])
except SDKError as e:
print(e)
# {
# 'type': 'Title',
# 'element_id': '015301d4f56aa4b20ec10ac889d2343f',
# 'metadata': {'filename': 'layout-parser-paper.pdf', 'filetype': 'application/pdf', 'page_number': 1},
# 'text': 'LayoutParser: A Unified Toolkit for Deep Learning Based Document Image Analysis'
# }
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.
s = UnstructuredClient()
# Using a local server
s.general.sdk_configuration.server_url = "http://localhost:8000"
# Using your own server
s.general.sdk_configuration.server_url = "https://your-server"
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.7.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 79d440babeeb112211d53bc3b614802fa0255697f46868b7f7ed164dc523562f |
|
MD5 | 7ca63a904e7720157c687070b84d7c11 |
|
BLAKE2b-256 | a7350142f60dfad39e838ddc13faf949f149ed430666ff418b3691869d30e0ad |
Hashes for unstructured_client-0.7.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 94b2e20a4e17444305b26f6f10112968c24bc84f9a7da3ef2d48dd4002719e55 |
|
MD5 | e5e9937c580c6d5a915fd4e33706d721 |
|
BLAKE2b-256 | f6ecb2492c64f3dbbd5e8a57bca6fa3410ae359fd595414e06e4c5d65a1b7be4 |