unstructured-client 0.5.1

Python Client SDK Generated by Speakeasy

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

# 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 = "/path/to/document"

with open(filename, "rb") as f:
    req = shared.PartitionParameters(
        files=shared.PartitionParametersFiles(
            content=f.read(),
            files=filename,
        )
    )
    
    res = s.general.partition(req)

    if res.partition_200_application_json_any is not None:
      # handle response

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.config_server_url("http://localhost:8000")

# Using your own server
s.config_server_url("https://my-hosted-api")

SDK Example Usage

import unstructured_client
from unstructured_client.models import shared

s = unstructured_client.UnstructuredClient(
    security=shared.Security(
        api_key_auth="YOUR_API_KEY",
    ),
)

req = shared.PartitionParameters(
    coordinates=False,
    encoding='utf-8',
    files=shared.PartitionParametersFiles(
        content='distinctio'.encode(),
        files='quibusdam',
    ),
    gz_uncompressed_content_type='application/pdf',
    hi_res_model_name='yolox',
    include_page_breaks=False,
    ocr_languages=[
        'eng',
    ],
    output_format='application/json',
    pdf_infer_table_structure=False,
    skip_infer_table_types=[
        'pdf',
    ],
    strategy='hi_res',
    xml_keep_tags=False,
)

res = s.general.partition(req)

if res.elements is not None:
    # handle response

Available Resources and Operations

General

• partition - Pipeline 1

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a Next method that can be called to pull down the next group of results. If the return value of Next is None, then there are no more pages to be fetched.

Here's an example of one such pagination call:

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