Bash.UnstructuredIO.Client
1.0.0-beta.1
See the version list below for details.
dotnet add package Bash.UnstructuredIO.Client --version 1.0.0-beta.1
NuGet\Install-Package Bash.UnstructuredIO.Client -Version 1.0.0-beta.1
<PackageReference Include="Bash.UnstructuredIO.Client" Version="1.0.0-beta.1" />
paket add Bash.UnstructuredIO.Client --version 1.0.0-beta.1
#r "nuget: Bash.UnstructuredIO.Client, 1.0.0-beta.1"
// Install Bash.UnstructuredIO.Client as a Cake Addin #addin nuget:?package=Bash.UnstructuredIO.Client&version=1.0.0-beta.1&prerelease // Install Bash.UnstructuredIO.Client as a Cake Tool #tool nuget:?package=Bash.UnstructuredIO.Client&version=1.0.0-beta.1&prerelease
Bash.UnstructuredIO.Client
Unofficial .NET SDK for the Unstructured API</p>
This is a .NET client for the Unstructured API.
Getting started
Install from NuGet
Install package Bash.UnstructuredIO.Client
from Nuget. Here's how via command line:
Install-Package Bash.UnstructuredIO.Client
SDK Example Usage
Using Dependency Injection
builder.Services.AddSingleton<IUnstructuredClient>(
new UnstructuredClient("http://localhost:8000", "my-key-123")
);
Directly Instantiating the client
UnstructuredClient unstructuredClient = new UnstructuredClient("http://localhost:8000", "my-key-123");
If you are self hosting the API, or developing locally, you can change the server URL when setting up the client. The api-key is optional and can be ommited.
Usage
var filePath = "SampleFiles\\lorem_ipsum.docx";
var result = await _unstructuredClient.PartitionAsync(filePath, CancellationToken.None);
var elements = result.Data;
foreach (var element in elements)
{
Console.WriteLine(element.Text);
}
Additional Parameters
See the api parameters page for all available parameters.
var options = new ExtractionOptions()
{
Strategy = UnstructuredConstants.Strategy.HighResolution,
Coordinates = true
};
var result = await unstructuredClient.PartitionAsync(filePath, options, CancellationToken.None);
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
This was a project aimed at learning how NuGet packages can be created alongwith the itch of doing some .NET besides work. Contributions are very welcome and needed. This is not probably following the best practices so willing to learn whoever contributes to do a code review!
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- System.Text.Json (>= 8.0.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.0.0 | 100 | 5/24/2024 |
1.0.0-beta.2 | 66 | 3/6/2024 |
1.0.0-beta.1 | 49 | 3/6/2024 |
First beta release