Metadata-Version: 2.1
Name: unstructured-client
Version: 0.7.0
Summary: Python Client SDK Generated by Speakeasy
Home-page: UNKNOWN
Author: Unstructured
License: UNKNOWN
Platform: UNKNOWN
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: certifi >=2022.12.7
Requires-Dist: charset-normalizer >=2.1.1
Requires-Dist: dataclasses-json >=0.6.1
Requires-Dist: idna >=3.3
Requires-Dist: jsonpath-python >=1.0.6
Requires-Dist: marshmallow >=3.17.1
Requires-Dist: marshmallow-enum >=1.5.1
Requires-Dist: mypy-extensions >=0.4.3
Requires-Dist: packaging >=21.3
Requires-Dist: pyparsing >=3.0.9
Requires-Dist: python-dateutil >=2.8.2
Requires-Dist: requests >=2.28.1
Requires-Dist: six >=1.16.0
Requires-Dist: typing-inspect >=0.8.0
Requires-Dist: typing-extensions >=4.3.0
Requires-Dist: urllib3 >=1.26.12
Provides-Extra: dev
Requires-Dist: pylint ==2.16.2 ; extra == 'dev'

<h3 align="center">
  <img
    src="https://raw.githubusercontent.com/Unstructured-IO/unstructured/main/img/unstructured_logo.png"
    height="200"
  >
</h3>

<div align="center">
    <a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
    <a href="https://github.com/Unstructured-IO/unstructured-client.git/actions"><img src="https://img.shields.io/github/actions/workflow/status/speakeasy-sdks/bolt-php/speakeasy_sdk_generation.yml?style=for-the-badge" /></a>
</div>

<h2 align="center">
  <p>Python SDK for the Unstructured API</p>
</h2>

This is a Python client for the [Unstructured API](https://unstructured-io.github.io/unstructured/api.html). 

<!-- Start SDK Installation -->
## SDK Installation

```bash
pip install unstructured-client
```
<!-- End SDK Installation -->

## Usage
Only the `files` parameter is required. See the [general partition](docs/sdks/general/README.md) page for all available parameters. 

```python
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 Uniﬁed 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.

```python
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"
```

<!-- Start Dev Containers -->

<!-- End Dev Containers -->




<!-- No SDK Example Usage -->

<!-- No SDK Available Operations -->

<!-- No Pagination -->

<!-- Placeholder for Future Speakeasy SDK Sections -->

### 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](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)


