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(
# Note that this currently only supports a single file
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.
# Using a local server
s = unstructured_client.UnstructuredClient(
server_url="http://localhost:8000",
security=shared.Security(
api_key_auth=api_key,
),
)
# Using your own server
s = unstructured_client.UnstructuredClient(
server_url="https://your-server",
security=shared.Security(
api_key_auth=api_key,
),
)
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.8.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8ca638b39f7f316816ef3764676b3118895a2f457a1019823f02923699124d2 |
|
MD5 | 53616ae24b9f3399f447c17eecd7af92 |
|
BLAKE2b-256 | 1ab93f0e5779b320fc04e45fdca33e8c8acca0d98ff911340eb4c346ea66105f |
Hashes for unstructured_client-0.8.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 634bf7bc262c5afcd84d1ae9cad5c5eb68d4648a6912e7fb920eabfabe44fee6 |
|
MD5 | 5a3944288b30405e4af4202aab8902e6 |
|
BLAKE2b-256 | f6c736bf09c7aca758fe073df81938804a517f141d78448b0ce6d2e81a138fce |