Skip to content

Commit 69cb604

Browse files
chore: 🐝 Update SDK - Generate 0.17.0 (#111)
> [!IMPORTANT] > Linting report available at: <https://app.speakeasy.com/org/unstructured/unstructured5xr/linting-report/6c992001320176a471c1952fc685b6de> > OpenAPI Change report available at: <https://app.speakeasy.com/org/unstructured/unstructured5xr/changes-report/1480bceeb03c91bc46bee8aa1716f276> # SDK update Based on: - OpenAPI Doc - Speakeasy CLI 1.398.0 (2.415.8) https://github.com/speakeasy-api/speakeasy ## OpenAPI Change Summary No specification changes Co-authored-by: speakeasybot <[email protected]>
1 parent 5166f33 commit 69cb604

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+1977
-1795
lines changed

.github/workflows/ci.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ jobs:
2525
node-version: 18
2626
- name: Install dependencies
2727
run: make install
28+
- name: Build dependencies
29+
run: make build
2830
- name: Run linter
2931
run: make check
3032
- name: Run unit tests
@@ -48,5 +50,7 @@ jobs:
4850
node-version: 18
4951
- name: Install dependencies
5052
run: make install
53+
- name: Build dependencies
54+
run: make build
5155
- name: Run integration tests
5256
run: make test-integration

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/__tests__
12
/funcs
23
/core.*
34
/esm

.npmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@
77
/cjs
88
/.tshy
99
/.tshy-*
10+
/__tests__

.speakeasy/gen.lock

Lines changed: 49 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ id: f42cb8e6-e2ce-4565-b975-5a9f38b94d5a
33
management:
44
docChecksum: 07648fa4a81409d493b04f9a0210053a
55
docVersion: 1.0.48
6-
speakeasyVersion: 1.390.7
7-
generationVersion: 2.409.8
8-
releaseVersion: 0.16.0
9-
configChecksum: 7d3a89591f1ead1b1ef84078be25d23c
6+
speakeasyVersion: 1.398.0
7+
generationVersion: 2.415.8
8+
releaseVersion: 0.17.0
9+
configChecksum: 2c276110c3d851f4c60673861a0ec379
1010
repoURL: https://github.com/Unstructured-IO/unstructured-js-client.git
1111
repoSubDirectory: .
1212
installationURL: https://github.com/Unstructured-IO/unstructured-js-client
@@ -15,8 +15,9 @@ features:
1515
typescript:
1616
additionalDependencies: 0.1.0
1717
constsAndDefaults: 0.1.11
18-
core: 3.16.1
18+
core: 3.17.3
1919
defaultEnabledRetries: 0.1.0
20+
enumUnions: 0.1.0
2021
envVarSecurityUsage: 0.1.1
2122
examples: 2.81.4
2223
globalSecurity: 2.82.11
@@ -32,16 +33,33 @@ features:
3233
unions: 2.85.7
3334
uploadStreams: 0.1.0
3435
generatedFiles:
35-
- src/funcs/generalPartition.ts
36-
- src/sdk/general.ts
37-
- src/sdk/sdk.ts
3836
- .eslintrc.cjs
37+
- .gitattributes
3938
- .npmignore
39+
- CONTRIBUTING.md
4040
- FUNCTIONS.md
4141
- RUNTIMES.md
42+
- USAGE.md
43+
- docs/sdk/models/errors/detail.md
44+
- docs/sdk/models/errors/httpvalidationerror.md
45+
- docs/sdk/models/errors/servererror.md
46+
- docs/sdk/models/operations/partitionrequest.md
47+
- docs/sdk/models/operations/partitionresponse.md
48+
- docs/sdk/models/shared/chunkingstrategy.md
49+
- docs/sdk/models/shared/files.md
50+
- docs/sdk/models/shared/loc.md
51+
- docs/sdk/models/shared/outputformat.md
52+
- docs/sdk/models/shared/partitionparameters.md
53+
- docs/sdk/models/shared/security.md
54+
- docs/sdk/models/shared/strategy.md
55+
- docs/sdk/models/shared/validationerror.md
4256
- jsr.json
4357
- package.json
4458
- src/core.ts
59+
- src/funcs/generalPartition.ts
60+
- src/hooks/hooks.ts
61+
- src/hooks/index.ts
62+
- src/hooks/types.ts
4563
- src/index.ts
4664
- src/lib/base64.ts
4765
- src/lib/config.ts
@@ -58,10 +76,21 @@ generatedFiles:
5876
- src/lib/sdks.ts
5977
- src/lib/security.ts
6078
- src/lib/url.ts
79+
- src/sdk/general.ts
6180
- src/sdk/index.ts
6281
- src/sdk/models/errors/httpclienterrors.ts
82+
- src/sdk/models/errors/httpvalidationerror.ts
83+
- src/sdk/models/errors/index.ts
6384
- src/sdk/models/errors/sdkerror.ts
6485
- src/sdk/models/errors/sdkvalidationerror.ts
86+
- src/sdk/models/errors/servererror.ts
87+
- src/sdk/models/operations/index.ts
88+
- src/sdk/models/operations/partition.ts
89+
- src/sdk/models/shared/index.ts
90+
- src/sdk/models/shared/partitionparameters.ts
91+
- src/sdk/models/shared/security.ts
92+
- src/sdk/models/shared/validationerror.ts
93+
- src/sdk/sdk.ts
6594
- src/sdk/types/blobs.ts
6695
- src/sdk/types/constdatetime.ts
6796
- src/sdk/types/enums.ts
@@ -71,31 +100,15 @@ generatedFiles:
71100
- src/sdk/types/rfcdate.ts
72101
- src/sdk/types/streams.ts
73102
- tsconfig.json
74-
- src/sdk/models/operations/partition.ts
75-
- src/sdk/models/errors/httpvalidationerror.ts
76-
- src/sdk/models/errors/servererror.ts
77-
- src/sdk/models/shared/validationerror.ts
78-
- src/sdk/models/shared/partitionparameters.ts
79-
- src/sdk/models/shared/security.ts
80-
- src/sdk/models/errors/index.ts
81-
- src/sdk/models/operations/index.ts
82-
- src/sdk/models/shared/index.ts
83-
- docs/sdk/models/operations/partitionrequest.md
84-
- docs/sdk/models/operations/partitionresponse.md
85-
- docs/sdk/models/errors/detail.md
86-
- docs/sdk/models/errors/httpvalidationerror.md
87-
- docs/sdk/models/errors/servererror.md
88-
- docs/sdk/models/shared/loc.md
89-
- docs/sdk/models/shared/validationerror.md
90-
- docs/sdk/models/shared/chunkingstrategy.md
91-
- docs/sdk/models/shared/files.md
92-
- docs/sdk/models/shared/outputformat.md
93-
- docs/sdk/models/shared/strategy.md
94-
- docs/sdk/models/shared/partitionparameters.md
95-
- docs/sdk/models/shared/security.md
96-
- USAGE.md
97-
- .gitattributes
98-
- src/hooks/hooks.ts
99-
- src/hooks/types.ts
100-
- src/hooks/index.ts
101-
- CONTRIBUTING.md
103+
examples:
104+
partition:
105+
speakeasy-default-partition:
106+
requestBody:
107+
multipart/form-data: {"chunking_strategy": "by_title", "files": {"": "{\"summary\":\"File to be partitioned\",\"externalValue\":\"https://github.com/Unstructured-IO/unstructured/blob/98d3541909f64290b5efb65a226fc3ee8a7cc5ee/example-docs/layout-parser-paper.pdf\"}"}, "split_pdf_page_range": [1, 10], "strategy": "hi_res"}
108+
responses:
109+
"200":
110+
application/json: [{"type": "Title", "element_id": "6aa0ff22f91bbe7e26e8e25ca8052acd", "text": "LayoutParser: A Unified Toolkit for Deep Learning Based Document Image Analysis", "metadata": {"languages": ["eng"], "page_number": 1, "filename": "layout-parser-paper.pdf", "filetype": "application/pdf"}}]
111+
"422":
112+
application/json: {"detail": "<value>"}
113+
5XX:
114+
application/json: {"detail": "An error occurred"}

.speakeasy/workflow.lock

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
speakeasyVersion: 1.390.7
1+
speakeasyVersion: 1.398.0
22
sources:
33
my-source:
44
sourceNamespace: my-source
5-
sourceRevisionDigest: sha256:38f3672383baa94018f7d826c034bf0f3e25ee8ed46d70c4633fc9661441c14b
5+
sourceRevisionDigest: sha256:c94b4493c1e49e6f6a922e16c6ba45f067f862adb66542e7bd3355b195a3477e
66
sourceBlobDigest: sha256:108f49adb0607b20fc4d54949d36599c08c87c2d19e0a40e4bd5a2b91d9ac3e3
77
tags:
88
- latest
@@ -11,9 +11,8 @@ targets:
1111
unstructed-typescript:
1212
source: my-source
1313
sourceNamespace: my-source
14-
sourceRevisionDigest: sha256:38f3672383baa94018f7d826c034bf0f3e25ee8ed46d70c4633fc9661441c14b
14+
sourceRevisionDigest: sha256:c94b4493c1e49e6f6a922e16c6ba45f067f862adb66542e7bd3355b195a3477e
1515
sourceBlobDigest: sha256:108f49adb0607b20fc4d54949d36599c08c87c2d19e0a40e4bd5a2b91d9ac3e3
16-
outLocation: /github/workspace/repo
1716
workflow:
1817
workflowVersion: 1.0.0
1918
speakeasyVersion: latest

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## 0.17.0
2+
3+
### Fixes
4+
Improves retry mechanisms for splitting logic for PDFs to be more resilient to intermittent failures.

FUNCTIONS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ const unstructuredClient = new UnstructuredClientCore();
3232
async function run() {
3333
const res = await generalPartition(unstructuredClient, {
3434
partitionParameters: {
35-
files: await openAsBlob("./sample-file"),
36-
chunkingStrategy: ChunkingStrategy.Basic,
35+
files: await openAsBlob("example.file"),
36+
chunkingStrategy: ChunkingStrategy.ByTitle,
3737
splitPdfPageRange: [
3838
1,
3939
10,

README.md

Lines changed: 72 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -163,36 +163,39 @@ To change the default retry strategy for a single API call, simply provide a ret
163163
```typescript
164164
import { openAsBlob } from "node:fs";
165165
import { UnstructuredClient } from "unstructured-client";
166-
import { ChunkingStrategy, Strategy } from "unstructured-client/sdk/models/shared";
166+
import {
167+
ChunkingStrategy,
168+
Strategy,
169+
} from "unstructured-client/sdk/models/shared";
167170

168171
const unstructuredClient = new UnstructuredClient();
169172

170173
async function run() {
171-
const result = await unstructuredClient.general.partition(
172-
{
173-
partitionParameters: {
174-
files: await openAsBlob("./sample-file"),
175-
chunkingStrategy: ChunkingStrategy.ByTitle,
176-
splitPdfPageRange: [1, 10],
177-
strategy: Strategy.HiRes,
178-
},
179-
},
180-
{
181-
retries: {
182-
strategy: "backoff",
183-
backoff: {
184-
initialInterval: 1,
185-
maxInterval: 50,
186-
exponent: 1.1,
187-
maxElapsedTime: 100,
188-
},
189-
retryConnectionErrors: false,
190-
},
191-
}
192-
);
193-
194-
// Handle the result
195-
console.log(result);
174+
const result = await unstructuredClient.general.partition({
175+
partitionParameters: {
176+
files: await openAsBlob("example.file"),
177+
chunkingStrategy: ChunkingStrategy.ByTitle,
178+
splitPdfPageRange: [
179+
1,
180+
10,
181+
],
182+
strategy: Strategy.HiRes,
183+
},
184+
}, {
185+
retries: {
186+
strategy: "backoff",
187+
backoff: {
188+
initialInterval: 1,
189+
maxInterval: 50,
190+
exponent: 1.1,
191+
maxElapsedTime: 100,
192+
},
193+
retryConnectionErrors: false,
194+
},
195+
});
196+
197+
// Handle the result
198+
console.log(result);
196199
}
197200

198201
run();
@@ -203,33 +206,39 @@ If you'd like to override the default retry strategy for all operations that sup
203206
```typescript
204207
import { openAsBlob } from "node:fs";
205208
import { UnstructuredClient } from "unstructured-client";
206-
import { ChunkingStrategy, Strategy } from "unstructured-client/sdk/models/shared";
209+
import {
210+
ChunkingStrategy,
211+
Strategy,
212+
} from "unstructured-client/sdk/models/shared";
207213

208214
const unstructuredClient = new UnstructuredClient({
209-
retryConfig: {
210-
strategy: "backoff",
211-
backoff: {
212-
initialInterval: 1,
213-
maxInterval: 50,
214-
exponent: 1.1,
215-
maxElapsedTime: 100,
216-
},
217-
retryConnectionErrors: false,
215+
retryConfig: {
216+
strategy: "backoff",
217+
backoff: {
218+
initialInterval: 1,
219+
maxInterval: 50,
220+
exponent: 1.1,
221+
maxElapsedTime: 100,
218222
},
223+
retryConnectionErrors: false,
224+
},
219225
});
220226

221227
async function run() {
222-
const result = await unstructuredClient.general.partition({
223-
partitionParameters: {
224-
files: await openAsBlob("./sample-file"),
225-
chunkingStrategy: ChunkingStrategy.ByTitle,
226-
splitPdfPageRange: [1, 10],
227-
strategy: Strategy.HiRes,
228-
},
229-
});
228+
const result = await unstructuredClient.general.partition({
229+
partitionParameters: {
230+
files: await openAsBlob("example.file"),
231+
chunkingStrategy: ChunkingStrategy.ByTitle,
232+
splitPdfPageRange: [
233+
1,
234+
10,
235+
],
236+
strategy: Strategy.HiRes,
237+
},
238+
});
230239

231-
// Handle the result
232-
console.log(result);
240+
// Handle the result
241+
console.log(result);
233242
}
234243

235244
run();
@@ -327,22 +336,28 @@ Certain SDK methods accept files as part of a multi-part request. It is possible
327336
```typescript
328337
import { openAsBlob } from "node:fs";
329338
import { UnstructuredClient } from "unstructured-client";
330-
import { ChunkingStrategy, Strategy } from "unstructured-client/sdk/models/shared";
339+
import {
340+
ChunkingStrategy,
341+
Strategy,
342+
} from "unstructured-client/sdk/models/shared";
331343

332344
const unstructuredClient = new UnstructuredClient();
333345

334346
async function run() {
335-
const result = await unstructuredClient.general.partition({
336-
partitionParameters: {
337-
files: await openAsBlob("./sample-file"),
338-
chunkingStrategy: ChunkingStrategy.ByTitle,
339-
splitPdfPageRange: [1, 10],
340-
strategy: Strategy.HiRes,
341-
},
342-
});
347+
const result = await unstructuredClient.general.partition({
348+
partitionParameters: {
349+
files: await openAsBlob("example.file"),
350+
chunkingStrategy: ChunkingStrategy.ByTitle,
351+
splitPdfPageRange: [
352+
1,
353+
10,
354+
],
355+
strategy: Strategy.HiRes,
356+
},
357+
});
343358

344-
// Handle the result
345-
console.log(result);
359+
// Handle the result
360+
console.log(result);
346361
}
347362

348363
run();

RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -444,4 +444,14 @@ Based on:
444444
### Generated
445445
- [typescript v0.16.0] .
446446
### Releases
447-
- [NPM v0.16.0] https://www.npmjs.com/package/unstructured-client/v/0.16.0 - .
447+
- [NPM v0.16.0] https://www.npmjs.com/package/unstructured-client/v/0.16.0 - .
448+
449+
## 2024-09-17 00:22:00
450+
### Changes
451+
Based on:
452+
- OpenAPI Doc
453+
- Speakeasy CLI 1.398.0 (2.415.8) https://github.com/speakeasy-api/speakeasy
454+
### Generated
455+
- [typescript v0.17.0] .
456+
### Releases
457+
- [NPM v0.17.0] https://www.npmjs.com/package/unstructured-client/v/0.17.0 - .

0 commit comments

Comments
 (0)