Skip to content

Commit a76e35e

Browse files
authored
Update README.md
1 parent e9caac3 commit a76e35e

File tree

1 file changed

+8
-36
lines changed

1 file changed

+8
-36
lines changed

README.md

Lines changed: 8 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,17 @@
55
>
66
</h3>
77
8-
# unstructured-client
9-
108
<div align="left">
119
<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>
1210
<a href="https://github.com/Unstructured-IO/unstructured-js-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>
13-
1411
</div>
1512

13+
<h2 align="center">
14+
<p>Typescript SDK for the Unstructured API</p>
15+
</h2>
16+
17+
This is a Typescript client for the [Unstructured API](https://unstructured-io.github.io/unstructured/api.html).
18+
1619
<!-- Start SDK Installation -->
1720
## SDK Installation
1821

@@ -30,7 +33,8 @@ yarn add https://github.com/Unstructured-IO/unstructured-js-client
3033
<!-- End SDK Installation -->
3134

3235
## SDK Example Usage
33-
<!-- Start SDK Example Usage -->
36+
Only the `files` parameter is required. See the [general partition]([General](docs/sdks/general/README.md)) page for all available parameters.
37+
3438
```typescript
3539
import { Unstructured } from "unstructured-client";
3640
import { PartitionResponse } from "unstructured-client/dist/sdk/models/operations";
@@ -67,43 +71,11 @@ sdk.general.partition({
6771
}
6872
});
6973
```
70-
<!-- End SDK Example Usage -->
71-
72-
<!-- Start SDK Available Operations -->
73-
## Available Resources and Operations
74-
75-
76-
### [General](docs/sdks/general/README.md)
77-
78-
* [partition](docs/sdks/general/README.md#partition) - Pipeline 1
79-
<!-- End SDK Available Operations -->
80-
81-
8274

8375
<!-- Start Dev Containers -->
84-
85-
86-
8776
<!-- End Dev Containers -->
88-
89-
90-
91-
<!-- Start Pagination -->
92-
# Pagination
93-
94-
Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
95-
returned response object will have a `next` method that can be called to pull down the next group of results. If the
96-
return value of `next` is `null`, then there are no more pages to be fetched.
97-
98-
Here's an example of one such pagination call:
99-
100-
101-
<!-- End Pagination -->
102-
10377
<!-- Placeholder for Future Speakeasy SDK Sections -->
10478

105-
106-
10779
### Maturity
10880

10981
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage

0 commit comments

Comments
 (0)