Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions .speakeasy/gen.lock
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
lockVersion: 2.0.0
id: f42cb8e6-e2ce-4565-b975-5a9f38b94d5a
management:
docChecksum: 75c4d04b99256e1e68d9940a982e1583
docVersion: 1.1.68
speakeasyVersion: 1.634.0
generationVersion: 2.721.0
releaseVersion: 0.27.0
configChecksum: 27956e70414cd99591e801c7e4701835
docChecksum: f69e063f6bdd37a7b29266aa34bb30a4
docVersion: 1.2.0
speakeasyVersion: 1.636.3
generationVersion: 2.723.11
releaseVersion: 0.28.0
configChecksum: 2f7d038efc0c06515032eb8b02c062d8
repoURL: https://github.com/Unstructured-IO/unstructured-js-client.git
repoSubDirectory: .
installationURL: https://github.com/Unstructured-IO/unstructured-js-client
Expand Down Expand Up @@ -53,10 +53,8 @@ generatedFiles:
- docs/sdk/models/shared/security.md
- docs/sdk/models/shared/strategy.md
- docs/sdk/models/shared/validationerror.md
- docs/sdk/models/shared/vlmmodel.md
- docs/sdk/models/shared/vlmmodelprovider.md
- docs/sdks/general/README.md
- docs/sdks/unstructuredclient/README.md
- eslint.config.mjs
- examples/.env.template
- examples/README.md
Expand Down Expand Up @@ -141,3 +139,4 @@ examples:
application/json: {"detail": "An error occurred"}
examplesVersion: 1.0.2
generatedTests: {}
releaseNotes: "## Typescript SDK Changes Detected:\n* `unstructured_client.general.partition()`: \n * `request.partitionParameters.vlmModel` **Changed** **Breaking** :warning:\n"
16 changes: 8 additions & 8 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
speakeasyVersion: 1.634.0
speakeasyVersion: 1.636.3
sources:
my-source:
sourceNamespace: my-source
sourceRevisionDigest: sha256:bb79c0280ddde01e2c792461935790617b4867ce4d03bf000bdee3dffc43b9e2
sourceBlobDigest: sha256:3040373c9d49d3dc7a4d1a497f82579fa11252afd263ebbe6e3a3c728fefe519
sourceRevisionDigest: sha256:05de7030a5d70689f6aa854ba186d44d83fe0951c5ae72a2310e91686946cadf
sourceBlobDigest: sha256:cfb1e6a24482556f98c7b5845db67aaf57ecbf7556a0d9904e673bfe0fc3ba7d
tags:
- latest
- speakeasy-sdk-regen-1759192246
- 1.1.68
- speakeasy-sdk-regen-1760488307
- 1.2.0
targets:
unstructed-typescript:
source: my-source
sourceNamespace: my-source
sourceRevisionDigest: sha256:bb79c0280ddde01e2c792461935790617b4867ce4d03bf000bdee3dffc43b9e2
sourceBlobDigest: sha256:3040373c9d49d3dc7a4d1a497f82579fa11252afd263ebbe6e3a3c728fefe519
sourceRevisionDigest: sha256:05de7030a5d70689f6aa854ba186d44d83fe0951c5ae72a2310e91686946cadf
sourceBlobDigest: sha256:cfb1e6a24482556f98c7b5845db67aaf57ecbf7556a0d9904e673bfe0fc3ba7d
codeSamplesNamespace: my-source-typescript-code-samples
codeSamplesRevisionDigest: sha256:48b37447a8858ac12025cfd1098aa4f1e9a8e86a4c7bc1147aaad3a3bdc7c0ab
codeSamplesRevisionDigest: sha256:c138bec1c39605da1156d9adb9a7ee21d9c28952f59b3f713b5400a97316ac96
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
4 changes: 2 additions & 2 deletions FUNCTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ specific category of applications.
import { openAsBlob } from "node:fs";
import { UnstructuredClientCore } from "unstructured-client/core.js";
import { generalPartition } from "unstructured-client/funcs/generalPartition.js";
import { Strategy, VLMModel, VLMModelProvider } from "unstructured-client/sdk/models/shared";
import { Strategy, VLMModelProvider } from "unstructured-client/sdk/models/shared";

// Use `UnstructuredClientCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
Expand All @@ -38,7 +38,7 @@ async function run() {
10,
],
strategy: Strategy.Auto,
vlmModel: VLMModel.Gpt4o,
vlmModel: "gpt-4o",
vlmModelProvider: VLMModelProvider.Openai,
},
});
Expand Down
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,6 @@ import { openAsBlob } from "node:fs";
import { UnstructuredClient } from "unstructured-client";
import {
Strategy,
VLMModel,
VLMModelProvider,
} from "unstructured-client/sdk/models/shared";

Expand All @@ -223,7 +222,7 @@ async function run() {
10,
],
strategy: Strategy.Auto,
vlmModel: VLMModel.Gpt4o,
vlmModel: "gpt-4o",
vlmModelProvider: VLMModelProvider.Openai,
},
}, {
Expand Down Expand Up @@ -252,7 +251,6 @@ import { openAsBlob } from "node:fs";
import { UnstructuredClient } from "unstructured-client";
import {
Strategy,
VLMModel,
VLMModelProvider,
} from "unstructured-client/sdk/models/shared";

Expand All @@ -279,7 +277,7 @@ async function run() {
10,
],
strategy: Strategy.Auto,
vlmModel: VLMModel.Gpt4o,
vlmModel: "gpt-4o",
vlmModelProvider: VLMModelProvider.Openai,
},
});
Expand Down Expand Up @@ -381,7 +379,6 @@ import { openAsBlob } from "node:fs";
import { UnstructuredClient } from "unstructured-client";
import {
Strategy,
VLMModel,
VLMModelProvider,
} from "unstructured-client/sdk/models/shared";

Expand All @@ -397,7 +394,7 @@ async function run() {
10,
],
strategy: Strategy.Auto,
vlmModel: VLMModel.Gpt4o,
vlmModel: "gpt-4o",
vlmModelProvider: VLMModelProvider.Openai,
},
});
Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -694,4 +694,14 @@ Based on:
### Generated
- [typescript v0.27.0] .
### Releases
- [NPM v0.27.0] https://www.npmjs.com/package/unstructured-client/v/0.27.0 - .
- [NPM v0.27.0] https://www.npmjs.com/package/unstructured-client/v/0.27.0 - .

## 2025-10-16 00:31:05
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.636.3 (2.723.11) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.28.0] .
### Releases
- [NPM v0.28.0] https://www.npmjs.com/package/unstructured-client/v/0.28.0 - .
12 changes: 6 additions & 6 deletions RUNTIMES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:

* [Web Fetch API][web-fetch]
* [Web Streams API][web-streams] and in particular `ReadableStream`
* [Async iterables][async-iter] using `Symbol.asyncIterator`
- [Web Fetch API][web-fetch]
- [Web Streams API][web-streams] and in particular `ReadableStream`
- [Async iterables][async-iter] using `Symbol.asyncIterator`

[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
Expand All @@ -25,7 +25,7 @@ Runtime environments that are explicitly supported are:

The following `tsconfig.json` options are recommended for projects using this
SDK in order to get static type support for features like async iterables,
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
so on):

Expand All @@ -38,11 +38,11 @@ so on):
{
"compilerOptions": {
"target": "es2020", // or higher
"lib": ["es2020", "dom", "dom.iterable"],
"lib": ["es2020", "dom", "dom.iterable"]
}
}
```

While `target` can be set to older ECMAScript versions, it may result in extra,
unnecessary compatibility code being generated if you are not targeting old
runtimes.
runtimes.
3 changes: 1 addition & 2 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import { openAsBlob } from "node:fs";
import { UnstructuredClient } from "unstructured-client";
import {
Strategy,
VLMModel,
VLMModelProvider,
} from "unstructured-client/sdk/models/shared";

Expand All @@ -20,7 +19,7 @@ async function run() {
10,
],
strategy: Strategy.Auto,
vlmModel: VLMModel.Gpt4o,
vlmModel: "gpt-4o",
vlmModelProvider: VLMModelProvider.Openai,
},
});
Expand Down
2 changes: 1 addition & 1 deletion codeSamples.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ actions:
"x-codeSamples":
- "lang": "typescript"
"label": "partition"
"source": "import { openAsBlob } from \"node:fs\";\nimport { UnstructuredClient } from \"unstructured-client\";\nimport { Strategy, VLMModel, VLMModelProvider } from \"unstructured-client/sdk/models/shared\";\n\nconst unstructuredClient = new UnstructuredClient();\n\nasync function run() {\n const result = await unstructuredClient.general.partition({\n partitionParameters: {\n files: await openAsBlob(\"example.file\"),\n strategy: Strategy.Auto,\n vlmModelProvider: VLMModelProvider.Openai,\n vlmModel: VLMModel.Gpt4o,\n chunkingStrategy: \"by_title\",\n splitPdfPageRange: [\n 1,\n 10,\n ],\n },\n });\n\n console.log(result);\n}\n\nrun();"
"source": "import { openAsBlob } from \"node:fs\";\nimport { UnstructuredClient } from \"unstructured-client\";\nimport { Strategy, VLMModelProvider } from \"unstructured-client/sdk/models/shared\";\n\nconst unstructuredClient = new UnstructuredClient();\n\nasync function run() {\n const result = await unstructuredClient.general.partition({\n partitionParameters: {\n files: await openAsBlob(\"example.file\"),\n strategy: Strategy.Auto,\n vlmModelProvider: VLMModelProvider.Openai,\n vlmModel: \"gpt-4o\",\n chunkingStrategy: \"by_title\",\n splitPdfPageRange: [\n 1,\n 10,\n ],\n },\n });\n\n console.log(result);\n}\n\nrun();"
Loading